Feed/Reader/Extension/Atom/Feed.php

Show:

inherited

Classes
- \Zend_Feed_Reader_Extension_Atom_Feed

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 [email protected] 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

array $_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

\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

\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

string $_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

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

inherited

Constructor

Inherited from: \Zend_Feed_Reader_Extension_FeedAbstract::__construct()

Parameters

Name	Type	Description
$dom
$type	string	Feed type
$xpath

_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

Name	Type	Description
$link

_getAtomType() : void

Detect the presence of any Atom namespaces in use

_getAuthor(\DOMElement $element) : string

Get an author entry in RSS format

Parameters

Name	Type	Description
$element	\DOMElement

Returns

Type	Description
string

_registerNamespaces() : void

getAuthor(int $index = 0) : string | null

Get a single author

Parameters

Name	Type	Description
$index	int

Returns

Type	Description
string \| null

getAuthors() : array

Get an array with feed authors

Returns

Type	Description
array

getBaseUrl() : string | null

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

Returns

Type	Description
string \| null

getCategories() : \Zend_Feed_Reader_Collection_Category

Get all categories

Returns

Type	Description
\Zend_Feed_Reader_Collection_Category

getCopyright() : string | null

Get the copyright entry

Returns

Type	Description
string \| null

getDateCreated() : \Zend_Date | null

Get the feed creation date

Returns

Type	Description
\Zend_Date \| null

getDateModified() : \Zend_Date | null

Get the feed modification date

Returns

Type	Description
\Zend_Date \| null

getDescription() : string | null

Get the feed description

Returns

Type	Description
string \| null

getDomDocument() : \DOMDocument

inherited

Get the DOM

Inherited from: \Zend_Feed_Reader_Extension_FeedAbstract::getDomDocument()

Returns

Type	Description
\DOMDocument

getEncoding() : string

inherited

Get the Feed's encoding

Inherited from: \Zend_Feed_Reader_Extension_FeedAbstract::getEncoding()

Returns

Type	Description
string

getFeedLink() : string | null

Get a link to the feed's XML Url

Returns

Type	Description
string \| null

getGenerator() : string | null

Get the feed generator entry

Returns

Type	Description
string \| null

getHubs() : array | null

Get an array of any supported Pusubhubbub endpoints

Returns

Type	Description
array \| null

getIcon() : array | null

Get the feed image

Returns

Type	Description
array \| null

getId() : string | null

Get the feed ID

Returns

Type	Description
string \| null

getImage() : array | null

Get the feed image

Returns

Type	Description
array \| null

getLanguage() : string | null

Get the feed language

Returns

Type	Description
string \| null

getLink() : string | null

Get a link to the source website

Returns

Type	Description
string \| null

getTitle() : string | null

Get the feed title

Returns

Type	Description
string \| null

getType() : string

inherited

Get the feed type

Inherited from: \Zend_Feed_Reader_Extension_FeedAbstract::getType()

Returns

Type	Description
string

getXpath() : string

inherited

Get the DOMXPath object

Inherited from: \Zend_Feed_Reader_Extension_FeedAbstract::getXpath()

Returns

Type	Description
string

getXpathPrefix() : string

inherited

Get the XPath prefix

Inherited from: \Zend_Feed_Reader_Extension_FeedAbstract::getXpathPrefix()

Returns

Type	Description
string

setXpath(\DOMXPath $xpath) : \Zend_Feed_Reader_Extension_EntryAbstract

inherited

Set the XPath query

Inherited from: \Zend_Feed_Reader_Extension_FeedAbstract::setXpath()

Parameters

Name	Type	Description
$xpath	\DOMXPath

Returns

Type	Description
\Zend_Feed_Reader_Extension_EntryAbstract

setXpathPrefix( $prefix) : \Zend_Feed_Reader_Feed_Atom

inherited

Set the XPath prefix

Inherited from: \Zend_Feed_Reader_Extension_FeedAbstract::setXpathPrefix()

Parameters

Name	Type	Description
$prefix

Returns

Type	Description
\Zend_Feed_Reader_Feed_Atom

toArray() : array

inherited

Return the feed as an array

Inherited from: \Zend_Feed_Reader_Extension_FeedAbstract::toArray()

Returns

Type	Description
array

Feed/Reader/Extension/Atom/Feed.php

\Zend_Feed_Reader_Extension_Atom_Feedjump to top

Properties

Methods

\Zend_Feed_Reader_Extension_Atom_Feed
jump to top