Documentation

xmlrpcval
in package

Table of Contents

Properties

$_php_class  : mixed
$me  : mixed
$mytype  : mixed

Methods

__construct()  : mixed
addArray()  : int
Add an array of xmlrpcval objects to an xmlrpcval
addScalar()  : int
Add a single php value to an (unitialized) xmlrpcval
addStruct()  : int
Add an array of named xmlrpcval objects to an xmlrpcval
arraymem()  : xmlrpcval
Returns the m-th member of an xmlrpcval of struct type
arraysize()  : int
Returns the number of members in an xmlrpcval of array type
dump()  : mixed
getval()  : mixed
kindOf()  : string
Returns a string containing "struct", "array" or "scalar" describing the base type of the value
scalartyp()  : string
Returns the type of the xmlrpcval.
scalarval()  : mixed
Returns the value of a scalar xmlrpcval
serialize()  : string
Returns xml representation of the value. XML prologue not included
serializedata()  : mixed
serializeval()  : mixed
structeach()  : xmlrpcval
Return next member element for xmlrpcvals of type struct.
structmem()  : xmlrpcval
Returns the value of a given struct member (an xmlrpcval object in itself).
structmemexists()  : bool
Checks wheter a struct member with a given name is present.
structreset()  : mixed
Reset internal pointer for xmlrpcvals of type struct.
structsize()  : int
Returns the number of members in an xmlrpcval of struct type

Properties

$_php_class

public mixed $_php_class = \null

$me

public mixed $me = array()

$mytype

public mixed $mytype = 0

Methods

__construct()

public __construct([mixed $val = -1 ][, string $type = '' ]) : mixed
Parameters
$val : mixed = -1
$type : string = ''

any valid xmlrpc type name (lowercase). If null, 'string' is assumed

addArray()

Add an array of xmlrpcval objects to an xmlrpcval

public addArray(array<string|int, mixed> $vals) : int
Parameters
$vals : array<string|int, mixed>
Tags
access

public

todo

add some checking for $vals to be an array of xmlrpcvals?

Return values
int —

1 or 0 on failure

addScalar()

Add a single php value to an (unitialized) xmlrpcval

public addScalar(mixed $val[, string $type = 'string' ]) : int
Parameters
$val : mixed
$type : string = 'string'
Return values
int —

1 or 0 on failure

addStruct()

Add an array of named xmlrpcval objects to an xmlrpcval

public addStruct(array<string|int, mixed> $vals) : int
Parameters
$vals : array<string|int, mixed>
Tags
access

public

todo

add some checking for $vals to be an array?

Return values
int —

1 or 0 on failure

arraymem()

Returns the m-th member of an xmlrpcval of struct type

public arraymem(int $m) : xmlrpcval
Parameters
$m : int

the index of the value to be retrieved (zero based)

Tags
access

public

Return values
xmlrpcval

arraysize()

Returns the number of members in an xmlrpcval of array type

public arraysize() : int
Tags
access

public

Return values
int

dump()

public dump(mixed $ar) : mixed
Parameters
$ar : mixed

getval()

public getval() : mixed

kindOf()

Returns a string containing "struct", "array" or "scalar" describing the base type of the value

public kindOf() : string
Tags
access

public

Return values
string

scalartyp()

Returns the type of the xmlrpcval.

public scalartyp() : string

For integers, 'int' is always returned in place of 'i4'

Tags
access

public

Return values
string

scalarval()

Returns the value of a scalar xmlrpcval

public scalarval() : mixed
Tags
access

public

serialize()

Returns xml representation of the value. 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

serializedata()

public serializedata(mixed $typ, mixed $val[, mixed $charset_encoding = '' ]) : mixed
Parameters
$typ : mixed
$val : mixed
$charset_encoding : mixed = ''
Tags
access

private

serializeval()

public serializeval(mixed $o) : mixed
Parameters
$o : mixed

structeach()

Return next member element for xmlrpcvals of type struct.

public structeach() : xmlrpcval
Tags
access

public

Return values
xmlrpcval

structmem()

Returns the value of a given struct member (an xmlrpcval object in itself).

public structmem(string $m) : xmlrpcval

Will raise a php warning if struct member of given name does not exist

Parameters
$m : string

the name of the struct member to be looked up

Tags
access

public

Return values
xmlrpcval

structmemexists()

Checks wheter a struct member with a given name is present.

public structmemexists(string $m) : bool

Works only on xmlrpcvals of type struct.

Parameters
$m : string

the name of the struct member to be looked up

Tags
access

public

Return values
bool

structreset()

Reset internal pointer for xmlrpcvals of type struct.

public structreset() : mixed
Tags
access

public

structsize()

Returns the number of members in an xmlrpcval of struct type

public structsize() : int
Tags
access

public

Return values
int 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results