Server/Method/Definition.php
Show:
inherited
inherited
Classes
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-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Server
- Subpackage
- Method
- Version
- $Id$
\Zend_Server_Method_Definition
Package: Zend_Server\Method
Method definition metadata
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
array $_invokeArguments = array()Default value
array()Details- Type
- array
string $_methodHelp = ''Default value
''Details- Type
- string
string $_nameDetails
- Type
- string
null|object $_objectDetails
- Type
- null | object
array $_prototypes = array()Array of Zend_Server_Method_Prototype objects
Default value
array()Details- Type
- array
Methods
__construct(null | array $options = null) : voidConstructor
Parameters
| Name | Type | Description |
|---|---|---|
| $options | null | array |
addPrototype(array | \Zend_Server_Method_Prototype $prototype) : \Zend_Server_Method_DefinitionAdd prototype to method definition
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $prototype | array | \Zend_Server_Method_Prototype |
| Type | Description |
|---|---|
| \Zend_Server_Method_Definition |
addPrototypes(array $prototypes) : \Zend_Server_Method_DefinitionAdd multiple prototypes at once
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $prototypes | array | Array of Zend_Server_Method_Prototype objects or arrays |
| Type | Description |
|---|---|
| \Zend_Server_Method_Definition |
getCallback() : \Zend_Server_Method_CallbackGet method callback
Returns
| Type | Description |
|---|---|
| \Zend_Server_Method_Callback |
getInvokeArguments() : arrayRetrieve invoke arguments
Returns
| Type | Description |
|---|---|
| array |
getMethodHelp() : stringGet method help
Returns
| Type | Description |
|---|---|
| string |
getName() : stringGet method name
Returns
| Type | Description |
|---|---|
| string |
getObject() : null | objectGet object to use with method calls
Returns
| Type | Description |
|---|---|
| null | object |
getPrototypes() : arrayGet 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_DefinitionSet method callback
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $callback | array | \Zend_Server_Method_Callback |
| Type | Description |
|---|---|
| \Zend_Server_Method_Definition |
setInvokeArguments(array $invokeArguments) : \Zend_Server_Method_DefinitionSet invoke arguments
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $invokeArguments | array |
| Type | Description |
|---|---|
| \Zend_Server_Method_Definition |
setMethodHelp(string $methodHelp) : \Zend_Server_Method_DefinitionSet method help
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $methodHelp | string |
| Type | Description |
|---|---|
| \Zend_Server_Method_Definition |
setName(string $name) : \Zend_Server_Method_DefinitionSet method name
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $name | string |
| Type | Description |
|---|---|
| \Zend_Server_Method_Definition |
setObject(object $object) : \Zend_Server_Method_DefinitionSet object to use with method calls
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $object | object |
| Type | Description |
|---|---|
| \Zend_Server_Method_Definition |
setOptions(array $options) : \Zend_Server_Method_DefinitionSet object state from options
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $options | array |
| Type | Description |
|---|---|
| \Zend_Server_Method_Definition |
setPrototypes(array $prototypes) : \Zend_Server_Method_DefinitionSet all prototypes at once (overwrites)
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $prototypes | array | Array of Zend_Server_Method_Prototype objects or arrays |
| Type | Description |
|---|---|
| \Zend_Server_Method_Definition |
toArray() : arraySerialize to array
Returns
| Type | Description |
|---|---|
| array |