Docs For Class XML_Feed

XML_Feed_Parser __construct(
string
$feed, [bool
$strict = false], [bool
$suppressWarnings = false], [bool
$tidy = false])

Detects feed types and instantiate appropriate objects.

Our constructor takes care of detecting feed types and instantiating appropriate classes. For now we're going to treat Atom 0.3 as Atom 1.0 but raise a warning. I do not intend to introduce full support for Atom 0.3 as it has been deprecated, but others are welcome to.

Deprecated: XML_Feed_Parser2

Overridden in child classes as:

XML_Feed_Parser2::__construct(): A variant of XML_Feed_Parser which does no work in the constructor.

Parameters:

string	`$feed`	—	XML serialization of the feed
bool	`$strict`	—	Whether or not to validate the feed
bool	`$suppressWarnings`	—	Trigger errors for deprecated feed types?
bool	`$tidy`	—	Whether or not to try and use the tidy library on input

[ Top ]

XML_Feed_Parser_Type current(
)

Return XML_Feed_Type object for current element

Return: Object

[ Top ]

XML_Feed_Parser_Type|false getEntryById(
string
$id)

Provides access to entries by ID if one is specified in the source feed.

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 offset. This method can be quite slow if dealing with a large feed that hasn't yet been processed as it instantiates objects for every entry until it finds the one needed.

Parameters:

string $id — Valid ID for the given feed format

[ Top ]

XML_Feed_Parser_Type|false getEntryByOffset(
int
$offset)

Retrieve entry by numeric offset, 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 — The position of the entry within the feed, starting from 0

[ Top ]

void initialize(
string
$feed, [bool
$strict = false], [bool
$suppressWarnings = false], [bool
$tidy = false])

Detects feed types and instantiate appropriate objects.

Our constructor takes care of detecting feed types and instantiating appropriate classes. For now we're going to treat Atom 0.3 as Atom 1.0 but raise a warning. I do not intend to introduce full support for Atom 0.3 as it has been deprecated, but others are welcome to.

Todo: No work in the constructor :(

Parameters:

string	`$feed`	—	XML serialization of the feed
bool	`$strict`	—	Whether or not to validate the feed
bool	`$suppressWarnings`	—	Trigger errors for deprecated feed types?
bool	`$tidy`	—	Whether or not to try and use the tidy library on input

[ Top ]

int key(
)

For iteration -- returns the key for the current stage in the array.

[ Top ]

void next(
)

Provides iteration functionality.

Of course we must be able to iterate... This function simply increases our internal counter.

[ Top ]

void rewind(
)

For iteration -- resets the internal counter to the beginning.

[ Top ]

void setFeed(

$feed)

Access: public

Parameters:

$feed —

[ Top ]

bool valid(
)

For iteration -- tells whether we have reached the end.

[ Top ]

void version(
)

Retrieve version details from feed type class.

Author: James Stewart

[ Top ]

void __call(
string
$call, array
$attributes)

Proxy to allow feed element names to be used as method names

For top-level feed elements we will provide access using methods or attributes. This function simply passes on a request to the appropriate feed type object.

Parameters:

string	`$call`	—	- the method being called
array	`$attributes`	—

[ Top ]

void __get(
string
$val)

Proxy to allow feed element names to be used as attribute names

To allow variable-like access to feed-level data we use this method. It simply passes along to __call() which in turn passes along to the relevant object.

Parameters:

string $val — - the name of the variable required

[ Top ]

String __toString(
)

Returns a string representation of the feed.

[ Top ]

Class: XML_Feed_Parser

Class Overview

Author(s):

Version:

Variables

Methods

Child classes:

Inherited Variables

Inherited Methods

Class Details

Class Variables

$idMappings = array()

$model =

Method Detail

__construct (Constructor) [line 90]

Parameters:

current [line 174]

getEntryById [line 220]

Parameters:

getEntryByOffset [line 244]

Parameters:

initialize [line 110]

Parameters:

key [line 184]

next [line 157]

rewind [line 203]

setFeed [line 116]

Parameters:

valid [line 195]

version [line 270]

__call [line 130]

Parameters:

__get [line 146]

Parameters:

__toString [line 280]