Server/Method/Parameter.php
- category
- Zend
- copyright
- Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
- license
- http://framework.zend.com/license/new-bsd New BSD License
- package
- Zend_Server
- subpackage
- Method
- version
- $Id: Parameter.php 20096 2010-01-06 02:05:09Z bkarwin $
- Classes
- Zend_Server_Method_Parameter
Description
Zend Framework
LICENSE
This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.
Zend_Server_Method_Parameter
- category
- Zend
- copyright
- Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
- license
- http://framework.zend.com/license/new-bsd New BSD License
- package
- Zend_Server
- subpackage
- Method
- Properties
- $_defaultValue
- $_description
- $_name
- $_optional
- $_type
- Methods
- __construct
- setOptions
- setDefaultValue
- getDefaultValue
- setDescription
- getDescription
- setName
- getName
- setOptional
- isOptional
- setType
- getType
- toArray
Description
Method parameter metadata
Properties
$_defaultValue
mixed $_defaultValue = ''
Details
- $_defaultValue
- mixed
Default parameter value - visibility
- protected
- default
- final
- false
- static
- false
$_description
string $_description = ''
Details
- $_description
- string
Parameter description - visibility
- protected
- default
- final
- false
- static
- false
$_name
string $_name = ''
Details
- $_name
- string
Parameter variable name - visibility
- protected
- default
- final
- false
- static
- false
$_optional
bool $_optional = 'false'
Details
- $_optional
- bool
Is parameter optional? - visibility
- protected
- default
- false
- final
- false
- static
- false
$_type
string $_type = 'mixed'
Details
- $_type
- string
Parameter type - visibility
- protected
- default
- mixed
- final
- false
- static
- false
Methods
__construct
__construct(
null|array $options
=
null
)
:
voidConstructor
Arguments
- $options
- nullarray
Details
- visibility
- public
- final
- false
- static
- false
getDefaultValue
getDefaultValue(
)
:
mixedRetrieve default value
Output
- mixed
Details
- visibility
- public
- final
- false
- static
- false
getDescription
getDescription(
)
:
stringRetrieve description
Output
- string
Details
- visibility
- public
- final
- false
- static
- false
getName
getName(
)
:
stringRetrieve name
Output
- string
Details
- visibility
- public
- final
- false
- static
- false
getType
getType(
)
:
stringRetrieve parameter type
Output
- string
Details
- visibility
- public
- final
- false
- static
- false
isOptional
isOptional(
)
:
boolIs the parameter optional?
Output
- bool
Details
- visibility
- public
- final
- false
- static
- false
setDefaultValue
setDefaultValue(
mixed $defaultValue
)
:
Zend_Server_Method_ParameterSet default value
Arguments
- $defaultValue
- mixed
Output
Details
- visibility
- public
- final
- false
- static
- false
setDescription
setDescription(
string $description
)
:
Zend_Server_Method_ParameterSet description
Arguments
- $description
- string
Output
Details
- visibility
- public
- final
- false
- static
- false
setName
setName(
string $name
)
:
Zend_Server_Method_ParameterSet name
Arguments
- $name
- string
Output
Details
- visibility
- public
- final
- false
- static
- false
setOptional
setOptional(
bool $flag
)
:
Zend_Server_Method_ParameterSet optional flag
Arguments
- $flag
- bool
Output
Details
- visibility
- public
- final
- false
- static
- false
setOptions
setOptions(
array $options
)
:
Zend_Server_Method_ParameterSet object state from array of options
Arguments
- $options
- array
Output
Details
- visibility
- public
- final
- false
- static
- false
setType
setType(
string $type
)
:
Zend_Server_Method_ParameterSet parameter type
Arguments
- $type
- string
Output
Details
- visibility
- public
- final
- false
- static
- false
toArray
toArray(
)
:
arrayCast to array
Output
- array
Details
- visibility
- public
- final
- false
- static
- false