Method definition metadata

package Default

 Methods

Constructor

__construct(null|array $options = null

Parameters

$options

nullarray

Add prototype to method definition

addPrototype(array|\Zend\Server\Method\Prototype $prototype) : \Zend\Server\Method\Definition

Parameters

$prototype

array\Zend\Server\Method\Prototype

Exceptions

\Zend\Server\Exception\InvalidArgumentException

Returns

\Zend\Server\Method\Definition

Add multiple prototypes at once

addPrototypes(array $prototypes) : \Zend\Server\Method\Definition

Parameters

$prototypes

array

Array of \Zend\Server\Method\Prototype objects or arrays

Returns

\Zend\Server\Method\Definition

Get method callback

getCallback() : \Zend\Server\Method\Callback

Returns

\Zend\Server\Method\Callback

Retrieve invoke arguments

getInvokeArguments() : array

Returns

array

Get method help

getMethodHelp() : string

Returns

string

Get method name

getName() : string

Returns

string

Get object to use with method calls

getObject() : null | object

Returns

nullobject

Get all prototypes

getPrototypes() : array

Returns

array$prototypes Array of \Zend\Server\Method\Prototype objects or arrays

Set method callback

setCallback(array|\Zend\Server\Method\Callback $callback) : \Zend\Server\Method\Definition

Parameters

$callback

array\Zend\Server\Method\Callback

Exceptions

\Zend\Server\Exception\InvalidArgumentException

Returns

\Zend\Server\Method\Definition

Set invoke arguments

setInvokeArguments(array $invokeArguments) : \Zend\Server\Method\Definition

Parameters

$invokeArguments

array

Returns

\Zend\Server\Method\Definition

Set method help

setMethodHelp(string $methodHelp) : \Zend\Server\Method\Definition

Parameters

$methodHelp

string

Returns

\Zend\Server\Method\Definition

Set method name

setName(string $name) : \Zend\Server\Method\Definition

Parameters

$name

string

Returns

\Zend\Server\Method\Definition

Set object to use with method calls

setObject(object $object) : \Zend\Server\Method\Definition

Parameters

$object

object

Exceptions

\Zend\Server\Exception\InvalidArgumentException

Returns

\Zend\Server\Method\Definition

Set object state from options

setOptions(array $options) : \Zend\Server\Method\Definition

Parameters

$options

array

Returns

\Zend\Server\Method\Definition

Set all prototypes at once (overwrites)

setPrototypes(array $prototypes) : \Zend\Server\Method\Definition

Parameters

$prototypes

array

Array of \Zend\Server\Method\Prototype objects or arrays

Returns

\Zend\Server\Method\Definition

Serialize to array

toArray() : array

Returns

array

 Properties

 

$callback

$callback : \Zend\Server\Method\Callback

Default

 

$invokeArguments

$invokeArguments : array

Default

array()
 

$methodHelp

$methodHelp : string

Default

''
 

$name

$name : string

Default

 

$object

$object : null | object

Default

 

Array of \Zend\Server\Method\Prototype objects

$prototypes : array

Default

array()