Class: Atom10

Source Location: /system/classes/syndication/atom.feed.class.php

Class Overview

FeedParserBase
   |
   --Atom10

atom10 provides reading and writing of Atom 1.0 format syndication feeds.

Author(s):

Michael Jervis (mike@fuckingbrit.com)

Copyright:

Michael Jervis 2005

Methods

Inherited Variables

Class: FeedParserBase

FeedParserBase::$articles
FeedParserBase::$copyright
FeedParserBase::$description
FeedParserBase::$encoding
FeedParserBase::$extensions
FeedParserBase::$feedlogo
FeedParserBase::$lang
FeedParserBase::$namespaces
FeedParserBase::$sitecontact
FeedParserBase::$sitelink
FeedParserBase::$system
FeedParserBase::$title
FeedParserBase::$url
FeedParserBase::$_currentTag

Inherited Methods

Class: FeedParserBase

FeedParserBase::FeedParserBase()
FeedParserBase::charData(): Handles character data.
FeedParserBase::createFeed(): Create a file for the stream
FeedParserBase::endElement(): Handle the close of an XML element
FeedParserBase::startElement(): Handle the begining of an XML element
FeedParserBase::_feedFooter(): Return the formatted end of a feed.
FeedParserBase::_feedHeader(): Return the formatted start of a feed.
FeedParserBase::_formatArticle(): Format an article into feed specific XML.
FeedParserBase::_injectExtendingTags(): Inject extending tags into the feed header, if needed.
FeedParserBase::_injectNamespaces(): Inject XMLNS items into the feed master element, if needed.
FeedParserBase::_safeXML(): Make sure a string is safe to be chardata in an xml element
FeedParserBase::_writeFile()

Class Details

[line 244]
atom10 provides reading and writing of Atom 1.0 format syndication feeds.

Tags:

author:	Michael Jervis (mike@fuckingbrit.com)
copyright:	Michael Jervis 2005
abstract:

[ Top ]

Class Methods

constructor Atom10 [line 258]

Atom10 Atom10(
)

[ Top ]

method charData [line 413]

void charData(

$parser, 
$data)

Handles character data.

Called by the parserfactory during parsing.

Overrides FeedParserBase::charData() (Handles character data.)

Parameters:

	$parser
	$data

[ Top ]

method endElement [line 398]

void endElement(

$parser, 
$name)

Handle the close of an XML element

Called by the parserfactory during parsing.

Overrides FeedParserBase::endElement() (Handle the close of an XML element)

Parameters:

	$parser
	$name

[ Top ]

method startElement [line 373]

void startElement(

$parser, 
$name, 
$attributes)

Handle the begining of an XML element

This is called from the parserfactory once the type of data has been determined. Standard XML_PARSER element handler.

Tags:

author:	Michael Jervis (mike@fuckingbrit.com)
copyright:	Michael Jervis 2004

Overrides FeedParserBase::startElement() (Handle the begining of an XML element)

Parameters:

	$parser
	$name
	$attributes

[ Top ]

method _createId [line 304]

void _createId(

$url, 
$date)

Parameters:

	$url
	$date

[ Top ]

method _feedFooter [line 358]

void _feedFooter(
)

Return the formatted end of a feed.

just closes things off nicely.

Overrides FeedParserBase::_feedFooter() (Return the formatted end of a feed.)

[ Top ]

method _feedHeader [line 333]

void _feedHeader(
)

Return the formatted start of a feed.

This will start the xml and create header information about the feed itself.

Overrides FeedParserBase::_feedHeader() (Return the formatted start of a feed.)

[ Top ]

method _formatArticle [line 272]

void _formatArticle(
array
$article)

Format an article into an Atom 0.3 <entry> tag.

Takes an associative article array and turns it into an XML definition of an article. Uses merely title, link and summary.

Overrides FeedParserBase::_formatArticle() (Format an article into feed specific XML.)

Parameters:

array

$article

Associative array describing an article.

[ Top ]

method _RFC3339Date [line 313]

void _RFC3339Date(
[
$timestamp = ''])

Parameters:

$timestamp

[ Top ]

Documentation generated on Sat, 11 Feb 2012 02:07:07 -0500 by phpDocumentor 1.4.3