API Documentation

Zend/Feed/Reader/FeedAbstract.php

Show: inherited
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 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Feed_Reader_FeedAbstract

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

Propertyprotectedarray  $_data= 'array()'

Parsed feed data

Default valuearray()Details
Type
array
Propertyprotected\DOMDocument  $_domDocument= 'null'

Parsed feed data in the shape of a DOMDocument

Default valuenullDetails
Type
\DOMDocument
Propertyprotectedarray  $_entries= 'array()'

An array of parsed feed entries

Default valuearray()Details
Type
array
Propertyprotectedint  $_entriesKey= '0'

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

Default value0Details
Type
int
Propertyprotectedarray  $_extensions= 'array()'

Array of loaded extensions

Default valuearray()Details
Type
array
Propertyprotectedstring  $_originalSourceUri= 'null'

Original Source URI (set if imported from a URI)

Default valuenullDetails
Type
string
Propertyprotected\DOMXPath  $_xpath= 'null'

The base XPath query used to retrieve feed data

Default valuenullDetails
Type
\DOMXPath

Methods

methodpublic__call(  $method,  $args ) : void

Parameters
Name Type Description
$method
$args
methodpublic__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

methodprotected_indexEntries( ) : void
abstract

Read all entries to the internal entries array

methodprotected_loadExtensions( ) : void

methodprotected_registerNamespaces( ) : void
abstract

Register the default namespaces for the current feed format

methodpubliccount( ) : int

Get the number of feed entries.

Required by the Iterator interface.

Returns
Type Description
int
methodpubliccurrent( ) : \Zend_Feed_Reader_EntryInterface

Return the current entry

Returns
Type Description
\Zend_Feed_Reader_EntryInterface
methodpublicgetDomDocument( ) : \DOMDocument

Get the DOM

Returns
Type Description
\DOMDocument
methodpublicgetElement( ) : \DOMElement

Get the DOMElement representing the items/feed element

Returns
Type Description
\DOMElement
methodpublicgetEncoding( ) : string

Get the Feed's encoding

Returns
Type Description
string
methodpublicgetExtension( 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
methodpublicgetExtensions( ) : void

methodpublicgetOriginalSourceUri( ) : 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
methodpublicgetType( ) : string

Get the feed type

Returns
Type Description
string
methodpublicgetXpath( ) : \DOMXPath

Get the DOMXPath object for this feed

Returns
Type Description
\DOMXPath
methodpublickey( ) : \unknown

Return the current feed key

Returns
Type Description
\unknown
methodpublicnext( ) : void

Move the feed pointer forward

methodpublicrewind( ) : void

Reset the pointer in the feed object

methodpublicsaveXml( ) : string

Get feed as xml

Returns
Type Description
string
methodpublicsetOriginalSourceUri( 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
methodpublicvalid( ) : boolean

Check to see if the iterator is still valid

Returns
Type Description
boolean
Documentation was generated by DocBlox 0.15.1.