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

\Zend_Feed_Reader_Extension_Atom_Feed
jump to top

Package: Zend\Feed\Reader
Parent(s)
\Zend_Feed_Reader_Extension_FeedAbstract
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_Extension_FeedAbstract::$$_data
Default valuearray()Details
Type
array
Inherited_from
\Zend_Feed_Reader_Extension_FeedAbstract::$$_data  
>VPropertyprotected\DOMDocument $_domDocument = null
inherited
Parsed feed data in the shape of a DOMDocument
Inherited from: \Zend_Feed_Reader_Extension_FeedAbstract::$$_domDocument
Default valuenullDetails
Type
\DOMDocument
Inherited_from
\Zend_Feed_Reader_Extension_FeedAbstract::$$_domDocument  
>VPropertyprotected\DOMXPath $_xpath = null
inherited
The base XPath query used to retrieve feed data
Inherited from: \Zend_Feed_Reader_Extension_FeedAbstract::$$_xpath
Default valuenullDetails
Type
\DOMXPath
Inherited_from
\Zend_Feed_Reader_Extension_FeedAbstract::$$_xpath  
>VPropertyprotectedstring $_xpathPrefix = ''
inherited
The XPath prefix
Inherited from: \Zend_Feed_Reader_Extension_FeedAbstract::$$_xpathPrefix
Default value''Details
Type
string
Inherited_from
\Zend_Feed_Reader_Extension_FeedAbstract::$$_xpathPrefix  

Methods

methodpublic__construct( $dom, string $type = null,  $xpath = null) : void
inherited

Constructor

Inherited from: \Zend_Feed_Reader_Extension_FeedAbstract::__construct()
Parameters
NameTypeDescription
$dom
$typestring

Feed type

$xpath
methodprotected_absolutiseUri( $link) : void

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.

Parameters
NameTypeDescription
$link
methodprotected_getAtomType() : void

Detect the presence of any Atom namespaces in use

methodprotected_getAuthor(\DOMElement $element) : string

Get an author entry in RSS format

Parameters
NameTypeDescription
$element\DOMElement
Returns
TypeDescription
string
methodprotected_registerNamespaces() : void

Register the default namespaces for the current feed format

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 the base URI of the feed (if set).

Returns
TypeDescription
string | null
methodpublicgetCategories() : \Zend_Feed_Reader_Collection_Category

Get all categories

Returns
TypeDescription
\Zend_Feed_Reader_Collection_Category
methodpublicgetCopyright() : string | null

Get the copyright entry

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

Get the feed creation date

Returns
TypeDescription
\Zend_Date | null
methodpublicgetDateModified() : \Zend_Date | null

Get the feed modification date

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

Get the feed description

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

Get the DOM

Inherited from: \Zend_Feed_Reader_Extension_FeedAbstract::getDomDocument()
Returns
TypeDescription
\DOMDocument
methodpublicgetEncoding() : string
inherited

Get the Feed's encoding

Inherited from: \Zend_Feed_Reader_Extension_FeedAbstract::getEncoding()
Returns
TypeDescription
string
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
methodpublicgetIcon() : array | null

Get the feed image

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

Get the feed ID

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

Get the feed image

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

Get the feed language

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

Get a link to the source website

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_Extension_FeedAbstract::getType()
Returns
TypeDescription
string
methodpublicgetXpath() : string
inherited

Get the DOMXPath object

Inherited from: \Zend_Feed_Reader_Extension_FeedAbstract::getXpath()
Returns
TypeDescription
string
methodpublicgetXpathPrefix() : string
inherited

Get the XPath prefix

Inherited from: \Zend_Feed_Reader_Extension_FeedAbstract::getXpathPrefix()
Returns
TypeDescription
string
methodpublicsetXpath(\DOMXPath $xpath) : \Zend_Feed_Reader_Extension_EntryAbstract
inherited

Set the XPath query

Inherited from: \Zend_Feed_Reader_Extension_FeedAbstract::setXpath()
Parameters
NameTypeDescription
$xpath\DOMXPath
Returns
TypeDescription
\Zend_Feed_Reader_Extension_EntryAbstract
methodpublicsetXpathPrefix( $prefix) : \Zend_Feed_Reader_Feed_Atom
inherited

Set the XPath prefix

Inherited from: \Zend_Feed_Reader_Extension_FeedAbstract::setXpathPrefix()
Parameters
NameTypeDescription
$prefix
Returns
TypeDescription
\Zend_Feed_Reader_Feed_Atom
methodpublictoArray() : array
inherited

Return the feed as an array

Inherited from: \Zend_Feed_Reader_Extension_FeedAbstract::toArray()
Returns
TypeDescription
array
Documentation was generated by phpDocumentor 2.0.0a12.