FeedParser
Feed Parser class.
| since |
3.1.4 |
|---|---|
| package |
Joomla CMS |
Methods
__construct
Constructor.
__construct(\XMLReader stream, \Joomla\CMS\Filter\InputFilter inputFilter = null) : mixed
| 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
fetchNamespace
Method to get a namespace object for a given namespace prefix.
fetchNamespace(string prefix) : mixed
| since |
3.1.4 |
|---|
Arguments
- prefix
stringThe XML prefix for which to fetch the namespace object.
Response
mixedNamespaceParserInterface or false if none exists.
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
| since |
3.1.4 |
|---|
moveToClosingElement
Method to move the stream parser to the closing XML node of the current element.
moveToClosingElement() : void
| since |
3.1.4 |
|---|---|
| throws |
|
moveToNextElement
Method to move the stream parser to the next XML element node.
moveToNextElement(string name = null) : bool
| 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.
parse
Method to parse the feed into a JFeed object.
parse() : \Joomla\CMS\Feed\Feed
| 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
| 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.
registerNamespace
Method to register a namespace handler object.
registerNamespace(string prefix, \Joomla\CMS\Feed\Parser\NamespaceParserInterface namespace) : \Joomla\CMS\Feed\JFeed
| 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.
| since |
3.1.4 |
|---|
Type(s)
string
namespaces
Array of NamespaceParserInterface objects
| since |
3.1.4 |
|---|
Type(s)
array
stream
The XMLReader stream object for the feed.
| since |
3.1.4 |
|---|
Type(s)
\XMLReader
inputFilter
The InputFilter
| since |
3.9.25 |
|---|
Type(s)
\Joomla\CMS\Filter\InputFilter