Location: PHPKode > scripts > Ripcord: Easy XML-RPC Client and Server for PHP 5 > ripcord-1.0/ripcord-1.0/docs/Ripcord/ripcord.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>Docs For Class ripcord</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Class ripcord</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
											<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
						
			</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-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.</p>
		<p class="notes">
			Located in <a class="field" href="_ripcord.php.html">/ripcord.php</a> (line <span class="field">16</span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>


	<a name="sec-const-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Class Constant Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
						<span class="disabled">Constants</span> (<a href="#sec-consts">details</a>)
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
			<div class="const-summary">
								<div class="const-title">
					<img src="../media/images/Constant.png" alt=" " />
					<a href="#cannotAccessURL" title="details" class="const-name">cannotAccessURL</a> = 					<span class="var-type"> -4</span>

				</div>
								<div class="const-title">
					<img src="../media/images/Constant.png" alt=" " />
					<a href="#cannotRecurse" title="details" class="const-name">cannotRecurse</a> = 					<span class="var-type"> -3</span>

				</div>
								<div class="const-title">
					<img src="../media/images/Constant.png" alt=" " />
					<a href="#methodNotFound" title="details" class="const-name">methodNotFound</a> = 					<span class="var-type"> -1</span>

				</div>
								<div class="const-title">
					<img src="../media/images/Constant.png" alt=" " />
					<a href="#notBase64" title="details" class="const-name">notBase64</a> = 					<span class="var-type"> -7</span>

				</div>
								<div class="const-title">
					<img src="../media/images/Constant.png" alt=" " />
					<a href="#notDatetime" title="details" class="const-name">notDatetime</a> = 					<span class="var-type"> -6</span>

				</div>
								<div class="const-title">
					<img src="../media/images/Constant.png" alt=" " />
					<a href="#notRipcordCall" title="details" class="const-name">notRipcordCall</a> = 					<span class="var-type"> -2</span>

				</div>
								<div class="const-title">
					<img src="../media/images/Constant.png" alt=" " />
					<a href="#unknownServiceType" title="details" class="const-name">unknownServiceType</a> = 					<span class="var-type"> -8</span>

				</div>
								<div class="const-title">
					<img src="../media/images/Constant.png" alt=" " />
					<a href="#xmlrpcNotInstalled" title="details" class="const-name">xmlrpcNotInstalled</a> = 					<span class="var-type"> -5</span>

				</div>
							</div>
		</div>
	</div>


	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
															<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
							
									<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
												<div class="method-definition">
					static 						<span class="method-result">object</span>
										<a href="#base64" title="details" class="method-name">base64</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$binary</span>)
									</div>
																<div class="method-definition">
					static 						<span class="method-result">string</span>
										<a href="#binary" title="details" class="method-name">binary</a>
											(<span class="var-type">object</span>&nbsp;<span class="var-name">$base64</span>)
									</div>
																								<div class="method-definition">
					static 						<span class="method-result">void</span>
										<a href="#client" title="details" class="method-name">client</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>, [<span class="var-type">array</span>&nbsp;<span class="var-name">$options</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$transport</span> = <span class="var-default">null</span>])
									</div>
																<div class="method-definition">
					static 						<span class="method-result">object</span>
										<a href="#datetime" title="details" class="method-name">datetime</a>
											(<span class="var-type">int</span>&nbsp;<span class="var-name">$timestamp</span>)
									</div>
																<div class="method-definition">
					static 						<span class="method-result">void</span>
										<a href="#documentor" title="details" class="method-name">documentor</a>
											([<span class="var-type">array</span>&nbsp;<span class="var-name">$options</span> = <span class="var-default">null</span>], [<span class="var-type">object docCommentParser</span>&nbsp;<span class="var-name">$docCommentParser</span> = <span class="var-default">null</span>])
									</div>
																<div class="method-definition">
					static 						<span class="method-result">object</span>
										<a href="#encodeCall" title="details" class="method-name">encodeCall</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$method</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$args,...</span>)
									</div>
																<div class="method-definition">
					static 						<span class="method-result">array</span>
										<a href="#fault" title="details" class="method-name">fault</a>
											(<span class="var-type">int</span>&nbsp;<span class="var-name">$code</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$message</span>)
									</div>
																<div class="method-definition">
					static 						<span class="method-result">string</span>
										<a href="#getType" title="details" class="method-name">getType</a>
											(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$param</span>)
									</div>
																<div class="method-definition">
					static 						<span class="method-result">bool</span>
										<a href="#isFault" title="details" class="method-name">isFault</a>
											(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$fault</span>)
									</div>
																<div class="method-definition">
					static 						<span class="method-result">boolean</span>
										<a href="#load" title="details" class="method-name">load</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$class</span>)
									</div>
																<div class="method-definition">
					static 						<span class="method-result">void</span>
										<a href="#server" title="details" class="method-name">server</a>
											([<span class="var-type">mixed</span>&nbsp;<span class="var-name">$services</span> = <span class="var-default">null</span>], [<span class="var-type">array</span>&nbsp;<span class="var-name">$options</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$documentor</span> = <span class="var-default">null</span>])
									</div>
																<div class="method-definition">
					static 						<span class="method-result">object</span>
										<a href="#simpleClient" title="details" class="method-name">simpleClient</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>, [<span class="var-type">array</span>&nbsp;<span class="var-name">$options</span> = <span class="var-default">null</span>])
									</div>
																<div class="method-definition">
					static 						<span class="method-result">void</span>
										<a href="#soapClient" title="details" class="method-name">soapClient</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>, [<span class="var-type">array</span>&nbsp;<span class="var-name">$options</span> = <span class="var-default">null</span>])
									</div>
																<div class="method-definition">
					static 						<span class="method-result">int</span>
										<a href="#timestamp" title="details" class="method-name">timestamp</a>
											(<span class="var-type">object</span>&nbsp;<span class="var-name">$datetime</span>)
									</div>
																<div class="method-definition">
					static 						<span class="method-result">object</span>
										<a href="#xmlrpcClient" title="details" class="method-name">xmlrpcClient</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>, [<span class="var-type">array</span>&nbsp;<span class="var-name">$options</span> = <span class="var-default">null</span>])
									</div>
								
																												<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#bind" title="details" class="method-name">bind</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">&$bound</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$call</span>)
									</div>
																																																																																																																</div>
		</div>
	</div>		

	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
																		<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
							
										<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>
<a name="methodbase64" id="base64"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">static method base64</span> (line <span class="line-number">139</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">This method returns an XML-RPC base64 object from a given binary string.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
	    static
		<span class="method-result">object</span>
		<span class="method-name">
			base64
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$binary</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$binary</span>			</li>
				</ul>
		
			
	</div>
<a name="methodbinary" id="binary"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">static method binary</span> (line <span class="line-number">152</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">This method returns a (binary) string from a given XML-RPC base64 object.</p>
<p class="description"><p>It will throw a 'Variable is not of type base64' Ripcord_Exception (code -7)  if the given argument is not of the correct type.</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
	    static
		<span class="method-result">string</span>
		<span class="method-name">
			binary
		</span>
					(<span class="var-type">object</span>&nbsp;<span class="var-name">$base64</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">object</span>
				<span class="var-name">$base64</span>			</li>
				</ul>
		
			
	</div>
<a name="methodclient" id="client"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">static method client</span> (line <span class="line-number">79</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-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.</p>
	<ul class="tags">
				<li><span class="field">see:</span> <a href="../Ripcord/Ripcord_Client.html">Ripcord_Client</a></li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
	    static
		<span class="method-result">void</span>
		<span class="method-name">
			client
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>, [<span class="var-type">array</span>&nbsp;<span class="var-name">$options</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$transport</span> = <span class="var-default">null</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$url</span><span class="var-description">: The url of the RPC server to connect with</span>			</li>
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$options</span><span class="var-description">: Optional. An array of options to set for the Ripcord client.</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$transport</span>			</li>
				</ul>
		
			
	</div>
<a name="methoddatetime" id="datetime"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">static method datetime</span> (line <span class="line-number">110</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">This method returns an XML-RPC datetime object from a given unix timestamp.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
	    static
		<span class="method-result">object</span>
		<span class="method-name">
			datetime
		</span>
					(<span class="var-type">int</span>&nbsp;<span class="var-name">$timestamp</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">int</span>
				<span class="var-name">$timestamp</span>			</li>
				</ul>
		
			
	</div>
<a name="methoddocumentor" id="documentor"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">static method documentor</span> (line <span class="line-number">96</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">This method returns a new Ripcord documentor object.</p>
	<ul class="tags">
				<li><span class="field">see:</span> <a href="../Ripcord/Ripcord_Client.html">Ripcord_Client</a></li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
	    static
		<span class="method-result">void</span>
		<span class="method-name">
			documentor
		</span>
					([<span class="var-type">array</span>&nbsp;<span class="var-name">$options</span> = <span class="var-default">null</span>], [<span class="var-type">object docCommentParser</span>&nbsp;<span class="var-name">$docCommentParser</span> = <span class="var-default">null</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$options</span><span class="var-description">: Optional. An array of options to set for the Ripcord documentor.</span>			</li>
					<li>
				<span class="var-type">object docCommentParser</span>
				<span class="var-name">$docCommentParser</span><span class="var-description">: Optional. An object that parses a docComment block. Must  implement the Ripcord_Documentor_CommentParser interface.</span>			</li>
				</ul>
		
			
	</div>
<a name="methodencodeCall" id="encodeCall"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">static method encodeCall</span> (line <span class="line-number">246</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-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.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
	    static
		<span class="method-result">object</span>
		<span class="method-name">
			encodeCall
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$method</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$args,...</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$method</span><span class="var-description">: The name of the method call to encode</span>			</li>
					<li>
				<span class="var-type">mixed</span>
				<span class="var-name">$args,...</span><span class="var-description">: The remainder of the arguments are encoded as parameters to the call</span>			</li>
				</ul>
		
			
	</div>
<a name="methodfault" id="fault"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">static method fault</span> (line <span class="line-number">38</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">This method generates an XML-RPC fault with the given code and message.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
	    static
		<span class="method-result">array</span>
		<span class="method-name">
			fault
		</span>
					(<span class="var-type">int</span>&nbsp;<span class="var-name">$code</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$message</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">int</span>
				<span class="var-name">$code</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$message</span>			</li>
				</ul>
		
			
	</div>
<a name="methodgetType" id="getType"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">static method getType</span> (line <span class="line-number">168</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">This method returns the type of the given parameter. This can be any of the XML-RPC data types, e.g.</p>
<p class="description"><p>'struct', 'int', 'string', 'base64', 'boolean', 'double', 'array' or 'datetime'.</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
	    static
		<span class="method-result">string</span>
		<span class="method-name">
			getType
		</span>
					(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$param</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">mixed</span>
				<span class="var-name">$param</span>			</li>
				</ul>
		
			
	</div>
<a name="methodisFault" id="isFault"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">static method isFault</span> (line <span class="line-number">23</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">This method checks whether the given argument is an XML-RPC fault.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
	    static
		<span class="method-result">bool</span>
		<span class="method-name">
			isFault
		</span>
					(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$fault</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">mixed</span>
				<span class="var-name">$fault</span>			</li>
				</ul>
		
			
	</div>
<a name="methodload" id="load"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">static method load</span> (line <span class="line-number">216</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">This method includes a ripcord class, using require_once. Used for autoloading ripcord classes.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
	    static
		<span class="method-result">boolean</span>
		<span class="method-name">
			load
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$class</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$class</span><span class="var-description">: The name of the class to load.</span>			</li>
				</ul>
		
			
	</div>
<a name="methodserver" id="server"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">static method server</span> (line <span class="line-number">51</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">This method returns a new Ripcord server, which by default implements XML-RPC, Simple RPC and SOAP 1.1.</p>
<p class="description"><p>The server will publish any methods passed through the $services argument. It can be configured through  the $options argument.</p></p>
	<ul class="tags">
				<li><span class="field">see:</span> <a href="../Ripcord/Ripcord_Server.html">Ripcord_Server</a></li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
	    static
		<span class="method-result">void</span>
		<span class="method-name">
			server
		</span>
					([<span class="var-type">mixed</span>&nbsp;<span class="var-name">$services</span> = <span class="var-default">null</span>], [<span class="var-type">array</span>&nbsp;<span class="var-name">$options</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$documentor</span> = <span class="var-default">null</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">mixed</span>
				<span class="var-name">$services</span><span class="var-description">: Optional. Either an object or an array of objects. If the array has non-numeric keys, the key will be used as a namespace for the methods in the object.</span>			</li>
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$options</span><span class="var-description">: Optional. An array of options to set for the Ripcord server.</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$documentor</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsimpleClient" id="simpleClient"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">static method simpleClient</span> (line <span class="line-number">205</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">This method returns a new Ripcord client, configured to access a Simple RPC server.</p>
	<ul class="tags">
				<li><span class="field">see:</span> <a href="../Ripcord/Ripcord_Client.html">Ripcord_Client</a></li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
	    static
		<span class="method-result">object</span>
		<span class="method-name">
			simpleClient
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>, [<span class="var-type">array</span>&nbsp;<span class="var-name">$options</span> = <span class="var-default">null</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$url</span>			</li>
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$options</span><span class="var-description">: Optional.</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsoapClient" id="soapClient"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">static method soapClient</span> (line <span class="line-number">179</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">This method returns a new Ripcord client, configured to access a SOAP 1.1 server.</p>
	<ul class="tags">
				<li><span class="field">see:</span> <a href="../Ripcord/Ripcord_Client.html">Ripcord_Client</a></li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
	    static
		<span class="method-result">void</span>
		<span class="method-name">
			soapClient
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>, [<span class="var-type">array</span>&nbsp;<span class="var-name">$options</span> = <span class="var-default">null</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$url</span>			</li>
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$options</span><span class="var-description">: Optional.</span>			</li>
				</ul>
		
			
	</div>
<a name="methodtimestamp" id="timestamp"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">static method timestamp</span> (line <span class="line-number">124</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">This method returns a unix timestamp from a given XML-RPC datetime object.</p>
<p class="description"><p>It will throw a 'Variable is not of type datetime' Ripcord_Exception (code -6)  if the given argument is not of the correct type.</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
	    static
		<span class="method-result">int</span>
		<span class="method-name">
			timestamp
		</span>
					(<span class="var-type">object</span>&nbsp;<span class="var-name">$datetime</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">object</span>
				<span class="var-name">$datetime</span>			</li>
				</ul>
		
			
	</div>
<a name="methodxmlrpcClient" id="xmlrpcClient"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">static method xmlrpcClient</span> (line <span class="line-number">192</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">This method returns a new Ripcord client, configured to access an XML-RPC server.</p>
	<ul class="tags">
				<li><span class="field">see:</span> <a href="../Ripcord/Ripcord_Client.html">Ripcord_Client</a></li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
	    static
		<span class="method-result">object</span>
		<span class="method-name">
			xmlrpcClient
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>, [<span class="var-type">array</span>&nbsp;<span class="var-name">$options</span> = <span class="var-default">null</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$url</span>			</li>
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$options</span><span class="var-description">: Optional.</span>			</li>
				</ul>
		
			
	</div>

<a name="methodbind" id="bind"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">bind</span> (line <span class="line-number">263</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			bind
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">&$bound</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$call</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"></span>
				<span class="var-name">&$bound</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$call</span>			</li>
				</ul>
		
			
	</div>
						
		</div>
	</div>

	<a name="sec-consts"></a>
	<div class="info-box">
		<div class="info-box-title">Class Constants</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
										<a href="#sec-var-summary">Constants</a> (<span class="disabled">details</span>)
						
			
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
			<a name="constcannotAccessURL" id="cannotAccessURL"><!-- --></A>
<div class="evenrow">

	<div class="const-header">
		<img src="../media/images/Variable.png" />
		<span class="const-title">
			<span class="const-name">cannotAccessURL</span>
			 = <span class="const-default"> -4</span>
			(line <span class="line-number">289</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Could not access {url} - Thrown by the transport object when unable to access the given url.</p>
	
	
</div>
<a name="constcannotRecurse" id="cannotRecurse"><!-- --></A>
<div class="oddrow">

	<div class="const-header">
		<img src="../media/images/Variable.png" />
		<span class="const-title">
			<span class="const-name">cannotRecurse</span>
			 = <span class="const-default"> -3</span>
			(line <span class="line-number">285</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Cannot recurse system.multiCall  - Thrown by the ripcord server when system.multicall is called within itself.</p>
	
	
</div>
<a name="constmethodNotFound" id="methodNotFound"><!-- --></A>
<div class="evenrow">

	<div class="const-header">
		<img src="../media/images/Variable.png" />
		<span class="const-title">
			<span class="const-name">methodNotFound</span>
			 = <span class="const-default"> -1</span>
			(line <span class="line-number">277</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Method {method} not found. - Thrown by the ripcord server when a requested method isn't found.</p>
	
	
</div>
<a name="constnotBase64" id="notBase64"><!-- --></A>
<div class="oddrow">

	<div class="const-header">
		<img src="../media/images/Variable.png" />
		<span class="const-title">
			<span class="const-name">notBase64</span>
			 = <span class="const-default"> -7</span>
			(line <span class="line-number">301</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Variable is not of type base64 - Thrown by the ripcord binary method.</p>
	
	
</div>
<a name="constnotDatetime" id="notDatetime"><!-- --></A>
<div class="evenrow">

	<div class="const-header">
		<img src="../media/images/Variable.png" />
		<span class="const-title">
			<span class="const-name">notDatetime</span>
			 = <span class="const-default"> -6</span>
			(line <span class="line-number">297</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Variable is not of type datetime - Thrown by the ripcord timestamp method.</p>
	
	
</div>
<a name="constnotRipcordCall" id="notRipcordCall"><!-- --></A>
<div class="oddrow">

	<div class="const-header">
		<img src="../media/images/Variable.png" />
		<span class="const-title">
			<span class="const-name">notRipcordCall</span>
			 = <span class="const-default"> -2</span>
			(line <span class="line-number">281</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Argument {index} is not a valid Ripcord call - Thrown by the client when passing incorrect arguments to system.multiCall.</p>
	
	
</div>
<a name="constunknownServiceType" id="unknownServiceType"><!-- --></A>
<div class="evenrow">

	<div class="const-header">
		<img src="../media/images/Variable.png" />
		<span class="const-title">
			<span class="const-name">unknownServiceType</span>
			 = <span class="const-default"> -8</span>
			(line <span class="line-number">305</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Variable is not a classname or an object - Thrown by the ripcord server.</p>
	
	
</div>
<a name="constxmlrpcNotInstalled" id="xmlrpcNotInstalled"><!-- --></A>
<div class="oddrow">

	<div class="const-header">
		<img src="../media/images/Variable.png" />
		<span class="const-title">
			<span class="const-name">xmlrpcNotInstalled</span>
			 = <span class="const-default"> -5</span>
			(line <span class="line-number">293</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">PHP XMLRPC library is not installed - Thrown by the ripcord server and client when the xmlrpc library is not installed.</p>
	
	
</div>
						
		</div>
	</div>

	<p class="notes" id="credit">
		Documentation generated on Tue, 16 Nov 2010 16:20:15 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
	</p>
	</div></body>
</html>
Return current item: Ripcord: Easy XML-RPC Client and Server for PHP 5