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_Type
Files:
Atom.php
AtomElement.php
Exception.php
Parser.php
RSS09.php
RSS09Element.php
RSS1.php
RSS1Element.php
RSS2.php
RSS2Element.php
Type.php

Class: XML_Feed_Parser_Atom

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

Class Overview

XML_Feed_Parser_Type
   |
   --XML_Feed_Parser_Atom

This is the class that determines how we manage Atom 1.0 feeds


Author(s):

Version:

  • Release: @package_version@

Variables

Methods

Child classes:

XML_Feed_Parser_AtomElement
This class provides support for atom entries. It will usually be called by XML_Feed_Parser_Atom with which it shares many methods.

Inherited Variables

Class: XML_Feed_Parser_Type

XML_Feed_Parser_Type::$entries
XML_Feed_Parser_Type::$model
XML_Feed_Parser_Type::$numberEntries

Inherited Methods

Class: XML_Feed_Parser_Type

XML_Feed_Parser_Type::addBase()
Gets us the xml:base data and then processes that with regard to our current link.
XML_Feed_Parser_Type::combineBases()
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.
XML_Feed_Parser_Type::count()
This function will tell us how many times the element $type appears at this level of the feed.
XML_Feed_Parser_Type::getCategory()
There is no single way of declaring a category in RSS1/1.1 as there is in RSS2
XML_Feed_Parser_Type::getDate()
Get a date construct. We use PHP's strtotime to return it as a unix datetime
XML_Feed_Parser_Type::getEntryByOffset()
Pretty fundamental!
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()
We need a couple of methods to access XHTML content stored in feeds.
XML_Feed_Parser_Type::traverseNode()
We need a couple of methods to access XHTML content stored in feeds.
XML_Feed_Parser_Type::__call()
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.
XML_Feed_Parser_Type::__get()
For many elements variable-style access will be desirable. This function provides for that.
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 36]
This is the class that determines how we manage Atom 1.0 feeds

How we deal with constructs: date - return as unix datetime for use with the 'date' function unless specified otherwise text - return as is. optional parameter will give access to attributes person - defaults to name, but parameter based access



[ Top ]

Class Variables

$compatMap = array(
      'guid' => array('id'),'links'=>array('link'),'tags'=>array('category'),'contributors'=>array('contributor'))

[line 103]

Here we provide a few mappings for those very special circumstances in which it makes sense to map back to the RSS2 spec. Key is RSS2 version value is an array consisting of the equivalent in atom and any attributes needed to make the mapping.
  • Access: protected

Type:   array


[ Top ]

$itemClass =  'XML_Feed_Parser_AtomElement'

[line 66]

The class used to represent individual items
  • Access: protected

Type:   string


[ Top ]

$itemElement =  'entry'

[line 72]

The element containing entries
  • Access: protected

Type:   string


[ Top ]

$map = array(
      'author' => array('Person'),'contributor'=>array('Person'),'icon'=>array('Text'),'logo'=>array('Text'),'id'=>array('Text','fail'),'rights'=>array('Text'),'subtitle'=>array('Text'),'title'=>array('Text','fail'),'updated'=>array('Date','fail'),'link'=>array('Link'),'generator'=>array('Text'),'category'=>array('Category'))

[line 82]

Here we map those elements we're not going to handle individually

to the constructs they are. The optional second parameter in the array tells the parser whether to 'fall back' (not apt. at the feed level) or fail if the element is missing. If the parameter is not set, the function will simply return false and leave it to the client to decide what to do.

  • Access: protected

Type:   array


[ Top ]

$version =  'Atom 1.0'

[line 60]

The feed type we are parsing
  • Access: public

Type:   string


[ Top ]

$xpath =

[line 48]

We're likely to use XPath, so let's keep it global
  • Access: public

Type:   DOMXPath


[ Top ]


Method Detail

__construct (Constructor)   [line 115]

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

Our constructor does nothing more than its parent.

Overridden in child classes as:

XML_Feed_Parser_AtomElement::__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 263]

string getCategory( string $method, array $arguments)

A feed or entry can have any number of categories. A category can have the attributes term, scheme and label.
  • Todo: offer other attributes

Overrides XML_Feed_Parser_Type::getCategory() (There is no single way of declaring a category in RSS1/1.1 as there is in RSS2)

Parameters:

string   $method   —  The name of the text construct we want
array   $arguments   —  An array which we hope gives a 'param'

[ Top ]

getEntryById   [line 141]

XML_Feed_Parser_AtomElement getEntryById( string $id)

This function uses XPath to get the entry based on its ID. Ideally we would also use XPath to find the offset of that node and therefore cache it, but the necessary XPath support isn't coming until at least PHP5.1.

Once it is available, I will try to implement support for it for those users on a capable platform.

  • Todo: Test with PHP5.1 and add conditional support

Parameters:

string   $id   —  any valid Atom ID.

[ Top ]

getLink   [line 288]

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

This element must be present at least once with rel="feed". This element may be present any number of further times so long as there is no clash. If no 'rel' is present and we're asked for one, we follow the example of the Universal Feed Parser and presume 'alternate'.
  • Return: the value of the attribute

Parameters:

int   $offset   —  the position of the link within the container
string   $attribute   —  the attribute name required
array   $params   —  an array of attributes to search by

[ Top ]

getPerson   [line 164]

string|false getPerson( string $method, array $arguments)

Get a person construct. We default to the 'name' element but allow access to any of the elements.
  • Access: protected

Parameters:

string   $method   —  The name of the person construct we want
array   $arguments   —  An array which we hope gives a 'param'

[ Top ]

getText   [line 196]

string getText( string $method, array $arguments)

Get a text construct. When calling this method, the two arguments allowed are 'offset' and 'attribute', so $parser->subtitle() would return the content of the element, while $parser->subtitle(false, 'type') would return the value of the type attribute.
  • Todo: Clarify overlap with getContent()
  • Access: protected

Overrides XML_Feed_Parser_Type::getText() (Get a text construct.)

Parameters:

string   $method   —  The name of the text construct we want
array   $arguments   —  An array which we hope gives a 'param'

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