Standardized code in all of core, not including language files, tests, or core mods.

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

1 files changed, 188 insertions, 165 deletions

diff --git a/engine/lib/xml-rpc.php b/engine/lib/xml-rpc.php
index cf08dd8e4..70eb627d8 100644
--- a/engine/lib/xml-rpc.php
+++ b/engine/lib/xml-rpc.php
@@ -1,174 +1,197 @@
 <?php
-	/**
-	 * Elgg XML-RPC library.
-	 * Contains functions and classes to handle XML-RPC services, currently only server only. 
-	 * 
-	 * @package Elgg
-	 * @subpackage Core
-	 */
-
-	// Helper functions ///////////////////////////////////////////////////////////////////////
-	
-	/**
-	 * parse XMLRPCCall parameters
-	 * 
-	 * Convert an XMLRPCCall result array into native data types
-	 *
-	 * @param array $parameters
-	 * @return array
-	 */
-	function xmlrpc_parse_params($parameters)
-	{
-	    $result = array();
-	    
-	    foreach ($parameters as $parameter)
-	    {
-	        $result[] = xmlrpc_scalar_value($parameter);
-	    }
-	    
-	    return $result;
+/**
+ * Elgg XML-RPC library.
+ * Contains functions and classes to handle XML-RPC services, currently only server only.
+ *
+ * @package Elgg.Core
+ * @subpackage XMLRPC
+ */
+
+/**
+ * parse XMLRPCCall parameters
+ *
+ * Convert an XMLRPCCall result array into native data types
+ *
+ * @param array $parameters An array of params
+ *
+ * @return array
+ */
+function xmlrpc_parse_params($parameters) {
+	$result = array();
+
+	foreach ($parameters as $parameter) {
+		$result[] = xmlrpc_scalar_value($parameter);
 	}
 
-	/**
-	 * Extract the scalar value of an XMLObject type result array
-	 *
-	 * @param XMLObject $object
-	 * @return mixed
-	 */
-	function xmlrpc_scalar_value($object)
-	{
-	    if ($object->name == 'param')
-	    {
-	        $object = $object->children[0]->children[0];
-	    }
-	
-	    switch ($object->name)
-	    {
-	        case 'string':
-	            return $object->content;
-	        case 'array':
-	            foreach ($object->children[0]->children as $child)
-	            {
-	                $value[] = xmlrpc_scalar_value($child);
-	            }
-	            return $value;
-	        case 'struct':
-	            foreach ($object->children as $child)
-	            {
-	            	if (isset($child->children[1]->children[0]))
-	                	$value[$child->children[0]->content] = xmlrpc_scalar_value($child->children[1]->children[0]);
-	                else
-	                	$value[$child->children[0]->content] = $child->children[1]->content;
-	            }
-	            return $value;
-	        case 'boolean':
-	            return (boolean) $object->content;
-	        case 'i4':
-	        case 'int':
-	            return (int) $object->content;
-	        case 'double':
-	            return (double) $object->content;
-	        case 'dateTime.iso8601':
-	            return (int) strtotime($object->content);
-	        case 'base64':
-	            return base64_decode($object->content);
-	        case 'value':
-	            return xmlrpc_scalar_value($object->children[0]);
-	        default:
-	            // @todo unsupported, throw an error
-	            return false;
-	    }
+	return $result;
+}
+
+/**
+ * Extract the scalar value of an XMLObject type result array
+ *
+ * @param XMLObject $object And object
+ *
+ * @return mixed
+ */
+function xmlrpc_scalar_value($object) {
+	if ($object->name == 'param') {
+		$object = $object->children[0]->children[0];
 	}
-	
-	// Functions for adding handlers //////////////////////////////////////////////////////////
-
-	/** XML-RPC Handlers */
-	$XML_RPC_HANDLERS = array();
-	
-	/**
-	 * Register a method handler for a given XML-RPC method.
-	 *
-	 * @param string $method Method parameter.
-	 * @param string $handler The handler function. This function accepts once XMLRPCCall object and must return a XMLRPCResponse object.
-	 * @return bool
-	 */
-	function register_xmlrpc_handler($method, $handler)
-	{
-		global $XML_RPC_HANDLERS;
-		
-		$XML_RPC_HANDLERS[$method] = $handler;
+
+	switch ($object->name) {
+		case 'string':
+			return $object->content;
+
+		case 'array':
+			foreach ($object->children[0]->children as $child) {
+				$value[] = xmlrpc_scalar_value($child);
+			}
+			return $value;
+
+		case 'struct':
+			foreach ($object->children as $child) {
+				if (isset($child->children[1]->children[0])) {
+					$value[$child->children[0]->content] = xmlrpc_scalar_value($child->children[1]->children[0]);
+				} else {
+					$value[$child->children[0]->content] = $child->children[1]->content;
+				}
+			}
+			return $value;
+
+		case 'boolean':
+			return (boolean) $object->content;
+
+		case 'i4':
+		case 'int':
+			return (int) $object->content;
+
+		case 'double':
+			return (double) $object->content;
+
+		case 'dateTime.iso8601':
+			return (int) strtotime($object->content);
+
+		case 'base64':
+			return base64_decode($object->content);
+
+		case 'value':
+			return xmlrpc_scalar_value($object->children[0]);
+
+		default:
+			// @todo unsupported, throw an error
+			return false;
 	}
-	
-	/**
-	 * Trigger a method call and pass the relevant parameters to the funciton.
-	 *
-	 * @param XMLRPCCall $parameters The call and parameters.
-	 * @return XMLRPCCall
-	 */
-	function trigger_xmlrpc_handler(XMLRPCCall $parameters)
-	{
-		global $XML_RPC_HANDLERS;
-		
-		// Go through and see if we have a handler
-		if (isset($XML_RPC_HANDLERS[$parameters->getMethodName()]))
-		{
-		    $handler = $XML_RPC_HANDLERS[$parameters->getMethodName()];
-			$result  = $handler($parameters);
-			
-			if (!($result instanceof XMLRPCResponse))
-				throw new InvalidParameterException(sprintf(elgg_echo('InvalidParameterException:UnexpectedReturnFormat'), $parameters->getMethodName()));
-				
-			// Result in right format, return it.
-			return $result;
+}
+
+// Functions for adding handlers //////////////////////////////////////////////////////////
+
+/** XML-RPC Handlers */
+$XML_RPC_HANDLERS = array();
+
+/**
+ * Register a method handler for a given XML-RPC method.
+ *
+ * @param string $method  Method parameter.
+ * @param string $handler The handler function. This function accepts
+ *                        one XMLRPCCall object and must return a XMLRPCResponse object.
+ *
+ * @return bool
+ */
+function register_xmlrpc_handler($method, $handler) {
+	global $XML_RPC_HANDLERS;
+
+	$XML_RPC_HANDLERS[$method] = $handler;
+}
+
+/**
+ * Trigger a method call and pass the relevant parameters to the funciton.
+ *
+ * @param XMLRPCCall $parameters The call and parameters.
+ *
+ * @return XMLRPCCall
+ */
+function trigger_xmlrpc_handler(XMLRPCCall $parameters) {
+	global $XML_RPC_HANDLERS;
+
+	// Go through and see if we have a handler
+	if (isset($XML_RPC_HANDLERS[$parameters->getMethodName()])) {
+		$handler = $XML_RPC_HANDLERS[$parameters->getMethodName()];
+		$result  = $handler($parameters);
+
+		if (!($result instanceof XMLRPCResponse)) {
+			$msg = sprintf(elgg_echo('InvalidParameterException:UnexpectedReturnFormat'),
+				$parameters->getMethodName());
+			throw new InvalidParameterException($msg);
 		}
-		
-		// if no handler then throw exception
-		throw new NotImplementedException(sprintf(elgg_echo('NotImplementedException:XMLRPCMethodNotImplemented'), $parameters->getMethodName()));
+
+		// Result in right format, return it.
+		return $result;
 	}
-	
-	// Error handler functions ////////////////////////////////////////////////////////////////
-
-	/**
-	 * PHP Error handler function.
-	 * This function acts as a wrapper to catch and report PHP error messages.
-	 * 
-	 * @see http://uk3.php.net/set-error-handler
-	 * @param unknown_type $errno
-	 * @param unknown_type $errmsg
-	 * @param unknown_type $filename
-	 * @param unknown_type $linenum
-	 * @param unknown_type $vars
-	 */
-	function __php_xmlrpc_error_handler($errno, $errmsg, $filename, $linenum, $vars)
-	{
-		$error = date("Y-m-d H:i:s (T)") . ": \"" . $errmsg . "\" in file " . $filename . " (line " . $linenum . ")";
-		
-		switch ($errno) {
-			case E_USER_ERROR:
-					error_log("ERROR: " . $error);
-					
-					// Since this is a fatal error, we want to stop any further execution but do so gracefully.
-					throw new Exception("ERROR: " . $error); 
-				break;
-	
-			case E_WARNING :
-			case E_USER_WARNING : 
-					error_log("WARNING: " . $error);
-				break;
-	
-			default:
-				error_log("DEBUG: " . $error); 
-		}
+
+	// if no handler then throw exception
+	$msg = sprintf(elgg_echo('NotImplementedException:XMLRPCMethodNotImplemented'),
+		$parameters->getMethodName());
+	throw new NotImplementedException($msg);
+}
+
+/**
+ * PHP Error handler function.
+ * This function acts as a wrapper to catch and report PHP error messages.
+ *
+ * @see http://uk3.php.net/set-error-handler
+ *
+ * @param int    $errno    Error number
+ * @param string $errmsg   Human readable message
+ * @param string $filename Filename
+ * @param int    $linenum  Line number
+ * @param array  $vars     Vars
+ *
+ * @return void
+ */
+function _php_xmlrpc_error_handler($errno, $errmsg, $filename, $linenum, $vars) {
+	$error = date("Y-m-d H:i:s (T)") . ": \"" . $errmsg . "\" in file "
+		. $filename . " (line " . $linenum . ")";
+
+	switch ($errno) {
+		case E_USER_ERROR:
+				error_log("ERROR: " . $error);
+
+				// Since this is a fatal error, we want to stop any further execution but do so gracefully.
+				throw new Exception("ERROR: " . $error);
+			break;
+
+		case E_WARNING :
+		case E_USER_WARNING :
+				error_log("WARNING: " . $error);
+			break;
+
+		default:
+			error_log("DEBUG: " . $error);
 	}
-	
-	/**
-	 * PHP Exception handler for XMLRPC.
-	 * @param Exception $exception
-	 */
-	function __php_xmlrpc_exception_handler($exception) {
-		
-		error_log("*** FATAL EXCEPTION (XML-RPC) *** : " . $exception);
-			
-		page_draw($exception->getMessage(), elgg_view("xml-rpc/output", array('result' => new XMLRPCErrorResponse($exception->getMessage(), $exception->getCode()==0 ? -32400 : $exception->getCode()))));
+}
+
+/**
+ * PHP Exception handler for XMLRPC.
+ *
+ * @param Exception $exception The exception
+ *
+ * @return void
+ */
+function _php_xmlrpc_exception_handler($exception) {
+
+	error_log("*** FATAL EXCEPTION (XML-RPC) *** : " . $exception);
+
+	$code = $exception->getCode();
+
+	if ($code == 0) {
+		$code = -32400;
 	}
-?>
+
+	$result = new XMLRPCErrorResponse($exception->getMessage(), $code);
+
+	$vars = array('result' => $result);
+
+	$content = elgg_view("xml-rpc/output", $vars);
+
+	page_draw($exception->getMessage(), $content);
+}