API Documentation

Zend/Feed/Writer/Renderer/RendererAbstract.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_Feed_Writer  
Version
$Id: RendererAbstract.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Feed_Writer_Renderer_RendererAbstract

Package: Zend\Feed\Writer

Children
\Zend_Feed_Writer_Renderer_Feed_Rss
\Zend_Feed_Writer_Renderer_Feed_Atom_AtomAbstract
\Zend_Feed_Writer_Renderer_Entry_Rss
\Zend_Feed_Writer_Renderer_Entry_Atom_Deleted
\Zend_Feed_Writer_Renderer_Entry_Atom
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprotectedmixed  $_container= 'null'

Default valuenullDetails
Type
mixed
Propertyprotected\DOMDocument  $_dom= 'null'

Default valuenullDetails
Type
\DOMDocument
Propertyprotectedstring  $_encoding= ''UTF-8''

Encoding of all text values

Default value'UTF-8'Details
Type
string
Propertyprotectedarray  $_exceptions= 'array()'

Default valuearray()Details
Type
array
Propertyprotectedarray  $_extensions= 'array()'

Extensions

Default valuearray()Details
Type
array
Propertyprotectedbool  $_ignoreExceptions= 'false'

Default valuefalseDetails
Type
bool
Propertyprotected\DOMElement  $_rootElement= 'null'

Default valuenullDetails
Type
\DOMElement
Propertyprotectedstring  $_type= 'null'

Holds the value "atom" or "rss" depending on the feed type set when when last exported.

Default valuenullDetails
Type
string

Methods

methodpublic__construct( mixed $container ) : void

Constructor

Parameters
Name Type Description
$container mixed
methodprotected_loadExtensions( ) : void

Load extensions from Zend_Feed_Writer

methodpublicgetDataContainer( ) : mixed

Get data container of items being rendered

Returns
Type Description
mixed
methodpublicgetDomDocument( ) : \DOMDocument

Get DOM document

Returns
Type Description
\DOMDocument
methodpublicgetElement( ) : \DOMElement

Get document element from DOM

Returns
Type Description
\DOMElement
methodpublicgetEncoding( ) : string

Get feed encoding

Returns
Type Description
string
methodpublicgetExceptions( ) : array

Get exception list

Returns
Type Description
array
methodpublicgetRootElement( ) : \DOMElement

Retrieve the absolute root element for the XML feed being generated.

Returns
Type Description
\DOMElement
methodpublicgetType( ) : string

Retrieve the current or last feed type exported.

Returns
Type Description
string Value will be "rss" or "atom"
methodpublicignoreExceptions( bool $bool = true ) : \Zend_Feed_Writer_Renderer_RendererAbstract

Indicate whether or not to ignore exceptions

Parameters
Name Type Description
$bool bool
Returns
Type Description
\Zend_Feed_Writer_Renderer_RendererAbstract
methodpublicsaveXml( ) : string

Save XML to string

Returns
Type Description
string
methodpublicsetEncoding( string $enc ) : \Zend_Feed_Writer_Renderer_RendererAbstract

Set feed encoding

Parameters
Name Type Description
$enc string
Returns
Type Description
\Zend_Feed_Writer_Renderer_RendererAbstract
methodpublicsetRootElement( \DOMElement $root ) : void

Sets the absolute root element for the XML feed being generated. This helps simplify the appending of namespace declarations, but also ensures namespaces are added to the root element - not scattered across the entire XML file - may assist namespace unsafe parsers and looks pretty ;).

Parameters
Name Type Description
$root \DOMElement
methodpublicsetType( string $type ) : void

Set the current feed type being exported to "rss" or "atom". This allows other objects to gracefully choose whether to execute or not, depending on their appropriateness for the current type, e.g. renderers.

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