Method parameter metadata

package Default

 Methods

Constructor

__construct(null|array $options = null

Parameters

$options

nullarray

Retrieve default value

getDefaultValue() : mixed

Returns

mixed

Retrieve description

getDescription() : string

Returns

string

Retrieve name

getName() : string

Returns

string

Retrieve parameter type

getType() : string

Returns

string

Is the parameter optional?

isOptional() : boolean

Returns

boolean

Set default value

setDefaultValue(mixed $defaultValue) : \Zend\Server\Method\Parameter

Parameters

$defaultValue

mixed

Returns

\Zend\Server\Method\Parameter

Set description

setDescription(string $description) : \Zend\Server\Method\Parameter

Parameters

$description

string

Returns

\Zend\Server\Method\Parameter

Set name

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

Parameters

$name

string

Returns

\Zend\Server\Method\Parameter

Set optional flag

setOptional(boolean $flag) : \Zend\Server\Method\Parameter

Parameters

$flag

boolean

Returns

\Zend\Server\Method\Parameter

Set object state from array of options

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

Parameters

$options

array

Returns

\Zend\Server\Method\Parameter

Set parameter type

setType(string $type) : \Zend\Server\Method\Parameter

Parameters

$type

string

Returns

\Zend\Server\Method\Parameter

Cast to array

toArray() : array

Returns

array

 Properties

 

Default parameter value

$defaultValue : mixed

Default

 

Parameter description

$description : string

Default

''
 

Parameter variable name

$name : string

Default

 

Is parameter optional?

$optional : boolean

Default

false
 

Parameter type

$type : string

Default

'mixed'