API Documentation

Zend/Filter/Callback.php

Show: inherited
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 24594 2012-01-05 21:27:01Z 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

Propertyprotectedstring|array  $_callback= 'null'

Callback in a call_user_func format

Default valuenullDetails
Type
stringarray
Propertyprotectedmixed  $_options= 'null'

Default options to set for the filter

Default valuenullDetails
Type
mixed

Methods

methodpublic__construct( mixed $options ) : void

Constructor

Parameters
Name Type Description
$options mixed

(Optional) Default options for this filter

methodpublicfilter( mixed $value ) : mixed

Calls the filter per callback

Parameters
Name Type Description
$value mixed

Options for the set callback

Returns
Type Description
mixed Result from the filter which was callbacked
methodpublicgetCallback( ) : string|array

Returns the set callback

Returns
Type Description
string|array Set callback
methodpublicgetOptions( ) : mixed

Returns the set default options

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

Sets a new callback for this filter

Parameters
Name Type Description
$callback \unknown_type
$options
Returns
Type Description
\unknown
methodpublicsetOptions( mixed $options ) : \Zend_Filter_Callback

Sets new default options to the callback filter

Parameters
Name Type Description
$options mixed

Default options to set

Returns
Type Description
\Zend_Filter_Callback
Documentation was generated by DocBlox 0.15.1.