Class JFeedParser

Feed Parser class.

Direct known subclasses

JFeedParserAtom, JFeedParserRss

Abstract
Package: Joomla\Platform\Feed
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
License: General Public License version 2 or later; see LICENSE
Since: 12.3
Located at joomla/feed/parser.php

Methods summary

`public`	# `__construct( XMLReader $stream )` Constructor. Constructor. Parameters `$stream` `XMLReader` - $stream The XMLReader stream object for the feed. Since 12.3
`public JFeed`	# `parse( )` Method to parse the feed into a JFeed object. Method to parse the feed into a JFeed object. Returns `JFeed` Since 12.3
`public JFeed`	# `registerNamespace( string $prefix, JFeedParserNamespace $namespace )` Method to register a namespace handler object. Method to register a namespace handler object. Parameters `$prefix` `string` - $prefix The XML namespace prefix for which to register the namespace object. `$namespace` `JFeedParserNamespace` - $namespace The namespace object to register. Returns `JFeed` Since 12.3
`abstract protected`	# `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. 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. Since 12.3
`protected`	# `processElement( JFeed $feed, SimpleXMLElement $el, array $namespaces )` Method to parse a specific feed element. Method to parse a specific feed element. Parameters `$feed` `JFeed` - $feed The JFeed object being built from the parsed feed. `$el` `SimpleXMLElement` - $el The current XML element object to handle. `$namespaces` `array` - $namespaces The array of relevant namespace objects to process for the element. Since 12.3
`protected mixed`	# `fetchNamespace( string $prefix )` Method to get a namespace object for a given namespace prefix. Method to get a namespace object for a given namespace prefix. Parameters `$prefix` `string` - $prefix The XML prefix for which to fetch the namespace object. Returns `mixed` - JFeedParserNamespace or false if none exists. Since 12.3
`protected boolean`	# `moveToNextElement( string $name = null )` Method to move the stream parser to the next XML element node. Method to move the stream parser to the next XML element node. Parameters `$name` `string` - $name The name of the element for which to move the stream forward until is found. Returns `boolean` - True if the stream parser is on an XML element node. Since 12.3
`protected`	# `moveToClosingElement( )` Method to move the stream parser to the closing XML node of the current element. Method to move the stream parser to the closing XML node of the current element. Throws `RuntimeException` - If the closing tag cannot be found. Since 12.3

Magic methods summary

Properties summary

`protected string`	`$entryElementName`	# The feed element name for the entry elements. The feed element name for the entry elements. Since 12.3
`protected array`	`$namespaces`	# Array of JFeedParserNamespace objects Array of JFeedParserNamespace objects Since 12.3
`protected XMLReader`	`$stream`	# The XMLReader stream object for the feed. The XMLReader stream object for the feed. Since 12.3

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JFeedParser

Direct known subclasses

Methods summary

Parameters

Since

Returns

Since

Parameters

Returns

Since

Since

Parameters

Since

Parameters

Returns

Since

Parameters

Returns

Since

Throws

Since

Magic methods summary

Properties summary

Since

Since

Since