API Documentation

Filter/File/Encrypt.php

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-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Filter  
version
$Id: Encrypt.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_Filter_File_Encrypt

Encrypts a given file and stores the encrypted file content

Extends from
\Zend_Filter_Encrypt
category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Filter  

Properties

Propertyprotectedstring  $_filename= ''

New filename to set

Details
Type
string

Methods

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

Calls adapter methods

Inherited from: \Zend_Filter_Encrypt::__call()
Parameters
Name Type Description
$method string Method to call
$options string|array Options for this method
methodpublic__construct( string|array $options = null ) : void

Class constructor

Inherited from: \Zend_Filter_Encrypt::__construct()
Parameters
Name Type Description
$options string|array

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

methodpublicfilter( string $value ) : string

Defined by Zend_Filter_Interface

Encrypts the file $value with the defined settings

Parameters
Name Type Description
$value string Full path of file to change
Returns
Type Description
string The filename which has been set, or false when there were errors
Throws
Exception Description
\Zend_Filter_Exception If filtering $value is impossible
methodpublicgetAdapter( ) : string

Returns the name of the set adapter

Inherited from: \Zend_Filter_Encrypt::getAdapter()
Returns
Type Description
string
methodpublicgetFilename( ) : string

Returns the new filename where the content will be stored

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

Sets new encryption options

Inherited from: \Zend_Filter_Encrypt::setAdapter()
Parameters
Name Type Description
$options string|array

(Optional) Encryption options

Returns
Type Description
\Zend_Filter_Encrypt
methodpublicsetFilename( string $filename = null ) : \Zend_Filter_File_Encryt

Sets the new filename where the content will be stored

Parameters
Name Type Description
$filename string

(Optional) New filename to set

Returns
Type Description
\Zend_Filter_File_Encryt
Documentation was generated by DocBlox 0.13.3.