Server methods metadata

 Methods

Constructor

__construct(null | array $methods) 

Parameters

$methods

nullarray

Add method to definition

addMethod(array | \Zend\Server\Method\Definition $method, null | string $name) : \Zend\Server\Definition

Parameters

$name

nullstring

Exceptions

\Zend\Server\Exception\InvalidArgumentException if duplicate or invalid method provided

Returns

Add multiple methods

addMethods(array $methods) : \Zend\Server\Definition

Parameters

$methods

array

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

Returns

Clear all method definitions

clearMethods() : \Zend\Server\Definition

Countable: count of methods

count() : int

Returns

int

Iterator: current item

current() : \Zend\Server\Method\Definition

Get a given method definition

getMethod(string $method) : null | \Zend\Server\Method\Definition

Parameters

$method

string

Returns

Get all method definitions

getMethods() : array

Returns

arrayArray of \Zend\Server\Method\Definition objects

Does the definition have the given method?

hasMethod(string $method) : bool

Parameters

$method

string

Returns

bool

Iterator: current item key

key() : int | string

Returns

intstring

Remove a method definition

removeMethod(string $method) : \Zend\Server\Definition

Parameters

$method

string

Returns

Iterator: return to first method

rewind() : void

Set all methods at once (overwrite)

setMethods(array $methods) : \Zend\Server\Definition

Parameters

$methods

array

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

Returns

Set flag indicating whether or not overwriting existing methods is allowed

setOverwriteExistingMethods(mixed $flag) : \Zend\Server\Definition

Parameters

$flag

mixed

Returns

Cast definition to an array

toArray() : array

Returns

array

Iterator: is the current index valid?

valid() : bool

Returns

bool

 Properties

 

<p>Array of \Zend\Server\Method\Definition objects</p>

$methods : array

 

<p>Whether or not overwriting existing methods is allowed</p>

$overwriteExistingMethods : bool