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

\Zend_Filter_File_Decrypt

Package: Zend\Filter
Decrypts a given file and stores the decrypted file content
Parent(s)
\Zend_Filter_Decrypt < \Zend_Filter_Encrypt
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

>VPropertyprotected$_adapter
inherited
Encryption adapter
Inherited from: \Zend_Filter_Encrypt::$$_adapter\Zend_Filter_Decrypt::$$_adapter
Details
Type
n/a
Inherited_from
\Zend_Filter_Encrypt::$$_adapter  
Inherited_from
\Zend_Filter_Decrypt::$$_adapter  
>VPropertyprotectedstring $_filename
New filename to set
Details
Type
string

Methods

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

Calls adapter methods

Inherited from: \Zend_Filter_Encrypt::__call()\Zend_Filter_Decrypt::__call()
Parameters
NameTypeDescription
$methodstring

Method to call

$optionsstring | array

Options for this method

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

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

methodpublicfilter(string $value) : string

Defined by Zend_Filter_Interface

Decrypts the file $value with the defined settings

Parameters
NameTypeDescription
$valuestring

Full path of file to change

Returns
TypeDescription
stringThe filename which has been set, or false when there were errors
Throws
ExceptionDescription
\Zend_Filter_ExceptionIf filtering $value is impossible
methodpublicgetAdapter() : string
inherited

Returns the name of the set adapter

Inherited from: \Zend_Filter_Encrypt::getAdapter()\Zend_Filter_Decrypt::getAdapter()
Returns
TypeDescription
string
methodpublicgetFilename() : string

Returns the new filename where the content will be stored

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

Sets new encryption options

Inherited from: \Zend_Filter_Encrypt::setAdapter()\Zend_Filter_Decrypt::setAdapter()
Parameters
NameTypeDescription
$optionsstring | array

(Optional) Encryption options

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

Sets the new filename where the content will be stored

Parameters
NameTypeDescription
$filenamestring

(Optional) New filename to set

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