API Documentation

Feed/Reader/FeedAbstract.php

Includes Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Feed_Reader
version
$Id: FeedAbstract.php 22093 2010-05-04 12:55:06Z padraic $
Classes
Zend_Feed_Reader_FeedAbstract

Description

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.

Zend_Feed_Reader_FeedAbstract
jump to top

Implements
Zend_Feed_Reader_FeedInterface
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Feed_Reader
Properties
$_data
$_domDocument
$_entries
$_entriesKey
$_xpath
$_extensions
$_originalSourceUri
Methods
__construct
setOriginalSourceUri
getOriginalSourceUri
count
current
getDomDocument
getEncoding
saveXml
getElement
getXpath
getType
key
next
rewind
valid
getExtensions
__call
getExtension
_loadExtensions
_indexEntries
_registerNamespaces

Description

Properties

$_data
jump to class

array $_data = 'array'

Parsed feed data

Details

$_data
array
visibility
protected
default
array
final
false
static
false

$_domDocument
jump to class

DOMDocument $_domDocument = 'null'

Parsed feed data in the shape of a DOMDocument

Details

$_domDocument
DOMDocument
visibility
protected
default
null
final
false
static
false

$_entries
jump to class

array $_entries = 'array'

An array of parsed feed entries

Details

$_entries
array
visibility
protected
default
array
final
false
static
false

$_entriesKey
jump to class

int $_entriesKey = '0'

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

Details

$_entriesKey
int
visibility
protected
default
0
final
false
static
false

$_extensions
jump to class

array $_extensions = 'array'

Array of loaded extensions

Details

$_extensions
array
visibility
protected
default
array
final
false
static
false

$_originalSourceUri
jump to class

string $_originalSourceUri = 'null'

Original Source URI (set if imported from a URI)

Details

$_originalSourceUri
string
visibility
protected
default
null
final
false
static
false

$_xpath
jump to class

DOMXPath $_xpath = 'null'

The base XPath query used to retrieve feed data

Details

$_xpath
DOMXPath
visibility
protected
default
null
final
false
static
false

Methods

__call
jump to class

__call(  $method,  $args ) :
Arguments
$method
$args
Details
visibility
public
final
false
static
false

__construct
jump to class

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

Constructor

Arguments
$domDocument
DomDocument
The DOM object for the feed's XML
$type
string
Feed type
Details
visibility
public
final
false
static
false

_indexEntries
jump to class

_indexEntries( ) :

Read all entries to the internal entries array

Details
visibility
protected
final
false
static
false

_loadExtensions
jump to class

_loadExtensions( ) :
Details
visibility
protected
final
false
static
false

_registerNamespaces
jump to class

_registerNamespaces( ) :

Register the default namespaces for the current feed format

Details
visibility
protected
final
false
static
false

count
jump to class

count( ) : int

Get the number of feed entries.

Required by the Iterator interface.

Output
int
Details
visibility
public
final
false
static
false

current
jump to class

current( ) : Zend_Feed_Reader_EntryInterface

Return the current entry

Output
Zend_Feed_Reader_EntryInterface
Details
visibility
public
final
false
static
false

getDomDocument
jump to class

getDomDocument( ) : DOMDocument

Get the DOM

Output
DOMDocument
Details
visibility
public
final
false
static
false

getElement
jump to class

getElement( ) : DOMElement

Get the DOMElement representing the items/feed element

Output
DOMElement
Details
visibility
public
final
false
static
false

getEncoding
jump to class

getEncoding( ) : string

Get the Feed's encoding

Output
string
Details
visibility
public
final
false
static
false

getExtension
jump to class

getExtension( string $name ) : Zend_Feed_Reader_Extension_FeedAbstract

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

Arguments
$name
string
Output
Zend_Feed_Reader_Extension_FeedAbstract
Details
visibility
public
final
false
static
false

getExtensions
jump to class

getExtensions( ) :
Details
visibility
public
final
false
static
false

getOriginalSourceUri
jump to class

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.

Output
string|null
Details
visibility
public
final
false
static
false

getType
jump to class

getType( ) : string

Get the feed type

Output
string
Details
visibility
public
final
false
static
false

getXpath
jump to class

getXpath( ) : DOMXPath

Get the DOMXPath object for this feed

Output
DOMXPath
Details
visibility
public
final
false
static
false

key
jump to class

key( ) : unknown

Return the current feed key

Output
unknown
Details
visibility
public
final
false
static
false

next
jump to class

next( ) :

Move the feed pointer forward

Details
visibility
public
final
false
static
false

rewind
jump to class

rewind( ) :

Reset the pointer in the feed object

Details
visibility
public
final
false
static
false

saveXml
jump to class

saveXml( ) : string

Get feed as xml

Output
string
Details
visibility
public
final
false
static
false

setOriginalSourceUri
jump to class

setOriginalSourceUri( string $uri ) :

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.

Arguments
$uri
string
Details
visibility
public
final
false
static
false

valid
jump to class

valid( ) : boolean

Check to see if the iterator is still valid

Output
boolean
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.