API Documentation

Zend/Server/Method/Parameter.php

Show: inherited
Table of Contents

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-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Server  
Subpackage
Method  
Version
$Id: Parameter.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Server_Method_Parameter

Package: Zend\Server\Method

Method parameter metadata

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprotectedmixed  $_defaultValue= ''

Default parameter value
Details
Type
mixed
Propertyprotectedstring  $_description= ''''

Parameter description
Default value''Details
Type
string
Propertyprotectedstring  $_name= ''

Parameter variable name
Details
Type
string
Propertyprotectedbool  $_optional= 'false'

Is parameter optional?
Default valuefalseDetails
Type
bool
Propertyprotectedstring  $_type= ''mixed''

Parameter type
Default value'mixed'Details
Type
string

Methods

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

Constructor

Parameters
Name Type Description
$options null|array
methodpublicgetDefaultValue( ) : mixed

Retrieve default value

Returns
Type Description
mixed
methodpublicgetDescription( ) : string

Retrieve description

Returns
Type Description
string
methodpublicgetName( ) : string

Retrieve name

Returns
Type Description
string
methodpublicgetType( ) : string

Retrieve parameter type

Returns
Type Description
string
methodpublicisOptional( ) : bool

Is the parameter optional?

Returns
Type Description
bool
methodpublicsetDefaultValue( mixed $defaultValue ) : \Zend_Server_Method_Parameter

Set default value

Parameters
Name Type Description
$defaultValue mixed
Returns
Type Description
\Zend_Server_Method_Parameter
methodpublicsetDescription( string $description ) : \Zend_Server_Method_Parameter

Set description

Parameters
Name Type Description
$description string
Returns
Type Description
\Zend_Server_Method_Parameter
methodpublicsetName( string $name ) : \Zend_Server_Method_Parameter

Set name

Parameters
Name Type Description
$name string
Returns
Type Description
\Zend_Server_Method_Parameter
methodpublicsetOptional( bool $flag ) : \Zend_Server_Method_Parameter

Set optional flag

Parameters
Name Type Description
$flag bool
Returns
Type Description
\Zend_Server_Method_Parameter
methodpublicsetOptions( array $options ) : \Zend_Server_Method_Parameter

Set object state from array of options

Parameters
Name Type Description
$options array
Returns
Type Description
\Zend_Server_Method_Parameter
methodpublicsetType( string $type ) : \Zend_Server_Method_Parameter

Set parameter type

Parameters
Name Type Description
$type string
Returns
Type Description
\Zend_Server_Method_Parameter
methodpublictoArray( ) : array

Cast to array

Returns
Type Description
array
Documentation was generated by DocBlox 0.15.1.