Filter/File/Decrypt.php
LICENSE
This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Filter
- Version
- $Id: Decrypt.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_Filter_File_Decrypt
- Parent(s)
- \Zend_Filter_Decrypt < \Zend_Filter_Encrypt
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties


$_adapter
- Type
- n/a
- Inherited_from
- \Zend_Filter_Encrypt::$$_adapter
- Inherited_from
- \Zend_Filter_Decrypt::$$_adapter
Methods


__call(string $method, string | array $options) : void
Calls adapter methods
Inherited from: \Zend_Filter_Encrypt::__call()\Zend_Filter_Decrypt::__call()Name | Type | Description |
---|---|---|
$method | string | Method to call |
$options | string | array | Options for this method |


__construct(string | array $options = null) : void
Class constructor
Inherited from: \Zend_Filter_Encrypt::__construct()\Zend_Filter_Decrypt::__construct()Name | Type | Description |
---|---|---|
$options | string | array | (Optional) Options to set, if null mcrypt is used |


filter(string $value) : string
Defined by Zend_Filter_Interface
Decrypts the file $value with the defined settings
Name | Type | Description |
---|---|---|
$value | string | Full path of file to change |
Type | Description |
---|---|
string | The filename which has been set, or false when there were errors |
Exception | Description |
---|---|
\Zend_Filter_Exception | If filtering $value is impossible |


getAdapter() : string
Returns the name of the set adapter
Inherited from: \Zend_Filter_Encrypt::getAdapter()\Zend_Filter_Decrypt::getAdapter()Type | Description |
---|---|
string |


getFilename() : string
Returns the new filename where the content will be stored
Type | Description |
---|---|
string |


setAdapter(string | array $options = null) : \Zend_Filter_Encrypt
Sets new encryption options
Inherited from: \Zend_Filter_Encrypt::setAdapter()\Zend_Filter_Decrypt::setAdapter()Name | Type | Description |
---|---|---|
$options | string | array | (Optional) Encryption options |
Type | Description |
---|---|
\Zend_Filter_Encrypt |