Filter/File/Decrypt.php

Show:

inherited

Classes
- \Zend_Filter_File_Decrypt

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
jump to top

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

$_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

string $_filename

New filename to set

Details

Type: string

Methods

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

inherited

Calls adapter methods

Inherited from: \Zend_Filter_Encrypt::__call()\Zend_Filter_Decrypt::__call()

Parameters

Name	Type	Description
$method	string	Method to call
$options	string \| array	Options for this method

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

inherited

Class constructor

Inherited from: \Zend_Filter_Encrypt::__construct()\Zend_Filter_Decrypt::__construct()

Parameters

Name	Type	Description
$options	string \| array	(Optional) Options to set, if null mcrypt is used

filter(string $value) : string

Defined by Zend_Filter_Interface

Decrypts 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

getAdapter() : string

inherited

Returns the name of the set adapter

Inherited from: \Zend_Filter_Encrypt::getAdapter()\Zend_Filter_Decrypt::getAdapter()

Returns

Type	Description
string

getFilename() : string

Returns the new filename where the content will be stored

Returns

Type	Description
string

setAdapter(string | array $options = null) : \Zend_Filter_Encrypt

inherited

Sets new encryption options

Inherited from: \Zend_Filter_Encrypt::setAdapter()\Zend_Filter_Decrypt::setAdapter()

Parameters

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

Returns

Type	Description
\Zend_Filter_Encrypt

setFilename(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

Filter/File/Decrypt.php

\Zend_Filter_File_Decryptjump to top

Properties

Methods

\Zend_Filter_File_Decrypt
jump to top