Zend_Filter_Callback Class Reference

Inheritance diagram for Zend_Filter_Callback:

Public Member Functions
	__construct ($options)
	getCallback ()
	setCallback ($callback, $options=null)
	getOptions ()
	setOptions ($options)
	filter ($value)

Protected Attributes
	$_callback = null
	$_options = null

Detailed Description

Definition at line 33 of file Callback.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$options

)

Constructor

Parameters

string | array	$callback	Callback in a call_user_func format
mixed	$options	(Optional) Default options for this filter

Definition at line 55 of file Callback.php.

    {
        if ($options instanceof Zend_Config) {
            $options = $options->toArray();
        } else if (!is_array($options) || !array_key_exists('callback', $options)) {
            $options          = func_get_args();
            $temp['callback'] = array_shift($options);
            if (!empty($options)) {
                $temp['options'] = array_shift($options);
            }

            $options = $temp;
        }

        if (!array_key_exists('callback', $options)) {
            #require_once 'Zend/Filter/Exception.php';
            throw new Zend_Filter_Exception('Missing callback to use');
        }

        $this->setCallback($options['callback']);
        if (array_key_exists('options', $options)) {
            $this->setOptions($options['options']);
        }
    }

Member Function Documentation

filter()

filter

(

$value

)

Calls the filter per callback

Parameters

mixed

$value

Options for the set callback

Returns

mixed Result from the filter which was callbacked

Implements Zend_Filter_Interface.

Definition at line 136 of file Callback.php.

    {
        $options = array();

        if ($this->_options !== null) {
            if (!is_array($this->_options)) {
                $options = array($this->_options);
            } else {
                $options = $this->_options;
            }
        }

        array_unshift($options, $value);

        return call_user_func_array($this->_callback, $options);
    }

getCallback()

getCallback

(

)

Returns the set callback

Returns

string|array Set callback

Definition at line 85 of file Callback.php.

    {
        return $this->_callback;
    }

getOptions()

getOptions

(

)

Returns the set default options

Returns

mixed

Definition at line 113 of file Callback.php.

    {
        return $this->_options;
    }

setCallback()

setCallback	(		$callback,
			$options = null
	)

Sets a new callback for this filter

Parameters

unknown_type

$callback

Returns

unknown

Definition at line 96 of file Callback.php.

    {
        if (!is_callable($callback)) {
            #require_once 'Zend/Filter/Exception.php';
            throw new Zend_Filter_Exception('Callback can not be accessed');
        }

        $this->_callback = $callback;
        $this->setOptions($options);
        return $this;
    }

setOptions()

setOptions

(

$options

)

Sets new default options to the callback filter

Parameters

mixed

$options

Default options to set

Returns

Zend_Filter_Callback

Definition at line 124 of file Callback.php.

    {
        $this->_options = $options;
        return $this;
    }

Field Documentation

$_callback

$_callback = null

protected

Definition at line 40 of file Callback.php.

$_options

$_options = null

protected

Definition at line 47 of file Callback.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/zendframework1/library/Zend/Filter/Callback.php