Class Encrypt

Summary

Fully Qualified Name: Zend\Filter\Encrypt
Extends: AbstractFilter

Description

Encrypts a given string

Methods

Name Description Defined By
__call() Calls adapter methods Encrypt
__construct() Class constructor Encrypt
__invoke() Invoke filter as a command AbstractFilter
filter() Defined by Zend\Filter\Filter Encrypt
getAdapter() Returns the name of the set adapter Encrypt
getAdapterInstance() Returns the adapter instance Encrypt
getOptions() Retrieve options representing object state AbstractFilter
hasPcreUnicodeSupport() AbstractFilter
setAdapter() Sets new encryption options Encrypt
setOptions() AbstractFilter

Method Details

__call()

Calls adapter methods

Parameter Name Type Description
$method string Method
$options string|array Options

Returns: mixed

__construct()

Class constructor

Parameter Name Type Description
$options string|array|\Traversable (Optional)

Returns:

__invoke()

Invoke filter as a command

Proxies to {@link filter()}

Parameter Name Type Description
$value mixed

Returns: mixed

filter()

Defined by Zend\Filter\Filter

Encrypts the content $value with the defined settings

Parameter Name Type Description
$value string Content

Returns: string The encrypted content

getAdapter()

Returns the name of the set adapter

Returns: string

getAdapterInstance()

Returns the adapter instance

Returns: \Encrypt\EncryptionAlgorithmInterface

getOptions()

Retrieve options representing object state

Returns: array

hasPcreUnicodeSupport()

Returns: bool

setAdapter()

Sets new encryption options

Parameter Name Type Description
$options string|array (Optional)

Returns: self

setOptions()

Parameter Name Type Description
$options array|\Traversable

Returns: self

Top