Zend Framework  3.0
Public Member Functions | Protected Member Functions | List of all members
Feed Class Reference

Public Member Functions

 getAuthor ($index=0)
 Get a single author.
 
 getAuthors ()
 Get an array with feed authors.
 
 getCopyright ()
 Get the copyright entry.
 
 getDateCreated ()
 Get the feed creation date.
 
 getDateModified ()
 Get the feed modification date.
 
 getDescription ()
 Get the feed description.
 
 getGenerator ()
 Get the feed generator entry.
 
 getId ()
 Get the feed ID.
 
 getLanguage ()
 Get the feed language.
 
 getImage ()
 Get the feed image.
 
 getBaseUrl ()
 Get the base URI of the feed (if set).
 
 getLink ()
 Get a link to the source website.
 
 getFeedLink ()
 Get a link to the feed's XML Url.
 
 getHubs ()
 Get an array of any supported Pusubhubbub endpoints.
 
 getTitle ()
 Get the feed title.
 
 getCategories ()
 Get all categories.
 
- Public Member Functions inherited from AbstractFeed
 __construct (DOMDocument $domDocument, $type=null)
 Constructor.
 
 setOriginalSourceUri ($uri)
 Set an original source URI for the feed being parsed.
 
 getOriginalSourceUri ()
 Get an original source URI for the feed being parsed.
 
 count ()
 Get the number of feed entries.
 
 current ()
 Return the current entry.
 
 getDomDocument ()
 Get the DOM.
 
 getEncoding ()
 Get the Feed's encoding.
 
 saveXml ()
 Get feed as xml.
 
 getElement ()
 Get the DOMElement representing the items/feed element.
 
 getXpath ()
 Get the DOMXPath object for this feed.
 
 getType ()
 Get the feed type.
 
 key ()
 Return the current feed key.
 
 next ()
 Move the feed pointer forward.
 
 rewind ()
 Reset the pointer in the feed object.
 
 valid ()
 Check to see if the iterator is still valid.
 
 getExtensions ()
 
 __call ($method, $args)
 
 getExtension ($name)
 Return an Extension object with the matching name (postfixed with _Feed)
 

Protected Member Functions

 getAuthorFromElement (DOMElement $element)
 Get an author entry in RSS format.
 
 absolutiseUri ($link)
 Attempt to absolutise the URI, i.e.
 
 registerNamespaces ()
 Register the default namespaces for the current feed format.
 
 getAtomType ()
 Detect the presence of any Atom namespaces in use.
 
- Protected Member Functions inherited from AbstractFeed
 loadExtensions ()
 
 indexEntries ()
 Read all entries to the internal entries array.
 
 registerNamespaces ()
 Register the default namespaces for the current feed format.
 

Additional Inherited Members

- Protected Attributes inherited from AbstractFeed
 $data = []
 
 $domDocument = null
 
 $entries = []
 
 $entriesKey = 0
 
 $xpath = null
 
 $extensions = []
 
 $originalSourceUri = null
 

Member Function Documentation

absolutiseUri (   $link)
protected

Attempt to absolutise the URI, i.e.

if a relative URI apply the xml:base value as a prefix to turn into an absolute URI.

getAtomType ( )
protected

Detect the presence of any Atom namespaces in use.

getAuthor (   $index = 0)

Get a single author.

Parameters
int$index
Returns
string|null

Implements FeedInterface.

getAuthorFromElement ( DOMElement  $element)
protected

Get an author entry in RSS format.

Parameters
DOMElement$element
Returns
string
getAuthors ( )

Get an array with feed authors.

Returns
Collection

Implements FeedInterface.

getBaseUrl ( )

Get the base URI of the feed (if set).

Returns
string|null
getCategories ( )

Get all categories.

Returns
Collection

Since Atom 0.3 did not support categories, it would have used the Dublin Core extension. However there is a small possibility Atom 0.3 may have been retrofittied to use Atom 1.0 instead.

Implements FeedInterface.

getCopyright ( )

Get the copyright entry.

Returns
string|null

Implements FeedInterface.

getDateCreated ( )

Get the feed creation date.

Returns
DateTime|null

Implements FeedInterface.

getDateModified ( )

Get the feed modification date.

Returns
DateTime|null

Implements FeedInterface.

getDescription ( )

Get the feed description.

Returns
string|null

Implements FeedInterface.

getFeedLink ( )

Get a link to the feed's XML Url.

Returns
string|null

Implements FeedInterface.

getGenerator ( )

Get the feed generator entry.

Returns
string|null

Implements FeedInterface.

getHubs ( )

Get an array of any supported Pusubhubbub endpoints.

Returns
array|null
getId ( )

Get the feed ID.

Returns
string|null

Implements FeedInterface.

getImage ( )

Get the feed image.

Returns
array|null
getLanguage ( )

Get the feed language.

Returns
string|null

Implements FeedInterface.

getLink ( )

Get a link to the source website.

Returns
string|null

Implements FeedInterface.

getTitle ( )

Get the feed title.

Returns
string|null

Implements FeedInterface.

registerNamespaces ( )
protected

Register the default namespaces for the current feed format.