Server/Method/Parameter.php
Show:
inherited
inherited
Classes
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.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Server
- Subpackage
- Method
- Version
- $Id$
\Zend_Server_Method_Parameter
Package: Zend_Server\Method
Method parameter metadata
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
mixed $_defaultValueDefault parameter value
Details
- Type
- mixed
string $_description = ''Parameter description
Default value
''Details- Type
- string
string $_nameParameter variable name
Details
- Type
- string
bool $_optional = falseIs parameter optional?
Default value
falseDetails- Type
- bool
string $_type = 'mixed'Parameter type
Default value
'mixed'Details- Type
- string
Methods
__construct(null | array $options = null) : voidConstructor
Parameters
| Name | Type | Description |
|---|---|---|
| $options | null | array |
getDefaultValue() : mixedRetrieve default value
Returns
| Type | Description |
|---|---|
| mixed |
getDescription() : stringRetrieve description
Returns
| Type | Description |
|---|---|
| string |
getName() : stringRetrieve name
Returns
| Type | Description |
|---|---|
| string |
getType() : stringRetrieve parameter type
Returns
| Type | Description |
|---|---|
| string |
isOptional() : boolIs the parameter optional?
Returns
| Type | Description |
|---|---|
| bool |
setDefaultValue(mixed $defaultValue) : \Zend_Server_Method_ParameterSet default value
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $defaultValue | mixed |
| Type | Description |
|---|---|
| \Zend_Server_Method_Parameter |
setDescription(string $description) : \Zend_Server_Method_ParameterSet description
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $description | string |
| Type | Description |
|---|---|
| \Zend_Server_Method_Parameter |
setName(string $name) : \Zend_Server_Method_ParameterSet name
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $name | string |
| Type | Description |
|---|---|
| \Zend_Server_Method_Parameter |
setOptional(bool $flag) : \Zend_Server_Method_ParameterSet optional flag
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $flag | bool |
| Type | Description |
|---|---|
| \Zend_Server_Method_Parameter |
setOptions(array $options) : \Zend_Server_Method_ParameterSet object state from array of options
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $options | array |
| Type | Description |
|---|---|
| \Zend_Server_Method_Parameter |
setType(string $type) : \Zend_Server_Method_ParameterSet parameter type
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $type | string |
| Type | Description |
|---|---|
| \Zend_Server_Method_Parameter |
toArray() : arrayCast to array
Returns
| Type | Description |
|---|---|
| array |