Class: XML_RPC2_Backend_Php_Value_Scalar

Source Location: /XML_RPC2-1.0.5/XML/RPC2/Backend/Php/Value/Scalar.php

Class Overview

XML_RPC2_Value
   |
   --XML_RPC2_Backend_Php_Value
      |
      --XML_RPC2_Backend_Php_Value_Scalar

XML_RPC scalar value abstract class. All XML_RPC value classes representing scalar types inherit from XML_RPC2_Value_Scalar

Author(s):

Sergio Carvalho <sergio.carvalho at portugalmail.com>

Copyright:

2004-2006 Sergio Carvalho

Methods

Child classes:

XML_RPC2_Backend_Php_Value_String: XML_RPC string value class. Instances of this class represent string scalars in XML_RPC

XML_RPC2_Backend_Php_Value_Double: XML_RPC double value class. Instances of this class represent int scalars in XML_RPC

XML_RPC2_Backend_Php_Value_Boolean: XML_RPC boolean value class. Instances of this class represent boolean scalars in XML_RPC

XML_RPC2_Backend_Php_Value_Integer: XML_RPC integer value class. Instances of this class represent int scalars in XML_RPC

Inherited Variables

Inherited Methods

Class: XML_RPC2_Backend_Php_Value

XML_RPC2_Backend_Php_Value::createFromDecode(): Decode an encoded value and build the applicable XML_RPC2_Value subclass
XML_RPC2_Backend_Php_Value::createFromNative(): Choose a XML_RPC2_Value subclass appropriate for the given value and create it.
XML_RPC2_Backend_Php_Value::getNativeValue(): nativeValue property getter
XML_RPC2_Backend_Php_Value::setNativeValue(): nativeValue setter

Class: XML_RPC2_Value

XML_RPC2_Value::createFromNative(): Factory method that constructs the appropriate XML-RPC encoded type value

Class Details

[line 57]
XML_RPC scalar value abstract class. All XML_RPC value classes representing scalar types inherit from XML_RPC2_Value_Scalar

Author: Sergio Carvalho <sergio.carvalho@portugalmail.com>
Copyright: 2004-2006 Sergio Carvalho
Link: http://pear.php.net/package/XML_RPC2
Abstract:
License: LGPL License 2.1

[ Top ]

Method Detail

__construct (Constructor) [line 115]

XML_RPC2_Backend_Php_Value_Scalar __construct(
mixed
$scalarType, 
$nativeValue)

Constructor. Will build a new XML_RPC2_Value_Scalar with the given nativeValue

Access: public

Overridden in child classes as:

XML_RPC2_Backend_Php_Value_String::__construct(): Constructor. Will build a new XML_RPC2_Backend_Php_Value_String with the given value

XML_RPC2_Backend_Php_Value_Double::__construct(): Constructor. Will build a new XML_RPC2_Backend_Php_Value_Double with the given value

XML_RPC2_Backend_Php_Value_Boolean::__construct(): Constructor. Will build a new XML_RPC2_Value_Boolean with the given value

XML_RPC2_Backend_Php_Value_Integer::__construct(): Constructor. Will build a new XML_RPC2_Backend_Php_Value_Integer with the given value

Parameters:

mixed	`$scalarType`	—	nativeValue
	`$nativeValue`	—

[ Top ]

createFromNative [line 133]

XML_RPC2_Value createFromNative(
string
$nativeValue, [string
$explicitType = null])

Choose a XML_RPC2_Value subclass appropriate for the given value and create it.

Return: The newly created value
Throws: XML_RPC2_InvalidTypeEncodeException When native value's type is not a native type
Access: public

Overrides XML_RPC2_Backend_Php_Value::createFromNative() (Choose a XML_RPC2_Value subclass appropriate for the given value and create it.)

Parameters:

string	`$nativeValue`	—	The native value
string	`$explicitType`	—	Optinally, the scalar type to use

[ Top ]

encode [line 163]

string encode(
)

Encode the instance into XML, for transport

Return: The encoded XML-RPC value,
Access: public

Overridden in child classes as:

XML_RPC2_Backend_Php_Value_String::encode(): Encode the instance into XML, for transport

XML_RPC2_Backend_Php_Value_Boolean::encode(): Encode the instance into XML, for transport

[ Top ]

getScalarType [line 102]

mixed getScalarType(
)

scalarType property getter

Return: The current scalarType
Access: public

[ Top ]

setScalarType [line 77]

void setScalarType(
mixed
$value)

scalarType property setter

Access: protected

Parameters:

mixed $value — value The new scalarType

[ Top ]