Class AbstractValue

Summary

Fully Qualified Name: Laminas\XmlRpc\AbstractValue

Description

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

This object as a very important static function Laminas\XmlRpc\Value::getXmlRpcValue, this function acts likes a factory for the Laminas\XmlRpc\Value objects

Using this function, users/Laminas\XmlRpc\Client object can create the Laminas\XmlRpc\Value objects from PHP variables, XML string or by specifying the exact XML-RPC native type

Methods

Name Description Defined By
generateXml() Generate XML code that represent a native XML/RPC value AbstractValue
getGenerator() Get XML generator instance AbstractValue
getType() Get the native XML-RPC type (the type is one of the Value::XMLRPC_TYPE_* constants) AbstractValue
getValue() Return the value of this object, convert the XML-RPC native value into a PHP variable AbstractValue
getXmlRpcTypeByValue() Get XML-RPC type for a PHP native variable AbstractValue
getXmlRpcValue() AbstractValue
saveXml() Return the XML code that represent a native MXL-RPC value AbstractValue
setEncoding() Changes the encoding of the generator AbstractValue
setGenerator() Sets XML generator instance AbstractValue

Method Details

generateXml()

Generate XML code that represent a native XML/RPC value

Returns: void

getGenerator()

Get XML generator instance

Returns: \Laminas\XmlRpc\Generator\GeneratorInterface

getType()

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

Returns: string

getValue()

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

Returns: mixed

getXmlRpcTypeByValue()

Get XML-RPC type for a PHP native variable

Parameter Name Type Description
$value mixed

Returns: string

getXmlRpcValue()

Parameter Name Type Description
$value
$type

Returns: void

saveXml()

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

Returns: string

setEncoding()

Changes the encoding of the generator

Parameter Name Type Description
$encoding string

Returns: void

setGenerator()

Sets XML generator instance

Parameter Name Type Description
$generator null|\Generator\GeneratorInterface

Returns: void

Top