d1/dc9/PEAR_2lib_2XML_2RPC2_2Server_8php_source.html

 <?php

 /* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4 foldmethod=marker: */

 // LICENSE AGREEMENT. If folded, press za here to unfold and read license {{{

 // }}}

 // dependencies {{{
 require_once 'XML/RPC2/Exception.php';
 require_once 'XML/RPC2/Backend.php';
 // }}}


 abstract class XML_RPC2_Server
 {

     // {{{ properties

     protected $callHandler = null;

     protected $prefix = '';

     protected $encoding = 'iso-8859-1';

     protected $autoDocument = true;

     protected $autoDocumentExternalLinks = true;

     protected $signatureChecking = true;

     // }}}
     // {{{ constructor

     protected function __construct($callHandler, $options = array())
     {
         $this->callHandler = $callHandler;
         if ((isset($options['prefix'])) && (is_string($options['prefix']))) {
             $this->prefix = $options['prefix'];
         }
         if ((isset($options['encoding'])) && (is_string($options['encoding']))) {
             $this->encoding = $options['encoding'];
         }
         if ((isset($options['autoDocument'])) && (is_bool($options['autoDocument']))) {
             $this->autoDocument = $options['autoDocument'];
         }
         if ((isset($options['autoDocumentExternalLinks'])) && (is_bool($options['autoDocumentExternalLinks']))) {
             $this->autoDocumentExternalLinks = $options['autoDocumentExternalLinks'];
         }
         if ((isset($options['signatureChecking'])) && (is_bool($options['signatureChecking']))) {
             $this->signatureChecking = $options['signatureChecking'];
         }
     }

     // }}}
     // {{{ create()

     public static function create($callTarget, $options = array())
     {
         if (isset($options['backend'])) {
             XML_RPC2_Backend::setBackend($options['backend']);
         }
         if (isset($options['prefix'])) {
             $prefix = $options['prefix'];
         } else {
             $prefix = '';
         }
         $backend = XML_RPC2_Backend::getServerClassname();
         // Find callHandler class
         if (!isset($options['callHandler'])) {
             if (is_object($callTarget)) { // Delegate calls to instance methods
                 require_once 'XML/RPC2/Server/CallHandler/Instance.php';
                 $callHandler = new XML_RPC2_Server_CallHandler_Instance($callTarget, $prefix);
             } else { // Delegate calls to static class methods
                 require_once 'XML/RPC2/Server/CallHandler/Class.php';
                 $callHandler = new XML_RPC2_Server_CallHandler_Class($callTarget, $prefix);
             }
         } else {
             $callHandler = $options['callHandler'];
         }
         return new $backend($callHandler, $options);
     }

     // }}}
     // {{{ handleCall()

     public abstract function handleCall();

     // }}}
     // {{{ errorToException()

     public static function errorToException($errno, $errstr, $errfile, $errline)
     {
         switch ($errno) {
             case E_WARNING:
             case E_NOTICE:
             case E_USER_WARNING:
             case E_USER_NOTICE:
             case E_STRICT:
                 // Silence warnings
                 // TODO Logging should occur here
                 break;
             default:
                 throw new Exception('Classic error reported "' . $errstr . '" on ' . $errfile . ':' . $errline);
         }
     }

     // }}}
     // {{{ autoDocument()
     /*     autoDocument {{{ */
     public function autoDocument()
     /* }}} */
     {
         print "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">\n";
         print "<html xmlns=\"http://www.w3.org/1999/xhtml\" lang=\"en\" xml:lang=\"en\">\n";
         print "  <head>\n";
         print "    <meta http-equiv=\"Content-Type\" content=\"text/HTML; charset=" . $this->encoding . "\"  />\n";
         print "    <title>Available XMLRPC methods for this server</title>\n";
         print "    <style type=\"text/css\">\n";
         print "      li,p { font-size: 10pt; font-family: Arial,Helvetia,sans-serif; }\n";
         print "      a:link { background-color: white; color: blue; text-decoration: underline; font-weight: bold; }\n";
         print "      a:visited { background-color: white; color: blue; text-decoration: underline; font-weight: bold; }\n";
         print "      table { border-collapse:collapse; width: 100% }\n";
         print "      table,td { padding: 5px; border: 1px solid black; }\n";
         print "      div.bloc { border: 1px dashed gray; padding: 10px; margin-bottom: 20px; }\n";
         print "      div.description { border: 1px solid black; padding: 10px; }\n";
         print "      span.type { background-color: white; color: gray; font-weight: normal; }\n";
         print "      span.paratype { background-color: white; color: gray; font-weight: normal; }\n";
         print "      span.name { background-color: white; color: #660000; }\n";
         print "      span.paraname { background-color: white; color: #336600; }\n";
         print "      img { border: 0px; }\n";
         print "      li { font-size: 12pt; }\n";
         print "    </style>\n";
         print "  </head>\n";
         print "  <body>\n";
         print "    <h1>Available XMLRPC methods for this server</h1>\n";
         print "    <h2><a name=\"index\">Index</a></h2>\n";
         print "    <ul>\n";
         foreach ($this->callHandler->getMethods() as $method) {
             $name = $method->getName();
             $id = md5($name);
             $signature = $method->getHTMLSignature();
             print "      <li><a href=\"#$id\">$name()</a></li>\n";
         }
         print "    </ul>\n";
         print "    <h2>Details</h2>\n";
         foreach ($this->callHandler->getMethods() as $method) {
             print "    <div class=\"bloc\">\n";
             $method->autoDocument();
             print "      <p>(return to <a href=\"#index\">index</a>)</p>\n";
             print "    </div>\n";
         }
         if (!($this->autoDocumentExternalLinks)) {
             print '    <p><a href="http://pear.php.net/packages/XML_RPC2"><img src="http://pear.php.net/gifs/pear-power.png" alt="Powered by PEAR/XML_RPC2" height="31" width="88" /></a> &nbsp; &nbsp; &nbsp; <a href="http://validator.w3.org/check?uri=referer"><img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0 Strict" height="31" width="88" /></a> &nbsp; &nbsp; &nbsp; <a href="http://jigsaw.w3.org/css-validator/"><img style="border:0;width:88px;height:31px" src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!" /></a></p>' . "\n";
         }
         print "  </body>\n";
         print "</html>\n";
     }
     // }}}
     // {{{ getContentLength()

     protected function getContentLength($content)
     {
         if (extension_loaded('mbstring') && (ini_get('mbstring.func_overload') & 2) == 2) {
             $length = mb_strlen($content, '8bit');
         } else {
             $length = strlen((binary)$content);
         }

         return $length;
     }

     // }}}
 }

 ?>
XML_RPC2_Server\$autoDocument
$autoDocument
Definition: Server.php:132

XML_RPC2_Server\handleCall
handleCall()
Receive the XML-RPC request, decode the HTTP payload, delegate execution to the call handler...

XML_RPC2_Backend\setBackend
static setBackend($backend)
Backend setter.
Definition: Backend.php:98

XML_RPC2_Server
Definition: Server.php:97

XML_RPC2_Server\autoDocument
autoDocument()
autoDocument.
Definition: Server.php:260

XML_RPC2_Backend\getServerClassname
static getServerClassname()
Include the relevant php files for the server class, and return the backend server class name...
Definition: Backend.php:157

XML_RPC2_Server\errorToException
static errorToException($errno, $errstr, $errfile, $errline)
Transform an error into an exception.
Definition: Server.php:236

XML_RPC2_Server\$encoding
$encoding
Definition: Server.php:125

$options
if(!is_array($argv)) $options
Definition: tcpdf_addfont.php:137

XML_RPC2_Server\__construct
__construct($callHandler, $options=array())
Create a new XML-RPC Server.
Definition: Server.php:160

XML_RPC2_Server\$prefix
$prefix
Definition: Server.php:116

XML_RPC2_Server\create
static create($callTarget, $options=array())
Factory method to select a backend and return a new XML_RPC2_Server based on the backend.
Definition: Server.php:190

XML_RPC2_Server\$signatureChecking
$signatureChecking
Definition: Server.php:149

XML_RPC2_Server\getContentLength
getContentLength($content)
Gets the content legth of a serialized XML-RPC message in bytes.
Definition: Server.php:318

XML_RPC2_Server\$autoDocumentExternalLinks
$autoDocumentExternalLinks
Definition: Server.php:139

XML_RPC2_Server\$callHandler
$callHandler
Definition: Server.php:109

Exception