\Zend_Server_Method_Parameter

Method parameter metadata

Summary

Methods
Properties
Constants
__construct()
setOptions()
setDefaultValue()
getDefaultValue()
setDescription()
getDescription()
setName()
getName()
setOptional()
isOptional()
setType()
getType()
toArray()
No public properties found
No constants found
No protected methods found
$_defaultValue
$_description
$_name
$_optional
$_type
N/A
No private methods found
No private properties found
N/A

Properties

$_defaultValue

$_defaultValue : mixed

Type

mixed — Default parameter value

$_description

$_description : string

Type

string — Parameter description

$_name

$_name : string

Type

string — Parameter variable name

$_optional

$_optional : boolean

Type

boolean — Is parameter optional?

$_type

$_type : string

Type

string — Parameter type

Methods

__construct()

__construct(null|array  $options = null) : void

Constructor

Parameters

null|array $options

setOptions()

setOptions(array  $options) : \Zend_Server_Method_Parameter

Set object state from array of options

Parameters

array $options

Returns

\Zend_Server_Method_Parameter

setDefaultValue()

setDefaultValue(mixed  $defaultValue) : \Zend_Server_Method_Parameter

Set default value

Parameters

mixed $defaultValue

Returns

\Zend_Server_Method_Parameter

getDefaultValue()

getDefaultValue() : mixed

Retrieve default value

Returns

mixed

setDescription()

setDescription(string  $description) : \Zend_Server_Method_Parameter

Set description

Parameters

string $description

Returns

\Zend_Server_Method_Parameter

getDescription()

getDescription() : string

Retrieve description

Returns

string

getName()

getName() : string

Retrieve name

Returns

string

setOptional()

setOptional(boolean  $flag) : \Zend_Server_Method_Parameter

Set optional flag

Parameters

boolean $flag

Returns

\Zend_Server_Method_Parameter

isOptional()

isOptional() : boolean

Is the parameter optional?

Returns

boolean

setType()

setType(string  $type) : \Zend_Server_Method_Parameter

Set parameter type

Parameters

string $type

Returns

\Zend_Server_Method_Parameter

getType()

getType() : string

Retrieve parameter type

Returns

string

toArray()

toArray() : array

Cast to array

Returns

array