Server/Method/Definition.php

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

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_Definition
jump to top

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: $_callback; $_invokeArguments; $_methodHelp; $_name; $_object; $_prototypes
Methods: __construct; setOptions; setName; getName; setCallback; getCallback; addPrototype; addPrototypes; setPrototypes; getPrototypes; setMethodHelp; getMethodHelp; setObject; getObject; setInvokeArguments; getInvokeArguments; toArray

Description

Method definition metadata

Properties

$_callback
jump to class

Zend_Server_Method_Callback $_callback = ''

Details

$_callback: Zend_Server_Method_Callback
visibility: protected
default
final: false
static: false

$_invokeArguments
jump to class

array $_invokeArguments = 'array'

Details

$_invokeArguments: array
visibility: protected
default: array
final: false
static: false

$_methodHelp
jump to class

string $_methodHelp = ''

Details

$_methodHelp: string
visibility: protected
default
final: false
static: false

$_name
jump to class

string $_name = ''

Details

$_name: string
visibility: protected
default
final: false
static: false

$_object
jump to class

null|object $_object = ''

Details

$_object: null|object
visibility: protected
default
final: false
static: false

$_prototypes
jump to class

array $_prototypes = 'array'

Details

$_prototypes: array
Array of Zend_Server_Method_Prototype objects
visibility: protected
default: array
final: false
static: false

Methods

__construct
jump to class

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

Constructor

Arguments

$options: nullarray

Details

visibility: public
final: false
static: false

addPrototype
jump to class

addPrototype(
          array|Zend_Server_Method_Prototype $prototype
          )
        
        :
        Zend_Server_Method_Definition

Add prototype to method definition

Arguments

$prototype: arrayZend_Server_Method_Prototype

Output

Zend_Server_Method_Definition

Details

visibility: public
final: false
static: false

addPrototypes
jump to class

addPrototypes(
          array $prototypes
          )
        
        :
        Zend_Server_Method_Definition

Add multiple prototypes at once

Arguments

$prototypes: array
Array of Zend_Server_Method_Prototype objects or arrays

Output

Zend_Server_Method_Definition

Details

visibility: public
final: false
static: false

getCallback
jump to class

getCallback(
          
          )
        
        :
        Zend_Server_Method_Callback

Get method callback

Output

Zend_Server_Method_Callback

Details

visibility: public
final: false
static: false

getInvokeArguments
jump to class

getInvokeArguments(
          
          )
        
        :
        array

Retrieve invoke arguments

Output

array

Details

visibility: public
final: false
static: false

getMethodHelp
jump to class

getMethodHelp(
          
          )
        
        :
        string

Get method help

Output

string

Details

visibility: public
final: false
static: false

getName
jump to class

getName(
          
          )
        
        :
        string

Get method name

Output

string

Details

visibility: public
final: false
static: false

getObject
jump to class

getObject(
          
          )
        
        :
        null|object

Get object to use with method calls

Output

null|object

Details

visibility: public
final: false
static: false

getPrototypes
jump to class

getPrototypes(
          
          )
        
        :
        array

Get all prototypes

Output

array: $prototypes Array of Zend_Server_Method_Prototype objects or arrays

Details

visibility: public
final: false
static: false

setCallback
jump to class

setCallback(
          array|Zend_Server_Method_Callback $callback
          )
        
        :
        Zend_Server_Method_Definition

Set method callback

Arguments

$callback: arrayZend_Server_Method_Callback

Output

Zend_Server_Method_Definition

Details

visibility: public
final: false
static: false

setInvokeArguments
jump to class

setInvokeArguments(
          array $invokeArguments
          )
        
        :
        Zend_Server_Method_Definition

Set invoke arguments

Arguments

$invokeArguments: array

Output

Zend_Server_Method_Definition

Details

visibility: public
final: false
static: false

setMethodHelp
jump to class

setMethodHelp(
          string $methodHelp
          )
        
        :
        Zend_Server_Method_Definition

Set method help

Arguments

$methodHelp: string

Output

Zend_Server_Method_Definition

Details

visibility: public
final: false
static: false

setName
jump to class

setName(
          string $name
          )
        
        :
        Zend_Server_Method_Definition

Set method name

Arguments

$name: string

Output

Zend_Server_Method_Definition

Details

visibility: public
final: false
static: false

setObject
jump to class

setObject(
          object $object
          )
        
        :
        Zend_Server_Method_Definition

Set object to use with method calls

Arguments

$object: object

Output

Zend_Server_Method_Definition

Details

visibility: public
final: false
static: false

setOptions
jump to class

setOptions(
          array $options
          )
        
        :
        Zend_Server_Method_Definition

Set object state from options

Arguments

$options: array

Output

Zend_Server_Method_Definition

Details

visibility: public
final: false
static: false

setPrototypes
jump to class

setPrototypes(
          array $prototypes
          )
        
        :
        Zend_Server_Method_Definition

Set all prototypes at once (overwrites)

Arguments

$prototypes: array
Array of Zend_Server_Method_Prototype objects or arrays

Output

Zend_Server_Method_Definition

Details

visibility: public
final: false
static: false

toArray
jump to class

toArray(
          
          )
        
        :
        array

Serialize to array

Output

array

Details

visibility: public
final: false
static: false

API Documentation

Server/Method/Definition.php

Description

Zend_Server_Method_Definitionjump to top

Description

Properties

$_callbackjump to class

Details

$_invokeArgumentsjump to class

Details

$_methodHelpjump to class

Details

$_namejump to class

Details

$_objectjump to class

Details

$_prototypesjump to class

Details

Methods

__constructjump to class

Arguments

Details

addPrototypejump to class

Arguments

Output

Details

addPrototypesjump to class

Arguments

Output

Details

getCallbackjump to class

Output

Details

getInvokeArgumentsjump to class

Output

Details

getMethodHelpjump to class

Output

Details

getNamejump to class

Output

Details

getObjectjump to class

Output

Details

getPrototypesjump to class

Output

Details

setCallbackjump to class

Arguments

Output

Details

setInvokeArgumentsjump to class

Arguments

Output

Details

setMethodHelpjump to class

Arguments

Output

Details

setNamejump to class

Arguments

Output

Details

setObjectjump to class

Arguments

Output

Details

setOptionsjump to class

Arguments

Output

Details

setPrototypesjump to class

Arguments

Output

Details

toArrayjump to class

Output

Details

Zend_Server_Method_Definition
jump to top

$_callback
jump to class

$_invokeArguments
jump to class

$_methodHelp
jump to class

$_name
jump to class

$_object
jump to class

$_prototypes
jump to class

__construct
jump to class

addPrototype
jump to class

addPrototypes
jump to class

getCallback
jump to class

getInvokeArguments
jump to class

getMethodHelp
jump to class

getName
jump to class

getObject
jump to class

getPrototypes
jump to class

setCallback
jump to class

setInvokeArguments
jump to class

setMethodHelp
jump to class

setName
jump to class

setObject
jump to class

setOptions
jump to class

setPrototypes
jump to class

toArray
jump to class