Feed/Writer/Renderer/RendererAbstract.php

Show:

inherited

Classes
- \Zend_Feed_Writer_Renderer_RendererAbstract

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 [email protected] 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 24593 2012-01-05 20:35:02Z matthew $

\Zend_Feed_Writer_Renderer_RendererAbstract
jump to top

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

mixed $_container = null

Default valuenullDetails

Type: mixed

\DOMDocument $_dom = null

Default valuenullDetails

Type: \DOMDocument

string $_encoding = 'UTF-8'

Encoding of all text values

Default value'UTF-8'Details

Type: string

array $_exceptions = array()

Default valuearray()Details

Type: array

array $_extensions = array()

Extensions

Default valuearray()Details

Type: array

bool $_ignoreExceptions = false

Default valuefalseDetails

Type: bool

\DOMElement $_rootElement = null

Default valuenullDetails

Type: \DOMElement

string $_type = null

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

Default valuenullDetails

Type: string

Methods

__construct(mixed $container) : void

Constructor

Parameters

Name	Type	Description
$container	mixed

_loadExtensions() : void

Load extensions from Zend_Feed_Writer

getDataContainer() : mixed

Get data container of items being rendered

Returns

Type	Description
mixed

getDomDocument() : \DOMDocument

Get DOM document

Returns

Type	Description
\DOMDocument

getElement() : \DOMElement

Get document element from DOM

Returns

Type	Description
\DOMElement

getEncoding() : string

Get feed encoding

Returns

Type	Description
string

getExceptions() : array

Get exception list

Returns

Type	Description
array

getRootElement() : \DOMElement

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

Returns

Type	Description
\DOMElement

getType() : string

Retrieve the current or last feed type exported.

Returns

Type	Description
string	Value will be "rss" or "atom"

ignoreExceptions(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

saveXml() : string

Save XML to string

Returns

Type	Description
string

setEncoding(string $enc) : \Zend_Feed_Writer_Renderer_RendererAbstract

Set feed encoding

Parameters

Name	Type	Description
$enc	string

Returns

Type	Description
\Zend_Feed_Writer_Renderer_RendererAbstract

setRootElement(\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

setType(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

Feed/Writer/Renderer/RendererAbstract.php

\Zend_Feed_Writer_Renderer_RendererAbstractjump to top

Properties

Methods

\Zend_Feed_Writer_Renderer_RendererAbstract
jump to top