Docs For Class Ripcord_Client

Class Ripcord_Client_Call

Description

This class is used with the Ripcord_Client when calling system.multiCall. Instead of immediately calling the method on the rpc server, a Ripcord_Client_Call object is created with all the information needed to call the method using the multicall parameters. The call object is returned immediately and is used as input parameter for the multiCall call. The result of the call can be bound to a php variable. This variable will be filled with the result of the call when it is available.

Located in /ripcord_client.php (line 361)

Variable Summary

mixed $bound

mixed $index

mixed $method

mixed $params

Method Summary

Ripcord_Client_Call __construct (string $method, array $params)

object Returns bind ( &$bound, mixed $bound)

array encode ()

Variables

mixed $bound = null (line 381)

A reference to the php variable to fill with the result of the call, if any.

access: public

mixed $index = null (line 376)

The index in the multicall request array, if any.

access: public

mixed $method = null (line 366)

The method to call on the rpc server

access: public

mixed $params = array() (line 371)

The arguments to pass on to the method.

access: public

Methods

Constructor __construct (line 388)

The constructor for the Ripcord_Client_Call class.

access: public

Ripcord_Client_Call __construct (string $method, array $params)

string $method: The name of the rpc method to call
array $params: The parameters for the rpc method.

bind (line 401)

This method allows you to bind a php variable to the result of this method call.

When the method call's result is available, the php variable will be filled with this result.

return: this object for chaining.
access: public

object Returns bind ( &$bound, mixed $bound)

mixed $bound: The variable to bind the result from this call to.
&$bound

encode (line 411)

This method returns the correct format for a multiCall argument.

return: An array with the methodName and params
access: public

array encode ()

Documentation generated on Tue, 16 Nov 2010 16:20:18 +0100 by phpDocumentor 1.4.3