Class: XML_Feed_Parser_RSS11

Source Location: /XML_Feed_Parser-1.0.1/Parser/RSS11.php

Class Overview

XML_Feed_Parser_Type
   |
   --XML_Feed_Parser_RSS11

This class handles RSS1.1 feeds. RSS1.1 is documented at: http://inamidst.com/rss1.1/

Author(s):

James Stewart <james at jystewart.net>

Version:

Release: @package_version@

Child classes:

XML_Feed_Parser_RSS11Element: RSS1 Element class for XML_Feed_Parser

Inherited Variables

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::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::processXHTMLAttributes(): Part of our xml:base processing code
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 34]
This class handles RSS1.1 feeds. RSS1.1 is documented at: http://inamidst.com/rss1.1/

Todo: Support for RDF:List
Todo: Ensure xml:lang is accessible to users
Version: Release: @package_version@
Author: James Stewart <james@jystewart.net>

[ Top ]

Method Detail

__construct (Constructor) [line 121]

XML_Feed_Parser_RSS11 __construct(

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

Our constructor does nothing more than its parent.

Overridden in child classes as:

XML_Feed_Parser_RSS11Element::__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 ]

getAuthor [line 245]

array|false getAuthor(
)

Attempts to discern authorship

Dublin Core provides the dc:creator, dc:contributor, and dc:publisher elements for defining authorship in RSS1. We will try each of those in turn in order to simulate the atom author element and will return it as text.

[ Top ]

getEntryById [line 152]

XML_Feed_Parser_RSS1Element getEntryById(
string
$id)

Attempts to identify an element by ID given by the rdf:about attribute

This is not really something that will work with RSS1.1 as it does not have clear restrictions on the global uniqueness of IDs. We will employ the _very_ hit and miss method of selecting entries based on the rdf:about attribute. Please note that this is even more hit and miss with RSS1.1 than with RSS1.0 since RSS1.1 does not require the rdf:about attribute for items.

Parameters:

string $id — any valid ID.

[ Top ]

getImage [line 172]

array|false getImage(
)

Get details of the image associated with the feed.

Return: an array simply containing the child elements

[ Top ]

getLink [line 265]

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

Retrieve a link

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 206]

array|false getTextInput(
)

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

[ Top ]