Zend Framework  1.12
Public Member Functions | Protected Attributes | List of all members
Zend_Server_Method_Parameter Class Reference

Public Member Functions

 __construct ($options=null)
 Constructor.
 
 setOptions (array $options)
 Set object state from array of options.
 
 setDefaultValue ($defaultValue)
 Set default value.
 
 getDefaultValue ()
 Retrieve default value.
 
 setDescription ($description)
 Set description.
 
 getDescription ()
 Retrieve description.
 
 setName ($name)
 Set name.
 
 getName ()
 Retrieve name.
 
 setOptional ($flag)
 Set optional flag.
 
 isOptional ()
 Is the parameter optional?
 
 setType ($type)
 Set parameter type.
 
 getType ()
 Retrieve parameter type.
 
 toArray ()
 Cast to array.
 

Protected Attributes

 $_defaultValue
 
 $_description = ''
 
 $_name
 
 $_optional = false
 
 $_type = 'mixed'
 

Constructor & Destructor Documentation

__construct (   $options = null)

Constructor.

Parameters
null | array$options
Returns
void

Member Function Documentation

getDefaultValue ( )

Retrieve default value.

Returns
mixed
getDescription ( )

Retrieve description.

Returns
string
getName ( )

Retrieve name.

Returns
string
getType ( )

Retrieve parameter type.

Returns
string
isOptional ( )

Is the parameter optional?

Returns
bool
setDefaultValue (   $defaultValue)

Set default value.

Parameters
mixed$defaultValue
Returns
Zend_Server_Method_Parameter
setDescription (   $description)

Set description.

Parameters
string$description
Returns
Zend_Server_Method_Parameter
setName (   $name)

Set name.

Parameters
string$name
Returns
Zend_Server_Method_Parameter
setOptional (   $flag)

Set optional flag.

Parameters
bool$flag
Returns
Zend_Server_Method_Parameter
setOptions ( array  $options)

Set object state from array of options.

Parameters
array$options
Returns
Zend_Server_Method_Parameter
setType (   $type)

Set parameter type.

Parameters
string$type
Returns
Zend_Server_Method_Parameter
toArray ( )

Cast to array.

Returns
array

Member Data Documentation

$_defaultValue
protected
$_description = ''
protected
$_name
protected
$_optional = false
protected
$_type = 'mixed'
protected