XML_RPC
[ class tree: XML_RPC ] [ index: XML_RPC ] [ all elements ]

Procedural File: server.php

Source Location: /modules/pearxmlrpc/server.php



Classes:

XML_RPC_Server
A server for receiving and replying to XML RPC requests


Page Details:

Server commands for our PHP implementation of the XML-RPC protocol

This is a PEAR-ified version of Useful inc's XML-RPC for PHP. It has support for HTTP transport, proxies and authentication.

PHP versions 4 and 5

LICENSE: License is granted to use or modify this software ("XML-RPC for PHP") for commercial or non-commercial use provided the copyright of the author is preserved in any distributed or derivative work.

THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.




Tags:

author:  Daniel Convissor <danielc@php.net>
author:  Stig Bakken <stig@php.net>
author:  Edd Dumbill <edd@usefulinc.com>
author:  Martin Jansen <mj@php.net>
version:  CVS: $Id$
copyright:  1999-2001 Edd Dumbill, 2001-2006 The PHP Group
link:  http://pear.php.net/package/XML_RPC





string $GLOBALS['XML_RPC_Server_debuginfo'] [line 129]

Default value:   ''


[ Top ]



array $GLOBALS['XML_RPC_Server_dmap'] [line 108]

dispatch map for the automatically declared XML-RPC methods.

Default value:   array(
    'system.listMethods' => array(
        'function'  => 'XML_RPC_Server_listMethods',
        'signature' => $GLOBALS['XML_RPC_Server_listMethods_sig'],
        'docstring' => $GLOBALS['XML_RPC_Server_listMethods_doc']
    ),'system.methodHelp'=>array('function'=>'XML_RPC_Server_methodHelp','signature'=>$GLOBALS['XML_RPC_Server_methodHelp_sig'],'docstring'=>$GLOBALS['XML_RPC_Server_methodHelp_doc']),'system.methodSignature'=>array('function'=>'XML_RPC_Server_methodSignature','signature'=>$GLOBALS['XML_RPC_Server_methodSignature_sig'],'docstring'=>$GLOBALS['XML_RPC_Server_methodSignature_doc']))


[ Top ]



string $GLOBALS['XML_RPC_Server_listMethods_doc'] [line 63]

docstring for system.listMethods

Default value:   'This method lists all the'
        . ' methods that the XML-RPC server knows how to dispatch'


[ Top ]



array $GLOBALS['XML_RPC_Server_listMethods_sig'] [line 52]

signature for system.listMethods: return = array,

parameters = a string or nothing


Default value:   array(
    array($GLOBALS['XML_RPC_Array'],
          $GLOBALS['XML_RPC_String']
    ),array($GLOBALS['XML_RPC_Array']))


[ Top ]



string $GLOBALS['XML_RPC_Server_methodHelp_doc'] [line 101]

docstring for methodHelp

Default value:   'Returns help text if defined'
        . ' for the method passed, otherwise returns an empty string'


[ Top ]



array $GLOBALS['XML_RPC_Server_methodHelp_sig'] [line 91]

signature for system.methodHelp: return = string,

parameters = string


Default value:   array(
    array($GLOBALS['XML_RPC_String'],
          $GLOBALS['XML_RPC_String']
    ))


[ Top ]



string $GLOBALS['XML_RPC_Server_methodSignature_doc'] [line 81]

docstring for system.methodSignature

Default value:   'Returns an array of known'
        . ' signatures (an array of arrays) for the method name passed. If'
        . ' no signatures are known, returns a none-array (test for type !='
        . ' array to detect missing signature)'


[ Top ]



array $GLOBALS['XML_RPC_Server_methodSignature_sig'] [line 71]

signature for system.methodSignature: return = array,

parameters = string


Default value:   array(
    array($GLOBALS['XML_RPC_Array'],
          $GLOBALS['XML_RPC_String']
    ))


[ Top ]






XML_RPC_Server_debugmsg [line 236]

void XML_RPC_Server_debugmsg( $m)



Parameters

   $m  
[ Top ]



XML_RPC_Server_listMethods [line 137]

object a XML_RPC_Server_listMethods( $server, $m)

Lists all the methods that the XML-RPC server knows how to dispatch



Tags:

return:  new XML_RPC_Response object


Parameters

   $server  
   $m  
[ Top ]



XML_RPC_Server_methodHelp [line 205]

object a XML_RPC_Server_methodHelp( $server, $m)

Returns help text if defined for the method passed, otherwise returns an empty string



Tags:

return:  new XML_RPC_Response object


Parameters

   $server  
   $m  
[ Top ]



XML_RPC_Server_methodSignature [line 162]

object a XML_RPC_Server_methodSignature( $server, $m)

Returns an array of known signatures (an array of arrays) for the given method

If no signatures are known, returns a none-array (test for type != array to detect missing signature)




Tags:

return:  new XML_RPC_Response object


Parameters

   $server  
   $m  
[ Top ]



Documentation generated on Thu, 12 Feb 2009 08:00:08 +0900 by phpDocumentor 1.4.2