Joomla! API

link
since	3.1.4
package	Joomla CMS

Constructor.

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

inherited

since	3.1.4

Arguments

stream: XMLReaderThe XMLReader stream object for the feed.
inputFilter: InputFilterThe InputFilter object to be used

Response

mixed

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

fetchNamespace( prefix) :

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

since	3.1.4

Arguments

feed: FeedThe Feed object being built from the parsed feed.
el: SimpleXMLElementThe current XML element object to handle.

Response

void

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

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

since	3.1.4

Arguments

feed: FeedThe Feed object being built from the parsed feed.
el: SimpleXMLElementThe current XML element object to handle.

Response

void

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

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

since	3.1.4

Arguments

feed: FeedThe Feed object being built from the parsed feed.
el: SimpleXMLElementThe current XML element object to handle.

Response

void

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

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

since	3.1.4

Arguments

feed: FeedThe Feed object being built from the parsed feed.
el: SimpleXMLElementThe current XML element object to handle.

Response

void

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

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

since	3.1.4

Arguments

feed: FeedThe Feed object being built from the parsed feed.
el: SimpleXMLElementThe current XML element object to handle.

Response

void

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

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

since	3.1.4

Arguments

feed: FeedThe Feed object being built from the parsed feed.
el: SimpleXMLElementThe current XML element object to handle.

Response

void

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

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

since	3.1.4

Arguments

feed: FeedThe Feed object being built from the parsed feed.
el: SimpleXMLElementThe current XML element object to handle.

Response

void

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

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

since	3.1.4

Arguments

feed: FeedThe Feed object being built from the parsed feed.
el: SimpleXMLElementThe current XML element object to handle.

Response

void

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

handleLink(\Joomla\CMS\Feed\Feed feed, \SimpleXMLElement el) :

since	3.1.4

Arguments

feed: FeedThe Feed object being built from the parsed feed.
el: SimpleXMLElementThe current XML element object to handle.

Response

void

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

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

since	3.1.4

Arguments

feed: FeedThe Feed object being built from the parsed feed.
el: SimpleXMLElementThe current XML element object to handle.

Response

void

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

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

since	3.1.4

Arguments

feed: FeedThe Feed object being built from the parsed feed.
el: SimpleXMLElementThe current XML element object to handle.

Response

void

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

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

since	3.1.4

Arguments

feed: FeedThe Feed object being built from the parsed feed.
el: SimpleXMLElementThe current XML element object to handle.

Response

void

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

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

since	3.1.4

Arguments

feed: FeedThe Feed object being built from the parsed feed.
el: SimpleXMLElementThe current XML element object to handle.

Response

void

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

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

since	3.1.4

Arguments

feed: FeedThe Feed object being built from the parsed feed.
el: SimpleXMLElementThe current XML element object to handle.

Response

void

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

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

since	3.1.4

Arguments

feed: FeedThe Feed object being built from the parsed feed.
el: SimpleXMLElementThe current XML element object to handle.

Response

void

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

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

since	3.1.4

Arguments

feed: FeedThe Feed object being built from the parsed feed.
el: SimpleXMLElementThe current XML element object to handle.

Response

void

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.

initialise() :

since	3.1.4

Response

void

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

moveToClosingElement() :

inherited

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

Response

void

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

moveToNextElement( name = null) :

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

Feed

Method to parse a specific feed element.

processElement(\Joomla\CMS\Feed\Feed feed, \SimpleXMLElement el, mixed||string|int namespaces) :

inherited

since	3.1.4

Arguments

feed: FeedThe Feed object being built from the parsed feed.
el: SimpleXMLElementThe current XML element object to handle.
namespaces: array<string|int, mixed>The array of relevant namespace objects to process for the element.

Response

void

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

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

since	3.1.4

Arguments

entry: FeedEntryThe FeedEntry object being built from the parsed feed entry.
el: SimpleXMLElementThe current XML element object to handle.

Response

void

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

processPerson( data) : \Joomla\CMS\Feed\FeedPerson

since	3.1.4

Arguments

data: stringThe string to parse for a person.

Response

FeedPerson

Method to register a namespace handler object.

registerNamespace( 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: NamespaceParserInterfaceThe namespace object to register.

Response

FeedParser

The feed element name for the entry elements.

since	3.1.4

Type(s)

string

Array of NamespaceParserInterface objects

inherited

since	3.1.4

Type(s)

array<string|int, mixed>

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

The feed format version.

since	3.1.4

Type(s)

string

RssParser

Methods

__construct

Arguments

Response

fetchNamespace

Arguments

Response

handleCategory

Arguments

Response

handleCloud

Arguments

Response

handleCopyright

Arguments

Response

handleDescription

Arguments

Response

handleGenerator

Arguments

Response

handleImage

Arguments

Response

handleLanguage

Arguments

Response

handleLastBuildDate

Arguments

Response

handleLink

Arguments

Response

handleManagingEditor

Arguments

Response

handlePubDate

Arguments

Response

handleSkipDays

Arguments

Response

handleSkipHours

Arguments

Response

handleTitle

Arguments

Response

handleTtl

Arguments

Response

handleWebmaster

Arguments

Response

initialise

Response

moveToClosingElement

Response

moveToNextElement

Arguments

Response

parse

Response

processElement

Arguments

Response

processFeedEntry

Arguments

Response

processPerson

Arguments

Response

registerNamespace

Arguments

Response

Properties

entryElementName

Type(s)