Search

Projects

Classes

Methods

⇦ Back to Joomla project (class list)

Class FeedParser - list of methods

Feed Parser class.

Direct known subclasses

AtomParser
RssParser
Package: Joomla\CMS\Feed
Copyright: (C) 2012 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE.txt
Located at: Joomla/Feed/FeedParser.php
Project: Joomla

Method Summary

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

Constructor.
Parameters
  • \XMLReader $stream The XMLReader stream object for the feed.
  • \Joomla\CMS\Filter\InputFilter $inputFilter The InputFilter object to be used
Since
  • 3.1.4
Show source code of this method: __construct Source Code

public \Joomla\CMS\Feed\Feed
()

Method to parse the feed into a JFeed object.
Returns
  • \Joomla\CMS\Feed\Feed
Since
  • 3.1.4
Show source code of this method: parse Source Code

public \Joomla\CMS\Feed\FeedParser
(mixed $prefix, \Joomla\CMS\Feed\Parser\NamespaceParserInterface $namespace)

Method to register a namespace handler object.
Parameters
  • string $prefix The XML namespace prefix for which to register the namespace object.
  • \Joomla\CMS\Feed\Parser\NamespaceParserInterface $namespace The namespace object to register.
Returns
  • \Joomla\CMS\Feed\FeedParser
Since
  • 3.1.4
Show source code of this method: registerNamespace Source Code

protected void
()

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.
Returns
  • void
Since
  • 3.1.4
Show source code of this method: initialise Source Code

protected void
(\Joomla\CMS\Feed\Feed $feed, \SimpleXMLElement $el, array $namespaces)

Method to parse a specific feed element.
Parameters
  • \Joomla\CMS\Feed\Feed $feed The Feed object being built from the parsed feed.
  • \SimpleXMLElement $el The current XML element object to handle.
  • array $namespaces The array of relevant namespace objects to process for the element.
Returns
  • void
Since
  • 3.1.4
Show source code of this method: processElement Source Code

protected mixed
(mixed $prefix)

Method to get a namespace object for a given namespace prefix.
Parameters
  • string $prefix The XML prefix for which to fetch the namespace object.
Returns
  • mixed NamespaceParserInterface or false if none exists.
Since
  • 3.1.4
Show source code of this method: fetchNamespace Source Code

protected bool
(mixed $name = null)

Method to move the stream parser to the next XML element node.
Parameters
  • string $name The name of the element for which to move the stream forward until is found.
Returns
  • bool True if the stream parser is on an XML element node.
Since
  • 3.1.4
Show source code of this method: moveToNextElement Source Code

protected void
()

Method to move the stream parser to the closing XML node of the current element.
Returns
  • void
Since
  • 3.1.4
-
  • \RuntimeException If the closing tag cannot be found.
Show source code of this method: moveToClosingElement Source Code

Properties Summary

protected string
$entryElementName
The feed element name for the entry elements.
Since
  • 3.1.4
protected array
$namespaces
Array of NamespaceParserInterface objects
Since
  • 3.1.4
protected \XMLReader
$stream
The XMLReader stream object for the feed.
Since
  • 3.1.4
protected \Joomla\CMS\Filter\InputFilter
$inputFilter
The InputFilter
Since
  • 3.9.25

Tags Summary

Since
3.1.4