model/modx/xmlrpc/modxmlrpcresponse.class.php
- package
- modx
- subpackage
- xmlrpc
- Classes
- modXMLRPCResponse
Description
\modXMLRPCResponse
- Extends from
- \modResponse
- package
- modx
- subpackage
- xmlrpc
- Properties
- $server
- $services
- Methods
- getServer
- outputContent
- registerService
- unregisterService
Description
Handles any XML-RPC resources and their response
Includes functions to manipluate header data, such as status codes, as well as manipulating the response body.
Properties
$server
\xmlrpc_server $server = 'null'The XML-RPC server attached to this response
Details
- \xmlrpc_server
- visibility
- public
- default
- null
- final
- false
- static
- false
- access
- public
$services
array $services = 'array'A collection of services attached to this response
Details
- array
- visibility
- public
- default
- array
- final
- false
- static
- false
- access
- public
Methods
getServer
getServer(
boolean $execute
=
false
)
:
booleanGets the XML-RPC server for this response
Arguments
- $execute
- boolean
Whether or not to execute the server as well as load it
Output
- boolean
- True if the server initialized an instance correctly
Details
- visibility
- public
- final
- false
- static
- false
- access
- public
outputContent
outputContent(
array $options
=
array
)
:
Output the content of the resource
{@inheritdoc}
Arguments
- $options
- array
An array of options for the output
Details
- visibility
- public
- final
- false
- static
- false
registerService
registerService(
string $key, string $signature
)
:
Registers a service to this response
Arguments
- $key
- string
The name of the service - $signature
- string
The signature of the service
Details
- visibility
- public
- final
- false
- static
- false
- access
- public
unregisterService
unregisterService(
string $key
)
:
Unregisters a service from this response
Arguments
- $key
- string
The name of the service
Details
- visibility
- public
- final
- false
- static
- false
- access
- public