API Documentation

Zend/XmlRpc/Generator/GeneratorAbstract.php

Show: inherited
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
Generator  
Version
$Id: GeneratorAbstract.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_XmlRpc_Generator_GeneratorAbstract

Package: Default

Abstract XML generator adapter

Children
\Zend_XmlRpc_Generator_XmlWriter
\Zend_XmlRpc_Generator_DomDocument

Properties

Propertyprotectedstring  $_encoding= ''

XML encoding string

Details
Type
string

Methods

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

Construct new instance of the generator

Parameters
Name Type Description
$encoding string

XML encoding, default UTF-8

methodpublic__toString( ) : string

Returns XML without document declaration

Returns
Type Description
string
methodprotected_closeElement( string $name ) : void
abstract

End XML element

Parameters
Name Type Description
$name string
methodprotected_openElement( string $name ) : void
abstract

Start XML element

Parameters
Name Type Description
$name string

XML element name

methodprotected_writeTextData( string $text ) : void
abstract

Write XML text data into the currently opened XML element

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

End of an XML element

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

Returns
Type Description
string
methodpublicgetEncoding( ) : string

Return encoding

Returns
Type Description
string
methodpublicopenElement( string $name, string $value = null ) : \Zend_XmlRpc_Generator_Abstract

Start XML element

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
abstract

Return XML as a string

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

Removes XML declaration from a string

Parameters
Name Type Description
$xml string
Returns
Type Description
string
Documentation was generated by DocBlox 0.15.1.