Feed/Reader/Feed/Atom/Source.php

Show:

inherited

Classes
- \Zend_Feed_Reader_Feed_Atom_Source

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: Source.php 24593 2012-01-05 20:35:02Z matthew $

\Zend_Feed_Reader_Feed_Atom_Source
jump to top

Package: Zend\Feed\Reader

Parent(s): \Zend_Feed_Reader_Feed_Atom < \Zend_Feed_Reader_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_FeedAbstract::$$_data \Zend_Feed_Reader_Feed_Atom::$$_data

Default valuearray()Details

Type: array
Inherited_from: \Zend_Feed_Reader_FeedAbstract::$$_data
Inherited_from: \Zend_Feed_Reader_Feed_Atom::$$_data

\DOMDocument $_domDocument = null

inherited

Parsed feed data in the shape of a DOMDocument

Inherited from: \Zend_Feed_Reader_FeedAbstract::$$_domDocument \Zend_Feed_Reader_Feed_Atom::$$_domDocument

Default valuenullDetails

Type: \DOMDocument
Inherited_from: \Zend_Feed_Reader_FeedAbstract::$$_domDocument
Inherited_from: \Zend_Feed_Reader_Feed_Atom::$$_domDocument

array $_entries = array()

inherited

An array of parsed feed entries

Inherited from: \Zend_Feed_Reader_FeedAbstract::$$_entries \Zend_Feed_Reader_Feed_Atom::$$_entries

Default valuearray()Details

Type: array
Inherited_from: \Zend_Feed_Reader_FeedAbstract::$$_entries
Inherited_from: \Zend_Feed_Reader_Feed_Atom::$$_entries

int $_entriesKey = 0

inherited

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

Inherited from: \Zend_Feed_Reader_FeedAbstract::$$_entriesKey \Zend_Feed_Reader_Feed_Atom::$$_entriesKey

Default value0Details

Type: int
Inherited_from: \Zend_Feed_Reader_FeedAbstract::$$_entriesKey
Inherited_from: \Zend_Feed_Reader_Feed_Atom::$$_entriesKey

array $_extensions = array()

inherited

Array of loaded extensions

Inherited from: \Zend_Feed_Reader_FeedAbstract::$$_extensions \Zend_Feed_Reader_Feed_Atom::$$_extensions

Default valuearray()Details

Type: array
Inherited_from: \Zend_Feed_Reader_FeedAbstract::$$_extensions
Inherited_from: \Zend_Feed_Reader_Feed_Atom::$$_extensions

string $_originalSourceUri = null

inherited

Original Source URI (set if imported from a URI)

Inherited from: \Zend_Feed_Reader_FeedAbstract::$$_originalSourceUri \Zend_Feed_Reader_Feed_Atom::$$_originalSourceUri

Default valuenullDetails

Type: string
Inherited_from: \Zend_Feed_Reader_FeedAbstract::$$_originalSourceUri
Inherited_from: \Zend_Feed_Reader_Feed_Atom::$$_originalSourceUri

\DOMXPath $_xpath = null

inherited

The base XPath query used to retrieve feed data

Inherited from: \Zend_Feed_Reader_FeedAbstract::$$_xpath \Zend_Feed_Reader_Feed_Atom::$$_xpath

Default valuenullDetails

Type: \DOMXPath
Inherited_from: \Zend_Feed_Reader_FeedAbstract::$$_xpath
Inherited_from: \Zend_Feed_Reader_Feed_Atom::$$_xpath

Methods

__call( $method, $args) : void

inherited

Inherited from: \Zend_Feed_Reader_FeedAbstract::__call()\Zend_Feed_Reader_Feed_Atom::__call()

Parameters

Name	Type	Description
$method
$args

__construct(\DOMElement $source, string $xpathPrefix, string $type = \Zend_Feed_Reader::TYPE_ATOM_10) : void

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

Parameters

Name	Type	Description
$source	\DOMElement
$xpathPrefix	string	Passed from parent Entry object
$type	string	Nearly always Atom 1.0

_indexEntries() : void

Read all entries to the internal entries array

_loadExtensions() : void

inherited

Inherited from: \Zend_Feed_Reader_FeedAbstract::_loadExtensions()\Zend_Feed_Reader_Feed_Atom::_loadExtensions()

_registerNamespaces() : void

inherited

Inherited from: \Zend_Feed_Reader_Feed_Atom::_registerNamespaces()

count() : void

Get the number of feed entries.

Required by the Iterator interface.

current() : void

Return the current entry

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

inherited

Get a single author

Inherited from: \Zend_Feed_Reader_Feed_Atom::getAuthor()

Parameters

Name	Type	Description
$index	int

Returns

Type	Description
string \| null

getAuthors() : array

inherited

Get an array with feed authors

Inherited from: \Zend_Feed_Reader_Feed_Atom::getAuthors()

Returns

Type	Description
array

getBaseUrl() : string | null

inherited

Get a link to the source website

Inherited from: \Zend_Feed_Reader_Feed_Atom::getBaseUrl()

Returns

Type	Description
string \| null

getCategories() : \Zend_Feed_Reader_Collection_Category

inherited

Get all categories

Inherited from: \Zend_Feed_Reader_Feed_Atom::getCategories()

Returns

Type	Description
\Zend_Feed_Reader_Collection_Category

getCopyright() : string | null

inherited

Get the copyright entry

Inherited from: \Zend_Feed_Reader_Feed_Atom::getCopyright()

Returns

Type	Description
string \| null

getDateCreated() : string | null

inherited

Get the feed creation date

Inherited from: \Zend_Feed_Reader_Feed_Atom::getDateCreated()

Returns

Type	Description
string \| null

getDateModified() : string | null

inherited

Get the feed modification date

Inherited from: \Zend_Feed_Reader_Feed_Atom::getDateModified()

Returns

Type	Description
string \| null

getDescription() : string | null

inherited

Get the feed description

Inherited from: \Zend_Feed_Reader_Feed_Atom::getDescription()

Returns

Type	Description
string \| null

getDomDocument() : \DOMDocument

inherited

Get the DOM

Inherited from: \Zend_Feed_Reader_FeedAbstract::getDomDocument()\Zend_Feed_Reader_Feed_Atom::getDomDocument()

Returns

Type	Description
\DOMDocument

getElement() : \DOMElement

inherited

Get the DOMElement representing the items/feed element

Inherited from: \Zend_Feed_Reader_FeedAbstract::getElement()\Zend_Feed_Reader_Feed_Atom::getElement()

Returns

Type	Description
\DOMElement

getEncoding() : string

inherited

Get the Feed's encoding

Inherited from: \Zend_Feed_Reader_FeedAbstract::getEncoding()\Zend_Feed_Reader_Feed_Atom::getEncoding()

Returns

Type	Description
string

getExtension(string $name) : \Zend_Feed_Reader_Extension_FeedAbstract

inherited

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

Inherited from: \Zend_Feed_Reader_FeedAbstract::getExtension()\Zend_Feed_Reader_Feed_Atom::getExtension()

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
\Zend_Feed_Reader_Extension_FeedAbstract

getExtensions() : void

inherited

Inherited from: \Zend_Feed_Reader_FeedAbstract::getExtensions()\Zend_Feed_Reader_Feed_Atom::getExtensions()

getFeedLink() : string | null

inherited

Get a link to the feed's XML Url

Inherited from: \Zend_Feed_Reader_Feed_Atom::getFeedLink()

Returns

Type	Description
string \| null

getGenerator() : string | null

inherited

Get the feed generator entry

Inherited from: \Zend_Feed_Reader_Feed_Atom::getGenerator()

Returns

Type	Description
string \| null

getHubs() : array | null

inherited

Get an array of any supported Pusubhubbub endpoints

Inherited from: \Zend_Feed_Reader_Feed_Atom::getHubs()

Returns

Type	Description
array \| null

getId() : string | null

inherited

Get the feed ID

Inherited from: \Zend_Feed_Reader_Feed_Atom::getId()

Returns

Type	Description
string \| null

getImage() : array | null

inherited

Get feed image data

Inherited from: \Zend_Feed_Reader_Feed_Atom::getImage()

Returns

Type	Description
array \| null

getLanguage() : string | null

inherited

Get the feed language

Inherited from: \Zend_Feed_Reader_Feed_Atom::getLanguage()

Returns

Type	Description
string \| null

getLastBuildDate() : string | null

inherited

Get the feed lastBuild date.

Inherited from: \Zend_Feed_Reader_Feed_Atom::getLastBuildDate()

This is not implemented in Atom.

Returns

Type	Description
string \| null

getLink() : string | null

inherited

Get a link to the source website

Inherited from: \Zend_Feed_Reader_Feed_Atom::getLink()

Returns

Type	Description
string \| null

getOriginalSourceUri() : string | null

inherited

Get an original source URI for the feed being parsed.

Inherited from: \Zend_Feed_Reader_FeedAbstract::getOriginalSourceUri()\Zend_Feed_Reader_Feed_Atom::getOriginalSourceUri()

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

Returns

Type	Description
string \| null

getTitle() : string | null

inherited

Get the feed title

Inherited from: \Zend_Feed_Reader_Feed_Atom::getTitle()

Returns

Type	Description
string \| null

getType() : string

inherited

Get the feed type

Inherited from: \Zend_Feed_Reader_FeedAbstract::getType()\Zend_Feed_Reader_Feed_Atom::getType()

Returns

Type	Description
string

getXpath() : \DOMXPath

inherited

Get the DOMXPath object for this feed

Inherited from: \Zend_Feed_Reader_FeedAbstract::getXpath()\Zend_Feed_Reader_Feed_Atom::getXpath()

Returns

Type	Description
\DOMXPath

key() : void

Return the current feed key

next() : void

Move the feed pointer forward

rewind() : void

Reset the pointer in the feed object

saveXml() : string

inherited

Get feed as xml

Inherited from: \Zend_Feed_Reader_FeedAbstract::saveXml()\Zend_Feed_Reader_Feed_Atom::saveXml()

Returns

Type	Description
string

setOriginalSourceUri(string $uri) : void

inherited

Set an original source URI for the feed being parsed.

Inherited from: \Zend_Feed_Reader_FeedAbstract::setOriginalSourceUri()\Zend_Feed_Reader_Feed_Atom::setOriginalSourceUri()

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

Parameters

Name	Type	Description
$uri	string

valid() : void

Check to see if the iterator is still valid

Feed/Reader/Feed/Atom/Source.php

\Zend_Feed_Reader_Feed_Atom_Sourcejump to top

Properties

Methods

\Zend_Feed_Reader_Feed_Atom_Source
jump to top