Alpha Framework alpha--util--feeds
[ class tree: alpha--util--feeds ] [ index: alpha--util--feeds ] [ all elements ]

Class: Atom

Source Location: /util/feeds/Atom.inc

Class Atom

Class Overview

Atom class for syndication

Located in /util/feeds/Atom.inc [line 49]

AlphaFeed
   |
   --Atom
Author(s):
  • John Collins <dev@alphaframework.org>
Information Tags:
Version:  $Id: Atom.inc 1454 2011-12-04 15:14:05Z johnc $
Copyright:  

Copyright (c) 2011, John Collins (founder of Alpha Framework). All rights reserved.

 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.

Since:  1.0
License:  The BSD License

Properties

Methods

[ Top ]
Inherited Properties, Constants, and Methods
Inherited Properties Inherited Methods Inherited Constants

Inherited From AlphaFeed

AlphaFeed::$docElement
AlphaFeed::$fieldNameMappings
AlphaFeed::$items
AlphaFeed::$root
AlphaFeed::$rssDoc

Inherited From AlphaFeed

AlphaFeed::__construct()
The constructor
AlphaFeed::addBO()
Method for adding a BO to the current feed
AlphaFeed::addItem()
Method for adding an item to a feed
AlphaFeed::createFeedElement()
Method for creating a new feed element
AlphaFeed::createLink()
Method for creating link elements (note that Atom has a different format)
AlphaFeed::createRSSNode()
Method for creating an RSS node with a title, url and description
AlphaFeed::loadBOs()
Method to load all of the BO items to the feed from the database, from the newest to the $limit provided
AlphaFeed::render()
Returns the formatted XML for the feed as a string
AlphaFeed::setFieldMappings()
Method for mapping BO fieldnames to feed field names

[ Top ]
Property Summary
boolean   $hasChannel   If the feed format has a channel or not
string   $nameSpace   The XML namespace
string   $rootTag   The actual root tag used in each feed type
array   $tagMap   Maps the tags to the feed-specific tags

[ Top ]
Method Summary
Atom   __construct()   Constructor to create a new Atom feed
void   addAuthor()   Adds an auther to a feed
void   addItem()   (non-PHPdoc)
void   createLink()   (non-PHPdoc)

[ Top ]
Properties
boolean   $hasChannel = false [line 72]

If the feed format has a channel or not

API Tags:
Access:  protected

Information Tags:
Since:  1.0

Redefinition of:
AlphaFeed::$hasChannel
If the feed format has a channel or not

[ Top ]
string   $nameSpace = 'http://www.w3.org/2005/Atom' [line 56]

The XML namespace

API Tags:
Access:  protected

Information Tags:
Since:  1.0

Redefinition of:
AlphaFeed::$nameSpace
The XML namespace to use in the generated feed

[ Top ]
string   $rootTag = '<feed xmlns="http://www.w3.org/2005/Atom" />' [line 64]

The actual root tag used in each feed type

API Tags:
Access:  protected

Information Tags:
Since:  1.0

Redefinition of:
AlphaFeed::$rootTag
The actual root tag used in each feed type

[ Top ]
array   $tagMap = array('item'=>'entry','feeddesc'=>'subtitle','itemdesc'=>'summary') [line 80]

Maps the tags to the feed-specific tags

API Tags:
Access:  protected

Information Tags:
Since:  1.0

Redefinition of:
AlphaFeed::$tagMap
Maps the tags to the feed-specific tags

[ Top ]
Methods
Constructor __construct  [line 102]

  Atom __construct( string $title, string $url, string $description, [string $pubDate = null], [integer $id = null]  )

Constructor to create a new Atom feed

Parameters:
string   $title: 
string   $url: 
string   $description: 
string   $pubDate: 
integer   $id: 

API Tags:
Access:  public

Information Tags:
Since:  1.0

Redefinition of:
AlphaFeed::__construct()
The constructor

[ Top ]
addAuthor  [line 116]

  void addAuthor( string $name  )

Adds an auther to a feed

Parameters:
string   $name:  The name of the author.

API Tags:
Access:  public

Information Tags:
Since:  1.0

[ Top ]
addItem  [line 128]

  void addItem( $title, $link, [ $description = null], [ $pubDate = null], [ $id = null]  )

(non-PHPdoc)

Parameters:
   $title: 
   $link: 
   $description: 
   $pubDate: 
   $id: 

API Tags:
See:  alpha/util/feeds/AlphaFeed::addItem()
Access:  protected


Redefinition of:
AlphaFeed::addItem()
Method for adding an item to a feed

[ Top ]
createLink  [line 86]

  void createLink( $parent, $url  )

(non-PHPdoc)

Parameters:
   $parent: 
   $url: 

API Tags:
See:  alpha/util/feeds/AlphaFeed::createLink()
Access:  protected


Redefinition of:
AlphaFeed::createLink()
Method for creating link elements (note that Atom has a different format)

[ Top ]

Documentation generated on Tue, 13 Dec 2011 20:26:28 +0000 by phpDocumentor 1.4.3