API Documentation

XmlRpc/Generator/XmlWriter.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
Generator  
version
$Id: XmlWriter.php 24479 2011-09-26 20:10:08Z matthew $  

\Zend_XmlRpc_Generator_XmlWriter

XML generator adapter based on XMLWriter

Extends from
\Zend_XmlRpc_Generator_GeneratorAbstract

Properties

Propertyprotected\XMLWriter  $_xmlWriter= ''

XMLWriter instance

Details
Type
\XMLWriter

Methods

methodpublic__construct( string $encoding = UTF-8 ) : void

Construct new instance of the generator

Inherited from: \Zend_XmlRpc_Generator_GeneratorAbstract::__construct()
Parameters
Name Type Description
$encoding string

XML encoding, default UTF-8

methodpublic__toString( ) : string

Returns XML without document declaration

Inherited from: \Zend_XmlRpc_Generator_GeneratorAbstract::__toString()
Returns
Type Description
string
methodprotected_closeElement( string $name ) : void

Close an previously opened XML element

Parameters
Name Type Description
$name string
methodprotected_init( ) : void

Initialized XMLWriter instance

methodprotected_openElement( string $name ) : void

Open a new XML element

Parameters
Name Type Description
$name string XML element name
methodprotected_writeTextData( string $text ) : void

Write XML text data into the currently opened XML element

Parameters
Name Type Description
$text string XML text data
methodpubliccloseElement( string $name ) : \Zend_XmlRpc_Generator_Abstract

End of an XML element

Inherited from: \Zend_XmlRpc_Generator_GeneratorAbstract::closeElement()

Method marks the end of an XML element

Parameters
Name Type Description
$name string XML tag name
Returns
Type Description
\Zend_XmlRpc_Generator_Abstract Fluent interface
methodpublicflush( ) : string

Returns the XML as a string and flushes all internal buffers

Inherited from: \Zend_XmlRpc_Generator_GeneratorAbstract::flush()
Returns
Type Description
string
methodpublicgetEncoding( ) : string
Returns
Type Description
string
methodpublicopenElement( string $name, string $value = null ) : \Zend_XmlRpc_Generator_Abstract

Method opens a new XML element with an element name and an optional value

Parameters
Name Type Description
$name string XML tag name
$value string Optional value of the XML tag
Returns
Type Description
\Zend_XmlRpc_Generator_Abstract Fluent interface
methodpublicsaveXml( ) : string

Return XML as a string

Returns
Type Description
string
methodpublicstripDeclaration( string $xml ) : string

Removes XML declaration from a string

Inherited from: \Zend_XmlRpc_Generator_GeneratorAbstract::stripDeclaration()
Parameters
Name Type Description
$xml string
Returns
Type Description
string
Documentation was generated by DocBlox 0.13.3.