category Zend
package Reader

 Methods

__call()

__call($method, $args) 
Inherited

inherited_from \Zend\Feed\Reader\Feed\AbstractFeed::__call()
inherited_from \Zend\Feed\Reader\Feed\Atom::__call()

Parameters

$method

$args

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

__construct(\DOMElement $source, string $xpathPrefix, string $type) 

Parameters

$source

\DOMElement

$xpathPrefix

string

Passed from parent Entry object

$type

string

Nearly always Atom 1.0

Get the number of feed entries.

count() : void

Required by the Iterator interface.

Return the current entry

current() : void

Get a single author

getAuthor(int $index) : string | null
Inherited

inherited_from \Zend\Feed\Reader\Feed\Atom::getAuthor()

Parameters

$index

int

Returns

stringnull

Get an array with feed authors

getAuthors() : array
Inherited

inherited_from \Zend\Feed\Reader\Feed\Atom::getAuthors()

Returns

array

Get a link to the source website

getBaseUrl() : string | null
Inherited

inherited_from \Zend\Feed\Reader\Feed\Atom::getBaseUrl()

Returns

stringnull

Get all categories

getCategories() : \Zend\Feed\Reader\Collection\Category
Inherited

inherited_from \Zend\Feed\Reader\Feed\Atom::getCategories()

Returns

Get the copyright entry

getCopyright() : string | null
Inherited

inherited_from \Zend\Feed\Reader\Feed\Atom::getCopyright()

Returns

stringnull

Get the feed creation date

getDateCreated() : string | null
Inherited

inherited_from \Zend\Feed\Reader\Feed\Atom::getDateCreated()

Returns

stringnull

Get the feed modification date

getDateModified() : string | null
Inherited

inherited_from \Zend\Feed\Reader\Feed\Atom::getDateModified()

Returns

stringnull

Get the feed description

getDescription() : string | null
Inherited

inherited_from \Zend\Feed\Reader\Feed\Atom::getDescription()

Returns

stringnull

Get the DOM

getDomDocument() : \DOMDocument
Inherited

inherited_from \Zend\Feed\Reader\Feed\AbstractFeed::getDomDocument()
inherited_from \Zend\Feed\Reader\Feed\Atom::getDomDocument()

Returns

Get the DOMElement representing the items/feed element

getElement() : \DOMElement
Inherited

inherited_from \Zend\Feed\Reader\Feed\AbstractFeed::getElement()
inherited_from \Zend\Feed\Reader\Feed\Atom::getElement()

Returns

Get the Feed's encoding

getEncoding() : string
Inherited

inherited_from \Zend\Feed\Reader\Feed\AbstractFeed::getEncoding()
inherited_from \Zend\Feed\Reader\Feed\Atom::getEncoding()

Returns

string

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

getExtension(string $name) : \Zend\Feed\Reader\Extension\AbstractFeed
Inherited

inherited_from \Zend\Feed\Reader\Feed\AbstractFeed::getExtension()
inherited_from \Zend\Feed\Reader\Feed\Atom::getExtension()

Parameters

$name

string

Returns

getExtensions()

getExtensions() 
Inherited

inherited_from \Zend\Feed\Reader\Feed\AbstractFeed::getExtensions()
inherited_from \Zend\Feed\Reader\Feed\Atom::getExtensions()

Get the feed generator entry

getGenerator() : string | null
Inherited

inherited_from \Zend\Feed\Reader\Feed\Atom::getGenerator()

Returns

stringnull

Get an array of any supported Pusubhubbub endpoints

getHubs() : array | null
Inherited

inherited_from \Zend\Feed\Reader\Feed\Atom::getHubs()

Returns

arraynull

Get the feed ID

getId() : string | null
Inherited

inherited_from \Zend\Feed\Reader\Feed\Atom::getId()

Returns

stringnull

Get feed image data

getImage() : array | null
Inherited

inherited_from \Zend\Feed\Reader\Feed\Atom::getImage()

Returns

arraynull

Get the feed language

getLanguage() : string | null
Inherited

inherited_from \Zend\Feed\Reader\Feed\Atom::getLanguage()

Returns

stringnull

Get the feed lastBuild date.

getLastBuildDate() : string | null
Inherited

This is not implemented in Atom.

inherited_from \Zend\Feed\Reader\Feed\Atom::getLastBuildDate()

Returns

stringnull

Get an original source URI for the feed being parsed.

getOriginalSourceUri() : string | null
Inherited

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

inherited_from \Zend\Feed\Reader\Feed\AbstractFeed::getOriginalSourceUri()
inherited_from \Zend\Feed\Reader\Feed\Atom::getOriginalSourceUri()

Returns

stringnull

Get the feed title

getTitle() : string | null
Inherited

inherited_from \Zend\Feed\Reader\Feed\Atom::getTitle()

Returns

stringnull

Get the feed type

getType() : string
Inherited

inherited_from \Zend\Feed\Reader\Feed\AbstractFeed::getType()
inherited_from \Zend\Feed\Reader\Feed\Atom::getType()

Returns

string

Get the DOMXPath object for this feed

getXpath() : \DOMXPath
Inherited

inherited_from \Zend\Feed\Reader\Feed\AbstractFeed::getXpath()
inherited_from \Zend\Feed\Reader\Feed\Atom::getXpath()

Returns

Return the current feed key

key() : void

Reset the pointer in the feed object

rewind() : void

Get feed as xml

saveXml() : string
Inherited

inherited_from \Zend\Feed\Reader\Feed\AbstractFeed::saveXml()
inherited_from \Zend\Feed\Reader\Feed\Atom::saveXml()

Returns

string

Set an original source URI for the feed being parsed.

setOriginalSourceUri(string $uri) 
Inherited

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

inherited_from \Zend\Feed\Reader\Feed\AbstractFeed::setOriginalSourceUri()
inherited_from \Zend\Feed\Reader\Feed\Atom::setOriginalSourceUri()

Parameters

$uri

string

Check to see if the iterator is still valid

valid() : void

Read all entries to the internal entries array

indexEntries() : void

loadExtensions()

loadExtensions() 
Inherited

inherited_from \Zend\Feed\Reader\Feed\AbstractFeed::loadExtensions()
inherited_from \Zend\Feed\Reader\Feed\Atom::loadExtensions()

Register the default namespaces for the current feed format

registerNamespaces() 
Inherited

inherited_from \Zend\Feed\Reader\Feed\Atom::registerNamespaces()

 Properties

 

Parsed feed data

$data : array
Inherited

inherited_from \Zend\Feed\Reader\Feed\AbstractFeed::$$data
inherited_from \Zend\Feed\Reader\Feed\Atom::$$data
 

Parsed feed data in the shape of a DOMDocument

$domDocument : \DOMDocument
Inherited

inherited_from \Zend\Feed\Reader\Feed\AbstractFeed::$$domDocument
inherited_from \Zend\Feed\Reader\Feed\Atom::$$domDocument
 

An array of parsed feed entries

$entries : array
Inherited

inherited_from \Zend\Feed\Reader\Feed\AbstractFeed::$$entries
inherited_from \Zend\Feed\Reader\Feed\Atom::$$entries
 

A pointer for the iterator to keep track of the entries array

$entriesKey : int
Inherited

inherited_from \Zend\Feed\Reader\Feed\AbstractFeed::$$entriesKey
inherited_from \Zend\Feed\Reader\Feed\Atom::$$entriesKey
 

Array of loaded extensions

$extensions : array
Inherited

inherited_from \Zend\Feed\Reader\Feed\AbstractFeed::$$extensions
inherited_from \Zend\Feed\Reader\Feed\Atom::$$extensions
 

Original Source URI (set if imported from a URI)

$originalSourceUri : string
Inherited

inherited_from \Zend\Feed\Reader\Feed\AbstractFeed::$$originalSourceUri
inherited_from \Zend\Feed\Reader\Feed\Atom::$$originalSourceUri
 

The base XPath query used to retrieve feed data

$xpath : \DOMXPath
Inherited

inherited_from \Zend\Feed\Reader\Feed\AbstractFeed::$$xpath
inherited_from \Zend\Feed\Reader\Feed\Atom::$$xpath