Filter/Encrypt.php

Show: PublicProtectedPrivateinherited
Table of Contents
Zend Framework

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: Encrypt.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_Filter_Encrypt

Package: Zend\Filter
Encrypts a given string
Implements
\Zend_Filter_Interface
Children
\Zend_Filter_File_Encrypt
\Zend_Filter_Decrypt
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

>VPropertyprotected$_adapter
Encryption adapter
Details
Type
n/a

Methods

methodpublic__call(string $method, string | array $options) : void

Calls adapter methods

Parameters
NameTypeDescription
$methodstring

Method to call

$optionsstring | array

Options for this method

methodpublic__construct(string | array $options = null) : void

Class constructor

Parameters
NameTypeDescription
$optionsstring | array

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

methodpublicfilter(string $value) : string

Defined by Zend_Filter_Interface

Encrypts the content $value with the defined settings

Parameters
NameTypeDescription
$valuestring

Content to encrypt

Returns
TypeDescription
stringThe encrypted content
Throws
ExceptionDescription
\Zend_Filter_ExceptionIf filtering $value is impossible
methodpublicgetAdapter() : string

Returns the name of the set adapter

Returns
TypeDescription
string
methodpublicsetAdapter(string | array $options = null) : \Zend_Filter_Encrypt

Sets new encryption options

Parameters
NameTypeDescription
$optionsstring | array

(Optional) Encryption options

Returns
TypeDescription
\Zend_Filter_Encrypt
Documentation was generated by phpDocumentor 2.0.0a12.