## [Ripcord] element index

All elements
_
top

$_autoDecode
  Ripcord_Client::$_autoDecode in ripcord_client.php
  Whether or not to decode the XML-RPC datetime and base64 types to unix timestamp and binary string respectively.
$_multiCall
  Ripcord_Client::$_multiCall in ripcord_client.php
  A flag to indicate if we are in a multiCall block. Start this with $client->system->multiCall()->start()
$_multiCallArgs
  Ripcord_Client::$_multiCallArgs in ripcord_client.php
  A list of deferred encoded calls.
$_request
  Ripcord_Client::$_request in ripcord_client.php
  The exact request from the client. For debugging purposes.
$_response
  Ripcord_Client::$_response in ripcord_client.php
  The exact response from the rpc server. For debugging purposes.
$_throwExceptions
  Ripcord_Client::$_throwExceptions in ripcord_client.php
  Whether or not to throw exceptions when an xml-rpc fault is returned by the server. Default is false.
__call
  Ripcord_Client::__call() in ripcord_client.php
  This method catches any native method called on the client and calls it on the rpc server instead. It automatically parses the resulting xml and returns native php type results.
__construct
  Ripcord_Documentor::__construct() in ripcord_documentor.php
  The constructor for the Ripcord_Documentor class.
__construct
  Ripcord_Documentor_Interface::__construct() in ripcord_documentor.php
__construct
  Ripcord_Server::__construct() in ripcord_server.php
  Creates a new instance of the Ripcord server.
__construct
  Ripcord_Transport_Stream::__construct() in ripcord_client.php
  This is the constructor for the Ripcord_Transport_Stream class.
__construct
  Ripcord_Transport_CURL::__construct() in ripcord_client.php
  This is the constructor for the Ripcord_Transport_CURL class.
__construct
  Ripcord_Client_Call::__construct() in ripcord_client.php
  The constructor for the Ripcord_Client_Call class.
__construct
  Ripcord_Client_MultiCall::__construct() in ripcord_client.php
__construct
  Ripcord_Client::__construct() in ripcord_client.php
  The constructor for the RPC client.
__get
  Ripcord_Client::__get() in ripcord_client.php
  This method catches any reference to properties of the client and uses them as a namespace. The property is automatically created as a new instance of the rpc client, with the name of the property as a namespace.

a
top

addMethod
  Ripcord_Server::addMethod() in ripcord_server.php
  Allows you to add a single method to the server after construction.
addService
  Ripcord_Server::addService() in ripcord_server.php
  Allows you to add a service to the server after construction.

b
top

$bound
  Ripcord_Client_Call::$bound in ripcord_client.php
  A reference to the php variable to fill with the result of the call, if any.
base64
  ripcord::base64() in ripcord.php
  This method returns an XML-RPC base64 object from a given binary string.
binary
  ripcord::binary() in ripcord.php
  This method returns a (binary) string from a given XML-RPC base64 object.
bind
  Ripcord_Client_Call::bind() in ripcord_client.php
  This method allows you to bind a php variable to the result of this method call.
bind
  ripcord::bind() in ripcord.php

c
top

$css
  Ripcord_Documentor::$css in ripcord_documentor.php
  A url to an optional css file or a css string for an inline stylesheet.
call
  Ripcord_Server::call() in ripcord_server.php
  Calls a method by its rpc name.
cannotAccessURL
  ripcord::cannotAccessURL in ripcord.php
  Could not access {url} - Thrown by the transport object when unable to access the given url.
cannotRecurse
  ripcord::cannotRecurse in ripcord.php
  Cannot recurse system.multiCall - Thrown by the ripcord server when system.multicall is called within itself.
client
  ripcord::client() in ripcord.php
  This method returns a new Ripcord client. By default this will be an XML-RPC client, but you can change this through the $options argument.

d
top

datetime
  ripcord::datetime() in ripcord.php
  This method returns an XML-RPC datetime object from a given unix timestamp.
documentor
  ripcord::documentor() in ripcord.php
  This method returns a new Ripcord documentor object.

e
top

encode
  Ripcord_Client_Call::encode() in ripcord_client.php
  This method returns the correct format for a multiCall argument.
encodeCall
  ripcord::encodeCall() in ripcord.php
  This method creates a new Ripcord_Client_Call object, which encodes the information needed for a method call to an rpc server. This is mostly used for the system.multiCall method.
execute
  Ripcord_Client_MultiCall::execute() in ripcord_client.php

f
top

$footer
  Ripcord_Documentor::$footer in ripcord_documentor.php
  Optional footer text for the online documentation.
fault
  ripcord::fault() in ripcord.php
  This method generates an XML-RPC fault with the given code and message.

g
top

getIntrospectionXML
  Ripcord_Documentor_Interface::getIntrospectionXML() in ripcord_documentor.php
getIntrospectionXML
  Ripcord_Documentor::getIntrospectionXML() in ripcord_documentor.php
  This method returns an XML document in the introspection format expected by xmlrpc_server_register_introspection_callback. It uses the php Reflection classes to gather information from the registered methods.
getType
  ripcord::getType() in ripcord.php
  This method returns the type of the given parameter. This can be any of the XML-RPC data types, e.g.

h
top

$header
  Ripcord_Documentor::$header in ripcord_documentor.php
  Optional header text for the online documentation.
handle
  Ripcord_Server::handle() in ripcord_server.php
  Handles the given request xml
handle
  Ripcord_Documentor::handle() in ripcord_documentor.php
  This method handles any request which isn't a valid rpc request.
handle
  Ripcord_Documentor_Interface::handle() in ripcord_documentor.php

i
top

$index
  Ripcord_Client_Call::$index in ripcord_client.php
  The index in the multicall request array, if any.
isFault
  ripcord::isFault() in ripcord.php
  This method checks whether the given argument is an XML-RPC fault.

l
top

load
  ripcord::load() in ripcord.php
  This method includes a ripcord class, using require_once. Used for autoloading ripcord classes.

m
top

$method
  Ripcord_Client_Call::$method in ripcord_client.php
  The method to call on the rpc server
methodNotFound
  ripcord::methodNotFound in ripcord.php
  Method {method} not found. - Thrown by the ripcord server when a requested method isn't found.

n
top

$name
  Ripcord_Documentor::$name in ripcord_documentor.php
  The name of the rpc server, used as the title and heading of the default HTML page.
notBase64
  ripcord::notBase64 in ripcord.php
  Variable is not of type base64 - Thrown by the ripcord binary method.
notDatetime
  ripcord::notDatetime in ripcord.php
  Variable is not of type datetime - Thrown by the ripcord timestamp method.
notRipcordCall
  ripcord::notRipcordCall in ripcord.php
  Argument {index} is not a valid Ripcord call - Thrown by the client when passing incorrect arguments to system.multiCall.

p
top

$params
  Ripcord_Client_Call::$params in ripcord_client.php
  The arguments to pass on to the method.
parse
  Ripcord_Documentor_Parser_phpdoc::parse() in ripcord_documentor.php
  This method parses a given docComment block and returns an array with information.
parse
  Ripcord_Documentor_Parser::parse() in ripcord_documentor.php
  This method parses a given docComment block and returns an array with information.
post
  Ripcord_Transport_CURL::post() in ripcord_client.php
  This method posts the request to the given url
post
  Ripcord_Transport::post() in ripcord_client.php
  This method must post the request to the given url and return the results.
post
  Ripcord_Transport_Stream::post() in ripcord_client.php
  This method posts the request to the given url.

r
top

$responseHeaders
  Ripcord_Transport_CURL::$responseHeaders in ripcord_client.php
  Contains the headers sent by the server.
$responseHeaders
  Ripcord_Transport_Stream::$responseHeaders in ripcord_client.php
  Contains the headers sent by the server.
$root
  Ripcord_Documentor::$root in ripcord_documentor.php
  The root URL of the rpc server.
ripcord
  ripcord in ripcord.php
  The ripcord class contains a number of useful static methods. This makes it a bit easier to create a server or client, convert types and check for errors.
ripcord.php
  ripcord.php in ripcord.php
Ripcord_BadMethodCallException
  Ripcord_BadMethodCallException in ripcord.php
  This class is used whenever an when a method passed to the server is invalid.
Ripcord_Client
  Ripcord_Client in ripcord_client.php
  This class implements a simple RPC client, for XML-RPC, (simplified) SOAP 1.1 or Simple RPC. The client abstracts the entire RPC process behind native PHP methods. Any method defined by the rpc server can be called as if it was a native method of the rpc client.
ripcord_client.php
  ripcord_client.php in ripcord_client.php
Ripcord_Client_Call
  Ripcord_Client_Call in ripcord_client.php
  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.
Ripcord_Client_MultiCall
  Ripcord_Client_MultiCall in ripcord_client.php
  This class provides the fetch interface for system.multiCall. It is returned
Ripcord_ConfigurationException
  Ripcord_ConfigurationException in ripcord.php
  This class is used whenever prerequisite requirements are not met.
Ripcord_Documentor
  Ripcord_Documentor in ripcord_documentor.php
  This class implements the default documentor for the ripcord server. Any request to the server without a request_xml is handled by the documentor.
ripcord_documentor.php
  ripcord_documentor.php in ripcord_documentor.php
Ripcord_Documentor_Interface
  Ripcord_Documentor_Interface in ripcord_documentor.php
  This interface defines the minimum methods any documentor needs to implement.
Ripcord_Documentor_Parser
  Ripcord_Documentor_Parser in ripcord_documentor.php
  This interface describes the minimum interface needed for a comment parser object used by the
Ripcord_Documentor_Parser_phpdoc
  Ripcord_Documentor_Parser_phpdoc in ripcord_documentor.php
  This class implements the Ripcord_Documentor_Parser interface, parsing the docComment as a phpdoc style docComment.
Ripcord_Exception
  Ripcord_Exception in ripcord.php
  This interface is implemented by all exceptions thrown by Ripcord.
Ripcord_InvalidArgumentException
  Ripcord_InvalidArgumentException in ripcord.php
  This class is used whenever an argument passed to a Ripcord method is invalid for any reason. Possible exceptions thrown are:
  - ripcord::notRipcordCall (-2) Argument {index} is not a valid Ripcord call - Thrown by the client when passing incorrect arguments to system.multiCall.
Ripcord_RemoteException
  Ripcord_RemoteException in ripcord.php
  This class is used for exceptions generated from xmlrpc faults returned by the server. The code and message correspond to the code and message from the xmlrpc fault.
Ripcord_Server
  Ripcord_Server in ripcord_server.php
  This class implements the Ripcord server. It is an OO wrapper around PHP's XML-RPC methods, with some added features.
ripcord_server.php
  ripcord_server.php in ripcord_server.php
Ripcord_Transport
  Ripcord_Transport in ripcord_client.php
  This interface describes the minimum interface needed for the transport object used by the
Ripcord_TransportException
  Ripcord_TransportException in ripcord.php
  This class is used whenever something goes wrong in sending / receiving data. Possible exceptions thrown are:
  - ripcord::cannotAccessURL (-4) Could not access {url} - Thrown by the transport object when unable to access the given url.
Ripcord_Transport_CURL
  Ripcord_Transport_CURL in ripcord_client.php
  This class implements the Ripcord_Transport interface using CURL.
Ripcord_Transport_Stream
  Ripcord_Transport_Stream in ripcord_client.php
  This class implements the Ripcord_Transport interface using PHP streams.
run
  Ripcord_Server::run() in ripcord_server.php
  Runs the rpc server. Automatically handles an incoming request.

s
top

server
  ripcord::server() in ripcord.php
  This method returns a new Ripcord server, which by default implements XML-RPC, Simple RPC and SOAP 1.1.
setMethodData
  Ripcord_Documentor_Interface::setMethodData() in ripcord_documentor.php
setMethodData
  Ripcord_Documentor::setMethodData() in ripcord_documentor.php
  This method fills the list of method data with all the user supplied methods of the rpc server.
setOutputOption
  Ripcord_Server::setOutputOption() in ripcord_server.php
  Allows you to set specific output options of the server after construction.
simpleClient
  ripcord::simpleClient() in ripcord.php
  This method returns a new Ripcord client, configured to access a Simple RPC server.
soapClient
  ripcord::soapClient() in ripcord.php
  This method returns a new Ripcord client, configured to access a SOAP 1.1 server.
start
  Ripcord_Client_MultiCall::start() in ripcord_client.php

t
top

timestamp
  ripcord::timestamp() in ripcord.php
  This method returns a unix timestamp from a given XML-RPC datetime object.

u
top

unknownServiceType
  ripcord::unknownServiceType in ripcord.php
  Variable is not a classname or an object - Thrown by the ripcord server.

v
top

$version
  Ripcord_Documentor::$version in ripcord_documentor.php
  Which version of the XML vocabulary the server implements. Either 'xmlrpc', 'soap 1.1', 'simple' or 'auto'.

w
top

$wsdl
  Ripcord_Documentor::$wsdl in ripcord_documentor.php
  The wsdl 1.0 description.
$wsdl2
  Ripcord_Documentor::$wsdl2 in ripcord_documentor.php
  The wsdl 2.0 description

x
top

xmlrpcClient
  ripcord::xmlrpcClient() in ripcord.php
  This method returns a new Ripcord client, configured to access an XML-RPC server.
xmlrpcNotInstalled
  ripcord::xmlrpcNotInstalled in ripcord.php
  PHP XMLRPC library is not installed - Thrown by the ripcord server and client when the xmlrpc library is not installed.