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_RSS1
XML_Feed_Parser_RSS1Element
XML_Feed_Parser_RSS2
XML_Feed_Parser_RSS2Element
XML_Feed_Parser_Type
Files:
accessTypes.php
Atom.php
atomCompliance.php
AtomElement.php
atomEntryOnly.php
atomValues.php
Exception.php
iteration.php
Parser.php
RSS1.php
RSS1Element.php
rss1Values.php
RSS2.php
RSS2Element.php
rss2Values.php
Type.php

Element index for package XML_Feed_Parser

[ a ] [ c ] [ e ] [ g ] [ i ] [ k ] [ n ] [ p ] [ r ] [ t ] [ v ] [ x ]

a

addBase
in file Type.php, method XML_Feed_Parser_Type::addBase()
    getBase gets us the xml:base data. We then need to process that with regard to our current link. This function does that and returns the link in as complete a form as possible.
AtomElement.php
procedural page AtomElement.php
Atom.php
procedural page Atom.php
accessTypes.php
procedural page accessTypes.php
atomCompliance.php
procedural page atomCompliance.php
atomEntryOnly.php
procedural page atomEntryOnly.php
atomValues.php
procedural page atomValues.php
top

c

count
in file Type.php, method XML_Feed_Parser_Type::count()
    This function will tell us how many times the element $type appears at this level of the feed.
current
in file Parser.php, method XML_Feed_Parser::current()
    Return XML_Feed_Type object for current element
top

e

Exception.php
procedural page Exception.php
top

g

getAuthor
in file RSS1.php, method XML_Feed_Parser_RSS1::getAuthor()
    Dublin Core provides the dc:creator, dc:contributor, and dc:publisher elements for defining authorship in RSS1. We will try each of those in turn in order to simulate the atom author element and will return it as text.
getAuthor
in file AtomElement.php, method XML_Feed_Parser_AtomElement::getAuthor()
    author data at the entry level is more complex than at the feed level.
getBase
in file Type.php, method XML_Feed_Parser_Type::getBase()
    We will often need to extract the xml:base values that apply to a link. This method iterates through the heirarchy and extracts the relevant attributes, and then combines them.
getCategory
in file Type.php, method XML_Feed_Parser_Type::getCategory()
    There is no single way of declaring a category in RSS1 or Atom as there is in RSS2.
getCategory
in file RSS2.php, method XML_Feed_Parser_RSS2::getCategory()
    The category element is a simple text construct which can occur any number of times. We allow access by offset or access to an array of results.
getCloud
in file RSS2.php, method XML_Feed_Parser_RSS2::getCloud()
    The cloud element is rarely used. It is designed to provide some details of a location to update the feed.
getContent
in file AtomElement.php, method XML_Feed_Parser_AtomElement::getContent()
    This element may or may not be present. It cannot be present more than once. It may have a 'src' attribute, in which case there's no content If not present, then the entry must have link with rel="alternate".
getContent
in file RSS1Element.php, method XML_Feed_Parser_RSS1Element::getContent()
    The official way to include full content in an RSS1 entry is to use the content module's element 'encoded'. Often, however, the 'description' element is used instead. We will offer that as a fallback.
getDate
in file Type.php, method XML_Feed_Parser_Type::getDate()
    Get a date construct. We use PHP's strtotime to return it as a unix datetime
getEnclosure
in file RSS2Element.php, method XML_Feed_Parser_RSS2Element::getEnclosure()
    The RSS2 spec is ambiguous as to whether an enclosure element must be unique in a given entry. For now we will assume it needn't, and allow for an offset.
getEnclosure
in file AtomElement.php, method XML_Feed_Parser_AtomElement::getEnclosure()
    The Atom spec doesn't provide for an enclosure element, but it is generally supported using the link element with rel='enclosure'.
getEnclosure
in file RSS1Element.php, method XML_Feed_Parser_RSS1Element::getEnclosure()
    How RSS1 should support for enclosures is not clear. For now we will return false.
getEntryById
in file Parser.php, method XML_Feed_Parser::getEntryById()
    As well as allowing the items to be iterated over we want to allow
getEntryById
in file RSS2.php, method XML_Feed_Parser_RSS2::getEntryById()
    This is not really something that will work with RSS2 as it does not have clear restrictions on the global uniqueness of IDs. But we can emulate it by allowing access based on the 'guid' element.
getEntryById
in file Atom.php, method XML_Feed_Parser_Atom::getEntryById()
    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.
getEntryById
in file RSS1.php, method XML_Feed_Parser_RSS1::getEntryById()
    This is not really something that will work with RSS1 as it does not have clear restrictions on the global uniqueness of IDs. We will employ the _very_ hit and miss method of selecting entries based on the rdf:about attribute.
getEntryByOffset
in file Type.php, method XML_Feed_Parser_Type::getEntryByOffset()
    Pretty fundamental!
getEntryByOffset
in file Parser.php, method XML_Feed_Parser::getEntryByOffset()
    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.
getGuid
in file RSS2Element.php, method XML_Feed_Parser_RSS2Element::getGuid()
    guid is the closest RSS2 has to atom's ID. It is usually but not always a URI.
getId
in file RSS1Element.php, method XML_Feed_Parser_RSS1Element::getId()
    There is no established way of showing an ID for an RSS1 entry. We will simulate it using the rdf:about attribute of the entry element. This cannot be relied upon for unique IDs but may prove useful.
getImage
in file RSS2.php, method XML_Feed_Parser_RSS2::getImage()
    Get details of the image associated with the feed.
getImage
in file RSS1.php, method XML_Feed_Parser_RSS1::getImage()
    Get details of the image associated with the feed.
getLink
in file RSS2.php, method XML_Feed_Parser_RSS2::getLink()
    In RSS2 a link is a text element but in order to ensure that we resolve URLs properly we have a special function for them. We maintain the parameter used by the atom getLink method, though we only use the offset parameter.
getLink
in file RSS1.php, method XML_Feed_Parser_RSS1::getLink()
    In RSS1 a link is a text element but in order to ensure that we resolve URLs properly we have a special function for them.
getSkipDays
in file RSS2.php, method XML_Feed_Parser_RSS2::getSkipDays()
    The skipdays element provides a list of days on which this feed should not be checked. We return an array of those days.
getSkipHours
in file RSS2.php, method XML_Feed_Parser_RSS2::getSkipHours()
    The skiphours element provides a list of hourss on which this feed should not be checked. We return an array of those hours (integers, 24 hour clock)
getSkips
in file RSS2.php, method XML_Feed_Parser_RSS2::getSkips()
    This is a general function used by both getSkipDays and getSkipHours. It simply returns an array of the values of the children of the appropriate tag.
getSource
in file AtomElement.php, method XML_Feed_Parser_AtomElement::getSource()
    Where an atom:entry is taken from another feed then the aggregator
getSource
in file RSS2Element.php, method XML_Feed_Parser_RSS2Element::getSource()
    source is an optional sub-element of item. Like atom:source it tells
getText
in file Type.php, method XML_Feed_Parser_Type::getText()
    Get a text construct.
getTextInput
in file RSS2.php, method XML_Feed_Parser_RSS2::getTextInput()
    The textinput element is little used, but in the interests of completeness...
getTextInput
in file RSS1.php, method XML_Feed_Parser_RSS1::getTextInput()
    The textinput element is little used, but in the interests of completeness we will support it.
top

i

iteration.php
procedural page iteration.php
top

k

key
in file Parser.php, method XML_Feed_Parser::key()
    Part of the iteration implementation. Returns the key for the current stage in the array.
top

n

next
in file Parser.php, method XML_Feed_Parser::next()
    Of course we must be able to iterate... This function simply increases our internal counter.
top

p

Parser.php
procedural page Parser.php
top

r

RSS1Element.php
procedural page RSS1Element.php
RSS1.php
procedural page RSS1.php
RSS2Element.php
procedural page RSS2Element.php
RSS2.php
procedural page RSS2.php
rss1Values.php
procedural page rss1Values.php
rss2Values.php
procedural page rss2Values.php
rewind
in file Parser.php, method XML_Feed_Parser::rewind()
    Part of the iteration implementation. Resets the internal counter to the beginning.
top

t

Type.php
procedural page Type.php
top

v

valid
in file Parser.php, method XML_Feed_Parser::valid()
    Part of the iteration implementation. Tells whether we have reached the end.
top

x

XML_Feed_Parser
in file Parser.php, class XML_Feed_Parser
    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.
XML_Feed_Parser_Atom
in file Atom.php, class XML_Feed_Parser_Atom
    This is the class that determines how we manage Atom 1.0 feeds
XML_Feed_Parser_AtomElement
in file AtomElement.php, class 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.
XML_Feed_Parser_Exception
in file Exception.php, class XML_Feed_Parser_Exception
    XML_Feed_Parser_Exception is a simple extension of PEAR_Exception, existing to help with identification of the source of exceptions.
XML_Feed_Parser_RSS1
in file RSS1.php, class XML_Feed_Parser_RSS1
    This class handles RSS1.0 feeds.
XML_Feed_Parser_RSS1Element
in file RSS1Element.php, class XML_Feed_Parser_RSS1Element
    RSS1 Element class for XML_Feed_Parser
XML_Feed_Parser_RSS2
in file RSS2.php, class XML_Feed_Parser_RSS2
    This class handles RSS2 feeds.
XML_Feed_Parser_RSS2Element
in file RSS2Element.php, class XML_Feed_Parser_RSS2Element
    This class provides support for RSS 2.0 entries. It will usually be called by XML_Feed_Parser_RSS2 with which it shares many methods.
XML_Feed_Parser_Type
in file Type.php, class XML_Feed_Parser_Type
    This abstract class provides some general methods that are likely to be implemented exactly the same way for all feed types.
top
Documentation generated on Tue, 11 Oct 2005 11:04:25 -0400 by phpDocumentor 1.2.3. PEAR Logo Copyright © PHP Group 2004.