Zend Framework » \Zend\Filter\File\Decrypt

Decrypts a given file and stores the decrypted file content

Methods

Calls adapter methods

__call(string $method, string | array $options) : mixed

Inherited

inherited_from	\Zend\Filter\Encrypt::__call()
inherited_from	\Zend\Filter\Decrypt::__call()

Parameters

$method

string

Method to call

$options

stringarray

Options for this method

Exceptions

`\Zend\Filter\Exception\BadMethodCallException`

Returns

mixed

Class constructor

__construct(string | array | \Traversable $options)

Inherited

inherited_from	\Zend\Filter\Encrypt::__construct()
inherited_from	\Zend\Filter\Decrypt::__construct()

Parameters

$options

stringarray\Traversable

(Optional) Options to set, if null mcrypt is used

Invoke filter as a command

__invoke(mixed $value) : mixed

Inherited

Proxies to filter()

inherited_from	\Zend\Filter\AbstractFilter::__invoke()
inherited_from	\Zend\Filter\Encrypt::__invoke()
inherited_from	\Zend\Filter\Decrypt::__invoke()

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

Parameters

$value

stringarray

Full path of file to change or $_FILES data array

Exceptions

`\Zend\Filter\Exception\InvalidArgumentException`
`\Zend\Filter\Exception\RuntimeException`

Returns

stringarrayThe filename which has been set

Returns the name of the set adapter

getAdapter() : string

Inherited

inherited_from	\Zend\Filter\Encrypt::getAdapter()
inherited_from	\Zend\Filter\Decrypt::getAdapter()

Returns

string

Returns the adapter instance

getAdapterInstance() : \Zend\Filter\Encrypt\EncryptionAlgorithmInterface

Inherited

inherited_from	\Zend\Filter\Encrypt::getAdapterInstance()
inherited_from	\Zend\Filter\Decrypt::getAdapterInstance()

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

Returns

string

Retrieve options representing object state

getOptions() : array

Inherited

inherited_from	\Zend\Filter\AbstractFilter::getOptions()
inherited_from	\Zend\Filter\Encrypt::getOptions()
inherited_from	\Zend\Filter\Decrypt::getOptions()

Returns

array

hasPcreUnicodeSupport()

hasPcreUnicodeSupport() : bool

Inherited

inherited_from	\Zend\Filter\AbstractFilter::hasPcreUnicodeSupport()
inherited_from	\Zend\Filter\Encrypt::hasPcreUnicodeSupport()
inherited_from	\Zend\Filter\Decrypt::hasPcreUnicodeSupport()

Returns

bool

Sets new encryption options

setAdapter(string | array $options) : \Zend\Filter\self

Inherited

inherited_from	\Zend\Filter\Encrypt::setAdapter()
inherited_from	\Zend\Filter\Decrypt::setAdapter()

Parameters

$options

stringarray

(Optional) Encryption options

Exceptions

`\Zend\Filter\Exception\DomainException`
`\Zend\Filter\Exception\InvalidArgumentException`

Returns

\Zend\Filter\self

Sets the new filename where the content will be stored

setFilename(string $filename) : \Zend\Filter\File\self

Parameters

$filename

string

(Optional) New filename to set

Returns

\Zend\Filter\File\self

setOptions()

setOptions(array | \Traversable $options) : \Zend\Filter\self

Inherited

inherited_from	\Zend\Filter\AbstractFilter::setOptions()
inherited_from	\Zend\Filter\Encrypt::setOptions()
inherited_from	\Zend\Filter\Decrypt::setOptions()

Parameters

$options

array\Traversable

Exceptions

`\Zend\Filter\Exception\InvalidArgumentException`

Returns

\Zend\Filter\self

isOptions()

isOptions(mixed $options) : bool

Inherited

inherited_from	\Zend\Filter\AbstractFilter::isOptions()
inherited_from	\Zend\Filter\Encrypt::isOptions()
inherited_from	\Zend\Filter\Decrypt::isOptions()

Parameters

$options

mixed

Returns

bool

Properties

Encryption adapter

$adapter

Inherited

param	<p>Encrypt\EncryptionAlgorithmInterface</p>
inherited_from	\Zend\Filter\Encrypt::$$adapter
inherited_from	\Zend\Filter\Decrypt::$$adapter

New filename to set

$filename : string

Filter options

$options : array

Inherited

inherited_from	\Zend\Filter\AbstractFilter::$$options
inherited_from	\Zend\Filter\Encrypt::$$options
inherited_from	\Zend\Filter\Decrypt::$$options