Documentation

xmlrpcresp
in package

Table of Contents

Properties

$_cookies  : mixed
$content_type  : mixed
$errno  : mixed
$errstr  : mixed
$hdrs  : mixed
$payload  : mixed
$raw_data  : mixed
$val  : mixed
$valtyp  : mixed

Methods

__construct()  : mixed
cookies()  : array<string|int, mixed>
Returns an array with the cookies received from the server.
faultCode()  : int
Returns the error code of the response.
faultString()  : string
Returns the error code of the response.
serialize()  : string
Returns xml representation of the response. XML prologue not included
value()  : mixed
Returns the value received by the server.

Properties

$_cookies

public mixed $_cookies = array()

$content_type

public mixed $content_type = 'text/xml'

$errno

public mixed $errno = 0

$errstr

public mixed $errstr = ''

$hdrs

public mixed $hdrs = array()

$payload

public mixed $payload

$raw_data

public mixed $raw_data = ''

Methods

__construct()

public __construct(mixed $val[, int $fcode = 0 ][, string $fstr = '' ][, string $valtyp = '' ]) : mixed
Parameters
$val : mixed

either an xmlrpcval obj, a php value or the xml serialization of an xmlrpcval (a string)

$fcode : int = 0

set it to anything but 0 to create an error response

$fstr : string = ''

the error string, in case of an error response

$valtyp : string = ''

either 'xmlrpcvals', 'phpvals' or 'xml'

Tags
todo

add check that $val / $fcode / $fstr is of correct type??? NB: as of now we do not do it, since it might be either an xmlrpcval or a plain php val, or a complete xml chunk, depending on usage of xmlrpc_client::send() inside which creator is called...

cookies()

Returns an array with the cookies received from the server.

public cookies() : array<string|int, mixed>

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 wheter they have to be sent back with the next request to the server (using xmlrpc_client::setCookie) or not

Tags
access

public

Return values
array<string|int, mixed> —

array of cookies received from the server

faultCode()

Returns the error code of the response.

public faultCode() : int
Tags
access

public

Return values
int —

the error code of this response (0 for not-error responses)

faultString()

Returns the error code of the response.

public faultString() : string
Tags
access

public

Return values
string —

the error string of this response ('' for not-error responses)

serialize()

Returns xml representation of the response. XML prologue not included

public serialize([string $charset_encoding = '' ]) : string
Parameters
$charset_encoding : string = ''

the charset to be used for serialization. if null, US-ASCII is assumed

Tags
access

public

Return values
string —

the xml representation of the response

value()

Returns the value received by the server.

public value() : mixed
Tags
access

public

Return values
mixed —

the xmlrpcval object returned by the server. Might be an xml string or php value if the response has been created by specially configured xmlrpc_client objects


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results