API Documentation

Filter/Callback.php

Includes Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Filter
version
$Id: Callback.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Filter_Callback

Description

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.

Zend_Filter_Callback

Implements
Zend_Filter_Interface
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Filter
Properties
$_callback
$_options
Methods
__construct
getCallback
setCallback
getOptions
setOptions
filter

Description

Properties

$_callback

string|array $_callback = 'null'

Callback in a call_user_func format

Details

$_callback
string|array
visibility
protected
default
null
final
false
static
false

$_options

mixed $_options = 'null'

Default options to set for the filter

Details

$_options
mixed
visibility
protected
default
null
final
false
static
false

Methods

__construct

__construct( mixed $options ) :

Constructor

Arguments
$options
mixed
(Optional) Default options for this filter
Details
visibility
public
final
false
static
false

filter

filter( $value $value ) : mixed

Calls the filter per callback

Arguments
$value
$value
mixed Options for the set callback
Output
mixed
Result from the filter which was callbacked
Details
visibility
public
final
false
static
false

getCallback

getCallback( ) : string|array

Returns the set callback

Output
string|array
Set callback
Details
visibility
public
final
false
static
false

getOptions

getOptions( ) : mixed

Returns the set default options

Output
mixed
Details
visibility
public
final
false
static
false

setCallback

setCallback( unknown_type $callback,  $options = null ) : unknown

Sets a new callback for this filter

Arguments
$callback
unknown_type
$options
Output
unknown
Details
visibility
public
final
false
static
false

setOptions

setOptions( mixed $options ) : Zend_Filter_Callback

Sets new default options to the callback filter

Arguments
$options
mixed
Default options to set
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.