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

 Methods

Add prefix path for loading Extensions

addPrefixPath(string $prefix, string $path) : void
Static

Parameters

$prefix

string

$path

string

Add multiple Extension prefix paths at once

addPrefixPaths(array $spec) : void
Static

Parameters

$spec

array

Utility method to apply array_unique operation to a multidimensional array.

arrayUnique(array $array) : array
Static

Parameters

$array

Returns

array

Detect the feed type of the provided feed

detectType(\Zend_Feed_Abstract|\DOMDocument|string $feed, boolean $specOnly = false) : string
Static

Parameters

$feed

\Zend_Feed_Abstract\DOMDocumentstring

$specOnly

boolean

Exceptions

\Zend_Feed_Exception

Returns

string

Get the Feed cache

getCache() : \Zend_Cache_Core
Static

Returns

\Zend_Cache_Core

Get a list of extensions

getExtensions() : array
Static

Returns

array

Gets the HTTP client object. If none is set, a new Zend_Http_Client will be used.

getHttpClient() : \Zend_Http_Client_Abstract
Static

Returns

\Zend_Http_Client_Abstract

Get the HTTP override state

getHttpMethodOverride() : boolean
Static

Returns

boolean

Get plugin loader for use with Extensions

getPluginLoader() : \Zend_Loader_PluginLoader_Interface
Static

Returns

\Zend_Loader_PluginLoader_Interface$loader

Import a feed by providing a URL

import($uri, string $etag = null, string $lastModified = null) : \Zend_Feed_Reader_FeedInterface
Static

Parameters

$uri

$etag

string

OPTIONAL Last received ETag for this resource

$lastModified

string

OPTIONAL Last-Modified value for this resource

Returns

\Zend_Feed_Reader_FeedInterface

Import a feed by providing a Zend_Feed_Abstract object

importFeed(\Zend_Feed_Abstract $feed) : \Zend_Feed_Reader_FeedInterface
Static

Parameters

$feed

\Zend_Feed_Abstract

A fully instantiated Zend_Feed object

Returns

\Zend_Feed_Reader_FeedInterface

Imports a feed from a file located at $filename.

importFile(string $filename) : \Zend_Feed_Reader_FeedInterface
Static

Parameters

$filename

string

Exceptions

\Zend_Feed_Exception

Returns

\Zend_Feed_Reader_FeedInterface

Import a feed from a string

importString(string $string) : \Zend_Feed_Reader_FeedInterface
Static

Parameters

$string

string

Returns

\Zend_Feed_Reader_FeedInterface

Is a given named Extension registered?

isRegistered(string $extensionName) : boolean
Static

Parameters

$extensionName

string

Returns

boolean

Register an Extension by name

registerExtension(string $name) : void
Static

Parameters

$name

string

Exceptions

\Zend_Feed_Exception if unable to resolve Extension class

Reset class state to defaults

reset() : void
Static

Set the feed cache

setCache(\Zend_Cache_Core $cache) : void
Static

Parameters

$cache

\Zend_Cache_Core

Set the HTTP client instance

setHttpClient(\Zend_Http_Client $httpClient) : void
Static

Sets the HTTP client object to use for retrieving the feeds.

Parameters

$httpClient

\Zend_Http_Client

Toggle using POST instead of PUT and DELETE HTTP methods

setHttpMethodOverride(boolean $override = true) : void
Static

Some feed implementations do not accept PUT and DELETE HTTP methods, or they can't be used because of proxies or other measures. This allows turning on using POST where PUT and DELETE would normally be used; in addition, an X-Method-Override header will be sent with a value of PUT or DELETE as appropriate.

Parameters

$override

boolean

Whether to override PUT and DELETE.

Set plugin loader for use with Extensions

setPluginLoader(\Zend_Loader_PluginLoader_Interface $loader) 
Static

Parameters

$loader

\Zend_Loader_PluginLoader_Interface

Set the flag indicating whether or not to use HTTP conditional GET

useHttpConditionalGet(boolean $bool = true) : void
Static

Parameters

$bool

boolean

Register core (default) extensions

_registerCoreExtensions() : void
Static

 Properties

 

Cache instance

$_cache : \Zend_Cache_Core

Default

null
Static
 

$_extensions

$_extensions 

Default

array('feed' => array('DublinCore_Feed', 'Atom_Feed'), 'entry' => array('Content_Entry', 'DublinCore_Entry', 'Atom_Entry'), 'core' => array('DublinCore_Feed', 'Atom_Feed', 'Content_Entry', 'DublinCore_Entry', 'Atom_Entry'))
Static
 

HTTP client object to use for retrieving feeds

$_httpClient : \Zend_Http_Client

Default

null
Static
 

$_httpConditionalGet

$_httpConditionalGet 

Default

false
Static
 

Override HTTP PUT and DELETE request methods?

$_httpMethodOverride : boolean

Default

false
Static
 

$_pluginLoader

$_pluginLoader 

Default

null
Static
 

$_prefixPaths

$_prefixPaths 

Default

array()
Static

 Constants

 

Namespace constants

NAMESPACE_ATOM_03 = 'http://purl.org/atom/ns#' 
 

NAMESPACE_ATOM_10

NAMESPACE_ATOM_10 = 'http://www.w3.org/2005/Atom' 
 

NAMESPACE_RDF

NAMESPACE_RDF = 'http://www.w3.org/1999/02/22-rdf-syntax-ns#' 
 

NAMESPACE_RSS_090

NAMESPACE_RSS_090 = 'http://my.netscape.com/rdf/simple/0.9/' 
 

NAMESPACE_RSS_10

NAMESPACE_RSS_10 = 'http://purl.org/rss/1.0/' 
 

Feed type constants

TYPE_ANY = 'any' 
 

TYPE_ATOM_03

TYPE_ATOM_03 = 'atom-03' 
 

TYPE_ATOM_10

TYPE_ATOM_10 = 'atom-10' 
 

TYPE_ATOM_10_ENTRY

TYPE_ATOM_10_ENTRY = 'atom-10-entry' 
 

TYPE_ATOM_ANY

TYPE_ATOM_ANY = 'atom' 
 

TYPE_RSS_090

TYPE_RSS_090 = 'rss-090' 
 

TYPE_RSS_091

TYPE_RSS_091 = 'rss-091' 
 

TYPE_RSS_091_NETSCAPE

TYPE_RSS_091_NETSCAPE = 'rss-091n' 
 

TYPE_RSS_091_USERLAND

TYPE_RSS_091_USERLAND = 'rss-091u' 
 

TYPE_RSS_092

TYPE_RSS_092 = 'rss-092' 
 

TYPE_RSS_093

TYPE_RSS_093 = 'rss-093' 
 

TYPE_RSS_094

TYPE_RSS_094 = 'rss-094' 
 

TYPE_RSS_10

TYPE_RSS_10 = 'rss-10' 
 

TYPE_RSS_20

TYPE_RSS_20 = 'rss-20' 
 

TYPE_RSS_ANY

TYPE_RSS_ANY = 'rss'