Docs For Class XML_Feed_Parser

addBase [line 188]

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:

string	`$link`	—
DOMElement	`$element`	—

[ Top ]

combineBases [line 150]

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:

string	`$base`	—	- the base to add the link to
string	`$link`	—

[ Top ]

count [line 308]

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.

Access: protected

Parameters:

string $type — the element we want to get a count of

[ Top ]

getCategory [line 281]

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.

Access: protected

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	`$call`	—	for compatibility with our overloading
array	`$arguments`	—	- arg 0 is the offset, arg 1 is whether to return as array

[ Top ]

getContent [line 424]

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.

Access: protected

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

[ Top ]

getDate [line 239]

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.

Return: datetime
Link: http://php.net/strtotime
Access: protected

Parameters:

string	`$method`	—	The name of the date construct we want
array	`$arguments`	—	Included for compatibility with our __call usage

[ Top ]

getEntryByOffset [line 207]

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:

int $offset —

[ Top ]

getSanitizer [line 120]

void getSanitizer(
)

Access: public

[ Top ]

getSchemaDir [line 484]

string getSchemaDir(
)

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

Return: PEAR data directory.
Access: public

[ Top ]

getText [line 255]

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

Get a text construct.

Access: protected

Overridden in child classes as:

XML_Feed_Parser_Atom::getText(): Retrieves an element's content where that content is a text construct.

Parameters:

string	`$method`	—	The name of the text construct we want
array	`$arguments`	—	Included for compatibility with our __call usage

[ Top ]

hasKey [line 457]

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

Checks if this element has a particular child element.

Parameters:

String	`$name`	—
Integer	`$offset`	—

[ Top ]

processEntitiesForNodeValue [line 349]

String processEntitiesForNodeValue(
String
$node)

Convert HTML entities based on the current character set.

Parameters:

String $node —

[ Top ]

processXHTMLAttributes [line 326]

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:

DOMElement $node — The DOM node we are iterating over

[ Top ]

relaxNGValidate [line 491]

void relaxNGValidate(
)

Access: public

Overridden in child classes as:

XML_Feed_Parser_RSS09::relaxNGValidate(): Not implemented - no available validation.

[ Top ]

setSanitizer [line 113]

void setSanitizer(
XML_Feed_Parser_Sanitizer
$sanitizer)

Access: public

Parameters:

XML_Feed_Parser_Sanitizer $sanitizer —

[ Top ]

traverseNode [line 385]

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:

DOMElement $node — The DOM node we are processing

[ Top ]

__call [line 70]

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:

string	`$call`	—	- the method attempted
array	`$arguments`	—	- arguments to that method

[ Top ]

__get [line 133]

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 $value — - the variable required

[ Top ]

__toString [line 470]

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.

Return: XML serialization of element

Overridden in child classes as:

XML_Feed_Parser_AtomElement::__toString(): Get the entry as an XML string

[ Top ]

Class: XML_Feed_Parser_Type

Class Overview

Author(s):

Version:

Variables

Methods

Child classes:

Inherited Variables

Inherited Methods

Class Details

Class Variables

$entries = array()

$idMappings = array()

$model =

$numberEntries =

$sanitizer =

Method Detail

addBase [line 188]

Parameters:

combineBases [line 150]

Parameters:

count [line 308]

Parameters:

getCategory [line 281]

Parameters:

getContent [line 424]

getDate [line 239]

Parameters:

getEntryByOffset [line 207]

Parameters:

getSanitizer [line 120]

getSchemaDir [line 484]

getText [line 255]

Parameters:

hasKey [line 457]

Parameters:

processEntitiesForNodeValue [line 349]

Parameters:

processXHTMLAttributes [line 326]

Parameters:

relaxNGValidate [line 491]

setSanitizer [line 113]

Parameters:

traverseNode [line 385]

Parameters:

__call [line 70]

Parameters:

__get [line 133]

Parameters:

__toString [line 470]