Class Atom

Atom class for syndication.

Alpha\Util\Feed\Atom

Namespace: Alpha\Util\Feed
Copyright:

Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the
following conditions are met:

* Redistributions of source code must retain the above
  copyright notice, this list of conditions and the
  following disclaimer.
* Redistributions in binary form must reproduce the above
  copyright notice, this list of conditions and the
  following disclaimer in the documentation and/or other
  materials provided with the distribution.
* Neither the name of the Alpha Framework nor the names
  of its contributors may be used to endorse or promote
  products derived from this software without specific
  prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

License: The BSD License
Author: John Collins dev@alphaframework.org
Since: 1.0
Located at Util/Feed/Atom.php

Methods summary

`protected`	# `createLink( DOMElement $parent, string $url )` Method for creating link elements (note that Atom has a different format). Method for creating link elements (note that Atom has a different format). Parameters `$parent` The parent element. `$url` The URL for the link. Overrides `Alpha\Util\Feed\Feed::createLink`
`public`	# `__construct( string $title, string $url, string $description, string $pubDate = null, integer $id = null )` Constructor to create a new Atom feed. Constructor to create a new Atom feed. Parameters `$title` `$url` `$description` `$pubDate` `$id` Throws IllegalArguementException Since 1.0 Overrides `Alpha\Util\Feed\Feed::__construct`
`public`	# `addAuthor( string $name )` Adds an auther to a feed. Adds an auther to a feed. Parameters `$name` The name of the author. Since 1.0
`protected`	# `addItem( string $title, string $link, string $description = null, string $pubDate = null, integer $id = null )` Method for adding an item to a feed. Method for adding an item to a feed. Parameters `$title` The title of the feed. `$link` $url The base URL for the feed. `$description` The description of the feed. `$pubDate` The publish date, only used in Atom feeds. `$id` The feed id, only used in Atom feeds. Overrides `Alpha\Util\Feed\Feed::addItem`

Methods inherited from Alpha\Util\Feed\Feed

addRecord(), createFeedElement(), createRSSNode(), loadRecords(), render(), setFieldMappings()

Properties summary

`protected string`	`$nameSpace` The XML namespace. The XML namespace. Since 1.0	# `'http://www.w3.org/2005/Atom'`
`protected string`	`$rootTag` The actual root tag used in each feed type. The actual root tag used in each feed type. Since 1.0	# `'<feed xmlns="http://www.w3.org/2005/Atom" />'`
`protected boolean`	`$hasChannel` If the feed format has a channel or not. If the feed format has a channel or not. Since 1.0	# `false`
`protected array`	`$tagMap` Maps the tags to the feed-specific tags. Maps the tags to the feed-specific tags. Since 1.0	# `array( 'item' => 'entry', 'feeddesc' => 'subtitle', 'itemdesc' => 'summary', )`

Properties inherited from Alpha\Util\Feed\Feed

$docElement, $fieldNameMappings, $items, $root, $rssDoc

Namespaces

Classes

Class Atom

Methods summary

Parameters

Overrides

Parameters

Throws

Since

Overrides

Parameters

Since

Parameters

Overrides

Methods inherited from Alpha\Util\Feed\Feed

Properties summary

Since

Since

Since

Since

Properties inherited from Alpha\Util\Feed\Feed