API Documentation

Feed/Reader/Extension/Syndication/Feed.php

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-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Feed_Reader  
version
$Id: Feed.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_Feed_Reader_Extension_Syndication_Feed

Extends from
\Zend_Feed_Reader_Extension_FeedAbstract
category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Feed_Reader  

Methods

methodpublic__construct(  $dom, string $type = null,  $xpath = null ) : void
Parameters
Name Type Description
$dom
$type string Feed type
$xpath
methodprivate_getData( string $name, string $type = string ) : mixed|null

Get the entry data specified by name

Parameters
Name Type Description
$name string
$type string
Returns
Type Description
mixednull
methodprotected_registerNamespaces( ) : void

Register Syndication namespaces

methodpublicgetDomDocument( ) : \DOMDocument
Returns
Type Description
\DOMDocument
methodpublicgetEncoding( ) : string

Get the Feed's encoding

Inherited from: \Zend_Feed_Reader_Extension_FeedAbstract::getEncoding()
Returns
Type Description
string
methodpublicgetType( ) : string

Get the feed type

Inherited from: \Zend_Feed_Reader_Extension_FeedAbstract::getType()
Returns
Type Description
string
methodpublicgetUpdateBase( ) : \Zend_Date|null

Get update base

Returns
Type Description
\Zend_Datenull
methodpublicgetUpdateFrequency( ) : int

Get update frequency

Returns
Type Description
int
methodpublicgetUpdateFrequencyAsTicks( ) : int

Get update frequency as ticks

Returns
Type Description
int
methodpublicgetUpdatePeriod( ) : string

Get update period

Returns
Type Description
string
methodpublicgetXpath( ) : string

Get the DOMXPath object

Inherited from: \Zend_Feed_Reader_Extension_FeedAbstract::getXpath()
Returns
Type Description
string
methodpublicgetXpathPrefix( ) : string

Get the XPath prefix

Inherited from: \Zend_Feed_Reader_Extension_FeedAbstract::getXpathPrefix()
Returns
Type Description
string
methodpublicsetXpath( \DOMXPath $xpath ) : \Zend_Feed_Reader_Extension_EntryAbstract

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
methodpublicsetXpathPrefix(  $prefix ) : \Zend_Feed_Reader_Feed_Atom

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
methodpublictoArray( ) : array

Return the feed as an array

Inherited from: \Zend_Feed_Reader_Extension_FeedAbstract::toArray()
Returns
Type Description
array
Documentation was generated by DocBlox 0.13.3.