Location: PHPKode > scripts > Ripcord: Easy XML-RPC Client and Server for PHP 5 > ripcord-1.0/ripcord-1.0/docs/elementindex.html
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title></title>
			<link rel="stylesheet" href="media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
						<a name="top"></a>
<h2>Full index</h2>
<h3>Package indexes</h3>
<ul>
	<li><a href="elementindex_Ripcord.html">Ripcord</a></li>
</ul>
<br />
<div class="index-letter-menu">
	<a class="index-letter" href="elementindex.html#a">a</a>
	<a class="index-letter" href="elementindex.html#b">b</a>
	<a class="index-letter" href="elementindex.html#c">c</a>
	<a class="index-letter" href="elementindex.html#d">d</a>
	<a class="index-letter" href="elementindex.html#e">e</a>
	<a class="index-letter" href="elementindex.html#f">f</a>
	<a class="index-letter" href="elementindex.html#g">g</a>
	<a class="index-letter" href="elementindex.html#h">h</a>
	<a class="index-letter" href="elementindex.html#i">i</a>
	<a class="index-letter" href="elementindex.html#l">l</a>
	<a class="index-letter" href="elementindex.html#m">m</a>
	<a class="index-letter" href="elementindex.html#n">n</a>
	<a class="index-letter" href="elementindex.html#p">p</a>
	<a class="index-letter" href="elementindex.html#r">r</a>
	<a class="index-letter" href="elementindex.html#s">s</a>
	<a class="index-letter" href="elementindex.html#t">t</a>
	<a class="index-letter" href="elementindex.html#u">u</a>
	<a class="index-letter" href="elementindex.html#v">v</a>
	<a class="index-letter" href="elementindex.html#w">w</a>
	<a class="index-letter" href="elementindex.html#x">x</a>
	<a class="index-letter" href="elementindex.html#_">_</a>
</div>

	<a name="a"></a>
	<div class="index-letter-section">
		<div style="float: left" class="index-letter-title">a</div>
		<div style="float: right"><a href="#top">top</a></div>
		<div style="clear: both"></div>
	</div>
	<dl>
			<dt class="field">
						<span class="method-title">addMethod</span>
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/Ripcord_Server.html#methodaddMethod">Ripcord_Server::addMethod()</a> in ripcord_server.php</div>
							<div class="index-item-description">Allows you to add a single method to the server after construction.</div>
					</dd>
			<dt class="field">
						<span class="method-title">addService</span>
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/Ripcord_Server.html#methodaddService">Ripcord_Server::addService()</a> in ripcord_server.php</div>
							<div class="index-item-description">Allows you to add a service to the server after construction.</div>
					</dd>
		</dl>
	<a name="b"></a>
	<div class="index-letter-section">
		<div style="float: left" class="index-letter-title">b</div>
		<div style="float: right"><a href="#top">top</a></div>
		<div style="clear: both"></div>
	</div>
	<dl>
			<dt class="field">
						<span class="var-title">$bound</span>
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/Ripcord_Client_Call.html#var$bound">Ripcord_Client_Call::$bound</a> in ripcord_client.php</div>
							<div class="index-item-description">A reference to the php variable to fill with the result of the call, if any.</div>
					</dd>
			<dt class="field">
						<span class="method-title">base64</span>
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/ripcord.html#methodbase64">ripcord::base64()</a> in ripcord.php</div>
							<div class="index-item-description">This method returns an XML-RPC base64 object from a given binary string.</div>
					</dd>
			<dt class="field">
						<span class="method-title">binary</span>
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/ripcord.html#methodbinary">ripcord::binary()</a> in ripcord.php</div>
							<div class="index-item-description">This method returns a (binary) string from a given XML-RPC base64 object.</div>
					</dd>
			<dt class="field">
						<span class="method-title">bind</span>
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/Ripcord_Client_Call.html#methodbind">Ripcord_Client_Call::bind()</a> in ripcord_client.php</div>
							<div class="index-item-description">This method allows you to bind a php variable to the result of this method call.</div>
					</dd>
			<dt class="field">
						<span class="method-title">bind</span>
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/ripcord.html#methodbind">ripcord::bind()</a> in ripcord.php</div>
					</dd>
		</dl>
	<a name="c"></a>
	<div class="index-letter-section">
		<div style="float: left" class="index-letter-title">c</div>
		<div style="float: right"><a href="#top">top</a></div>
		<div style="clear: both"></div>
	</div>
	<dl>
			<dt class="field">
						<span class="var-title">$css</span>
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/Ripcord_Documentor.html#var$css">Ripcord_Documentor::$css</a> in ripcord_documentor.php</div>
							<div class="index-item-description">A url to an optional css file or a css string for an inline stylesheet.</div>
					</dd>
			<dt class="field">
						<span class="method-title">call</span>
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/Ripcord_Server.html#methodcall">Ripcord_Server::call()</a> in ripcord_server.php</div>
							<div class="index-item-description">Calls a method by its rpc name.</div>
					</dd>
			<dt class="field">
						cannotAccessURL
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/ripcord.html#constcannotAccessURL">ripcord::cannotAccessURL</a> in ripcord.php</div>
							<div class="index-item-description">Could not access {url} - Thrown by the transport object when unable to access the given url.</div>
					</dd>
			<dt class="field">
						cannotRecurse
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/ripcord.html#constcannotRecurse">ripcord::cannotRecurse</a> in ripcord.php</div>
							<div class="index-item-description">Cannot recurse system.multiCall  - Thrown by the ripcord server when system.multicall is called within itself.</div>
					</dd>
			<dt class="field">
						<span class="method-title">client</span>
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/ripcord.html#methodclient">ripcord::client()</a> in ripcord.php</div>
							<div class="index-item-description">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.</div>
					</dd>
		</dl>
	<a name="d"></a>
	<div class="index-letter-section">
		<div style="float: left" class="index-letter-title">d</div>
		<div style="float: right"><a href="#top">top</a></div>
		<div style="clear: both"></div>
	</div>
	<dl>
			<dt class="field">
						<span class="method-title">datetime</span>
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/ripcord.html#methoddatetime">ripcord::datetime()</a> in ripcord.php</div>
							<div class="index-item-description">This method returns an XML-RPC datetime object from a given unix timestamp.</div>
					</dd>
			<dt class="field">
						<span class="method-title">documentor</span>
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/ripcord.html#methoddocumentor">ripcord::documentor()</a> in ripcord.php</div>
							<div class="index-item-description">This method returns a new Ripcord documentor object.</div>
					</dd>
		</dl>
	<a name="e"></a>
	<div class="index-letter-section">
		<div style="float: left" class="index-letter-title">e</div>
		<div style="float: right"><a href="#top">top</a></div>
		<div style="clear: both"></div>
	</div>
	<dl>
			<dt class="field">
						<span class="method-title">encode</span>
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/Ripcord_Client_Call.html#methodencode">Ripcord_Client_Call::encode()</a> in ripcord_client.php</div>
							<div class="index-item-description">This method returns the correct format for a multiCall argument.</div>
					</dd>
			<dt class="field">
						<span class="method-title">encodeCall</span>
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/ripcord.html#methodencodeCall">ripcord::encodeCall()</a> in ripcord.php</div>
							<div class="index-item-description">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.</div>
					</dd>
			<dt class="field">
						<span class="method-title">execute</span>
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/Ripcord_Client_MultiCall.html#methodexecute">Ripcord_Client_MultiCall::execute()</a> in ripcord_client.php</div>
					</dd>
		</dl>
	<a name="f"></a>
	<div class="index-letter-section">
		<div style="float: left" class="index-letter-title">f</div>
		<div style="float: right"><a href="#top">top</a></div>
		<div style="clear: both"></div>
	</div>
	<dl>
			<dt class="field">
						<span class="var-title">$footer</span>
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/Ripcord_Documentor.html#var$footer">Ripcord_Documentor::$footer</a> in ripcord_documentor.php</div>
							<div class="index-item-description">Optional footer text for the online documentation.</div>
					</dd>
			<dt class="field">
						<span class="method-title">fault</span>
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/ripcord.html#methodfault">ripcord::fault()</a> in ripcord.php</div>
							<div class="index-item-description">This method generates an XML-RPC fault with the given code and message.</div>
					</dd>
		</dl>
	<a name="g"></a>
	<div class="index-letter-section">
		<div style="float: left" class="index-letter-title">g</div>
		<div style="float: right"><a href="#top">top</a></div>
		<div style="clear: both"></div>
	</div>
	<dl>
			<dt class="field">
						<span class="method-title">getIntrospectionXML</span>
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/Ripcord_Documentor_Interface.html#methodgetIntrospectionXML">Ripcord_Documentor_Interface::getIntrospectionXML()</a> in ripcord_documentor.php</div>
					</dd>
			<dt class="field">
						<span class="method-title">getIntrospectionXML</span>
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/Ripcord_Documentor.html#methodgetIntrospectionXML">Ripcord_Documentor::getIntrospectionXML()</a> in ripcord_documentor.php</div>
							<div class="index-item-description">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.</div>
					</dd>
			<dt class="field">
						<span class="method-title">getType</span>
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/ripcord.html#methodgetType">ripcord::getType()</a> in ripcord.php</div>
							<div class="index-item-description">This method returns the type of the given parameter. This can be any of the XML-RPC data types, e.g.</div>
					</dd>
		</dl>
	<a name="h"></a>
	<div class="index-letter-section">
		<div style="float: left" class="index-letter-title">h</div>
		<div style="float: right"><a href="#top">top</a></div>
		<div style="clear: both"></div>
	</div>
	<dl>
			<dt class="field">
						<span class="var-title">$header</span>
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/Ripcord_Documentor.html#var$header">Ripcord_Documentor::$header</a> in ripcord_documentor.php</div>
							<div class="index-item-description">Optional header text for the online documentation.</div>
					</dd>
			<dt class="field">
						<span class="method-title">handle</span>
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/Ripcord_Server.html#methodhandle">Ripcord_Server::handle()</a> in ripcord_server.php</div>
							<div class="index-item-description">Handles the given request xml</div>
					</dd>
			<dt class="field">
						<span class="method-title">handle</span>
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/Ripcord_Documentor.html#methodhandle">Ripcord_Documentor::handle()</a> in ripcord_documentor.php</div>
							<div class="index-item-description">This method handles any request which isn't a valid rpc request.</div>
					</dd>
			<dt class="field">
						<span class="method-title">handle</span>
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/Ripcord_Documentor_Interface.html#methodhandle">Ripcord_Documentor_Interface::handle()</a> in ripcord_documentor.php</div>
					</dd>
		</dl>
	<a name="i"></a>
	<div class="index-letter-section">
		<div style="float: left" class="index-letter-title">i</div>
		<div style="float: right"><a href="#top">top</a></div>
		<div style="clear: both"></div>
	</div>
	<dl>
			<dt class="field">
						<span class="var-title">$index</span>
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/Ripcord_Client_Call.html#var$index">Ripcord_Client_Call::$index</a> in ripcord_client.php</div>
							<div class="index-item-description">The index in the multicall request array, if any.</div>
					</dd>
			<dt class="field">
						<span class="method-title">isFault</span>
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/ripcord.html#methodisFault">ripcord::isFault()</a> in ripcord.php</div>
							<div class="index-item-description">This method checks whether the given argument is an XML-RPC fault.</div>
					</dd>
		</dl>
	<a name="l"></a>
	<div class="index-letter-section">
		<div style="float: left" class="index-letter-title">l</div>
		<div style="float: right"><a href="#top">top</a></div>
		<div style="clear: both"></div>
	</div>
	<dl>
			<dt class="field">
						<span class="method-title">load</span>
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/ripcord.html#methodload">ripcord::load()</a> in ripcord.php</div>
							<div class="index-item-description">This method includes a ripcord class, using require_once. Used for autoloading ripcord classes.</div>
					</dd>
		</dl>
	<a name="m"></a>
	<div class="index-letter-section">
		<div style="float: left" class="index-letter-title">m</div>
		<div style="float: right"><a href="#top">top</a></div>
		<div style="clear: both"></div>
	</div>
	<dl>
			<dt class="field">
						<span class="var-title">$method</span>
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/Ripcord_Client_Call.html#var$method">Ripcord_Client_Call::$method</a> in ripcord_client.php</div>
							<div class="index-item-description">The method to call on the rpc server</div>
					</dd>
			<dt class="field">
						methodNotFound
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/ripcord.html#constmethodNotFound">ripcord::methodNotFound</a> in ripcord.php</div>
							<div class="index-item-description">Method {method} not found. - Thrown by the ripcord server when a requested method isn't found.</div>
					</dd>
		</dl>
	<a name="n"></a>
	<div class="index-letter-section">
		<div style="float: left" class="index-letter-title">n</div>
		<div style="float: right"><a href="#top">top</a></div>
		<div style="clear: both"></div>
	</div>
	<dl>
			<dt class="field">
						<span class="var-title">$name</span>
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/Ripcord_Documentor.html#var$name">Ripcord_Documentor::$name</a> in ripcord_documentor.php</div>
							<div class="index-item-description">The name of the rpc server, used as the title and heading of the default HTML page.</div>
					</dd>
			<dt class="field">
						notBase64
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/ripcord.html#constnotBase64">ripcord::notBase64</a> in ripcord.php</div>
							<div class="index-item-description">Variable is not of type base64 - Thrown by the ripcord binary method.</div>
					</dd>
			<dt class="field">
						notDatetime
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/ripcord.html#constnotDatetime">ripcord::notDatetime</a> in ripcord.php</div>
							<div class="index-item-description">Variable is not of type datetime - Thrown by the ripcord timestamp method.</div>
					</dd>
			<dt class="field">
						notRipcordCall
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/ripcord.html#constnotRipcordCall">ripcord::notRipcordCall</a> in ripcord.php</div>
							<div class="index-item-description">Argument {index} is not a valid Ripcord call - Thrown by the client when passing incorrect arguments to system.multiCall.</div>
					</dd>
		</dl>
	<a name="p"></a>
	<div class="index-letter-section">
		<div style="float: left" class="index-letter-title">p</div>
		<div style="float: right"><a href="#top">top</a></div>
		<div style="clear: both"></div>
	</div>
	<dl>
			<dt class="field">
						<span class="var-title">$params</span>
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/Ripcord_Client_Call.html#var$params">Ripcord_Client_Call::$params</a> in ripcord_client.php</div>
							<div class="index-item-description">The arguments to pass on to the method.</div>
					</dd>
			<dt class="field">
						<span class="method-title">parse</span>
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/Ripcord_Documentor_Parser_phpdoc.html#methodparse">Ripcord_Documentor_Parser_phpdoc::parse()</a> in ripcord_documentor.php</div>
							<div class="index-item-description">This method parses a given docComment block and returns an array with information.</div>
					</dd>
			<dt class="field">
						<span class="method-title">parse</span>
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/Ripcord_Documentor_Parser.html#methodparse">Ripcord_Documentor_Parser::parse()</a> in ripcord_documentor.php</div>
							<div class="index-item-description">This method parses a given docComment block and returns an array with information.</div>
					</dd>
			<dt class="field">
						<span class="method-title">post</span>
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/Ripcord_Transport_CURL.html#methodpost">Ripcord_Transport_CURL::post()</a> in ripcord_client.php</div>
							<div class="index-item-description">This method posts the request to the given url</div>
					</dd>
			<dt class="field">
						<span class="method-title">post</span>
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/Ripcord_Transport.html#methodpost">Ripcord_Transport::post()</a> in ripcord_client.php</div>
							<div class="index-item-description">This method must post the request to the given url and return the results.</div>
					</dd>
			<dt class="field">
						<span class="method-title">post</span>
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/Ripcord_Transport_Stream.html#methodpost">Ripcord_Transport_Stream::post()</a> in ripcord_client.php</div>
							<div class="index-item-description">This method posts the request to the given url.</div>
					</dd>
		</dl>
	<a name="r"></a>
	<div class="index-letter-section">
		<div style="float: left" class="index-letter-title">r</div>
		<div style="float: right"><a href="#top">top</a></div>
		<div style="clear: both"></div>
	</div>
	<dl>
			<dt class="field">
						<span class="var-title">$responseHeaders</span>
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/Ripcord_Transport_CURL.html#var$responseHeaders">Ripcord_Transport_CURL::$responseHeaders</a> in ripcord_client.php</div>
							<div class="index-item-description">Contains the headers sent by the server.</div>
					</dd>
			<dt class="field">
						<span class="var-title">$responseHeaders</span>
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/Ripcord_Transport_Stream.html#var$responseHeaders">Ripcord_Transport_Stream::$responseHeaders</a> in ripcord_client.php</div>
							<div class="index-item-description">Contains the headers sent by the server.</div>
					</dd>
			<dt class="field">
						<span class="var-title">$root</span>
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/Ripcord_Documentor.html#var$root">Ripcord_Documentor::$root</a> in ripcord_documentor.php</div>
							<div class="index-item-description">The root URL of the rpc server.</div>
					</dd>
			<dt class="field">
						ripcord
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/ripcord.html">ripcord</a> in ripcord.php</div>
							<div class="index-item-description">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.</div>
					</dd>
			<dt class="field">
						<span class="include-title">ripcord.php</span>
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/_ripcord.php.html">ripcord.php</a> in ripcord.php</div>
					</dd>
			<dt class="field">
						Ripcord_BadMethodCallException
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/Ripcord_BadMethodCallException.html">Ripcord_BadMethodCallException</a> in ripcord.php</div>
							<div class="index-item-description">This class is used whenever an when a method passed to the server is invalid.</div>
					</dd>
			<dt class="field">
						Ripcord_Client
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/Ripcord_Client.html">Ripcord_Client</a> in ripcord_client.php</div>
							<div class="index-item-description">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.</div>
					</dd>
			<dt class="field">
						<span class="include-title">ripcord_client.php</span>
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/_ripcord_client.php.html">ripcord_client.php</a> in ripcord_client.php</div>
					</dd>
			<dt class="field">
						Ripcord_Client_Call
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/Ripcord_Client_Call.html">Ripcord_Client_Call</a> in ripcord_client.php</div>
							<div class="index-item-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.</div>
					</dd>
			<dt class="field">
						Ripcord_Client_MultiCall
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/Ripcord_Client_MultiCall.html">Ripcord_Client_MultiCall</a> in ripcord_client.php</div>
							<div class="index-item-description">This class provides the fetch interface for system.multiCall. It is returned</div>
					</dd>
			<dt class="field">
						Ripcord_ConfigurationException
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/Ripcord_ConfigurationException.html">Ripcord_ConfigurationException</a> in ripcord.php</div>
							<div class="index-item-description">This class is used whenever prerequisite requirements are not met.</div>
					</dd>
			<dt class="field">
						Ripcord_Documentor
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/Ripcord_Documentor.html">Ripcord_Documentor</a> in ripcord_documentor.php</div>
							<div class="index-item-description">This class implements the default documentor for the ripcord server. Any request to the server  without a request_xml is handled by the documentor.</div>
					</dd>
			<dt class="field">
						<span class="include-title">ripcord_documentor.php</span>
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/_ripcord_documentor.php.html">ripcord_documentor.php</a> in ripcord_documentor.php</div>
					</dd>
			<dt class="field">
						Ripcord_Documentor_Interface
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/Ripcord_Documentor_Interface.html">Ripcord_Documentor_Interface</a> in ripcord_documentor.php</div>
							<div class="index-item-description">This interface defines the minimum methods any documentor needs to implement.</div>
					</dd>
			<dt class="field">
						Ripcord_Documentor_Parser
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/Ripcord_Documentor_Parser.html">Ripcord_Documentor_Parser</a> in ripcord_documentor.php</div>
							<div class="index-item-description">This interface describes the minimum interface needed for a comment parser object used by the</div>
					</dd>
			<dt class="field">
						Ripcord_Documentor_Parser_phpdoc
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/Ripcord_Documentor_Parser_phpdoc.html">Ripcord_Documentor_Parser_phpdoc</a> in ripcord_documentor.php</div>
							<div class="index-item-description">This class implements the Ripcord_Documentor_Parser interface, parsing the docComment  as a phpdoc style docComment.</div>
					</dd>
			<dt class="field">
						Ripcord_Exception
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/Ripcord_Exception.html">Ripcord_Exception</a> in ripcord.php</div>
							<div class="index-item-description">This interface is implemented by all exceptions thrown by Ripcord.</div>
					</dd>
			<dt class="field">
						Ripcord_InvalidArgumentException
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/Ripcord_InvalidArgumentException.html">Ripcord_InvalidArgumentException</a> in ripcord.php</div>
							<div class="index-item-description">This class is used whenever an argument passed to a Ripcord method is invalid for any reason. Possible exceptions thrown are: <ul><li>ripcord::notRipcordCall (-2) Argument {index} is not a valid Ripcord call - Thrown by the client when passing incorrect arguments to system.multiCall.</li></ul></div>
					</dd>
			<dt class="field">
						Ripcord_RemoteException
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/Ripcord_RemoteException.html">Ripcord_RemoteException</a> in ripcord.php</div>
							<div class="index-item-description">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.</div>
					</dd>
			<dt class="field">
						Ripcord_Server
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/Ripcord_Server.html">Ripcord_Server</a> in ripcord_server.php</div>
							<div class="index-item-description">This class implements the Ripcord server. It is an OO wrapper around PHP's XML-RPC methods, with some added features.</div>
					</dd>
			<dt class="field">
						<span class="include-title">ripcord_server.php</span>
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/_ripcord_server.php.html">ripcord_server.php</a> in ripcord_server.php</div>
					</dd>
			<dt class="field">
						Ripcord_Transport
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/Ripcord_Transport.html">Ripcord_Transport</a> in ripcord_client.php</div>
							<div class="index-item-description">This interface describes the minimum interface needed for the transport object used by the</div>
					</dd>
			<dt class="field">
						Ripcord_TransportException
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/Ripcord_TransportException.html">Ripcord_TransportException</a> in ripcord.php</div>
							<div class="index-item-description">This class is used whenever something goes wrong in sending / receiving data. Possible exceptions thrown are: <ul><li>ripcord::cannotAccessURL (-4) Could not access {url} - Thrown by the transport object when unable to access the given url.</li></ul></div>
					</dd>
			<dt class="field">
						Ripcord_Transport_CURL
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/Ripcord_Transport_CURL.html">Ripcord_Transport_CURL</a> in ripcord_client.php</div>
							<div class="index-item-description">This class implements the Ripcord_Transport interface using CURL.</div>
					</dd>
			<dt class="field">
						Ripcord_Transport_Stream
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/Ripcord_Transport_Stream.html">Ripcord_Transport_Stream</a> in ripcord_client.php</div>
							<div class="index-item-description">This class implements the Ripcord_Transport interface using PHP streams.</div>
					</dd>
			<dt class="field">
						<span class="method-title">run</span>
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/Ripcord_Server.html#methodrun">Ripcord_Server::run()</a> in ripcord_server.php</div>
							<div class="index-item-description">Runs the rpc server. Automatically handles an incoming request.</div>
					</dd>
		</dl>
	<a name="s"></a>
	<div class="index-letter-section">
		<div style="float: left" class="index-letter-title">s</div>
		<div style="float: right"><a href="#top">top</a></div>
		<div style="clear: both"></div>
	</div>
	<dl>
			<dt class="field">
						<span class="method-title">server</span>
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/ripcord.html#methodserver">ripcord::server()</a> in ripcord.php</div>
							<div class="index-item-description">This method returns a new Ripcord server, which by default implements XML-RPC, Simple RPC and SOAP 1.1.</div>
					</dd>
			<dt class="field">
						<span class="method-title">setMethodData</span>
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/Ripcord_Documentor_Interface.html#methodsetMethodData">Ripcord_Documentor_Interface::setMethodData()</a> in ripcord_documentor.php</div>
					</dd>
			<dt class="field">
						<span class="method-title">setMethodData</span>
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/Ripcord_Documentor.html#methodsetMethodData">Ripcord_Documentor::setMethodData()</a> in ripcord_documentor.php</div>
							<div class="index-item-description">This method fills the list of method data with all the user supplied methods of the rpc server.</div>
					</dd>
			<dt class="field">
						<span class="method-title">setOutputOption</span>
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/Ripcord_Server.html#methodsetOutputOption">Ripcord_Server::setOutputOption()</a> in ripcord_server.php</div>
							<div class="index-item-description">Allows you to set specific output options of the server after construction.</div>
					</dd>
			<dt class="field">
						<span class="method-title">simpleClient</span>
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/ripcord.html#methodsimpleClient">ripcord::simpleClient()</a> in ripcord.php</div>
							<div class="index-item-description">This method returns a new Ripcord client, configured to access a Simple RPC server.</div>
					</dd>
			<dt class="field">
						<span class="method-title">soapClient</span>
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/ripcord.html#methodsoapClient">ripcord::soapClient()</a> in ripcord.php</div>
							<div class="index-item-description">This method returns a new Ripcord client, configured to access a SOAP 1.1 server.</div>
					</dd>
			<dt class="field">
						<span class="method-title">start</span>
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/Ripcord_Client_MultiCall.html#methodstart">Ripcord_Client_MultiCall::start()</a> in ripcord_client.php</div>
					</dd>
		</dl>
	<a name="t"></a>
	<div class="index-letter-section">
		<div style="float: left" class="index-letter-title">t</div>
		<div style="float: right"><a href="#top">top</a></div>
		<div style="clear: both"></div>
	</div>
	<dl>
			<dt class="field">
						<span class="method-title">timestamp</span>
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/ripcord.html#methodtimestamp">ripcord::timestamp()</a> in ripcord.php</div>
							<div class="index-item-description">This method returns a unix timestamp from a given XML-RPC datetime object.</div>
					</dd>
		</dl>
	<a name="u"></a>
	<div class="index-letter-section">
		<div style="float: left" class="index-letter-title">u</div>
		<div style="float: right"><a href="#top">top</a></div>
		<div style="clear: both"></div>
	</div>
	<dl>
			<dt class="field">
						unknownServiceType
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/ripcord.html#constunknownServiceType">ripcord::unknownServiceType</a> in ripcord.php</div>
							<div class="index-item-description">Variable is not a classname or an object - Thrown by the ripcord server.</div>
					</dd>
		</dl>
	<a name="v"></a>
	<div class="index-letter-section">
		<div style="float: left" class="index-letter-title">v</div>
		<div style="float: right"><a href="#top">top</a></div>
		<div style="clear: both"></div>
	</div>
	<dl>
			<dt class="field">
						<span class="var-title">$version</span>
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/Ripcord_Documentor.html#var$version">Ripcord_Documentor::$version</a> in ripcord_documentor.php</div>
							<div class="index-item-description">Which version of the XML vocabulary the server implements. Either 'xmlrpc', 'soap 1.1', 'simple' or 'auto'.</div>
					</dd>
		</dl>
	<a name="w"></a>
	<div class="index-letter-section">
		<div style="float: left" class="index-letter-title">w</div>
		<div style="float: right"><a href="#top">top</a></div>
		<div style="clear: both"></div>
	</div>
	<dl>
			<dt class="field">
						<span class="var-title">$wsdl</span>
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/Ripcord_Documentor.html#var$wsdl">Ripcord_Documentor::$wsdl</a> in ripcord_documentor.php</div>
							<div class="index-item-description">The wsdl 1.0 description.</div>
					</dd>
			<dt class="field">
						<span class="var-title">$wsdl2</span>
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/Ripcord_Documentor.html#var$wsdl2">Ripcord_Documentor::$wsdl2</a> in ripcord_documentor.php</div>
							<div class="index-item-description">The wsdl 2.0 description</div>
					</dd>
		</dl>
	<a name="x"></a>
	<div class="index-letter-section">
		<div style="float: left" class="index-letter-title">x</div>
		<div style="float: right"><a href="#top">top</a></div>
		<div style="clear: both"></div>
	</div>
	<dl>
			<dt class="field">
						<span class="method-title">xmlrpcClient</span>
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/ripcord.html#methodxmlrpcClient">ripcord::xmlrpcClient()</a> in ripcord.php</div>
							<div class="index-item-description">This method returns a new Ripcord client, configured to access an XML-RPC server.</div>
					</dd>
			<dt class="field">
						xmlrpcNotInstalled
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/ripcord.html#constxmlrpcNotInstalled">ripcord::xmlrpcNotInstalled</a> in ripcord.php</div>
							<div class="index-item-description">PHP XMLRPC library is not installed - Thrown by the ripcord server and client when the xmlrpc library is not installed.</div>
					</dd>
		</dl>
	<a name="_"></a>
	<div class="index-letter-section">
		<div style="float: left" class="index-letter-title">_</div>
		<div style="float: right"><a href="#top">top</a></div>
		<div style="clear: both"></div>
	</div>
	<dl>
			<dt class="field">
						<span class="var-title">$_autoDecode</span>
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/Ripcord_Client.html#var$_autoDecode">Ripcord_Client::$_autoDecode</a> in ripcord_client.php</div>
							<div class="index-item-description">Whether or not to decode the XML-RPC datetime and base64 types to unix timestamp and binary string  respectively.</div>
					</dd>
			<dt class="field">
						<span class="var-title">$_multiCall</span>
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/Ripcord_Client.html#var$_multiCall">Ripcord_Client::$_multiCall</a> in ripcord_client.php</div>
							<div class="index-item-description">A flag to indicate if we are in a multiCall block. Start this with $client-&gt;system-&gt;multiCall()-&gt;start()</div>
					</dd>
			<dt class="field">
						<span class="var-title">$_multiCallArgs</span>
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/Ripcord_Client.html#var$_multiCallArgs">Ripcord_Client::$_multiCallArgs</a> in ripcord_client.php</div>
							<div class="index-item-description">A list of deferred encoded calls.</div>
					</dd>
			<dt class="field">
						<span class="var-title">$_request</span>
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/Ripcord_Client.html#var$_request">Ripcord_Client::$_request</a> in ripcord_client.php</div>
							<div class="index-item-description">The exact request from the client. For debugging purposes.</div>
					</dd>
			<dt class="field">
						<span class="var-title">$_response</span>
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/Ripcord_Client.html#var$_response">Ripcord_Client::$_response</a> in ripcord_client.php</div>
							<div class="index-item-description">The exact response from the rpc server. For debugging purposes.</div>
					</dd>
			<dt class="field">
						<span class="var-title">$_throwExceptions</span>
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/Ripcord_Client.html#var$_throwExceptions">Ripcord_Client::$_throwExceptions</a> in ripcord_client.php</div>
							<div class="index-item-description">Whether or not to throw exceptions when an xml-rpc fault is returned by the server. Default is false.</div>
					</dd>
			<dt class="field">
						<span class="method-title">__call</span>
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/Ripcord_Client.html#method__call">Ripcord_Client::__call()</a> in ripcord_client.php</div>
							<div class="index-item-description">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.</div>
					</dd>
			<dt class="field">
						<span class="method-title">__construct</span>
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/Ripcord_Documentor.html#method__construct">Ripcord_Documentor::__construct()</a> in ripcord_documentor.php</div>
							<div class="index-item-description">The constructor for the Ripcord_Documentor class.</div>
					</dd>
			<dt class="field">
						<span class="method-title">__construct</span>
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/Ripcord_Documentor_Interface.html#method__construct">Ripcord_Documentor_Interface::__construct()</a> in ripcord_documentor.php</div>
					</dd>
			<dt class="field">
						<span class="method-title">__construct</span>
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/Ripcord_Server.html#method__construct">Ripcord_Server::__construct()</a> in ripcord_server.php</div>
							<div class="index-item-description">Creates a new instance of the Ripcord server.</div>
					</dd>
			<dt class="field">
						<span class="method-title">__construct</span>
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/Ripcord_Transport_Stream.html#method__construct">Ripcord_Transport_Stream::__construct()</a> in ripcord_client.php</div>
							<div class="index-item-description">This is the constructor for the Ripcord_Transport_Stream class.</div>
					</dd>
			<dt class="field">
						<span class="method-title">__construct</span>
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/Ripcord_Transport_CURL.html#method__construct">Ripcord_Transport_CURL::__construct()</a> in ripcord_client.php</div>
							<div class="index-item-description">This is the constructor for the Ripcord_Transport_CURL class.</div>
					</dd>
			<dt class="field">
						<span class="method-title">__construct</span>
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/Ripcord_Client_Call.html#method__construct">Ripcord_Client_Call::__construct()</a> in ripcord_client.php</div>
							<div class="index-item-description">The constructor for the Ripcord_Client_Call class.</div>
					</dd>
			<dt class="field">
						<span class="method-title">__construct</span>
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/Ripcord_Client_MultiCall.html#method__construct">Ripcord_Client_MultiCall::__construct()</a> in ripcord_client.php</div>
					</dd>
			<dt class="field">
						<span class="method-title">__construct</span>
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/Ripcord_Client.html#method__construct">Ripcord_Client::__construct()</a> in ripcord_client.php</div>
							<div class="index-item-description">The constructor for the RPC client.</div>
					</dd>
			<dt class="field">
						<span class="method-title">__get</span>
					</dt>
		<dd class="index-item-body">
			<div class="index-item-details"><a href="Ripcord/Ripcord_Client.html#method__get">Ripcord_Client::__get()</a> in ripcord_client.php</div>
							<div class="index-item-description">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.</div>
					</dd>
		</dl>

<div class="index-letter-menu">
	<a class="index-letter" href="elementindex.html#a">a</a>
	<a class="index-letter" href="elementindex.html#b">b</a>
	<a class="index-letter" href="elementindex.html#c">c</a>
	<a class="index-letter" href="elementindex.html#d">d</a>
	<a class="index-letter" href="elementindex.html#e">e</a>
	<a class="index-letter" href="elementindex.html#f">f</a>
	<a class="index-letter" href="elementindex.html#g">g</a>
	<a class="index-letter" href="elementindex.html#h">h</a>
	<a class="index-letter" href="elementindex.html#i">i</a>
	<a class="index-letter" href="elementindex.html#l">l</a>
	<a class="index-letter" href="elementindex.html#m">m</a>
	<a class="index-letter" href="elementindex.html#n">n</a>
	<a class="index-letter" href="elementindex.html#p">p</a>
	<a class="index-letter" href="elementindex.html#r">r</a>
	<a class="index-letter" href="elementindex.html#s">s</a>
	<a class="index-letter" href="elementindex.html#t">t</a>
	<a class="index-letter" href="elementindex.html#u">u</a>
	<a class="index-letter" href="elementindex.html#v">v</a>
	<a class="index-letter" href="elementindex.html#w">w</a>
	<a class="index-letter" href="elementindex.html#x">x</a>
	<a class="index-letter" href="elementindex.html#_">_</a>
</div>	</body>
</html>
Return current item: Ripcord: Easy XML-RPC Client and Server for PHP 5