Feed/Reader/Feed/Atom.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: Atom.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_Feed_Reader_Feed_Atom

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

Properties

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

Methods

methodpublic__call( $method,  $args) : void
Parameters
NameTypeDescription
$method
$args
methodpublic__construct(\DOMDocument $dom, string $type = null) : void

Constructor

Parameters
NameTypeDescription
$dom\DOMDocument
$typestring
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

methodpubliccount() : int
inherited

Get the number of feed entries.

Inherited from: \Zend_Feed_Reader_FeedAbstract::count()

Required by the Iterator interface.

Returns
TypeDescription
int
methodpubliccurrent() : \Zend_Feed_Reader_EntryInterface
inherited

Return the current entry

Inherited from: \Zend_Feed_Reader_FeedAbstract::current()
Returns
TypeDescription
\Zend_Feed_Reader_EntryInterface
methodpublicgetAuthor(int $index = 0) : string | null

Get a single author

Parameters
NameTypeDescription
$indexint
Returns
TypeDescription
string | null
methodpublicgetAuthors() : array

Get an array with feed authors

Returns
TypeDescription
array
methodpublicgetBaseUrl() : string | null

Get a link to the source website

Returns
TypeDescription
string | null
methodpublicgetCategories() : \Zend_Feed_Reader_Collection_Category

Get all categories

methodpublicgetCopyright() : string | null

Get the copyright entry

Returns
TypeDescription
string | null
methodpublicgetDateCreated() : string | null

Get the feed creation date

Returns
TypeDescription
string | null
methodpublicgetDateModified() : string | null

Get the feed modification date

Returns
TypeDescription
string | null
methodpublicgetDescription() : string | null

Get the feed description

Returns
TypeDescription
string | null
methodpublicgetDomDocument() : \DOMDocument
inherited

Get the DOM

Inherited from: \Zend_Feed_Reader_FeedAbstract::getDomDocument()
Returns
TypeDescription
\DOMDocument
methodpublicgetElement() : \DOMElement
inherited

Get the DOMElement representing the items/feed element

Inherited from: \Zend_Feed_Reader_FeedAbstract::getElement()
Returns
TypeDescription
\DOMElement
methodpublicgetEncoding() : string
inherited

Get the Feed's encoding

Inherited from: \Zend_Feed_Reader_FeedAbstract::getEncoding()
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()
Parameters
NameTypeDescription
$namestring
Returns
TypeDescription
\Zend_Feed_Reader_Extension_FeedAbstract
methodpublicgetExtensions() : void
methodpublicgetFeedLink() : string | null

Get a link to the feed's XML Url

Returns
TypeDescription
string | null
methodpublicgetGenerator() : string | null

Get the feed generator entry

Returns
TypeDescription
string | null
methodpublicgetHubs() : array | null

Get an array of any supported Pusubhubbub endpoints

Returns
TypeDescription
array | null
methodpublicgetId() : string | null

Get the feed ID

Returns
TypeDescription
string | null
methodpublicgetImage() : array | null

Get feed image data

Returns
TypeDescription
array | null
methodpublicgetLanguage() : string | null

Get the feed language

Returns
TypeDescription
string | null
methodpublicgetLastBuildDate() : string | null

Get the feed lastBuild date.

This is not implemented in Atom.

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

Get a link to the source website

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()

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

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

Get the feed title

Returns
TypeDescription
string | null
methodpublicgetType() : string
inherited

Get the feed type

Inherited from: \Zend_Feed_Reader_FeedAbstract::getType()
Returns
TypeDescription
string
methodpublicgetXpath() : \DOMXPath
inherited

Get the DOMXPath object for this feed

Inherited from: \Zend_Feed_Reader_FeedAbstract::getXpath()
Returns
TypeDescription
\DOMXPath
methodpublickey() : \unknown
inherited

Return the current feed key

Inherited from: \Zend_Feed_Reader_FeedAbstract::key()
Returns
TypeDescription
\unknown
methodpublicnext() : void
inherited

Move the feed pointer forward

Inherited from: \Zend_Feed_Reader_FeedAbstract::next()
methodpublicrewind() : void
inherited

Reset the pointer in the feed object

Inherited from: \Zend_Feed_Reader_FeedAbstract::rewind()
methodpublicsaveXml() : string
inherited

Get feed as xml

Inherited from: \Zend_Feed_Reader_FeedAbstract::saveXml()
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()

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

Parameters
NameTypeDescription
$uristring
methodpublicvalid() : boolean
inherited

Check to see if the iterator is still valid

Inherited from: \Zend_Feed_Reader_FeedAbstract::valid()
Returns
TypeDescription
boolean
Documentation was generated by phpDocumentor 2.0.0a12.