API Documentation

Server/Method/Prototype.php

Classes 
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: Prototype.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Server_Method_Prototype

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_Prototype

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
$_returnType
$_parameterNameMap
$_parameters
Methods
__construct
setReturnType
getReturnType
addParameter
addParameters
setParameters
getParameters
getParameterObjects
getParameter
setOptions
toArray

Description

Method prototype metadata

Properties

$_parameterNameMap

array $_parameterNameMap = 'array'

Details

$_parameterNameMap
array
Map parameter names to parameter index
visibility
protected
default
array
final
false
static
false

$_parameters

array $_parameters = 'array'

Details

$_parameters
array
Method parameters
visibility
protected
default
array
final
false
static
false

$_returnType

string $_returnType = 'void'

Details

$_returnType
string
Return type
visibility
protected
default
void
final
false
static
false

Methods

__construct

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

Constructor

Arguments
$options
nullarray
Details
visibility
public
final
false
static
false

addParameter

addParameter( string $parameter ) : Zend_Server_Method_Prototype

Add a parameter

Arguments
$parameter
string
Details
visibility
public
final
false
static
false

addParameters

addParameters(  $parameters ) : Zend_Server_Method_Prototype

Add parameters

Arguments
$parameters
Details
visibility
public
final
false
static
false

getParameter

getParameter( string|int $index ) : null|Zend_Server_Method_Parameter

Retrieve a single parameter by name or index

Arguments
$index
stringint
Details
visibility
public
final
false
static
false

getParameterObjects

getParameterObjects( ) : array

Get parameter objects

Output
array
Details
visibility
public
final
false
static
false

getParameters

getParameters( ) : array

Retrieve parameters as list of types

Output
array
Details
visibility
public
final
false
static
false

getReturnType

getReturnType( ) : string

Retrieve return type

Output
string
Details
visibility
public
final
false
static
false

setOptions

setOptions( array $options ) : Zend_Server_Method_Prototype

Set object state from array

Arguments
$options
array
Details
visibility
public
final
false
static
false

setParameters

setParameters( array $parameters ) : Zend_Server_Method_Prototype

Set parameters

Arguments
$parameters
array
Details
visibility
public
final
false
static
false

setReturnType

setReturnType( string $returnType ) : Zend_Server_Method_Prototype

Set return value

Arguments
$returnType
string
Details
visibility
public
final
false
static
false

toArray

toArray( ) : array

Serialize to array

Output
array
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.