API Documentation

Zend/Server/Method/Prototype.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: Prototype.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Server_Method_Prototype

Package: Zend\Server\Method

Method prototype metadata

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

Properties

Propertyprotectedarray  $_parameterNameMap= 'array()'

Map parameter names to parameter index
Default valuearray()Details
Type
array
Propertyprotectedarray  $_parameters= 'array()'

Method parameters
Default valuearray()Details
Type
array
Propertyprotectedstring  $_returnType= ''void''

Return type
Default value'void'Details
Type
string

Methods

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

Constructor

Parameters
Name Type Description
$options null|array
methodpublicaddParameter( string $parameter ) : \Zend_Server_Method_Prototype

Add a parameter

Parameters
Name Type Description
$parameter string
Returns
Type Description
\Zend_Server_Method_Prototype
methodpublicaddParameters(  $parameters ) : \Zend_Server_Method_Prototype

Add parameters

Parameters
Name Type Description
$parameters
Returns
Type Description
\Zend_Server_Method_Prototype
methodpublicgetParameter( string|int $index ) : null|\Zend_Server_Method_Parameter

Retrieve a single parameter by name or index

Parameters
Name Type Description
$index string|int
Returns
Type Description
null|\Zend_Server_Method_Parameter
methodpublicgetParameterObjects( ) : array

Get parameter objects

Returns
Type Description
array
methodpublicgetParameters( ) : array

Retrieve parameters as list of types

Returns
Type Description
array
methodpublicgetReturnType( ) : string

Retrieve return type

Returns
Type Description
string
methodpublicsetOptions( array $options ) : \Zend_Server_Method_Prototype

Set object state from array

Parameters
Name Type Description
$options array
Returns
Type Description
\Zend_Server_Method_Prototype
methodpublicsetParameters( array $parameters ) : \Zend_Server_Method_Prototype

Set parameters

Parameters
Name Type Description
$parameters array
Returns
Type Description
\Zend_Server_Method_Prototype
methodpublicsetReturnType( string $returnType ) : \Zend_Server_Method_Prototype

Set return value

Parameters
Name Type Description
$returnType string
Returns
Type Description
\Zend_Server_Method_Prototype
methodpublictoArray( ) : array

Serialize to array

Returns
Type Description
array
Documentation was generated by DocBlox 0.15.1.