Class JFeedParserRss

Description

RSS Feed Parser class.

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

JFeedParser
   |
   --JFeedParserRss
Variable Summary
 string $version
Method Summary
 void handleCategory (JFeed $feed, SimpleXMLElement $el)
 void handleCloud (JFeed $feed, SimpleXMLElement $el)
 void handleCopyright (JFeed $feed, SimpleXMLElement $el)
 void handleDescription (JFeed $feed, SimpleXMLElement $el)
 void handleGenerator (JFeed $feed, SimpleXMLElement $el)
 void handleImage (JFeed $feed, SimpleXMLElement $el)
 void handleLanguage (JFeed $feed, SimpleXMLElement $el)
 void handleLastBuildDate (JFeed $feed, SimpleXMLElement $el)
 void handleLink (JFeed $feed, SimpleXMLElement $el)
 void handleManagingEditor (JFeed $feed, SimpleXMLElement $el)
 void handlePubDate (JFeed $feed, SimpleXMLElement $el)
 void handleSkipDays (JFeed $feed, SimpleXMLElement $el)
 void handleSkipHours (JFeed $feed, SimpleXMLElement $el)
 void handleTitle (JFeed $feed, SimpleXMLElement $el)
 void handleTtl (JFeed $feed, SimpleXMLElement $el)
 void handleWebmaster (JFeed $feed, SimpleXMLElement $el)
 void initialise ()
 void processFeedEntry (JFeedEntry $entry, SimpleXMLElement $el)
 JFeedPerson processPerson (string $data)
Variables
string $entryElementName = 'item' (line 26)
  • var: The feed element name for the entry elements.
  • since: 12.3
  • access: protected

Redefinition of:
JFeedParser::$entryElementName
The feed element name for the entry elements.
string $version (line 32)
  • var: The feed format version.
  • since: 12.3
  • access: protected

Inherited Variables

Inherited from JFeedParser

JFeedParser::$namespaces
JFeedParser::$stream
Methods
handleCategory (line 44)

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

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

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

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

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

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

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

  • since: 12.3
  • access: protected
void handleDescription (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 115)

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.
handleImage (line 130)

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

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

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

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

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

  • since: 12.3
  • access: protected
void handleLastBuildDate (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 190)

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.
handleManagingEditor (line 207)

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

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

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

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

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

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

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

  • since: 12.3
  • access: protected
void handleSkipHours (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 285)

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.
handleTtl (line 300)

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

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

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

  • since: 12.3
  • access: protected
void handleWebmaster (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 342)

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 362)

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

  • 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.
processPerson (line 411)

Method to parse a string with person data and return a JFeedPerson object.

  • since: 12.3
  • access: protected
JFeedPerson processPerson (string $data)
  • string $data: The string to parse for a person.

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 15:12:29 +0100 by phpDocumentor 1.4.3