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

Class: XML_Feed_Parser

Source Location: /XML_Feed_Parser-0.2.8alpha/Parser.php

Class Overview


This is the core of the XML_Feed_Parser package. It identifies feed types and abstracts access to them. It is an iterator, allowing for easy access to the entire feed.


Author(s):

Version:

  • Release: @package_version@

Variables

Methods


Inherited Variables

Inherited Methods


Class Details

[line 46]
This is the core of the XML_Feed_Parser package. It identifies feed types and abstracts access to them. It is an iterator, allowing for easy access to the entire feed.
  • Author: James Stewart <james@jystewart.net>
  • Version: Release: @package_version@
  • Todo: Look into working with Tidy extension to handle ill-formed XML


[ Top ]


Class Variables

$idMappings = array()

[line 64]

A map between entry ID and offset
  • Access: protected

Type:   array


[ Top ]

$model =

[line 58]

To allow for extensions, we make a public reference to the feed model
  • Access: public

Type:   DOMDocument


[ Top ]



Method Detail

__construct (Constructor)   [line 85]

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

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.

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?

[ Top ]

current   [line 219]

XML_Feed_Parser_Type current( )

Return XML_Feed_Type object for current element
  • Return: Object

[ Top ]

getEntryById   [line 265]

XML_Feed_Parser_Type|false getEntryById( string $id)

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   — 

[ Top ]

getEntryByOffset   [line 289]

XML_Feed_Parser_Type|false getEntryByOffset( int $offset)

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 ]

key   [line 230]

int key( )

Part of the iteration implementation. Returns the key for the current stage in the array.

[ Top ]

next   [line 202]

void next( )

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

[ Top ]

rewind   [line 250]

void rewind( )

Part of the iteration implementation. Resets the internal counter to the beginning.

[ Top ]

valid   [line 241]

bool valid( )

Part of the iteration implementation. Tells whether we have reached the end.

[ Top ]

version   [line 316]

void version( )

Retrieve version details from feed type class.
  • Author: James Stewart

[ Top ]

__call   [line 179]

void __call( string $call, array $attributes)

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 ]

__get   [line 193]

void __get( string $val)

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 ]

__toString   [line 321]

void __toString( )


[ Top ]


Documentation generated on Mon, 11 Mar 2019 14:32:00 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.