package |
Default |
inherited_from |
\Zend\Filter\Decrypt |
Methods
Calls adapter methods
__call(string $method, string|array $options) : mixed
Inherited
Parameters
$method
string
Method to call
$options
string
array
Options for this method
Exceptions
\Zend\Filter\Exception\BadMethodCallException |
|
Returns
mixed
Class constructor
__construct(string|array|\Traversable $options = null
)
Inherited
Parameters
$options
string
array
\Traversable
(Optional) Options to set, if null mcrypt is used
Invoke filter as a command
__invoke(mixed $value) : mixed
Inherited
Parameters
$value
mixed
Exceptions
\Zend\Filter\Exception\ExceptionInterface |
If filtering $value is impossible |
Returns
mixed
Defined by Zend\Filter\FilterInterface
filter(string|array $value) : string | array
Decrypts the file $value with the defined settings
inherited_from |
\Zend\Filter\Decrypt::filter() |
Parameters
$value
string
array
Full path of file to change or $_FILES data array
Exceptions
\Zend\Filter\Exception\InvalidArgumentException |
|
\Zend\Filter\Exception\RuntimeException |
|
Returns
string
array
The filename which has been set
Defined by Zend\Filter\Filter
filter(string $value) : string
Inherited
Encrypts the content $value with the defined settings
Parameters
$value
string
Content to encrypt
Returns
string
The encrypted content
Returns the name of the set adapter
getAdapter() : string
Inherited
Returns the adapter instance
getAdapterInstance() : \Zend\Filter\Encrypt\EncryptionAlgorithmInterface
Inherited
Exceptions
\Zend\Filter\Exception\RuntimeException |
|
\Zend\Filter\Exception\InvalidArgumentException |
|
Returns
\Zend\Filter\Encrypt\EncryptionAlgorithmInterface
Returns the new filename where the content will be stored
getFilename() : string
Retrieve options representing object state
getOptions() : array
Inherited
hasPcreUnicodeSupport()
hasPcreUnicodeSupport() : boolean
InheritedStatic
Sets new encryption options
setAdapter(string|array $options = null
) : \Zend\Filter\File\Decrypt
Inherited
fluent |
This method is part of a fluent interface and will return the same instance |
Parameters
$options
string
array
(Optional) Encryption options
Exceptions
\Zend\Filter\Exception\DomainException |
|
\Zend\Filter\Exception\InvalidArgumentException |
|
Returns
\Zend\Filter\File\Decrypt
Sets the new filename where the content will be stored
setFilename(string $filename = null
) : \Zend\Filter\File\Decrypt
fluent |
This method is part of a fluent interface and will return the same instance |
Parameters
$filename
string
(Optional) New filename to set
Returns
\Zend\Filter\File\Decrypt
setOptions()
setOptions(array|\Traversable $options) : \Zend\Filter\File\Decrypt
Inherited
fluent |
This method is part of a fluent interface and will return the same instance |
Parameters
$options
array
\Traversable
Exceptions
\Zend\Filter\Exception\InvalidArgumentException |
|
Returns
\Zend\Filter\File\Decrypt
isOptions()
isOptions(mixed $options) : boolean
InheritedStatic
Parameters
$options
mixed
Returns
boolean
Properties
Encryption adapter
$adapter
New filename to set
$filename : string
Filter options
$options : array