Refs #2220: Pulled most classes / interfaces out of lib files (except query.php and exception.php) into "classes" folder. Replaced inline classes with "require_once" statements for now. Ran unit tests to verify functionality before committing.

git-svn-id: http://code.elgg.org/elgg/trunk@6908 36083f99-b078-4883-b0ff-0f9b5a30f544

1 files changed, 14 insertions, 375 deletions

diff --git a/engine/lib/xml-rpc.php b/engine/lib/xml-rpc.php
index 110dd76dd..79c3eba07 100644
--- a/engine/lib/xml-rpc.php
+++ b/engine/lib/xml-rpc.php
@@ -10,385 +10,24 @@
 	 */
 
 	// XMLRPC Call ////////////////////////////////////////////////////////////////////////////
-	
-	/**
-	 * @class XMLRPCCall
-	 * This class represents 
-	 * @author Curverider Ltd
-	 */
-	class XMLRPCCall
-	{
-		/** Method name */
-		private $methodname;
-		/** Parameters */
-		private $params;
-		
-		/**
-		 * Construct a new XML RPC Call
-		 *
-		 * @param string $xml
-		 */
-		function __construct($xml)
-		{
-			$this->parse($xml);
-		}
-		
-		/**
-		 * Return the method name associated with the call.
-		 *
-		 * @return string
-		 */
-		public function getMethodName() { return $this->methodname; }
-		
-		/**
-		 * Return the parameters.
-		 * Returns a nested array of XmlElement.
-		 * 
-		 * @see XmlElement 
-		 * @return array
-		 */
-		public function getParameters() { return $this->params; }
-		
-		/**
-		 * Parse the xml into its components according to spec. 
-		 * This first version is a little primitive. 
-		 *
-		 * @param string $xml
-		 */
-		private function parse($xml)
-		{
-			$xml = xml_to_object($xml);
-			
-			// sanity check
-			if ((isset($xml->name)) && (strcasecmp($xml->name, "methodCall")!=0))
-				throw new CallException(elgg_echo('CallException:NotRPCCall'));
-			
-			// method name
-			$this->methodname = $xml->children[0]->content;
-			
-			// parameters 
-			$this->params = $xml->children[1]->children;			
-		}
-	}
-	
-	// Response classes ///////////////////////////////////////////////////////////////////////
 
-	/**
-	 * @class XMLRPCParameter Superclass for all RPC parameters.
-	 * @author Curverider Ltd
-	 */
-	abstract class XMLRPCParameter
-	{
-		protected $value;
+	require_once dirname(dirname(__FILE__)).'/classes/XMLRPCCall.php';
 
-		function __construct() { }
-			
-	}
-	
-	/**
-	 * @class XMLRPCIntParameter An Integer.
-	 * @author Curverider Ltd
-	 */
-	class XMLRPCIntParameter extends XMLRPCParameter
-	{
-		function __construct($value)
-		{
-			parent::__construct();
-			
-			$this->value = (int)$value; 
-		}
-		
-		function __toString() 
-		{
-			return "<value><i4>{$this->value}</i4></value>";
-		}
-	}
 	
-	/**
-	 * @class XMLRPCBoolParameter A boolean.
-	 * @author Curverider Ltd
-	 */
-	class XMLRPCBoolParameter extends XMLRPCParameter
-	{
-		function __construct($value)
-		{
-			parent::__construct();
-			
-			$this->value = (bool)$value; 
-		}
-		
-		function __toString() 
-		{
-			$code = ($this->value) ? "1" : "0";
-			return "<value><boolean>{$code}</boolean></value>";
-		}
-	}
-	
-	/**
-	 * @class XMLRPCStringParameter A string.
-	 * @author Curverider Ltd
-	 */
-	class XMLRPCStringParameter extends XMLRPCParameter
-	{
-		function __construct($value)
-		{
-			parent::__construct();
-			
-			$this->value = $value; 
-		}
-		
-		function __toString() 
-		{
-			$value = htmlentities($this->value);
-			return "<value><string>{$value}</string></value>";
-		}
-	}
-	
-	/**
-	 * @class XMLRPCDoubleParameter A double precision signed floating point number.
-	 * @author Curverider Ltd
-	 */
-	class XMLRPCDoubleParameter extends XMLRPCParameter
-	{
-		function __construct($value)
-		{
-			parent::__construct();
-			
-			$this->value = (float)$value; 
-		}
-		
-		function __toString() 
-		{
-			return "<value><double>{$this->value}</double></value>";
-		}
-	}
-	
-	/**
-	 * @class XMLRPCDateParameter An ISO8601 data and time.
-	 * @author Curverider Ltd
-	 */
-	class XMLRPCDateParameter extends XMLRPCParameter
-	{
-		/**
-		 * Construct a date
-		 *
-		 * @param int $timestamp The unix timestamp, or blank for "now".
-		 */
-		function __construct($timestamp = 0)
-		{
-			parent::__construct();
-			
-			$this->value = $timestamp;
-			if (!$timestamp)
-				$this->value = time(); 
-		}
-		
-		function __toString() 
-		{
-			$value = date('c', $this->value);
-			return "<value><dateTime.iso8601>{$value}</dateTime.iso8601></value>";
-		}
-	}
-	
-	/**
-	 * @class XMLRPCBase64Parameter A base 64 encoded blob of binary.
-	 * @author Curverider Ltd
-	 */
-	class XMLRPCBase64Parameter extends XMLRPCParameter
-	{
-		/**
-		 * Construct a base64 encoded block
-		 *
-		 * @param string $blob Unencoded binary blob
-		 */
-		function __construct($blob)
-		{
-			parent::__construct();
-			
-			$this->value = base64_encode($blob);
-		}
-		
-		function __toString() 
-		{
-			return "<value><base64>{$value}</base64></value>";
-		}
-	}
-	
-	/**
-	 * @class XMLRPCStructParameter A structure containing other XMLRPCParameter objects.
-	 * @author Curverider Ltd
-	 */
-	class XMLRPCStructParameter extends XMLRPCParameter
-	{
-		/**
-		 * Construct a struct.
-		 *
-		 * @param array $parameters Optional associated array of parameters, if not provided then addField must be used.
-		 */
-		function __construct($parameters = NULL)
-		{
-			parent::__construct();
-			
-			if (is_array($parameters))
-			{
-				foreach ($parameters as $k => $v)
-					$this->addField($k, $v);
-			}
-		}
-		
-		/**
-		 * Add a field to the container.
-		 *
-		 * @param string $name The name of the field.
-		 * @param XMLRPCParameter $value The value.
-		 */
-		public function addField($name, XMLRPCParameter $value)
-		{
-			if (!is_array($this->value))
-				$this->value = array();
-				
-			$this->value[$name] = $value;
-		}
-		
-		function __toString() 
-		{
-			$params = "";
-			foreach ($this->value as $k => $v)
-			{
-				$params .= "<member><name>$k</name>$v</member>";
-			}
-			
-			return "<value><struct>$params</struct></value>";
-		}
-	}
-	
-	/**
-	 * @class XMLRPCArrayParameter An array containing other XMLRPCParameter objects.
-	 * @author Curverider Ltd
-	 */
-	class XMLRPCArrayParameter extends XMLRPCParameter
-	{
-		/**
-		 * Construct an array.
-		 *
-		 * @param array $parameters Optional array of parameters, if not provided then addField must be used.
-		 */
-		function __construct($parameters = NULL)
-		{
-			parent::__construct();
-			
-			if (is_array($parameters))
-			{
-				foreach ($parameters as $v)
-					$this->addField($v);
-			}
-		}
-		
-		/**
-		 * Add a field to the container.
-		 *
-		 * @param XMLRPCParameter $value The value.
-		 */
-		public function addField(XMLRPCParameter $value)
-		{
-			if (!is_array($this->value))
-				$this->value = array();
-				
-			$this->value[] = $value;
-		}
-		
-		function __toString() 
-		{
-			$params = "";
-			foreach ($this->value as $value)
-			{
-				$params .= "$value";
-			}
-			
-			return "<array><data>$params</data></array>";
-		}
-	}
-	
-	/**
-	 * @class XMLRPCResponse XML-RPC Response. 
-	 * @author Curverider Ltd
-	 */
-	abstract class XMLRPCResponse
-	{
-		/** An array of parameters */
-		protected $parameters = array();
-		
-		/**
-		 * Add a parameter here.
-		 *
-		 * @param XMLRPCParameter $param The parameter.
-		 */
-		public function addParameter(XMLRPCParameter $param)
-		{
-			if (!is_array($this->parameters))
-				$this->parameters = array();
-				
-			$this->parameters[] = $param;
-		}
-
-		public function addInt($value) { $this->addParameter(new XMLRPCIntParameter($value)); }
-		public function addString($value) { $this->addParameter(new XMLRPCStringParameter($value)); }
-		public function addDouble($value) { $this->addParameter(new XMLRPCDoubleParameter($value)); }
-		public function addBoolean($value) { $this->addParameter(new XMLRPCBoolParameter($value)); }
-	}
-
-	/**
-	 * @class XMLRPCSuccessResponse
-	 * @author Curverider Ltd
-	 */
-	class XMLRPCSuccessResponse extends XMLRPCResponse
-	{
-		/**
-		 * Output to XML.
-		 */
-		public function __toString()
-		{
-			$params = "";
-			foreach ($this->parameters as $param)
-				$params .= "<param>$param</param>\n";
-			
-			return "<methodResponse><params>$params</params></methodResponse>";
-		}
-	}
+	// Response classes ///////////////////////////////////////////////////////////////////////
 
-	/**
-	 * @class XMLRPCErrorResponse
-	 * @author Curverider Ltd
-	 */
-	class XMLRPCErrorResponse extends XMLRPCResponse
-	{		
-		/**
-		 * Set the error response and error code.
-		 *
-		 * @param string $message The message
-		 * @param int $code Error code (default = system error as defined by http://xmlrpc-epi.sourceforge.net/specs/rfc.fault_codes.php)
-		 */
-		function __construct($message, $code = -32400)
-		{
-			$this->addParameter(
-				new XMLRPCStructParameter(
-					array (
-						'faultCode' => new XMLRPCIntParameter($code),
-						'faultString' => new XMLRPCStringParameter($message)
-					)
-				)
-			);
-		}
-		
-		/**
-		 * Output to XML.
-		 */
-		public function __toString()
-		{
-			return "<methodResponse><fault><value>{$this->parameters[0]}</value></fault></methodResponse>";
-		}
-	}
-	
+	require_once dirname(dirname(__FILE__)).'/classes/XMLRPCParameter.php';
+	require_once dirname(dirname(__FILE__)).'/classes/XMLRPCIntParameter.php';
+	require_once dirname(dirname(__FILE__)).'/classes/XMLRPCBoolParameter.php';
+	require_once dirname(dirname(__FILE__)).'/classes/XMLRPCStringParameter.php';
+	require_once dirname(dirname(__FILE__)).'/classes/XMLRPCDoubleParameter.php';
+	require_once dirname(dirname(__FILE__)).'/classes/XMLRPCDateParameter.php';
+	require_once dirname(dirname(__FILE__)).'/classes/XMLRPCBase64Parameter.php';
+	require_once dirname(dirname(__FILE__)).'/classes/XMLRPCStructParameter.php';
+	require_once dirname(dirname(__FILE__)).'/classes/XMLRPCArrayParameter.php';
+	require_once dirname(dirname(__FILE__)).'/classes/XMLRPCResponse.php';
+	require_once dirname(dirname(__FILE__)).'/classes/XMLRPCSuccessResponse.php';
+	require_once dirname(dirname(__FILE__)).'/classes/XMLRPCErrorResponse.php';
 	
 	// Helper functions ///////////////////////////////////////////////////////////////////////