Zend\Feed\Reader\Feed\Atom\Source
Synopsis
class Source
extends Atom
{
- // Inherited members from AbstractFeed
- protected array $data;
- protected DOMDocument $domDocument;
- protected array $entries;
- protected integer $entriesKey;
- protected DOMXPath $xpath;
- protected array $extensions;
- protected string $originalSourceUri;
- // methods
- public void __construct()
- public void count()
- public void current()
- public void key()
- public void next()
- public void rewind()
- public void valid()
- protected void indexEntries()
- // Inherited methods from Atom
- public void __construct()
- public string|null getAuthor()
- public array getAuthors()
- public string|null getCopyright()
- public string|null getDateCreated()
- public string|null getDateModified()
- public string|null getLastBuildDate()
- public string|null getDescription()
- public string|null getGenerator()
- public string|null getId()
- public string|null getLanguage()
- public string|null getBaseUrl()
- public string|null getLink()
- public array|null getImage()
- public string|null getFeedLink()
- public string|null getTitle()
- public array|null getHubs()
- public Category getCategories()
- protected void indexEntries()
- protected void registerNamespaces()
- // Inherited methods from AbstractFeed
- public void __construct()
- public void setOriginalSourceUri()
- public string|null getOriginalSourceUri()
- public int count()
- public EntryInterface current()
- public DOMDocument getDomDocument()
- public string getEncoding()
- public string saveXml()
- public DOMElement getElement()
- public DOMXPath getXpath()
- public string getType()
- public int key()
- public void next()
- public void rewind()
- public bool valid()
- public void getExtensions()
- public void __call()
- public AbstractFeed getExtension()
- protected void loadExtensions()
- protected abstract void indexEntries()
- protected abstract void registerNamespaces()
Hierarchy
Extends
Members
protected
- $data
—
array
Parsed feed data - $domDocument
—
DOMDocument
Parsed feed data in the shape of a DOMDocument - $entries
—
array
An array of parsed feed entries - $entriesKey
—
int
A pointer for the iterator to keep track of the entries array - $extensions
—
array
Array of loaded extensions - $originalSourceUri
—
string
Original Source URI (set if imported from a URI) - $xpath
—
DOMXPath
The base XPath query used to retrieve feed data
Methods
protected
public
- __construct() — 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.
- count()
- current()
- key()
- next()
- rewind()
- valid()
Inherited from Zend\Feed\Reader\Feed\Atom
protected
- indexEntries() — Read all entries to the internal entries array
- registerNamespaces() — Register the default namespaces for the current feed format
public
- getAuthor() — Get a single author
- getAuthors() — Get an array with feed authors
- getBaseUrl() — Get a link to the source website
- getCategories() — Get all categories
- getCopyright() — Get the copyright entry
- getDateCreated() — Get the feed creation date
- getDateModified() — Get the feed modification date
- getDescription() — Get the feed description
- getFeedLink() — Get a link to the feed's XML Url
- getGenerator() — Get the feed generator entry
- getHubs() — Get an array of any supported Pusubhubbub endpoints
- getId() — Get the feed ID
- getImage() — Get feed image data
- getLanguage() — Get the feed language
- getLastBuildDate() — Get the feed lastBuild date. This is not implemented in Atom.
- getLink() — Get a link to the source website
- getTitle() — Get the feed title
Inherited from Zend\Feed\Reader\Feed\AbstractFeed
protected
- indexEntries() — Read all entries to the internal entries array
- loadExtensions()
- registerNamespaces() — Register the default namespaces for the current feed format
public
- __call()
- count() — Get the number of feed entries.
- current() — Return the current entry
- getDomDocument() — Get the DOM
- getElement() — Get the DOMElement representing the items/feed element
- getEncoding() — Get the Feed's encoding
- getExtension() — Return an Extension object with the matching name (postfixed with _Feed)
- getExtensions()
- getOriginalSourceUri() — Get an original source URI for the feed being parsed. Returns null if unset or the feed was not imported from a URI.
- getType() — Get the feed type
- getXpath() — Get the DOMXPath object for this feed
- key() — Return the current feed key
- next() — Move the feed pointer forward
- rewind() — Reset the pointer in the feed object
- saveXml() — Get feed as xml
- setOriginalSourceUri() — 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.
- valid() — Check to see if the iterator is still valid