API Documentation

XmlRpc/Value/Base64.php

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-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_XmlRpc  
subpackage
Value  
version
$Id: Base64.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_XmlRpc_Value_Base64

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

Extends from
\Zend_XmlRpc_Value_Scalar
category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_XmlRpc  
subpackage
Value  

Methods

methodpublic__construct( string $value,  $alreadyEncoded = false ) : void

Set the value of a base64 native type We keep this value in base64 encoding

Parameters
Name Type Description
$value string
$alreadyEncoded
methodprotected_createSimpleXMLElement(  $xml ) : void
Parameters
Name Type Description
$xml
methodprotected_extractTypeAndValue( \SimpleXMLElement $xml, string $type, string $value ) : void
static

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

methodprotected_generateXml( ) : void

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

Inherited from: \Zend_XmlRpc_Value_Scalar::_generateXml()
methodprotected_phpVarToNativeXmlRpc( mixed $value ) : \Zend_XmlRpc_Value
static

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
 
methodprotected_setXML( string $xml ) : void
Parameters
Name Type Description
$xml string
methodprotected_xmlStringToNativeXmlRpc( string|\SimpleXMLElement $xml ) : \Zend_XmlRpc_Value
static

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
 
methodpublicgenerateXml( ) : void

Generate XML code that represent a native XML/RPC value

Inherited from: \Zend_XmlRpc_Value::generateXml()
methodpublicgetGenerator( ) : \Zend_XmlRpc_Generator_GeneratorAbstract
static

Get XML generator instance

Inherited from: \Zend_XmlRpc_Value::getGenerator()
Returns
Type Description
\Zend_XmlRpc_Generator_GeneratorAbstract
methodpublicgetType( ) : string

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
methodpublicgetValue( ) : string

Return the value of this object, convert the XML-RPC native base64 value into a PHP string We return this value decoded (a normal string)

Returns
Type Description
string
methodpublicgetXmlRpcTypeByValue( mixed $value ) : string
static

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
 
methodpublicgetXmlRpcValue( mixed $value, \Zend_XmlRpc_Value::constant $type = self ) : \Zend_XmlRpc_Value
static

Creates a Zend_XmlRpc_Value* object, representing a native XML-RPC value A XmlRpcValue object can be created in 3 ways: 1. 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)

Inherited from: \Zend_XmlRpc_Value::getXmlRpcValue()

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
 
methodpublicsaveXml( ) : string

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

Inherited from: \Zend_XmlRpc_Value::saveXml()
Returns
Type Description
string
methodpublicsetEncoding( string $encoding ) : void
static

Changes the encoding of the generator

Inherited from: \Zend_XmlRpc_Value::setEncoding()
Parameters
Name Type Description
$encoding string
methodpublicsetGenerator( \Zend_XmlRpc_Generator_GeneratorAbstract $generator ) : void
static

Sets XML generator instance

Inherited from: \Zend_XmlRpc_Value::setGenerator()
Parameters
Name Type Description
$generator \Zend_XmlRpc_Generator_GeneratorAbstract
Documentation was generated by DocBlox 0.13.3.