Zend_Server_Method_Callback Class Reference

Public Member Functions
	__construct ($options=null)
	setOptions (array $options)
	setClass ($class)
	getClass ()
	setFunction ($function)
	getFunction ()
	setMethod ($method)
	getMethod ()
	setType ($type)
	getType ()
	toArray ()

Protected Attributes
	$_class
	$_function
	$_method
	$_type
	$_types = array('function', 'static', 'instance')

Detailed Description

Definition at line 32 of file Callback.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$options = null

)

Constructor

Parameters

null | array

$options

Returns

void

Definition at line 65 of file Callback.php.

    {
        if ((null !== $options) && is_array($options))  {
            $this->setOptions($options);
        }
    }

Member Function Documentation

getClass()

getClass

(

)

Get callback class

Returns

string|null

Definition at line 109 of file Callback.php.

    {
        return $this->_class;
    }

getFunction()

getFunction

(

)

Get callback function

Returns

null|string

Definition at line 132 of file Callback.php.

    {
        return $this->_function;
    }

getMethod()

getMethod

(

)

Get callback class method

Returns

null|string

Definition at line 154 of file Callback.php.

    {
        return $this->_method;
    }

getType()

getType

(

)

Get callback type

Returns

string

Definition at line 181 of file Callback.php.

    {
        return $this->_type;
    }

setClass()

setClass

(

$class

)

Set callback class

Parameters

string

$class

Returns

Zend_Server_Method_Callback

Definition at line 95 of file Callback.php.

    {
        if (is_object($class)) {
            $class = get_class($class);
        }
        $this->_class = $class;
        return $this;
    }

setFunction()

setFunction

(

$function

)

Set callback function

Parameters

string

$function

Returns

Zend_Server_Method_Callback

Definition at line 120 of file Callback.php.

    {
        $this->_function = (string) $function;
        $this->setType('function');
        return $this;
    }

setMethod()

setMethod

(

$method

)

Set callback class method

Parameters

string

$method

Returns

Zend_Server_Method_Callback

Definition at line 143 of file Callback.php.

    {
        $this->_method = $method;
        return $this;
    }

setOptions()

setOptions

(

array

$options

)

Set object state from array of options

Parameters

array

$options

Returns

Zend_Server_Method_Callback

Definition at line 78 of file Callback.php.

    {
        foreach ($options as $key => $value) {
            $method = 'set' . ucfirst($key);
            if (method_exists($this, $method)) {
                $this->$method($value);
            }
        }
        return $this;
    }

setType()

setType

(

$type

)

Set callback type

Parameters

string

$type

Returns

Zend_Server_Method_Callback

Exceptions

Zend_Server_Exception

Definition at line 166 of file Callback.php.

    {
        if (!in_array($type, $this->_types)) {
            #require_once 'Zend/Server/Exception.php';
            throw new Zend_Server_Exception('Invalid method callback type  passed to ' . __CLASS__ . '::' . __METHOD__);
        }
        $this->_type = $type;
        return $this;
    }

toArray()

toArray

(

)

Cast callback to array

Returns

array

Definition at line 191 of file Callback.php.

    {
        $type = $this->getType();
        $array = array(
            'type' => $type,
        );
        if ('function' == $type) {
            $array['function'] = $this->getFunction();
        } else {
            $array['class']  = $this->getClass();
            $array['method'] = $this->getMethod();
        }
        return $array;
    }

Field Documentation

$_class

$_class

protected

Definition at line 37 of file Callback.php.

$_function

$_function

protected

Definition at line 42 of file Callback.php.

$_method

$_method

protected

Definition at line 47 of file Callback.php.

$_type

$_type

protected

Definition at line 52 of file Callback.php.

$_types

$_types = array('function', 'static', 'instance')

protected

Definition at line 57 of file Callback.php.

---

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

• vendor/magento/zendframework1/library/Zend/Server/Method/Callback.php