XML_RPC
[ class tree: XML_RPC ] [ index: XML_RPC ] [ all elements ]

Class: XML_RPC_Message

Source Location: /XML_RPC-1.2.0RC7/RPC.php

Class Overview

XML_RPC_Base
   |
   --XML_RPC_Message



Author(s):

Version:

  • Release: @package_version@

Copyright:

  • 1999-2001 Edd Dumbill

Variables

Methods


Inherited Variables

Inherited Methods

Class: XML_RPC_Base

XML_RPC_Base::isError()
Tell whether something is a PEAR_Error object
XML_RPC_Base::raiseError()
PEAR Error handling

Class Details

[line 955]


[ Top ]


Class Variables

$debug =  0

[line 961]

The current debug mode (1 = on, 0 = off)

Type:   integer


[ Top ]

$methodname =  ''

[line 978]

The method presently being evaluated

Type:   string


[ Top ]

$params = array()

[line 983]


Type:   array


[ Top ]

$payload =  ''

[line 989]

The XML message being generated

Type:   string


[ Top ]

$send_encoding =  ''

[line 972]

The encoding to be used for outgoing messages

Defaults to the value of $GLOBALS['XML_RPC_defencoding']


Type:   string


[ Top ]



Method Detail

XML_RPC_Message (Constructor)   [line 994]

void XML_RPC_Message( $meth, [ $pars = 0])


Parameters:

   $meth   — 
   $pars   — 

[ Top ]

addParam   [line 1076]

void addParam( $par)


Parameters:

   $par   — 

[ Top ]

createPayload   [line 1039]

void createPayload( )


[ Top ]

getEncoding   [line 1126]

string getEncoding( string $data)

Determine the XML's encoding via the encoding attribute in the XML declaration

If the encoding parameter is not set or is not ISO-8859-1, UTF-8 or US-ASCII, $XML_RPC_defencoding will be returned.


Parameters:

string   $data   —  the XML that will be parsed

[ Top ]

getNumParams   [line 1092]

int getNumParams( )

  • Return: the number of parameters

[ Top ]

getParam   [line 1084]

void getParam( $i)


Parameters:

   $i   — 

[ Top ]

method   [line 1056]

string method( [ $meth = ''])

  • Return: the name of the method

Parameters:

   $meth   — 

[ Top ]

parseResponse   [line 1164]

object a parseResponse( [ $data = ''])

  • Return: new XML_RPC_Response object

Parameters:

   $data   — 

[ Top ]

parseResponseFile   [line 1152]

object a parseResponseFile( $fp)

  • Return: new XML_RPC_Response object

Parameters:

   $fp   — 

[ Top ]

serialize   [line 1067]

string serialize( )

  • Return: the payload

[ Top ]

setSendEncoding   [line 1107]

void setSendEncoding( string $type)

Sets the XML declaration's encoding attribute

Parameters:

string   $type   —  the encoding type (ISO-8859-1, UTF-8 or US-ASCII)

[ Top ]

xml_footer   [line 1029]

string xml_footer( )

  • Return: the closing </methodCall> tag

[ Top ]

xml_header   [line 1016]

string xml_header( )

Produces the XML declaration including the encoding attribute

The encoding is determined by this class' $send_encoding property. If the $send_encoding property is not set, use $GLOBALS['XML_RPC_defencoding'].


[ Top ]


Documentation generated on Mon, 11 Mar 2019 14:24:42 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.