Docs For Class XML_Feed_Parser

Class: XML_Feed_Parser_RSS1Element

Class Overview

XML_Feed_Parser_Type
   |
   --XML_Feed_Parser_RSS1
      |
      --XML_Feed_Parser_RSS1Element

RSS1 Element class for XML_Feed_Parser

Author(s):

James Stewart <mailto:james at jystewart.net>

Version:

CVS: $Id: RSS1Element.php,v 1.5 2006/01/10 18:39:09 jystewart Exp $

Copyright:

2005 James Stewart <james@jystewart.net>

Inherited Variables

Inherited Methods

Class: XML_Feed_Parser_RSS1

XML_Feed_Parser_RSS1::getAuthor(): 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.
XML_Feed_Parser_RSS1::getEntryById(): This is not really something that will work with RSS1 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.
XML_Feed_Parser_RSS1::getImage(): Get details of the image associated with the feed.
XML_Feed_Parser_RSS1::getLink(): 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.
XML_Feed_Parser_RSS1::getTextInput(): The textinput element is little used, but in the interests of completeness we will support it.

Class: XML_Feed_Parser_Type

XML_Feed_Parser_Type::addBase(): Gets us the xml:base data and then processes that with regard to our current link.
XML_Feed_Parser_Type::combineBases(): We have other methods which will traverse the DOM and work out the different xml:base declarations we need to be aware of. We then need to combine them.
XML_Feed_Parser_Type::count(): This function will tell us how many times the element $type appears at this level of the feed.
XML_Feed_Parser_Type::getCategory(): There is no single way of declaring a category in RSS1/1.1 as there is in RSS2
XML_Feed_Parser_Type::getContent(): The official way to include full content in an RSS1 entry is to use the content module's element 'encoded', and RSS2 feeds often duplicate that.
XML_Feed_Parser_Type::getDate(): Get a date construct. We use PHP's strtotime to return it as a unix datetime
XML_Feed_Parser_Type::getEntryByOffset(): Pretty fundamental!
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(): We need a couple of methods to access XHTML content stored in feeds.
XML_Feed_Parser_Type::traverseNode(): We need a couple of methods to access XHTML content stored in feeds.

Class Details

[line 32]
RSS1 Element class for XML_Feed_Parser

PHP versions 5

LICENSE: This source file is subject to version 3.0 of the PHP license that is available through the world-wide-web at the following URI: http://www.php.net/license/3_0.txt. If you did not receive a copy of the PHP License and are unable to obtain it through the web, please send a note to license@php.net so we can mail you a copy immediately.

Link: http://pear.php.net/package/XML_Feed_Parser/
Version: CVS: $Id: RSS1Element.php,v 1.5 2006/01/10 18:39:09 jystewart Exp $
License: GNU LGPL 2.1
Author: James Stewart <mailto:james@jystewart.net>

Method Detail

getEnclosure [line 108]

false getEnclosure(
)

How RSS1 should support for enclosures is not clear. For now we will return false.

[ Top ]

getId [line 94]

string|false getId(
)

There is no established way of showing an ID for an RSS1 entry. We will simulate it using the rdf:about attribute of the entry element. This cannot be relied upon for unique IDs but may prove useful.

[ Top ]