Zend_Server_Method_Definition Class Reference

Public Member Functions
	__construct ($options=null)
	setOptions (array $options)
	setName ($name)
	getName ()
	setCallback ($callback)
	getCallback ()
	addPrototype ($prototype)
	addPrototypes (array $prototypes)
	setPrototypes (array $prototypes)
	getPrototypes ()
	setMethodHelp ($methodHelp)
	getMethodHelp ()
	setObject ($object)
	getObject ()
	setInvokeArguments (array $invokeArguments)
	getInvokeArguments ()
	toArray ()

Protected Attributes
	$_callback
	$_invokeArguments = array()
	$_methodHelp = ''
	$_name
	$_object
	$_prototypes = array()

Detailed Description

Definition at line 32 of file Definition.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$options = null

)

Constructor

Parameters

null | array

$options

Returns

void

Definition at line 70 of file Definition.php.

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

Member Function Documentation

addPrototype()

addPrototype

(

$prototype

)

Add prototype to method definition

Parameters

array | Zend_Server_Method_Prototype

$prototype

Returns

Zend_Server_Method_Definition

Definition at line 151 of file Definition.php.

    {
        if (is_array($prototype)) {
            #require_once 'Zend/Server/Method/Prototype.php';
            $prototype = new Zend_Server_Method_Prototype($prototype);
        } elseif (!$prototype instanceof Zend_Server_Method_Prototype) {
            #require_once 'Zend/Server/Exception.php';
            throw new Zend_Server_Exception('Invalid method prototype provided');
        }
        $this->_prototypes[] = $prototype;
        return $this;
    }

addPrototypes()

addPrototypes

(

array

$prototypes

)

Add multiple prototypes at once

Parameters

array

$prototypes

Array of Zend_Server_Method_Prototype objects or arrays

Returns

Zend_Server_Method_Definition

Definition at line 170 of file Definition.php.

    {
        foreach ($prototypes as $prototype) {
            $this->addPrototype($prototype);
        }
        return $this;
    }

getCallback()

getCallback

(

)

Get method callback

Returns

Zend_Server_Method_Callback

Definition at line 140 of file Definition.php.

    {
        return $this->_callback;
    }

getInvokeArguments()

getInvokeArguments

(

)

Retrieve invoke arguments

Returns

array

Definition at line 266 of file Definition.php.

    {
        return $this->_invokeArguments;
    }

getMethodHelp()

getMethodHelp

(

)

Get method help

Returns

string

Definition at line 218 of file Definition.php.

    {
        return $this->_methodHelp;
    }

getName()

getName

(

)

Get method name

Returns

string

Definition at line 111 of file Definition.php.

    {
        return $this->_name;
    }

getObject()

getObject

(

)

Get object to use with method calls

Returns

null|object

Definition at line 244 of file Definition.php.

    {
        return $this->_object;
    }

getPrototypes()

getPrototypes

(

)

Get all prototypes

Returns

array $prototypes Array of Zend_Server_Method_Prototype objects or arrays

Definition at line 196 of file Definition.php.

    {
        return $this->_prototypes;
    }

setCallback()

setCallback

(

$callback

)

Set method callback

Parameters

array | Zend_Server_Method_Callback

$callback

Returns

Zend_Server_Method_Definition

Definition at line 122 of file Definition.php.

    {
        if (is_array($callback)) {
            #require_once 'Zend/Server/Method/Callback.php';
            $callback = new Zend_Server_Method_Callback($callback);
        } elseif (!$callback instanceof Zend_Server_Method_Callback) {
            #require_once 'Zend/Server/Exception.php';
            throw new Zend_Server_Exception('Invalid method callback provided');
        }
        $this->_callback = $callback;
        return $this;
    }

setInvokeArguments()

setInvokeArguments

(

array

$invokeArguments

)

Set invoke arguments

Parameters

array

$invokeArguments

Returns

Zend_Server_Method_Definition

Definition at line 255 of file Definition.php.

    {
        $this->_invokeArguments = $invokeArguments;
        return $this;
    }

setMethodHelp()

setMethodHelp

(

$methodHelp

)

Set method help

Parameters

string

$methodHelp

Returns

Zend_Server_Method_Definition

Definition at line 207 of file Definition.php.

    {
        $this->_methodHelp = (string) $methodHelp;
        return $this;
    }

setName()

setName

(

$name

)

Set method name

Parameters

string

$name

Returns

Zend_Server_Method_Definition

Definition at line 100 of file Definition.php.

    {
        $this->_name = (string) $name;
        return $this;
    }

setObject()

setObject

(

$object

)

Set object to use with method calls

Parameters

object

$object

Returns

Zend_Server_Method_Definition

Definition at line 229 of file Definition.php.

    {
        if (!is_object($object) && (null !== $object)) {
            #require_once 'Zend/Server/Exception.php';
            throw new Zend_Server_Exception('Invalid object passed to ' . __CLASS__ . '::' . __METHOD__);
        }
        $this->_object = $object;
        return $this;
    }

setOptions()

setOptions

(

array

$options

)

Set object state from options

Parameters

array

$options

Returns

Zend_Server_Method_Definition

Definition at line 83 of file Definition.php.

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

setPrototypes()

setPrototypes

(

array

$prototypes

)

Set all prototypes at once (overwrites)

Parameters

array

$prototypes

Array of Zend_Server_Method_Prototype objects or arrays

Returns

Zend_Server_Method_Definition

Definition at line 184 of file Definition.php.

    {
        $this->_prototypes = array();
        $this->addPrototypes($prototypes);
        return $this;
    }

toArray()

toArray

(

)

Serialize to array

Returns

array

Definition at line 276 of file Definition.php.

    {
        $prototypes = $this->getPrototypes();
        $signatures = array();
        foreach ($prototypes as $prototype) {
            $signatures[] = $prototype->toArray();
        }

        return array(
            'name'            => $this->getName(),
            'callback'        => $this->getCallback()->toArray(),
            'prototypes'      => $signatures,
            'methodHelp'      => $this->getMethodHelp(),
            'invokeArguments' => $this->getInvokeArguments(),
            'object'          => $this->getObject(),
        );
    }

Field Documentation

$_callback

$_callback

protected

Definition at line 37 of file Definition.php.

$_invokeArguments

$_invokeArguments = array()

protected

Definition at line 42 of file Definition.php.

$_methodHelp

$_methodHelp = ''

protected

Definition at line 47 of file Definition.php.

$_name

$_name

protected

Definition at line 52 of file Definition.php.

$_object

$_object

protected

Definition at line 57 of file Definition.php.

$_prototypes

$_prototypes = array()

protected

Definition at line 62 of file Definition.php.

---

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

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