Joomla! API

link
since	3.1.4
package	Application

Constructor.

__construct(\XMLReader stream, \Joomla\CMS\Filter\InputFilter inputFilter = null) : mixed

inherited

since	3.1.4

Arguments

stream: \XMLReaderThe XMLReader stream object for the feed.
inputFilter: \Joomla\CMS\Filter\InputFilterThe InputFilter object to be used

Response

mixed

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.

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.

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.

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.

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.

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.

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.

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.

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.

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

handleLink(\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.

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.

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.

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.

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.

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.

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.

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.

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

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

moveToClosingElement() : void

inherited

since	3.1.4
throws	`\RuntimeException`If the closing tag cannot be found.

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

moveToNextElement(string name = null) : bool

inherited

since	3.1.4

Arguments

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

Response

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

Method to parse the feed into a JFeed object.

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

inherited

since	3.1.4

Response

\Joomla\CMS\Feed\Feed

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.

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.

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

Method to register a namespace handler object.

registerNamespace(string prefix, \Joomla\CMS\Feed\Parser\NamespaceParserInterface namespace) : \Joomla\CMS\Feed\FeedParser

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\FeedParser

The feed element name for the entry elements.

inherited

since	3.1.4

Type(s)

string

The feed format version.

since	3.1.4

Type(s)

string

Array of NamespaceParserInterface objects

inherited

since	3.1.4

Type(s)

array

The XMLReader stream object for the feed.

inherited

since	3.1.4

Type(s)

\XMLReader

The InputFilter

inherited

since	3.9.25

Type(s)

InputFilter

RssParser

Methods

__construct

Arguments

Response

fetchNamespace

Arguments

Response

handleCategory

Arguments

handleCloud

Arguments

handleCopyright

Arguments

handleDescription

Arguments

handleGenerator

Arguments

handleImage

Arguments

handleLanguage

Arguments

handleLastBuildDate

Arguments

handleLink

Arguments

handleManagingEditor

Arguments

handlePubDate

Arguments

handleSkipDays

Arguments

handleSkipHours

Arguments

handleTitle

Arguments

handleTtl

Arguments

handleWebmaster

Arguments

initialise

moveToClosingElement

moveToNextElement

Arguments

Response

parse

Response

processElement

Arguments

processFeedEntry

Arguments

processPerson

Arguments

Response

registerNamespace

Arguments

Response

Properties

entryElementName

Type(s)

version

Type(s)

namespaces

Type(s)

stream

Type(s)

inputFilter

Type(s)