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

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


Child classes:

Atom03
atom03 provides reading and writing of Atom 0.3 format syndication feeds.

Inherited Constants

Inherited Variables

Inherited Methods

Class: FeedParserBase

FeedParserBase::__construct()
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 46]
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 __construct [line 48]

Atom10 __construct( )



Tags:

access:  public


Overridden in child classes as:

Atom03::__construct()

Overrides FeedParserBase::__construct() (parent method not documented)

[ Top ]

method charData [line 203]

void charData( $parser, $data)

Handles character data.

Called by the parserfactory during parsing.




Tags:

access:  public


Overridden in child classes as:

Atom03::charData()
Handles character data.

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

Parameters:

   $parser  
   $data  

[ Top ]

method endElement [line 188]

void endElement( $parser, $name)

Handle the close of an XML element

Called by the parserfactory during parsing.




Tags:

access:  public


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

Parameters:

   $parser  
   $name  

[ Top ]

method startElement [line 160]

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
access:  public


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

Parameters:

   $parser  
   $name  
   $attributes  

[ Top ]

method _createId [line 92]

void _createId( $url, $date)



Tags:

access:  protected


Parameters:

   $url  
   $date  

[ Top ]

method _feedFooter [line 146]

void _feedFooter( )

Return the formatted end of a feed.

just closes things off nicely.




Tags:

access:  protected


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

[ Top ]

method _feedHeader [line 117]

void _feedHeader( )

Return the formatted start of a feed.

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




Tags:

access:  protected


Overridden in child classes as:

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

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

[ Top ]

method _formatArticle [line 62]

void _formatArticle( $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.




Tags:

access:  protected


Overridden in child classes as:

Atom03::_formatArticle()
Format an article into an Atom 0.3 <entry> tag.

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

Parameters:

array   $article   Associative array describing an article.

[ Top ]

method _RFC3339Date [line 102]

void _RFC3339Date( [ $timestamp = ''])



Tags:

access:  protected


Parameters:

   $timestamp  

[ Top ]


Documentation generated on Sun, 02 Oct 2016 07:44:07 +0000 by phpDocumentor 1.4.3