RssParser

Extends \Joomla\CMS\Feed\FeedParser

RSS Feed Parser class.

link

http://cyber.law.harvard.edu/rss/rss.html

since

3.1.4

Methods

__construct

Constructor.

__construct(\XMLReader $stream) 
inherited
since

3.1.4

Arguments

$stream

\XMLReaderThe XMLReader stream object for the feed.

fetchNamespace

Method to get a namespace object for a given namespace prefix.

fetchNamespace(string $prefix) : mixed
inherited
since

3.1.4

Arguments

$prefix

stringThe XML prefix for which to fetch the namespace object.

Response

mixedNamespaceParserInterface or false if none exists.

handleCategory

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

handleCategory(\Joomla\CMS\Feed\Feed $feed, \SimpleXMLElement $el) : void
since

3.1.4

Arguments

$feed

\Joomla\CMS\Feed\FeedThe Feed object being built from the parsed feed.

$el

\SimpleXMLElementThe current XML element object to handle.

handleCloud

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

handleCloud(\Joomla\CMS\Feed\Feed $feed, \SimpleXMLElement $el) : void
since

3.1.4

Arguments

$feed

\Joomla\CMS\Feed\FeedThe Feed object being built from the parsed feed.

$el

\SimpleXMLElementThe current XML element object to handle.

handleCopyright

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

handleCopyright(\Joomla\CMS\Feed\Feed $feed, \SimpleXMLElement $el) : void
since

3.1.4

Arguments

$feed

\Joomla\CMS\Feed\FeedThe Feed object being built from the parsed feed.

$el

\SimpleXMLElementThe current XML element object to handle.

handleDescription

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

handleDescription(\Joomla\CMS\Feed\Feed $feed, \SimpleXMLElement $el) : void
since

3.1.4

Arguments

$feed

\Joomla\CMS\Feed\FeedThe Feed object being built from the parsed feed.

$el

\SimpleXMLElementThe current XML element object to handle.

handleGenerator

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

handleGenerator(\Joomla\CMS\Feed\Feed $feed, \SimpleXMLElement $el) : void
since

3.1.4

Arguments

$feed

\Joomla\CMS\Feed\FeedThe Feed object being built from the parsed feed.

$el

\SimpleXMLElementThe current XML element object to handle.

handleImage

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

handleImage(\Joomla\CMS\Feed\Feed $feed, \SimpleXMLElement $el) : void
since

3.1.4

Arguments

$feed

\Joomla\CMS\Feed\FeedThe Feed object being built from the parsed feed.

$el

\SimpleXMLElementThe current XML element object to handle.

handleLanguage

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

handleLanguage(\Joomla\CMS\Feed\Feed $feed, \SimpleXMLElement $el) : void
since

3.1.4

Arguments

$feed

\Joomla\CMS\Feed\FeedThe Feed object being built from the parsed feed.

$el

\SimpleXMLElementThe current XML element object to handle.

handleLastBuildDate

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

handleLastBuildDate(\Joomla\CMS\Feed\Feed $feed, \SimpleXMLElement $el) : void
since

3.1.4

Arguments

$feed

\Joomla\CMS\Feed\FeedThe Feed object being built from the parsed feed.

$el

\SimpleXMLElementThe current XML element object to handle.

handleManagingEditor

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

handleManagingEditor(\Joomla\CMS\Feed\Feed $feed, \SimpleXMLElement $el) : void
since

3.1.4

Arguments

$feed

\Joomla\CMS\Feed\FeedThe Feed object being built from the parsed feed.

$el

\SimpleXMLElementThe current XML element object to handle.

handlePubDate

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

handlePubDate(\Joomla\CMS\Feed\Feed $feed, \SimpleXMLElement $el) : void
since

3.1.4

Arguments

$feed

\Joomla\CMS\Feed\FeedThe Feed object being built from the parsed feed.

$el

\SimpleXMLElementThe current XML element object to handle.

handleSkipDays

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

handleSkipDays(\Joomla\CMS\Feed\Feed $feed, \SimpleXMLElement $el) : void
since

3.1.4

Arguments

$feed

\Joomla\CMS\Feed\FeedThe Feed object being built from the parsed feed.

$el

\SimpleXMLElementThe current XML element object to handle.

handleSkipHours

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

handleSkipHours(\Joomla\CMS\Feed\Feed $feed, \SimpleXMLElement $el) : void
since

3.1.4

Arguments

$feed

\Joomla\CMS\Feed\FeedThe Feed object being built from the parsed feed.

$el

\SimpleXMLElementThe current XML element object to handle.

handleTitle

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

handleTitle(\Joomla\CMS\Feed\Feed $feed, \SimpleXMLElement $el) : void
since

3.1.4

Arguments

$feed

\Joomla\CMS\Feed\FeedThe Feed object being built from the parsed feed.

$el

\SimpleXMLElementThe current XML element object to handle.

handleTtl

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

handleTtl(\Joomla\CMS\Feed\Feed $feed, \SimpleXMLElement $el) : void
since

3.1.4

Arguments

$feed

\Joomla\CMS\Feed\FeedThe Feed object being built from the parsed feed.

$el

\SimpleXMLElementThe current XML element object to handle.

handleWebmaster

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

handleWebmaster(\Joomla\CMS\Feed\Feed $feed, \SimpleXMLElement $el) : void
since

3.1.4

Arguments

$feed

\Joomla\CMS\Feed\FeedThe Feed object being built from the parsed feed.

$el

\SimpleXMLElementThe current XML element object to handle.

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.

initialise() : void
inherited abstract
since

3.1.4

moveToClosingElement

Method to move the stream parser to the closing XML node of the current element.

moveToClosingElement() : void
inherited
since

3.1.4

throws

\RuntimeExceptionIf the closing tag cannot be found.

moveToNextElement

Method to move the stream parser to the next XML element node.

moveToNextElement(string $name = null) : boolean
inherited
since

3.1.4

Arguments

$name

stringThe name of the element for which to move the stream forward until is found.

Response

booleanTrue if the stream parser is on an XML element node.

parse

Method to parse the feed into a JFeed object.

parse() : \Joomla\CMS\Feed\Feed
inherited
since

3.1.4

Response

\Joomla\CMS\Feed\Feed

processElement

Method to parse a specific feed element.

processElement(\Joomla\CMS\Feed\Feed $feed, \SimpleXMLElement $el, array $namespaces) : void
inherited
since

3.1.4

Arguments

$feed

\Joomla\CMS\Feed\FeedThe Feed object being built from the parsed feed.

$el

\SimpleXMLElementThe current XML element object to handle.

$namespaces

arrayThe array of relevant namespace objects to process for the element.

processFeedEntry

Method to handle a <item> element for the feed.

processFeedEntry(\Joomla\CMS\Feed\FeedEntry $entry, \SimpleXMLElement $el) : void
since

3.1.4

Arguments

$entry

\Joomla\CMS\Feed\FeedEntryThe FeedEntry object being built from the parsed feed entry.

$el

\SimpleXMLElementThe current XML element object to handle.

processPerson

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

processPerson(string $data) : \Joomla\CMS\Feed\FeedPerson
since

3.1.4

Arguments

$data

stringThe string to parse for a person.

Response

\Joomla\CMS\Feed\FeedPerson

registerNamespace

Method to register a namespace handler object.

registerNamespace(string $prefix, \Joomla\CMS\Feed\Parser\NamespaceParserInterface $namespace) : \Joomla\CMS\Feed\JFeed
inherited
since

3.1.4

Arguments

$prefix

stringThe XML namespace prefix for which to register the namespace object.

$namespace

\Joomla\CMS\Feed\Parser\NamespaceParserInterfaceThe namespace object to register.

Response

\Joomla\CMS\Feed\JFeed

Properties

entryElementName

The feed element name for the entry elements.

inherited
since

3.1.4

Type(s)

string

version

The feed format version.

since

3.1.4

Type(s)

string

namespaces

Array of NamespaceParserInterface objects

inherited
since

3.1.4

Type(s)

array

stream

The XMLReader stream object for the feed.

inherited
since

3.1.4

Type(s)

\XMLReader