API Documentation

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

\Zend_Server_Method_Definition

Package: Zend\Server\Method

Method definition metadata

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

Properties

Propertyprotected\Zend_Server_Method_Callback  $_callback= ''

Propertyprotectedarray  $_invokeArguments= 'array()'

Default valuearray()Details
Type
array
Propertyprotectedstring  $_methodHelp= ''''

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

Details
Type
string
Propertyprotectednull|object  $_object= ''

Details
Type
nullobject
Propertyprotectedarray  $_prototypes= 'array()'

Array of Zend_Server_Method_Prototype objects
Default valuearray()Details
Type
array

Methods

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

Constructor

Parameters
Name Type Description
$options null|array
methodpublicaddPrototype( array|\Zend_Server_Method_Prototype $prototype ) : \Zend_Server_Method_Definition

Add prototype to method definition

Parameters
Name Type Description
$prototype array|\Zend_Server_Method_Prototype
Returns
Type Description
\Zend_Server_Method_Definition
methodpublicaddPrototypes( array $prototypes ) : \Zend_Server_Method_Definition

Add multiple prototypes at once

Parameters
Name Type Description
$prototypes array

Array of Zend_Server_Method_Prototype objects or arrays

Returns
Type Description
\Zend_Server_Method_Definition
methodpublicgetCallback( ) : \Zend_Server_Method_Callback

Get method callback

Returns
Type Description
\Zend_Server_Method_Callback
methodpublicgetInvokeArguments( ) : array

Retrieve invoke arguments

Returns
Type Description
array
methodpublicgetMethodHelp( ) : string

Get method help

Returns
Type Description
string
methodpublicgetName( ) : string

Get method name

Returns
Type Description
string
methodpublicgetObject( ) : null|object

Get object to use with method calls

Returns
Type Description
null|object
methodpublicgetPrototypes( ) : array

Get all prototypes

Returns
Type Description
array $prototypes Array of Zend_Server_Method_Prototype objects or arrays
methodpublicsetCallback( array|\Zend_Server_Method_Callback $callback ) : \Zend_Server_Method_Definition

Set method callback

Parameters
Name Type Description
$callback array|\Zend_Server_Method_Callback
Returns
Type Description
\Zend_Server_Method_Definition
methodpublicsetInvokeArguments( array $invokeArguments ) : \Zend_Server_Method_Definition

Set invoke arguments

Parameters
Name Type Description
$invokeArguments array
Returns
Type Description
\Zend_Server_Method_Definition
methodpublicsetMethodHelp( string $methodHelp ) : \Zend_Server_Method_Definition

Set method help

Parameters
Name Type Description
$methodHelp string
Returns
Type Description
\Zend_Server_Method_Definition
methodpublicsetName( string $name ) : \Zend_Server_Method_Definition

Set method name

Parameters
Name Type Description
$name string
Returns
Type Description
\Zend_Server_Method_Definition
methodpublicsetObject( object $object ) : \Zend_Server_Method_Definition

Set object to use with method calls

Parameters
Name Type Description
$object object
Returns
Type Description
\Zend_Server_Method_Definition
methodpublicsetOptions( array $options ) : \Zend_Server_Method_Definition

Set object state from options

Parameters
Name Type Description
$options array
Returns
Type Description
\Zend_Server_Method_Definition
methodpublicsetPrototypes( array $prototypes ) : \Zend_Server_Method_Definition

Set all prototypes at once (overwrites)

Parameters
Name Type Description
$prototypes array

Array of Zend_Server_Method_Prototype objects or arrays

Returns
Type Description
\Zend_Server_Method_Definition
methodpublictoArray( ) : array

Serialize to array

Returns
Type Description
array
Documentation was generated by DocBlox 0.15.1.