Zend Framework  1.12
Public Member Functions | Protected Attributes | List of all members
Zend_Server_Method_Definition Class Reference

Public Member Functions

 __construct ($options=null)
 Constructor.
 
 setOptions (array $options)
 Set object state from options.
 
 setName ($name)
 Set method name.
 
 getName ()
 Get method name.
 
 setCallback ($callback)
 Set method callback.
 
 getCallback ()
 Get method callback.
 
 addPrototype ($prototype)
 Add prototype to method definition.
 
 addPrototypes (array $prototypes)
 Add multiple prototypes at once.
 
 setPrototypes (array $prototypes)
 Set all prototypes at once (overwrites)
 
 getPrototypes ()
 Get all prototypes.
 
 setMethodHelp ($methodHelp)
 Set method help.
 
 getMethodHelp ()
 Get method help.
 
 setObject ($object)
 Set object to use with method calls.
 
 getObject ()
 Get object to use with method calls.
 
 setInvokeArguments (array $invokeArguments)
 Set invoke arguments.
 
 getInvokeArguments ()
 Retrieve invoke arguments.
 
 toArray ()
 Serialize to array.
 

Protected Attributes

 $_callback
 
 $_invokeArguments = array()
 
 $_methodHelp = ''
 
 $_name
 
 $_object
 
 $_prototypes = array()
 

Constructor & Destructor Documentation

__construct (   $options = null)

Constructor.

Parameters
null | array$options
Returns
void

Member Function Documentation

addPrototype (   $prototype)

Add prototype to method definition.

Parameters
array | Zend_Server_Method_Prototype$prototype
Returns
Zend_Server_Method_Definition
addPrototypes ( array  $prototypes)

Add multiple prototypes at once.

Parameters
array$prototypesArray of Zend_Server_Method_Prototype objects or arrays
Returns
Zend_Server_Method_Definition
getCallback ( )

Get method callback.

Returns
Zend_Server_Method_Callback
getInvokeArguments ( )

Retrieve invoke arguments.

Returns
array
getMethodHelp ( )

Get method help.

Returns
string
getName ( )

Get method name.

Returns
string
getObject ( )

Get object to use with method calls.

Returns
null|object
getPrototypes ( )

Get all prototypes.

Returns
array $prototypes Array of Zend_Server_Method_Prototype objects or arrays
setCallback (   $callback)

Set method callback.

Parameters
array | Zend_Server_Method_Callback$callback
Returns
Zend_Server_Method_Definition
setInvokeArguments ( array  $invokeArguments)

Set invoke arguments.

Parameters
array$invokeArguments
Returns
Zend_Server_Method_Definition
setMethodHelp (   $methodHelp)

Set method help.

Parameters
string$methodHelp
Returns
Zend_Server_Method_Definition
setName (   $name)

Set method name.

Parameters
string$name
Returns
Zend_Server_Method_Definition
setObject (   $object)

Set object to use with method calls.

Parameters
object$object
Returns
Zend_Server_Method_Definition
setOptions ( array  $options)

Set object state from options.

Parameters
array$options
Returns
Zend_Server_Method_Definition
setPrototypes ( array  $prototypes)

Set all prototypes at once (overwrites)

Parameters
array$prototypesArray of Zend_Server_Method_Prototype objects or arrays
Returns
Zend_Server_Method_Definition
toArray ( )

Serialize to array.

Returns
array

Member Data Documentation

$_callback
protected
$_invokeArguments = array()
protected
$_methodHelp = ''
protected
$_name
protected
$_object
protected
$_prototypes = array()
protected