Server/Method/Definition.php

Show:

inherited

Classes
- \Zend_Server_Method_Definition

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 24593 2012-01-05 20:35:02Z matthew $

\Zend_Server_Method_Definition
jump to top

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

\Zend_Server_Method_Callback $_callback

Details

Type: \Zend_Server_Method_Callback

array $_invokeArguments = array()

Default valuearray()Details

Type: array

string $_methodHelp = ''

Default value''Details

Type: string

string $_name

Details

Type: string

null|object $_object

Details

Type: null | object

array $_prototypes = array()

Array of Zend_Server_Method_Prototype objects

Default valuearray()Details

Type: array

Methods

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

Constructor

Parameters

Name	Type	Description
$options	null \| array

addPrototype(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

addPrototypes(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

getCallback() : \Zend_Server_Method_Callback

Get method callback

Returns

Type	Description
\Zend_Server_Method_Callback

getInvokeArguments() : array

Retrieve invoke arguments

Returns

Type	Description
array

getMethodHelp() : string

Get method help

Returns

Type	Description
string

getName() : string

Get method name

Returns

Type	Description
string

getObject() : null | object

Get object to use with method calls

Returns

Type	Description
null \| object

getPrototypes() : array

Get all prototypes

Returns

Type	Description
array	$prototypes Array of Zend_Server_Method_Prototype objects or arrays

setCallback(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

setInvokeArguments(array $invokeArguments) : \Zend_Server_Method_Definition

Set invoke arguments

Parameters

Name	Type	Description
$invokeArguments	array

Returns

Type	Description
\Zend_Server_Method_Definition

setMethodHelp(string $methodHelp) : \Zend_Server_Method_Definition

Set method help

Parameters

Name	Type	Description
$methodHelp	string

Returns

Type	Description
\Zend_Server_Method_Definition

setName(string $name) : \Zend_Server_Method_Definition

Set method name

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
\Zend_Server_Method_Definition

setObject(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

setOptions(array $options) : \Zend_Server_Method_Definition

Set object state from options

Parameters

Name	Type	Description
$options	array

Returns

Type	Description
\Zend_Server_Method_Definition

setPrototypes(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

toArray() : array

Serialize to array

Returns

Type	Description
array

Server/Method/Definition.php

\Zend_Server_Method_Definitionjump to top

Properties

Methods

\Zend_Server_Method_Definition
jump to top