Search moodle.org's
Developer Documentation
Developer Documentation
See Release Notes
Long Term Support Release
- Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
- Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
- PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
/lib/phpxmlrpc/ -> Response.php (source)
Differences Between: [Versions 401 and 402] [Versions 401 and 403]
(no description)
| File Size: | 263 lines (10 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Defines 1 class
Response:: (13 methods):
getCharsetEncoder()
setCharsetEncoder()
__construct()
faultCode()
faultString()
value()
cookies()
httpResponse()
serialize()
__get()
__set()
__isset()
__unset()
This class provides the representation of the response of an XML-RPC server.
Server-side, a server method handler will construct a Response and pass it as its return value.
An identical Response object will be returned by the result of an invocation of the send() method of the Client class.
Server-side, a server method handler will construct a Response and pass it as its return value.
An identical Response object will be returned by the result of an invocation of the send() method of the Client class.
| getCharsetEncoder() X-Ref |
| No description |
| setCharsetEncoder($charsetEncoder) X-Ref |
| No description |
| __construct($val, $fCode = 0, $fString = '', $valType = '', $httpResponse = null) X-Ref |
param: Value|string|mixed $val either a Value object, a php value or the xml serialization of an xmlrpc value (a string) param: integer $fCode set it to anything but 0 to create an error response. In that case, $val is discarded param: string $fString the error string, in case of an error response param: string $valType The type of $val passed in. Either 'xmlrpcvals', 'phpvals' or 'xml'. Leave empty to let param: array|null $httpResponse |
| faultCode() X-Ref |
| Returns the error code of the response. return: integer the error code of this response (0 for not-error responses) |
| faultString() X-Ref |
| Returns the error code of the response. return: string the error string of this response ('' for not-error responses) |
| value() X-Ref |
| Returns the value received by the server. If the Response's faultCode is non-zero then the value returned by this method should not be used (it may not even be an object). return: Value|string|mixed the Value object returned by the server. Might be an xml string or plain php value |
| cookies() X-Ref |
| Returns an array with the cookies received from the server. Array has the form: $cookiename => array ('value' => $val, $attr1 => $val1, $attr2 => $val2, ...) with attributes being e.g. 'expires', 'path', domain'. NB: cookies sent as 'expired' by the server (i.e. with an expiry date in the past) are still present in the array. It is up to the user-defined code to decide how to use the received cookies, and whether they have to be sent back with the next request to the server (using Client::setCookie) or not. return: array[] array of cookies received from the server |
| httpResponse() X-Ref |
return: array array with keys 'headers', 'cookies', 'raw_data' and 'status_code' |
| serialize($charsetEncoding = '') X-Ref |
| Returns xml representation of the response. XML prologue not included. param: string $charsetEncoding the charset to be used for serialization. If null, US-ASCII is assumed return: string the xml representation of the response |
| __get($name) X-Ref |
| No description |
| __set($name, $value) X-Ref |
| No description |
| __isset($name) X-Ref |
| No description |
| __unset($name) X-Ref |
| No description |
