Class: XML_Feed_Parser_Type

string addBase( string $link, DOMElement $element)

Determine whether we need to apply our xml:base rules

Gets us the xml:base data and then processes that with regard to our current link.

Parameters:

void combineBases( string $base, string $link)

Utility function to help us resolve xml:base values

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. If a declaration starts with a protocol then we restart the string. If it starts with a / then we add on to the domain name. Otherwise we simply tag it on to the end.

Parameters:

int count( string $type)

Count occurrences of an element

This function will tell us how many times the element $type appears at this level of the feed.

Parameters:

string|array|false getCategory( string $call, array $arguments)

Apply various rules to retrieve category data.

There is no single way of declaring a category in RSS1/1.1 as there is in RSS2 and Atom. Instead the usual approach is to use the dublin core namespace to declare categories. For example delicious use both: <dc:subject>PEAR</dc:subject> and: <taxo:topics><rdf:Bag> <rdf:li resource="http://del.icio.us/tag/PEAR" /></rdf:Bag></taxo:topics> to declare a categorisation of 'PEAR'.

We need to be sensitive to this where possible.

Overridden in child classes as:

XML_Feed_Parser_Atom::getCategory()

Get a category from the entry.

XML_Feed_Parser_RSS2::getCategory()

Get a category from the element

Parameters:

string|false getContent( )

Get content from RSS feeds (atom has its own implementation)

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. Often, however, the 'description' element is used instead. We will offer that as a fallback. Atom uses its own approach and overrides this method.

Overridden in child classes as:

XML_Feed_Parser_AtomElement::getContent()

Returns the content of the content element or info on a specific attribute

XML_Feed_Parser_RSS11Element::getContent()

Return the entry's content

int|false getDate( string $method, array $arguments)

Return a date in seconds since epoch.

Get a date construct. We use PHP's strtotime to return it as a unix datetime, which is the number of seconds since 1970-01-01 00:00:00.

Parameters:

XML_Feed_Parser_RSS1Element getEntryByOffset( int $offset)

Get an entry by its position in the feed, starting from zero

As well as allowing the items to be iterated over we want to allow users to be able to access a specific entry. This is one of two ways of doing that, the other being by ID.

Parameters:

string getSchemaDir( )

Get directory holding RNG schemas. Method is based on that found in Contact_AddressBook.

string getText( string $method, [array $arguments = array()])

Get a text construct.

Overridden in child classes as:

XML_Feed_Parser_Atom::getText()

Retrieves an element's content where that content is a text construct.

Parameters:

bool hasKey( String $name, [Integer $offset = 0])

Checks if this element has a particular child element.

Parameters:

string processXHTMLAttributes( DOMElement $node)

Part of our xml:base processing code

We need a couple of methods to access XHTML content stored in feeds. This is because we dereference all xml:base references before returning the element. This method handles the attributes.

Parameters:

string traverseNode( DOMElement $node)

Part of our xml:base processing code

We need a couple of methods to access XHTML content stored in feeds. This is because we dereference all xml:base references before returning the element. This method recurs through the tree descending from the node and builds our string

Parameters:

mixed __call( string $call, [array $arguments = array()])

Proxy to allow use of element names as method names

We are not going to provide methods for every entry type so this function will allow for a lot of mapping. We rely pretty heavily on this to handle our mappings between other feed types and atom.

Parameters:

mixed __get( string $value)

Proxy to allow use of element names as attribute names

For many elements variable-style access will be desirable. This function provides for that.

Parameters:

string __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.

Overridden in child classes as:

XML_Feed_Parser_AtomElement::__toString()

Get the entry as an XML string