XmlRpc/Value/Scalar.php

Show:

inherited

Classes
- \Zend_XmlRpc_Value_Scalar

Table of Contents

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_XmlRpc
Subpackage: Value
Version: $Id: Scalar.php 24593 2012-01-05 20:35:02Z matthew $

\Zend_XmlRpc_Value_Scalar
jump to top

Package: Zend\XmlRpc\Value

Represent a native XML-RPC value entity, used as parameters for the methods called by the Zend_XmlRpc_Client object and as the return value for those calls.

This object as a very important static function Zend_XmlRpc_Value::getXmlRpcValue, this function acts likes a factory for the Zend_XmlRpc_Value objects

Using this function, users/Zend_XmlRpc_Client object can create the Zend_XmlRpc_Value objects from PHP variables, XML string or by specifing the exact XML-RPC natvie type

Parent(s): \Zend_XmlRpc_Value
Children: \Zend_XmlRpc_Value_DateTime; \Zend_XmlRpc_Value_String; \Zend_XmlRpc_Value_Integer; \Zend_XmlRpc_Value_Double; \Zend_XmlRpc_Value_Boolean; \Zend_XmlRpc_Value_Nil; \Zend_XmlRpc_Value_Base64
Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Constants

 
                AUTO_DETECT_TYPE
                = 'auto_detect'

inherited

Specify that the XML-RPC native type will be auto detected from a PHP variable type

Inherited from: \Zend_XmlRpc_Value::AUTO_DETECT_TYPE

Inherited_from: \Zend_XmlRpc_Value::AUTO_DETECT_TYPE

 
                XML_STRING
                = 'xml'

inherited

Specify that the XML-RPC value will be parsed out from a given XML code

Inherited from: \Zend_XmlRpc_Value::XML_STRING

Inherited_from: \Zend_XmlRpc_Value::XML_STRING

 
                XMLRPC_TYPE_I4
                = 'i4'

inherited

All the XML-RPC native types

Inherited from: \Zend_XmlRpc_Value::XMLRPC_TYPE_I4

Inherited_from: \Zend_XmlRpc_Value::XMLRPC_TYPE_I4

 
                XMLRPC_TYPE_INTEGER
                = 'int'

inheritedInherited from: \Zend_XmlRpc_Value::XMLRPC_TYPE_INTEGER

Inherited_from: \Zend_XmlRpc_Value::XMLRPC_TYPE_INTEGER

 
                XMLRPC_TYPE_I8
                = 'i8'

inheritedInherited from: \Zend_XmlRpc_Value::XMLRPC_TYPE_I8

Inherited_from: \Zend_XmlRpc_Value::XMLRPC_TYPE_I8

 
                XMLRPC_TYPE_APACHEI8
                = 'ex:i8'

inheritedInherited from: \Zend_XmlRpc_Value::XMLRPC_TYPE_APACHEI8

Inherited_from: \Zend_XmlRpc_Value::XMLRPC_TYPE_APACHEI8

 
                XMLRPC_TYPE_DOUBLE
                = 'double'

inheritedInherited from: \Zend_XmlRpc_Value::XMLRPC_TYPE_DOUBLE

Inherited_from: \Zend_XmlRpc_Value::XMLRPC_TYPE_DOUBLE

 
                XMLRPC_TYPE_BOOLEAN
                = 'boolean'

inheritedInherited from: \Zend_XmlRpc_Value::XMLRPC_TYPE_BOOLEAN

Inherited_from: \Zend_XmlRpc_Value::XMLRPC_TYPE_BOOLEAN

 
                XMLRPC_TYPE_STRING
                = 'string'

inheritedInherited from: \Zend_XmlRpc_Value::XMLRPC_TYPE_STRING

Inherited_from: \Zend_XmlRpc_Value::XMLRPC_TYPE_STRING

 
                XMLRPC_TYPE_DATETIME
                = 'dateTime.iso8601'

inheritedInherited from: \Zend_XmlRpc_Value::XMLRPC_TYPE_DATETIME

Inherited_from: \Zend_XmlRpc_Value::XMLRPC_TYPE_DATETIME

 
                XMLRPC_TYPE_BASE64
                = 'base64'

inheritedInherited from: \Zend_XmlRpc_Value::XMLRPC_TYPE_BASE64

Inherited_from: \Zend_XmlRpc_Value::XMLRPC_TYPE_BASE64

 
                XMLRPC_TYPE_ARRAY
                = 'array'

inheritedInherited from: \Zend_XmlRpc_Value::XMLRPC_TYPE_ARRAY

Inherited_from: \Zend_XmlRpc_Value::XMLRPC_TYPE_ARRAY

 
                XMLRPC_TYPE_STRUCT
                = 'struct'

inheritedInherited from: \Zend_XmlRpc_Value::XMLRPC_TYPE_STRUCT

Inherited_from: \Zend_XmlRpc_Value::XMLRPC_TYPE_STRUCT

 
                XMLRPC_TYPE_NIL
                = 'nil'

inheritedInherited from: \Zend_XmlRpc_Value::XMLRPC_TYPE_NIL

Inherited_from: \Zend_XmlRpc_Value::XMLRPC_TYPE_NIL

 
                XMLRPC_TYPE_APACHENIL
                = 'ex:nil'

inheritedInherited from: \Zend_XmlRpc_Value::XMLRPC_TYPE_APACHENIL

Inherited_from: \Zend_XmlRpc_Value::XMLRPC_TYPE_APACHENIL

Properties

\Zend_XmlRpc_Generator_GeneratorAbstract $_generator

staticinherited

Inherited from: \Zend_XmlRpc_Value::$$_generator

Details

Type: \Zend_XmlRpc_Generator_GeneratorAbstract
Inherited_from: \Zend_XmlRpc_Value::$$_generator

$_type

inherited

The native XML-RPC type of this object One of the XMLRPC_TYPE_* constants

Inherited from: \Zend_XmlRpc_Value::$$_type

Details

Type: n/a
Inherited_from: \Zend_XmlRpc_Value::$$_type

$_value

inherited

The native XML-RPC representation of this object's value

Inherited from: \Zend_XmlRpc_Value::$$_value

If the native type of this object is array or struct, this will be an array of Zend_XmlRpc_Value objects

Details

Type: n/a
Inherited_from: \Zend_XmlRpc_Value::$$_value

$_xml

inherited

XML code representation of this object (will be calculated only once)

Inherited from: \Zend_XmlRpc_Value::$$_xml

Details

Type: n/a
Inherited_from: \Zend_XmlRpc_Value::$$_xml

Methods

_createSimpleXMLElement( $xml) : void

staticinherited

Inherited from: \Zend_XmlRpc_Value::_createSimpleXMLElement()

Parameters

Name	Type	Description
$xml

_extractTypeAndValue(\SimpleXMLElement $xml, string $type, string $value) : void

staticinherited

Extract XML/RPC type and value from SimpleXMLElement object

Inherited from: \Zend_XmlRpc_Value::_extractTypeAndValue()

Parameters

Name	Type	Description
$xml	\SimpleXMLElement
$type	string	&$type Type bind variable
$value	string	&$value Value bind variable

_generateXml() : void

Generate the XML code that represent a scalar native MXL-RPC value

_phpVarToNativeXmlRpc(mixed $value) : \Zend_XmlRpc_Value

staticinherited

Transform a PHP native variable into a XML-RPC native value

Inherited from: \Zend_XmlRpc_Value::_phpVarToNativeXmlRpc()

Parameters

Name	Type	Description
$value	mixed	The PHP variable for convertion

Returns

Type	Description
\Zend_XmlRpc_Value

Details

Static

_setXML(string $xml) : void

inherited

Inherited from: \Zend_XmlRpc_Value::_setXML()

Parameters

Name	Type	Description
$xml	string

_xmlStringToNativeXmlRpc(string | \SimpleXMLElement $xml) : \Zend_XmlRpc_Value

staticinherited

Transform an XML string into a XML-RPC native value

Inherited from: \Zend_XmlRpc_Value::_xmlStringToNativeXmlRpc()

Parameters

Name	Type	Description
$xml	string \| \SimpleXMLElement	A SimpleXMLElement object represent the XML string It can be also a valid XML string for convertion

Returns

Type	Description
\Zend_XmlRpc_Value

Details

Static

generateXml() : void

inherited

Generate XML code that represent a native XML/RPC value

Inherited from: \Zend_XmlRpc_Value::generateXml()

getGenerator() : \Zend_XmlRpc_Generator_GeneratorAbstract

staticinherited

Get XML generator instance

Inherited from: \Zend_XmlRpc_Value::getGenerator()

Returns

Type	Description
\Zend_XmlRpc_Generator_GeneratorAbstract

getType() : string

inherited

Get the native XML-RPC type (the type is one of the Zend_XmlRpc_Value::XMLRPC_TYPE_* constants)

Inherited from: \Zend_XmlRpc_Value::getType()

Returns

Type	Description
string

getValue() : mixed

abstractinherited

Return the value of this object, convert the XML-RPC native value into a PHP variable

Inherited from: \Zend_XmlRpc_Value::getValue()

Returns

Type	Description
mixed

getXmlRpcTypeByValue(mixed $value) : string

staticinherited

Get XML-RPC type for a PHP native variable

Inherited from: \Zend_XmlRpc_Value::getXmlRpcTypeByValue()

Parameters

Name	Type	Description
$value	mixed

Returns

Type	Description
string

Details

Static

getXmlRpcValue(mixed $value, \Zend_XmlRpc_Value::constant $type = self::AUTO_DETECT_TYPE) : \Zend_XmlRpc_Value

staticinherited

Creates a Zend_XmlRpc_Value* object, representing a native XML-RPC value A XmlRpcValue object can be created in 3 ways: 1.

Inherited from: \Zend_XmlRpc_Value::getXmlRpcValue()

Autodetecting the native type out of a PHP variable (if $type is not set or equal to Zend_XmlRpc_Value::AUTO_DETECT_TYPE) 2. By specifing the native type ($type is one of the Zend_XmlRpc_Value::XMLRPC_TYPE_* constants) 3. From a XML string ($type is set to Zend_XmlRpc_Value::XML_STRING)

By default the value type is autodetected according to it's PHP type

Parameters

Name	Type	Description
$value	mixed
$type	\Zend_XmlRpc_Value::constant

Returns

Type	Description
\Zend_XmlRpc_Value

Details

Static

saveXml() : string

inherited

Return the XML code that represent a native MXL-RPC value

Inherited from: \Zend_XmlRpc_Value::saveXml()

Returns

Type	Description
string

setEncoding(string $encoding) : void

staticinherited

Changes the encoding of the generator

Inherited from: \Zend_XmlRpc_Value::setEncoding()

Parameters

Name	Type	Description
$encoding	string

setGenerator(\Zend_XmlRpc_Generator_GeneratorAbstract $generator) : void

staticinherited

Sets XML generator instance

Inherited from: \Zend_XmlRpc_Value::setGenerator()

Parameters

Name	Type	Description
$generator	\Zend_XmlRpc_Generator_GeneratorAbstract

XmlRpc/Value/Scalar.php

\Zend_XmlRpc_Value_Scalarjump to top

Constants

Properties

Methods

\Zend_XmlRpc_Value_Scalar
jump to top