Feed/Writer/Renderer/Entry/Atom.php

Show:

inherited

Classes
- \Zend_Feed_Writer_Renderer_Entry_Atom

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: Atom.php 24593 2012-01-05 20:35:02Z matthew $

\Zend_Feed_Writer_Renderer_Entry_Atom
jump to top

Package: Zend\Feed\Writer

Implements: \Zend_Feed_Writer_Renderer_RendererInterface
Parent(s): \Zend_Feed_Writer_Renderer_RendererAbstract
Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Properties

mixed $_container = null

inherited

Inherited from: \Zend_Feed_Writer_Renderer_RendererAbstract::$$_container

Default valuenullDetails

Type: mixed
Inherited_from: \Zend_Feed_Writer_Renderer_RendererAbstract::$$_container

\DOMDocument $_dom = null

inherited

Inherited from: \Zend_Feed_Writer_Renderer_RendererAbstract::$$_dom

Default valuenullDetails

Type: \DOMDocument
Inherited_from: \Zend_Feed_Writer_Renderer_RendererAbstract::$$_dom

string $_encoding = 'UTF-8'

inherited

Encoding of all text values

Inherited from: \Zend_Feed_Writer_Renderer_RendererAbstract::$$_encoding

Default value'UTF-8'Details

Type: string
Inherited_from: \Zend_Feed_Writer_Renderer_RendererAbstract::$$_encoding

array $_exceptions = array()

inherited

Inherited from: \Zend_Feed_Writer_Renderer_RendererAbstract::$$_exceptions

Default valuearray()Details

Type: array
Inherited_from: \Zend_Feed_Writer_Renderer_RendererAbstract::$$_exceptions

array $_extensions = array()

inherited

Extensions

Inherited from: \Zend_Feed_Writer_Renderer_RendererAbstract::$$_extensions

Default valuearray()Details

Type: array
Inherited_from: \Zend_Feed_Writer_Renderer_RendererAbstract::$$_extensions

bool $_ignoreExceptions = false

inherited

Inherited from: \Zend_Feed_Writer_Renderer_RendererAbstract::$$_ignoreExceptions

Default valuefalseDetails

Type: bool
Inherited_from: \Zend_Feed_Writer_Renderer_RendererAbstract::$$_ignoreExceptions

\DOMElement $_rootElement = null

inherited

Inherited from: \Zend_Feed_Writer_Renderer_RendererAbstract::$$_rootElement

Default valuenullDetails

Type: \DOMElement
Inherited_from: \Zend_Feed_Writer_Renderer_RendererAbstract::$$_rootElement

string $_type = null

inherited

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

Inherited from: \Zend_Feed_Writer_Renderer_RendererAbstract::$$_type

Default valuenullDetails

Type: string
Inherited_from: \Zend_Feed_Writer_Renderer_RendererAbstract::$$_type

Methods

__construct(\Zend_Feed_Writer_Entry $container) : void

Constructor

Parameters

Name	Type	Description
$container	\Zend_Feed_Writer_Entry

_loadExtensions() : void

inherited

Load extensions from Zend_Feed_Writer

Inherited from: \Zend_Feed_Writer_Renderer_RendererAbstract::_loadExtensions()

_loadXhtml( $content) : void

Load a HTML string and attempt to normalise to XML

Parameters

Name	Type	Description
$content

_setAuthors(\DOMDocument $dom, \DOMElement $root) : void

Set entry authors

Parameters

Name	Type	Description
$dom	\DOMDocument
$root	\DOMElement

_setCategories(\DOMDocument $dom, \DOMElement $root) : void

Set entry cateories

Parameters

Name	Type	Description
$dom	\DOMDocument
$root	\DOMElement

_setContent(\DOMDocument $dom, \DOMElement $root) : void

Set entry content

Parameters

Name	Type	Description
$dom	\DOMDocument
$root	\DOMElement

_setDateCreated(\DOMDocument $dom, \DOMElement $root) : void

Set date entry was created

Parameters

Name	Type	Description
$dom	\DOMDocument
$root	\DOMElement

_setDateModified(\DOMDocument $dom, \DOMElement $root) : void

Set date entry was modified

Parameters

Name	Type	Description
$dom	\DOMDocument
$root	\DOMElement

_setDescription(\DOMDocument $dom, \DOMElement $root) : void

Set entry description

Parameters

Name	Type	Description
$dom	\DOMDocument
$root	\DOMElement

_setEnclosure(\DOMDocument $dom, \DOMElement $root) : void

Set entry enclosure

Parameters

Name	Type	Description
$dom	\DOMDocument
$root	\DOMElement

_setId(\DOMDocument $dom, \DOMElement $root) : void

Set entry identifier

Parameters

Name	Type	Description
$dom	\DOMDocument
$root	\DOMElement

_setLink( $dom, $root) : void

Parameters

Name	Type	Description
$dom
$root

_setSource(\DOMDocument $dom, \DOMElement $root) : void

Append Source element (Atom 1.0 Feed Metadata)

Parameters

Name	Type	Description
$dom	\DOMDocument
$root	\DOMElement

_setTitle(\DOMDocument $dom, \DOMElement $root) : void

Set entry title

Parameters

Name	Type	Description
$dom	\DOMDocument
$root	\DOMElement

_validateTagUri(string $id) : bool

Validate a URI using the tag scheme (RFC 4151)

Parameters

Name	Type	Description
$id	string

Returns

Type	Description
bool

getDataContainer() : mixed

inherited

Get data container containing feed items

Inherited from: \Zend_Feed_Writer_Renderer_RendererInterface::getDataContainer()

Returns

Type	Description
mixed

getDomDocument() : \DOMDocument

inherited

Get DOM document

Inherited from: \Zend_Feed_Writer_Renderer_RendererInterface::getDomDocument()

Returns

Type	Description
\DOMDocument

getElement() : \DOMElement

inherited

Get document element from DOM

Inherited from: \Zend_Feed_Writer_Renderer_RendererInterface::getElement()

Returns

Type	Description
\DOMElement

getEncoding() : string

inherited

Get feed encoding

Inherited from: \Zend_Feed_Writer_Renderer_RendererAbstract::getEncoding()

Returns

Type	Description
string

getExceptions() : array

inherited

Get list of thrown exceptions

Inherited from: \Zend_Feed_Writer_Renderer_RendererInterface::getExceptions()

Returns

Type	Description
array

getRootElement() : \DOMElement

inherited

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

Inherited from: \Zend_Feed_Writer_Renderer_RendererInterface::getRootElement()

Returns

Type	Description
\DOMElement

getType() : string

inherited

Retrieve the current or last feed type exported.

Inherited from: \Zend_Feed_Writer_Renderer_RendererInterface::getType()

Returns

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

ignoreExceptions() : mixed

inherited

Should exceptions be ignored?

Inherited from: \Zend_Feed_Writer_Renderer_RendererInterface::ignoreExceptions()

Returns

Type	Description
mixed

render() : \Zend_Feed_Writer_Renderer_Entry_Atom

Render atom entry

Returns

Type	Description
\Zend_Feed_Writer_Renderer_Entry_Atom

saveXml() : string

inherited

Save feed and/or entry to XML and return string

Inherited from: \Zend_Feed_Writer_Renderer_RendererInterface::saveXml()

Returns

Type	Description
string

setEncoding(string $enc) : \Zend_Feed_Writer_Renderer_RendererAbstract

inherited

Set feed encoding

Inherited from: \Zend_Feed_Writer_Renderer_RendererAbstract::setEncoding()

Parameters

Name	Type	Description
$enc	string

Returns

Type	Description
\Zend_Feed_Writer_Renderer_RendererAbstract

setRootElement(\DOMElement $root) : void

inherited

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

Inherited from: \Zend_Feed_Writer_Renderer_RendererInterface::setRootElement()

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

inherited

Set the current feed type being exported to "rss" or "atom".

Inherited from: \Zend_Feed_Writer_Renderer_RendererInterface::setType()

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/Entry/Atom.php

\Zend_Feed_Writer_Renderer_Entry_Atomjump to top

Properties

Methods

\Zend_Feed_Writer_Renderer_Entry_Atom
jump to top