Feed/Reader/Feed/Atom/Source.php

Show: PublicProtectedPrivateinherited
Table of Contents
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-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Feed_Reader  
Version
$Id: Source.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_Feed_Reader_Feed_Atom_Source

Package: Zend\Feed\Reader
Parent(s)
\Zend_Feed_Reader_Feed_Atom < \Zend_Feed_Reader_FeedAbstract
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

>VPropertyprotectedarray $_data = array()
Default valuearray()Details
Type
array
Inherited_from
\Zend_Feed_Reader_FeedAbstract::$$_data  
Inherited_from
\Zend_Feed_Reader_Feed_Atom::$$_data  
>VPropertyprotected\DOMDocument $_domDocument = null
inherited
Parsed feed data in the shape of a DOMDocument
Inherited from: \Zend_Feed_Reader_FeedAbstract::$$_domDocument\Zend_Feed_Reader_Feed_Atom::$$_domDocument
>VPropertyprotectedarray $_entries = array()
inherited
An array of parsed feed entries
Inherited from: \Zend_Feed_Reader_FeedAbstract::$$_entries\Zend_Feed_Reader_Feed_Atom::$$_entries
Default valuearray()Details
Type
array
Inherited_from
\Zend_Feed_Reader_FeedAbstract::$$_entries  
Inherited_from
\Zend_Feed_Reader_Feed_Atom::$$_entries  
>VPropertyprotectedint $_entriesKey = 0
inherited
A pointer for the iterator to keep track of the entries array
Inherited from: \Zend_Feed_Reader_FeedAbstract::$$_entriesKey\Zend_Feed_Reader_Feed_Atom::$$_entriesKey
Default value0Details
Type
int
Inherited_from
\Zend_Feed_Reader_FeedAbstract::$$_entriesKey  
Inherited_from
\Zend_Feed_Reader_Feed_Atom::$$_entriesKey  
>VPropertyprotectedarray $_extensions = array()
Default valuearray()Details
Type
array
Inherited_from
\Zend_Feed_Reader_FeedAbstract::$$_extensions  
Inherited_from
\Zend_Feed_Reader_Feed_Atom::$$_extensions  
>VPropertyprotectedstring $_originalSourceUri = null
inherited
Original Source URI (set if imported from a URI)
Inherited from: \Zend_Feed_Reader_FeedAbstract::$$_originalSourceUri\Zend_Feed_Reader_Feed_Atom::$$_originalSourceUri
Default valuenullDetails
Type
string
Inherited_from
\Zend_Feed_Reader_FeedAbstract::$$_originalSourceUri  
Inherited_from
\Zend_Feed_Reader_Feed_Atom::$$_originalSourceUri  
>VPropertyprotected\DOMXPath $_xpath = null
inherited
The base XPath query used to retrieve feed data
Inherited from: \Zend_Feed_Reader_FeedAbstract::$$_xpath\Zend_Feed_Reader_Feed_Atom::$$_xpath
Default valuenullDetails
Type
\DOMXPath
Inherited_from
\Zend_Feed_Reader_FeedAbstract::$$_xpath  
Inherited_from
\Zend_Feed_Reader_Feed_Atom::$$_xpath  

Methods

methodpublic__call( $method,  $args) : void
Parameters
NameTypeDescription
$method
$args
methodpublic__construct(\DOMElement $source, string $xpathPrefix, string $type = \Zend_Feed_Reader::TYPE_ATOM_10) : 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
NameTypeDescription
$source\DOMElement
$xpathPrefixstring

Passed from parent Entry object

$typestring

Nearly always Atom 1.0

methodprotected_indexEntries() : void

Read all entries to the internal entries array

methodprotected_registerNamespaces() : void
inherited

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
inherited

Get a single author

Inherited from: \Zend_Feed_Reader_Feed_Atom::getAuthor()
Parameters
NameTypeDescription
$indexint
Returns
TypeDescription
string | null
methodpublicgetAuthors() : array
inherited

Get an array with feed authors

Inherited from: \Zend_Feed_Reader_Feed_Atom::getAuthors()
Returns
TypeDescription
array
methodpublicgetBaseUrl() : string | null
inherited

Get a link to the source website

Inherited from: \Zend_Feed_Reader_Feed_Atom::getBaseUrl()
Returns
TypeDescription
string | null
methodpublicgetCategories() : \Zend_Feed_Reader_Collection_Category
inherited

Get all categories

Inherited from: \Zend_Feed_Reader_Feed_Atom::getCategories()
methodpublicgetCopyright() : string | null
inherited

Get the copyright entry

Inherited from: \Zend_Feed_Reader_Feed_Atom::getCopyright()
Returns
TypeDescription
string | null
methodpublicgetDateCreated() : string | null
inherited

Get the feed creation date

Inherited from: \Zend_Feed_Reader_Feed_Atom::getDateCreated()
Returns
TypeDescription
string | null
methodpublicgetDateModified() : string | null
inherited

Get the feed modification date

Inherited from: \Zend_Feed_Reader_Feed_Atom::getDateModified()
Returns
TypeDescription
string | null
methodpublicgetDescription() : string | null
inherited

Get the feed description

Inherited from: \Zend_Feed_Reader_Feed_Atom::getDescription()
Returns
TypeDescription
string | null
methodpublicgetElement() : \DOMElement
inherited

Get the DOMElement representing the items/feed element

Inherited from: \Zend_Feed_Reader_FeedAbstract::getElement()\Zend_Feed_Reader_Feed_Atom::getElement()
Returns
TypeDescription
\DOMElement
methodpublicgetEncoding() : string
Returns
TypeDescription
string
methodpublicgetExtension(string $name) : \Zend_Feed_Reader_Extension_FeedAbstract
inherited

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

Inherited from: \Zend_Feed_Reader_FeedAbstract::getExtension()\Zend_Feed_Reader_Feed_Atom::getExtension()
Parameters
NameTypeDescription
$namestring
Returns
TypeDescription
\Zend_Feed_Reader_Extension_FeedAbstract
methodpublicgetFeedLink() : string | null
inherited

Get a link to the feed's XML Url

Inherited from: \Zend_Feed_Reader_Feed_Atom::getFeedLink()
Returns
TypeDescription
string | null
methodpublicgetGenerator() : string | null
inherited

Get the feed generator entry

Inherited from: \Zend_Feed_Reader_Feed_Atom::getGenerator()
Returns
TypeDescription
string | null
methodpublicgetHubs() : array | null
inherited

Get an array of any supported Pusubhubbub endpoints

Inherited from: \Zend_Feed_Reader_Feed_Atom::getHubs()
Returns
TypeDescription
array | null
methodpublicgetId() : string | null
inherited

Get the feed ID

Inherited from: \Zend_Feed_Reader_Feed_Atom::getId()
Returns
TypeDescription
string | null
methodpublicgetImage() : array | null
inherited

Get feed image data

Inherited from: \Zend_Feed_Reader_Feed_Atom::getImage()
Returns
TypeDescription
array | null
methodpublicgetLanguage() : string | null
inherited

Get the feed language

Inherited from: \Zend_Feed_Reader_Feed_Atom::getLanguage()
Returns
TypeDescription
string | null
methodpublicgetLastBuildDate() : string | null
inherited

Get the feed lastBuild date.

Inherited from: \Zend_Feed_Reader_Feed_Atom::getLastBuildDate()

This is not implemented in Atom.

Returns
TypeDescription
string | null
methodpublicgetLink() : string | null
inherited

Get a link to the source website

Inherited from: \Zend_Feed_Reader_Feed_Atom::getLink()
Returns
TypeDescription
string | null
methodpublicgetOriginalSourceUri() : string | null
inherited

Get an original source URI for the feed being parsed.

Inherited from: \Zend_Feed_Reader_FeedAbstract::getOriginalSourceUri()\Zend_Feed_Reader_Feed_Atom::getOriginalSourceUri()

Returns null if unset or the feed was not imported from a URI.

Returns
TypeDescription
string | null
methodpublicgetTitle() : string | null
inherited

Get the feed title

Inherited from: \Zend_Feed_Reader_Feed_Atom::getTitle()
Returns
TypeDescription
string | null
methodpublicgetType() : string
Returns
TypeDescription
string
methodpublicgetXpath() : \DOMXPath
inherited

Get the DOMXPath object for this feed

Inherited from: \Zend_Feed_Reader_FeedAbstract::getXpath()\Zend_Feed_Reader_Feed_Atom::getXpath()
Returns
TypeDescription
\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
Returns
TypeDescription
string
methodpublicsetOriginalSourceUri(string $uri) : void
inherited

Set an original source URI for the feed being parsed.

Inherited from: \Zend_Feed_Reader_FeedAbstract::setOriginalSourceUri()\Zend_Feed_Reader_Feed_Atom::setOriginalSourceUri()

This value is returned from getFeedLink() method if the feed does not carry a self-referencing URI.

Parameters
NameTypeDescription
$uristring
methodpublicvalid() : void

Check to see if the iterator is still valid

Documentation was generated by phpDocumentor 2.0.0a12.