XML_Feed_Parser
[ class tree: XML_Feed_Parser ] [ index: XML_Feed_Parser ] [ all elements ]
Packages:
XML_Feed_Parser


Classes:
XML_Feed_Parser
XML_Feed_Parser_Atom
XML_Feed_Parser_AtomElement
XML_Feed_Parser_Exception
XML_Feed_Parser_RSS09
XML_Feed_Parser_RSS09Element
XML_Feed_Parser_RSS1
XML_Feed_Parser_RSS1Element
XML_Feed_Parser_RSS2
XML_Feed_Parser_RSS2Element
XML_Feed_Parser_RSS11
XML_Feed_Parser_RSS11Element
XML_Feed_Parser_Type
Files:
accessTypes.php
amp.php
atom.php
Atom.php
atom10.php
atomCompliance.php
AtomElement.php
atomEntryOnly.php
atomValues.php
base.php
cdf.php
convert-tests.php
date.php
encoding.php
errors.php
Exception.php
farsi.php
feedburner.php
http.php
iteration.php
itunes.php
japanese.php
lang.php
namespace.php
Parser.php
rdf.php
rss.php
RSS09.php
RSS09Element.php
rss091Values.php
rss092Values.php
RSS1.php
RSS1Element.php
rss1Values.php
RSS2.php
RSS2Element.php
rss2Values.php
RSS11.php
RSS11Element.php
sanitize.php
tidy.php
Type.php
XML_Feed_Parser_TestCase.php

Class: XML_Feed_Parser_RSS2

Source Location: /XML_Feed_Parser-1.0.0/Parser/RSS2.php

Class Overview

XML_Feed_Parser_Type
   |
   --XML_Feed_Parser_RSS2

This class handles RSS2 feeds.


Author(s):

Version:

  • Release: @package_version@

Methods

Child classes:

XML_Feed_Parser_RSS2Element
This class provides support for RSS 2.0 entries. It will usually be called by XML_Feed_Parser_RSS2 with which it shares many methods.

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 31]
This class handles RSS2 feeds.


[ Top ]

Method Detail

__construct (Constructor)   [line 114]

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

Our constructor does nothing more than its parent.

Overridden in child classes as:

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

getCategory   [line 172]

string|array|false getCategory( string $call, [array $arguments = array()])

Get a category from the element

The category element is a simple text construct which can occur any number of times. We allow access by offset or access to an array of results.


Overrides XML_Feed_Parser_Type::getCategory() (Apply various rules to retrieve category data.)

Parameters:

string   $call   —   for compatibility with our overloading
array   $arguments   —   - arg 0 is the offset, arg 1 is whether to return as array

[ Top ]

getCloud   [line 296]

array getCloud( )

Return content of the little-used 'cloud' element

The cloud element is rarely used. It is designed to provide some details of a location to update the feed.

  • Return: an array of the attributes of the element

[ Top ]

getEntryById   [line 144]

XML_Feed_Parser_RSS2Element getEntryById( string $id)

Retrieves an entry by ID, if the ID is specified with the guid element

This is not really something that will work with RSS2 as it does not have clear restrictions on the global uniqueness of IDs. But we can emulate it by allowing access based on the 'guid' element. If DOMXPath::evaluate is available, we also use that to store a reference to the entry in the array used by getEntryByOffset so that method does not have to seek out the entry if it's requested that way.


Parameters:

string   $id   —   any valid ID.

[ Top ]

getImage   [line 195]

array|false getImage( )

Get details of the image associated with the feed.
  • Return: an array simply containing the child elements

[ Top ]

getLink   [line 322]

string getLink( int $offset, [string $attribute = 'href'], [array $params = array()])

Get link URL

In RSS2 a link is a text element but in order to ensure that we resolve URLs properly we have a special function for them. We maintain the parameter used by the atom getLink method, though we only use the offset parameter.


Parameters:

int   $offset   —   The position of the link within the feed. Starts from 0
string   $attribute   —   The attribute of the link element required
array   $params   —   An array of other parameters. Not used.

[ Top ]

getSkipDays   [line 283]

array getSkipDays( )

Retrieve skipDays data

The skipdays element provides a list of days on which this feed should not be checked. We return an array of those days.


[ Top ]

getSkipHours   [line 270]

array getSkipHours( )

Retrieve skipHours data

The skiphours element provides a list of hours on which this feed should not be checked. We return an array of those hours (integers, 24 hour clock)


[ Top ]

getSkips   [line 247]

array|false getSkips( string $tagName)

Utility function for getSkipDays and getSkipHours

This is a general function used by both getSkipDays and getSkipHours. It simply returns an array of the values of the children of the appropriate tag.


Parameters:

string   $tagName   —   The tag name (getSkipDays or getSkipHours)

[ Top ]

getTextInput   [line 223]

array|false getTextInput( )

The textinput element is little used, but in the interests of completeness...

[ Top ]
Documentation generated on Tue, 26 Dec 2006 16:32:21 -0500 by phpDocumentor 1.3.0. PEAR Logo Copyright © PHP Group 2004.