Class JFeedParserAtom

Description

ATOM Feed Parser class.

Located in /libraries/joomla/feed/parser/atom.php (line 20)

JFeedParser
   |
   --JFeedParserAtom
Variable Summary
 string $version
Method Summary
 void handleAuthor (JFeed $feed, SimpleXMLElement $el)
 void handleContributor (JFeed $feed, SimpleXMLElement $el)
 void handleGenerator (JFeed $feed, SimpleXMLElement $el)
 void handleId (JFeed $feed, SimpleXMLElement $el)
 void handleLink (JFeed $feed, SimpleXMLElement $el)
 void handleRights (JFeed $feed, SimpleXMLElement $el)
 void handleSubtitle (JFeed $feed, SimpleXMLElement $el)
 void handleTitle (JFeed $feed, SimpleXMLElement $el)
 void handleUpdated (JFeed $feed, SimpleXMLElement $el)
 void initialise ()
 void processFeedEntry (JFeedEntry $entry, SimpleXMLElement $el)
Variables
string $version (line 26)
  • var: The feed format version.
  • since: 12.3
  • access: protected

Inherited Variables

Inherited from JFeedParser

JFeedParser::$entryElementName
JFeedParser::$namespaces
JFeedParser::$stream
Methods
handleAuthor (line 38)

Method to handle the <author> element for the feed.

  • since: 12.3
  • access: protected
void handleAuthor (JFeed $feed, SimpleXMLElement $el)
  • JFeed $feed: The JFeed object being built from the parsed feed.
  • SimpleXMLElement $el: The current XML element object to handle.
handleContributor (line 54)

Method to handle the <contributor> element for the feed.

  • since: 12.3
  • access: protected
void handleContributor (JFeed $feed, SimpleXMLElement $el)
  • JFeed $feed: The JFeed object being built from the parsed feed.
  • SimpleXMLElement $el: The current XML element object to handle.
handleGenerator (line 69)

Method to handle the <generator> element for the feed.

  • since: 12.3
  • access: protected
void handleGenerator (JFeed $feed, SimpleXMLElement $el)
  • JFeed $feed: The JFeed object being built from the parsed feed.
  • SimpleXMLElement $el: The current XML element object to handle.
handleId (line 84)

Method to handle the <id> element for the feed.

  • since: 12.3
  • access: protected
void handleId (JFeed $feed, SimpleXMLElement $el)
  • JFeed $feed: The JFeed object being built from the parsed feed.
  • SimpleXMLElement $el: The current XML element object to handle.
handleLink (line 99)

Method to handle the <link> element for the feed.

  • since: 12.3
  • access: protected
void handleLink (JFeed $feed, SimpleXMLElement $el)
  • JFeed $feed: The JFeed object being built from the parsed feed.
  • SimpleXMLElement $el: The current XML element object to handle.
handleRights (line 122)

Method to handle the <rights> element for the feed.

  • since: 12.3
  • access: protected
void handleRights (JFeed $feed, SimpleXMLElement $el)
  • JFeed $feed: The JFeed object being built from the parsed feed.
  • SimpleXMLElement $el: The current XML element object to handle.
handleSubtitle (line 137)

Method to handle the <subtitle> element for the feed.

  • since: 12.3
  • access: protected
void handleSubtitle (JFeed $feed, SimpleXMLElement $el)
  • JFeed $feed: The JFeed object being built from the parsed feed.
  • SimpleXMLElement $el: The current XML element object to handle.
handleTitle (line 152)

Method to handle the <title> element for the feed.

  • since: 12.3
  • access: protected
void handleTitle (JFeed $feed, SimpleXMLElement $el)
  • JFeed $feed: The JFeed object being built from the parsed feed.
  • SimpleXMLElement $el: The current XML element object to handle.
handleUpdated (line 167)

Method to handle the <updated> element for the feed.

  • since: 12.3
  • access: protected
void handleUpdated (JFeed $feed, SimpleXMLElement $el)
  • JFeed $feed: The JFeed object being built from the parsed feed.
  • SimpleXMLElement $el: The current XML element object to handle.
initialise (line 180)

Method to initialise the feed for parsing. Here we detect the version and advance the stream reader so that it is ready to parse feed elements.

  • since: 12.3
  • access: protected
void initialise ()

Redefinition of:
JFeedParser::initialise()
Method to initialise the feed for parsing. If child parsers need to detect versions or other such things this is where you'll want to implement that logic.
processFeedEntry (line 199)

Method to handle the feed entry element for the feed: <entry>.

  • since: 12.3
  • access: protected
void processFeedEntry (JFeedEntry $entry, SimpleXMLElement $el)
  • JFeedEntry $entry: The JFeedEntry object being built from the parsed feed entry.
  • SimpleXMLElement $el: The current XML element object to handle.

Inherited Methods

Inherited From JFeedParser

 JFeedParser::__construct()
 JFeedParser::fetchNamespace()
 JFeedParser::initialise()
 JFeedParser::moveToClosingElement()
 JFeedParser::moveToNextElement()
 JFeedParser::parse()
 JFeedParser::processElement()
 JFeedParser::registerNamespace()

Documentation generated on Tue, 19 Nov 2013 14:54:08 +0100 by phpDocumentor 1.4.3