API Documentation

Feed/Reader/Feed/Atom/Source.php

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Feed_Reader  
version
$Id: Source.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_Feed_Reader_Feed_Atom_Source

Extends from
\Zend_Feed_Reader_Feed_Atom
category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Feed_Reader  

Methods

methodpublic__call(  $method,  $args ) : void
Parameters
Name Type Description
$method
$args
methodpublic__construct( \DOMElement $source, string $xpathPrefix, string $type = Zend_Feed_Reader ) : void

Constructor: Create a Source object which is largely just a normal Zend_Feed_Reader_FeedAbstract object only designed to retrieve feed level metadata from an Atom entry's source element.

Parameters
Name Type Description
$source \DOMElement
$xpathPrefix string Passed from parent Entry object
$type string Nearly always Atom 1.0
methodprotected_indexEntries( ) : void

Read all entries to the internal entries array

methodprotected_loadExtensions( ) : void
methodprotected_registerNamespaces( ) : void

Register the default namespaces for the current feed format

Inherited from: \Zend_Feed_Reader_Feed_Atom::_registerNamespaces()
methodpubliccount( ) : void

Get the number of feed entries.

Required by the Iterator interface.

methodpubliccurrent( ) : void

Return the current entry

methodpublicgetAuthor( int $index = 0 ) : string|null

Get a single author

Inherited from: \Zend_Feed_Reader_Feed_Atom::getAuthor()
Parameters
Name Type Description
$index int
Returns
Type Description
stringnull
methodpublicgetAuthors( ) : array

Get an array with feed authors

Inherited from: \Zend_Feed_Reader_Feed_Atom::getAuthors()
Returns
Type Description
array
methodpublicgetBaseUrl( ) : string|null

Get a link to the source website

Inherited from: \Zend_Feed_Reader_Feed_Atom::getBaseUrl()
Returns
Type Description
stringnull
methodpublicgetCategories( ) : \Zend_Feed_Reader_Collection_Category

Get all categories

Inherited from: \Zend_Feed_Reader_Feed_Atom::getCategories()
Returns
Type Description
\Zend_Feed_Reader_Collection_Category
methodpublicgetCopyright( ) : string|null

Get the copyright entry

Inherited from: \Zend_Feed_Reader_Feed_Atom::getCopyright()
Returns
Type Description
stringnull
methodpublicgetDateCreated( ) : string|null

Get the feed creation date

Inherited from: \Zend_Feed_Reader_Feed_Atom::getDateCreated()
Returns
Type Description
stringnull
methodpublicgetDateModified( ) : string|null

Get the feed modification date

Inherited from: \Zend_Feed_Reader_Feed_Atom::getDateModified()
Returns
Type Description
stringnull
methodpublicgetDescription( ) : string|null

Get the feed description

Inherited from: \Zend_Feed_Reader_Feed_Atom::getDescription()
Returns
Type Description
stringnull
methodpublicgetDomDocument( ) : \DOMDocument
Returns
Type Description
\DOMDocument
methodpublicgetElement( ) : \DOMElement

Get the DOMElement representing the items/feed element

Inherited from: \Zend_Feed_Reader_FeedAbstract::getElement()
Returns
Type Description
\DOMElement
methodpublicgetEncoding( ) : string

Get the Feed's encoding

Inherited from: \Zend_Feed_Reader_FeedAbstract::getEncoding()
Returns
Type Description
string
methodpublicgetExtension( string $name ) : \Zend_Feed_Reader_Extension_FeedAbstract

Return an Extension object with the matching name (postfixed with _Feed)

Inherited from: \Zend_Feed_Reader_FeedAbstract::getExtension()
Parameters
Name Type Description
$name string
Returns
Type Description
\Zend_Feed_Reader_Extension_FeedAbstract
methodpublicgetExtensions( ) : void
methodpublicgetFeedLink( ) : string|null

Get a link to the feed's XML Url

Inherited from: \Zend_Feed_Reader_Feed_Atom::getFeedLink()
Returns
Type Description
stringnull
methodpublicgetGenerator( ) : string|null

Get the feed generator entry

Inherited from: \Zend_Feed_Reader_Feed_Atom::getGenerator()
Returns
Type Description
stringnull
methodpublicgetHubs( ) : array|null

Get an array of any supported Pusubhubbub endpoints

Inherited from: \Zend_Feed_Reader_Feed_Atom::getHubs()
Returns
Type Description
arraynull
methodpublicgetId( ) : string|null

Get the feed ID

Inherited from: \Zend_Feed_Reader_Feed_Atom::getId()
Returns
Type Description
stringnull
methodpublicgetImage( ) : array|null

Get feed image data

Inherited from: \Zend_Feed_Reader_Feed_Atom::getImage()
Returns
Type Description
arraynull
methodpublicgetLanguage( ) : string|null

Get the feed language

Inherited from: \Zend_Feed_Reader_Feed_Atom::getLanguage()
Returns
Type Description
stringnull
methodpublicgetLastBuildDate( ) : string|null

Get the feed lastBuild date. This is not implemented in Atom.

Inherited from: \Zend_Feed_Reader_Feed_Atom::getLastBuildDate()
Returns
Type Description
stringnull
methodpublicgetLink( ) : string|null

Get a link to the source website

Inherited from: \Zend_Feed_Reader_Feed_Atom::getLink()
Returns
Type Description
stringnull
methodpublicgetOriginalSourceUri( ) : string|null

Get an original source URI for the feed being parsed. Returns null if unset or the feed was not imported from a URI.

Inherited from: \Zend_Feed_Reader_FeedAbstract::getOriginalSourceUri()
Returns
Type Description
stringnull
methodpublicgetTitle( ) : string|null

Get the feed title

Inherited from: \Zend_Feed_Reader_Feed_Atom::getTitle()
Returns
Type Description
stringnull
methodpublicgetType( ) : string

Get the feed type

Inherited from: \Zend_Feed_Reader_FeedAbstract::getType()
Returns
Type Description
string
methodpublicgetXpath( ) : \DOMXPath

Get the DOMXPath object for this feed

Inherited from: \Zend_Feed_Reader_FeedAbstract::getXpath()
Returns
Type Description
\DOMXPath
methodpublickey( ) : void

Return the current feed key

methodpublicnext( ) : void

Move the feed pointer forward

methodpublicrewind( ) : void

Reset the pointer in the feed object

methodpublicsaveXml( ) : string

Get feed as xml

Inherited from: \Zend_Feed_Reader_FeedAbstract::saveXml()
Returns
Type Description
string
methodpublicsetOriginalSourceUri( string $uri ) : void

Set an original source URI for the feed being parsed. This value is returned from getFeedLink() method if the feed does not carry a self-referencing URI.

Inherited from: \Zend_Feed_Reader_FeedAbstract::setOriginalSourceUri()
Parameters
Name Type Description
$uri string
methodpublicvalid( ) : void

Check to see if the iterator is still valid

Documentation was generated by DocBlox 0.13.3.