Class: XML_RPC_Server

Source Location: /XML_RPC-1.4.5/Server.php

Class Overview

A server for receiving and replying to XML RPC requests

Author(s):

Daniel Convissor <mailto:danielc at php.net>
Stig Bakken <mailto:stig at php.net>
Martin Jansen <mailto:mj at php.net>
Edd Dumbill <mailto:edd at usefulinc.com>

Version:

Release: 1.4.5

Copyright:

1999-2001 Edd Dumbill, 2001-2005 The PHP Group

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

[line 276]
A server for receiving and replying to XML RPC requests


1     $server = new XML_RPC_Server(
2          array(
3              'isan8' =>
4                  array(
5                      'function' => 'is_8',
6                      'signature' =>
7                           array(
8                               array('boolean', 'int'),
9                               array('boolean', 'int', 'boolean'),
10                              array('boolean', 'string'),
11                              array('boolean', 'string', 'boolean'),
12                          ),
13                     'docstring' => 'Is the value an 8?'
14                 ),
15         ),
16         1,
17         0
18     );

Version: Release: 1.4.5
Link: http://pear.php.net/package/XML_RPC
Copyright: 1999-2001 Edd Dumbill, 2001-2005 The PHP Group
Author: Daniel Convissor <mailto:danielc@php.net>
Author: Stig Bakken <mailto:stig@php.net>
Author: Martin Jansen <mailto:mj@php.net>
Author: Edd Dumbill <mailto:edd@usefulinc.com>

[ Top ]

Class Variables

$debug = 0

[line 295]

Debug mode (0 = off, 1 = on)

Type:

integer

[ Top ]

$dmap = array()

[line 282]

The dispatch map, listing the methods this server provides.

Type:

array

[ Top ]

$encoding = ''

[line 289]

The present response's encoding

See: XML_RPC_Message::getEncoding()

Type:

string

[ Top ]

$server_headers = ''

[line 301]

The response's HTTP headers

Type:

string

[ Top ]

$server_payload = ''

[line 307]

The response's XML payload

Type:

string

[ Top ]

Method Detail

XML_RPC_Server (Constructor) [line 333]

void XML_RPC_Server(
array
$dispMap, [int
$serviceNow = 1], [int
$debug = 0])

Constructor for the XML_RPC_Server class

Parameters:

array	`$dispMap`	—	the dispatch map. An associative array explaining each function. The keys of the main array are the procedure names used by the clients. The value is another associative array that contains up to three elements: The 'function' element's value is the name of the function or method that gets called. To define a class' method: 'class::method'. The 'signature' element (optional) is an array describing the return values and parameters The 'docstring' element (optional) is a string describing what the method does
int	`$serviceNow`	—	should the HTTP response be sent now? (1 = yes, 0 = no)
int	`$debug`	—	should debug output be displayed? (1 = yes, 0 = no)

[ Top ]

createServerHeaders [line 440]

boolean createServerHeaders(
)

Determines the HTTP headers and puts them in the $server_headers property

Return: TRUE if okay, FALSE if $server_payload isn't set.
Uses: XML_RPC_Server::createServerPayload(), - XML_RPC_Server::$server_headers

[ Top ]

createServerPayload [line 422]

void createServerPayload(
)

Generates the payload and puts it in the $server_payload property

Uses: XML_RPC_Server::parseRequest(), - XML_RPC_Server::$encoding, XML_RPC_Response::serialize(), XML_RPC_Server::serializeDebug()

[ Top ]

echoInput [line 625]

void echoInput(
)

Echos back the input packet as a string value

Return: Useful for debugging.

[ Top ]

parseRequest [line 509]

object a parseRequest(
[mixed
$data = ''])

Return: new XML_RPC_Response object
Uses: XML_RPC_Message::getEncoding(), - XML_RPC_Server::$encoding

[ Top ]

serializeDebug [line 356]

string serializeDebug(
)

Return: the debug information if debug debug mode is on

[ Top ]

service [line 386]

void service(
)

Sends the response

The encoding and content-type are determined by XML_RPC_Message::getEncoding()

Uses: XML_RPC_Server::createServerPayload(), - XML_RPC_Server::createServerHeaders()

[ Top ]

verifySignature [line 455]

array verifySignature(
mixed
$in, mixed
$sig)

[ Top ]