## Class Ripcord_Documentor

Description

Implements interfaces:

- Ripcord_Documentor_Interface

This class implements the default documentor for the ripcord server. Any request to the server without a request_xml is handled by the documentor.

Located in /ripcord_documentor.php (line 28)

Variable Summary
mixed $css
mixed $footer
mixed $header
mixed $name
mixed $root
mixed $version
mixed $wsdl
mixed $wsdl2
Method Summary
Ripcord_Documentor __construct ([ $options = null], [ $docCommentParser = null], array $options.)
string getIntrospectionXML ()
void handle (object $rpcServer)
void setMethodData (array $methodData)
Variables
mixed $css = "
html {
font-family: georgia, times, serif;
font-size: 79%;
background-color: #EEEEEE;
}
h1 {
font-family: 'arial black', helvetica, sans-serif;
font-size: 2em;
font-weight: normal;
margin: -20px -21px 0.4em -20px;
padding: 40px 20px 20px;
background: #01648E; /* for non-css3 browsers */
filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#00486E', endColorstr='#09799E'); /* for IE */
background: -webkit-gradient(linear, left top, left bottom, from(#00486E), to(#09799E)); /* for webkit browsers */
background: -moz-linear-gradient(top, #00486E, #09799E); /* for firefox 3.6+ */
color: white;
border-bottom: 4px solid black;
text-shadow: black 0.1em 0.1em 0.2em;
}
h2 {
font-family: arial, helvetica, sans-serif;
font-weight: bold;
font-size: 1.4em;
color: #444444;
text-shadow: #AAAAAA 0.1em 0.1em 0.2em;
margin-top: 2.5em;
border-bottom: 1px solid #09799E;
}
h3 {
font-family: arial, helvetica, sans-serif;
font-weight: normal;
font-size: 1.4em;
color: #555555;
text-shadow: #AAAAAA 0.1em 0.1em 0.2em;
margin-bottom: 0px;
}
div.signature {
font-family: courier, monospace;
margin-bottom: 1.4em;
}
ul, ol, li {
margin: 0px;
padding: 0px;
}
ul, ol {
color: #09799E;
margin-bottom: 1.4em;
}
ul li {
list-style: square;
}
ul li, ol li {
margin-left: 20px;
}
li span, li label {
color: black;
}
li.param label {
font-family: courier, monospace;
padding-right: 1.4em;
}
a {
text-decoration: none;
}
a:hover {
text-decoration: underline;
}
body {
background-color: white;
width: 830px;
margin: 10px auto;
padding: 20px;
-moz-box-shadow: 5px 5px 5px #ccc;
-webkit-box-shadow: 5px 5px 5px #ccc;
box-shadow: 5px 5px 5px #ccc;
}
code {
display: block;
background-color: #999999;
padding: 10px;
margin: 0.4em 0px 1.4em 0px;
color: white;
white-space: pre;
font-family: courier, monospace;
font-size: 1.2em;
}
.tag, .argName, .argType {
margin-right: 10px;
}
.argument {
margin-left: 20px;
}
.footer {
font-family: helvetica, sans-serif;
font-size: 0.9em;
font-weight: normal;
margin: 0px -21px -20px -20px;
padding: 20px;
background: #01648E; /* for non-css3 browsers */
filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#00486E', endColorstr='#09799E'); /* for IE */
background: -webkit-gradient(linear, left top, left bottom, from(#00486E), to(#09799E)); /* for webkit browsers */
background: -moz-linear-gradient(top, #00486E, #09799E); /* for firefox 3.6+ */
color: white;
}
.footer a {
color: white;
text-decoration: none;
}
" (line 43)

A url to an optional css file or a css string for an inline stylesheet.

- access: public

mixed $footer = '' (line 182)

Optional footer text for the online documentation.

- access: public

mixed $header = '' (line 177)

Optional header text for the online documentation.

- access: public

mixed $name = 'Ripcord: Simple RPC Server' (line 38)

The name of the rpc server, used as the title and heading of the default HTML page.

- access: public

mixed $root = '' (line 172)

The root URL of the rpc server.

- access: public

mixed $version = 'auto' (line 167)

Which version of the XML vocabulary the server implements. Either 'xmlrpc', 'soap 1.1', 'simple' or 'auto'.

- access: public

mixed $wsdl = false (line 157)

The wsdl 1.0 description.

- access: public

mixed $wsdl2 = false (line 162)

The wsdl 2.0 description

- access: public

Methods
Constructor __construct (line 193)

The constructor for the Ripcord_Documentor class.

- access: public

Ripcord_Documentor __construct ([ $options = null], [ $docCommentParser = null], array $options.)

- array $options.: Optional. Allows you to set the public properties of this class upon construction.
- $options
- $docCommentParser

Implementation of:

Ripcord_Documentor_Interface::__construct()

getIntrospectionXML (line 399)

This method returns an XML document in the introspection format expected by xmlrpc_server_register_introspection_callback. It uses the php Reflection classes to gather information from the registered methods.

Descriptions are added from phpdoc docblocks if found.

- return: XML string with the introspection data.

string getIntrospectionXML ()

Implementation of:

Ripcord_Documentor_Interface::getIntrospectionXML()

handle (line 219)

This method handles any request which isn't a valid rpc request.

- access: public

void handle (object $rpcServer)

- object $rpcServer: A reference to the active rpc server.

Implementation of:

Ripcord_Documentor_Interface::handle()

setMethodData (line 210)

This method fills the list of method data with all the user supplied methods of the rpc server.

- access: public

void setMethodData (array $methodData)

- array $methodData: A list of methods with name and callback information.

Implementation of:

Ripcord_Documentor_Interface::setMethodData()

Documentation generated on Tue, 16 Nov 2010 16:20:18 +0100 by phpDocumentor 1.4.3