Class: XML_Feed_Parser_RSS09

Source Location: /XML_Feed_Parser-1.0.5/XML/Feed/Parser/RSS09.php

Class Overview

XML_Feed_Parser_Type
   |
   --XML_Feed_Parser_RSS09

This class handles RSS0.9 feeds.

Author(s):

James Stewart <james at jystewart.net>

Version:

Release: @package_version@

Child classes:

XML_Feed_Parser_RSS09Element: RSS0.9 Element class for XML_Feed_Parser

Inherited Variables

Class: XML_Feed_Parser_Type

XML_Feed_Parser_Type::$entries
XML_Feed_Parser_Type::$idMappings
XML_Feed_Parser_Type::$model
XML_Feed_Parser_Type::$numberEntries
XML_Feed_Parser_Type::$sanitizer

Inherited Methods

Class: XML_Feed_Parser_Type

XML_Feed_Parser_Type::addBase(): Determine whether we need to apply our xml:base rules
XML_Feed_Parser_Type::combineBases(): Utility function to help us resolve xml:base values
XML_Feed_Parser_Type::count(): Count occurrences of an element
XML_Feed_Parser_Type::getCategory(): Apply various rules to retrieve category data.
XML_Feed_Parser_Type::getContent(): Get content from RSS feeds (atom has its own implementation)
XML_Feed_Parser_Type::getDate(): Return a date in seconds since epoch.
XML_Feed_Parser_Type::getEntryByOffset(): Get an entry by its position in the feed, starting from zero
XML_Feed_Parser_Type::getSanitizer()
XML_Feed_Parser_Type::getSchemaDir(): Get directory holding RNG schemas. Method is based on that found in Contact_AddressBook.
XML_Feed_Parser_Type::getText(): Get a text construct.
XML_Feed_Parser_Type::hasKey(): Checks if this element has a particular child element.
XML_Feed_Parser_Type::processEntitiesForNodeValue(): Convert HTML entities based on the current character set.
XML_Feed_Parser_Type::processXHTMLAttributes(): Part of our xml:base processing code
XML_Feed_Parser_Type::relaxNGValidate()
XML_Feed_Parser_Type::setSanitizer()
XML_Feed_Parser_Type::traverseNode(): Part of our xml:base processing code
XML_Feed_Parser_Type::__call(): Proxy to allow use of element names as method names
XML_Feed_Parser_Type::__get(): Proxy to allow use of element names as attribute names
XML_Feed_Parser_Type::__toString(): Return an XML serialization of the feed, should it be required. Most users however, will already have a serialization that they used when instantiating the object.

Class Details

[line 32]
This class handles RSS0.9 feeds.

Author: James Stewart <james@jystewart.net>
Version: Release: @package_version@
Todo: Find a Relax NG URI we can use

[ Top ]

Class Variables

$compatMap = array(
'title' => array('title'),'link'=>array('link'),'subtitle'=>array('description'))

[line 85]

Here we map some elements to their atom equivalents. This is going to be quite tricky to pull off effectively (and some users' methods may vary) but is worth trying. The key is the atom version, the value is RSS2.

Access: protected

Type:

array

[ Top ]

$itemClass = 'XML_Feed_Parser_RSS09Element'

[line 56]

The class used to represent individual items

Access: protected

Type:

string

[ Top ]

$itemElement = 'item'

[line 62]

The element containing entries

Access: protected

Type:

string

[ Top ]

$map = array(
'title' => array('Text'),'link'=>array('Text'),'description'=>array('Text'),'image'=>array('Image'),'textinput'=>array('TextInput'))

[line 72]

Here we map those elements we're not going to handle individually

to the constructs they are. The optional second parameter in the array tells the parser whether to 'fall back' (not apt. at the feed level) or fail if the element is missing. If the parameter is not set, the function will simply return false and leave it to the client to decide what to do.

Access: protected

Type:

array

[ Top ]

$namespaces = array(
'rdf' => 'http://www.w3.org/1999/02/22-rdf-syntax-ns#')

[line 95]

We will be working with multiple namespaces and it is useful to

keep them together

Access: protected

Type:

array

[ Top ]

$relax = ''

[line 38]

The URI of the RelaxNG schema used to (optionally) validate the feed

Access: protected

Type:

string

[ Top ]

$version = 'RSS 0.9'

[line 50]

The feed type we are parsing

Access: public

Type:

string

[ Top ]

$xpath =

[line 44]

We're likely to use XPath, so let's keep it global

Access: protected

Type:

DOMXPath

[ Top ]

Method Detail

__construct (Constructor) [line 105]

XML_Feed_Parser_RSS09 __construct(
DOMDocument
$model, [bool
$strict = false], DOMDocument
$xml)

Our constructor does nothing more than its parent.

Todo: RelaxNG validation

Overridden in child classes as:

XML_Feed_Parser_RSS09Element::__construct(): Store useful information for later.

Parameters:

DOMDocument	`$xml`	—	A DOM object representing the feed
bool	`$strict`	—	(optional) $string Whether or not to validate this feed
DOMDocument	`$model`	—

[ Top ]

getEntryById [line 125]

false getEntryById(
string
$id)

Included for compatibility -- will not work with RSS 0.9

This is not something that will work with RSS0.9 as it does not have clear restrictions on the global uniqueness of IDs.

Parameters:

string $id — any valid ID.

[ Top ]

getImage [line 135]

array|false getImage(
)

Get details of the image associated with the feed.

Return: an array simply containing the child elements
Access: protected

[ Top ]

getLink [line 203]

string getLink(
[
$offset = 0], [
$attribute = 'href'], [
$params = false])

Get details of a link from the feed.

In RSS1 a link is a text element but in order to ensure that we resolve URLs properly we have a special function for them.

Parameters:

	`$offset`	—
	`$attribute`	—
	`$params`	—

[ Top ]

getTextInput [line 166]

array|false getTextInput(
)

The textinput element is little used, but in the interests of completeness we will support it.

Access: protected

[ Top ]

relaxNGValidate [line 216]

void relaxNGValidate(
)

Not implemented - no available validation.

Access: public

Overrides XML_Feed_Parser_Type::relaxNGValidate() (parent method not documented)

[ Top ]

Class: XML_Feed_Parser_RSS09

Class Overview

Author(s):

Version:

Variables

Methods

Child classes:

Inherited Variables

Class: XML_Feed_Parser_Type

Inherited Methods

Class: XML_Feed_Parser_Type

Class Details

Class Variables

$compatMap = array( 'title' => array('title'),'link'=>array('link'),'subtitle'=>array('description'))

$itemClass = 'XML_Feed_Parser_RSS09Element'

$itemElement = 'item'

$map = array( 'title' => array('Text'),'link'=>array('Text'),'description'=>array('Text'),'image'=>array('Image'),'textinput'=>array('TextInput'))

$namespaces = array( 'rdf' => 'http://www.w3.org/1999/02/22-rdf-syntax-ns#')

$relax = ''

$version = 'RSS 0.9'

$xpath =

Method Detail

__construct (Constructor) [line 105]

Parameters:

getEntryById [line 125]

Parameters:

getImage [line 135]

getLink [line 203]

Parameters:

getTextInput [line 166]

relaxNGValidate [line 216]

$compatMap = array(
'title' => array('title'),'link'=>array('link'),'subtitle'=>array('description'))

$map = array(
'title' => array('Text'),'link'=>array('Text'),'description'=>array('Text'),'image'=>array('Image'),'textinput'=>array('TextInput'))

$namespaces = array(
'rdf' => 'http://www.w3.org/1999/02/22-rdf-syntax-ns#')