Filter/Callback.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 [email protected] 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


string|array $_callback = null
Callback in a call_user_func format
Default value
null
Details- Type
- string | array
Methods


__construct(mixed $options) : void
Constructor
Parameters
Name | Type | Description |
---|---|---|
$options | mixed | (Optional) Default options for this filter |


filter(mixed $value) : mixed
Calls the filter per callback
Parameters
Returns
Throws
Name | Type | Description |
---|---|---|
$value | mixed | Options for the set callback |
Type | Description |
---|---|
mixed | Result from the filter which was callbacked |
Exception | Description |
---|---|
\Zend_Filter_Exception | If filtering $value is impossible |


getCallback() : string | array
Returns the set callback
Returns
Type | Description |
---|---|
string | array | Set callback |


setCallback(\unknown_type $callback, $options = null) : \unknown
Sets a new callback for this filter
Parameters
Returns
Name | Type | Description |
---|---|---|
$callback | \unknown_type | |
$options |
Type | Description |
---|---|
\unknown |


setOptions(mixed $options) : \Zend_Filter_Callback
Sets new default options to the callback filter
Parameters
Returns
Name | Type | Description |
---|---|---|
$options | mixed | Default options to set |
Type | Description |
---|---|
\Zend_Filter_Callback |