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

\Zend_Filter_Callback

Package: Zend\Filter
Implements
\Zend_Filter_Interface
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

>VPropertyprotectedstring|array $_callback = null
Callback in a call_user_func format
Default valuenullDetails
Type
string | array
>VPropertyprotectedmixed $_options = null
Default options to set for the filter
Default valuenullDetails
Type
mixed

Methods

methodpublic__construct(mixed $options) : void

Constructor

Parameters
NameTypeDescription
$optionsmixed

(Optional) Default options for this filter

methodpublicfilter(mixed $value) : mixed

Calls the filter per callback

Parameters
NameTypeDescription
$valuemixed

Options for the set callback

Returns
TypeDescription
mixedResult from the filter which was callbacked
Throws
ExceptionDescription
\Zend_Filter_ExceptionIf filtering $value is impossible
methodpublicgetCallback() : string | array

Returns the set callback

Returns
TypeDescription
string | arraySet callback
methodpublicgetOptions() : mixed

Returns the set default options

Returns
TypeDescription
mixed
methodpublicsetCallback(\unknown_type $callback,  $options = null) : \unknown

Sets a new callback for this filter

Parameters
NameTypeDescription
$callback\unknown_type
$options
Returns
TypeDescription
\unknown
methodpublicsetOptions(mixed $options) : \Zend_Filter_Callback

Sets new default options to the callback filter

Parameters
NameTypeDescription
$optionsmixed

Default options to set

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