Feed/Reader/FeedAbstract.php

Show:

inherited

Classes
- \Zend_Feed_Reader_FeedAbstract

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: FeedAbstract.php 25024 2012-07-30 15:08:15Z rob $

\Zend_Feed_Reader_FeedAbstract
jump to top

Package: Zend\Feed\Reader

Implements: \Zend_Feed_Reader_FeedInterface
Children: \Zend_Feed_Reader_Feed_Rss; \Zend_Feed_Reader_Feed_Atom
Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Properties

array $_data = array()

Parsed feed data

Default valuearray()Details

Type: array

\DOMDocument $_domDocument = null

Parsed feed data in the shape of a DOMDocument

Default valuenullDetails

Type: \DOMDocument

array $_entries = array()

An array of parsed feed entries

Default valuearray()Details

Type: array

int $_entriesKey = 0

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

Default value0Details

Type: int

array $_extensions = array()

Array of loaded extensions

Default valuearray()Details

Type: array

string $_originalSourceUri = null

Original Source URI (set if imported from a URI)

Default valuenullDetails

Type: string

\DOMXPath $_xpath = null

The base XPath query used to retrieve feed data

Default valuenullDetails

Type: \DOMXPath

Methods

__call( $method, $args) : void

Parameters

Name	Type	Description
$method
$args

__construct(\DomDocument $domDocument, string $type = null) : void

Constructor

Parameters

Name	Type	Description
$domDocument	\DomDocument	The DOM object for the feed's XML
$type	string	Feed type

_indexEntries() : void

abstract

Read all entries to the internal entries array

_loadExtensions() : void

_registerNamespaces() : void

abstract

count() : int

Get the number of feed entries.

Required by the Iterator interface.

Returns

Type	Description
int

current() : \Zend_Feed_Reader_EntryInterface

Return the current entry

Returns

Type	Description
\Zend_Feed_Reader_EntryInterface

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

inherited

Get a single author

Inherited from: \Zend_Feed_Reader_FeedInterface::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_FeedInterface::getAuthors()

Returns

Type	Description
array

getCategories() : \Zend_Feed_Reader_Collection_Category

inherited

Get all categories

Inherited from: \Zend_Feed_Reader_FeedInterface::getCategories()

Returns

Type	Description
\Zend_Feed_Reader_Collection_Category

getCopyright() : string | null

inherited

Get the copyright entry

Inherited from: \Zend_Feed_Reader_FeedInterface::getCopyright()

Returns

Type	Description
string \| null

getDateCreated() : string | null

inherited

Get the feed creation date

Inherited from: \Zend_Feed_Reader_FeedInterface::getDateCreated()

Returns

Type	Description
string \| null

getDateModified() : string | null

inherited

Get the feed modification date

Inherited from: \Zend_Feed_Reader_FeedInterface::getDateModified()

Returns

Type	Description
string \| null

getDescription() : string | null

inherited

Get the feed description

Inherited from: \Zend_Feed_Reader_FeedInterface::getDescription()

Returns

Type	Description
string \| null

getDomDocument() : \DOMDocument

Get the DOM

Returns

Type	Description
\DOMDocument

getElement() : \DOMElement

Get the DOMElement representing the items/feed element

Returns

Type	Description
\DOMElement

getEncoding() : string

Get the Feed's encoding

Returns

Type	Description
string

getExtension(string $name) : \Zend_Feed_Reader_Extension_FeedAbstract

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

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
\Zend_Feed_Reader_Extension_FeedAbstract

getExtensions() : void

getFeedLink() : string | null

inherited

Get a link to the XML feed

Inherited from: \Zend_Feed_Reader_FeedInterface::getFeedLink()

Returns

Type	Description
string \| null

getGenerator() : string | null

inherited

Get the feed generator entry

Inherited from: \Zend_Feed_Reader_FeedInterface::getGenerator()

Returns

Type	Description
string \| null

getId() : string | null

inherited

Get the feed ID

Inherited from: \Zend_Feed_Reader_FeedInterface::getId()

Returns

Type	Description
string \| null

getLanguage() : string | null

inherited

Get the feed language

Inherited from: \Zend_Feed_Reader_FeedInterface::getLanguage()

Returns

Type	Description
string \| null

getLink() : string | null

inherited

Get a link to the HTML source

Inherited from: \Zend_Feed_Reader_FeedInterface::getLink()

Returns

Type	Description
string \| null

getOriginalSourceUri() : string | null

Get an original source URI for the feed being parsed.

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_FeedInterface::getTitle()

Returns

Type	Description
string \| null

getType() : string

Get the feed type

Returns

Type	Description
string

getXpath() : \DOMXPath

Get the DOMXPath object for this feed

Returns

Type	Description
\DOMXPath

key() : \unknown

Return the current feed key

Returns

Type	Description
\unknown

next() : void

Move the feed pointer forward

rewind() : void

Reset the pointer in the feed object

saveXml() : string

Get feed as xml

Returns

Type	Description
string

setOriginalSourceUri(string $uri) : void

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.

Parameters

Name	Type	Description
$uri	string

valid() : boolean

Check to see if the iterator is still valid

Returns

Type	Description
boolean

Feed/Reader/FeedAbstract.php

\Zend_Feed_Reader_FeedAbstractjump to top

Properties

Methods

\Zend_Feed_Reader_FeedAbstract
jump to top