Feed/Reader.php

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: Reader.php 22093 2010-05-04 12:55:06Z padraic $
Classes: Zend_Feed_Reader

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
jump to top

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
Constants: NAMESPACE_ATOM_03; NAMESPACE_ATOM_10; NAMESPACE_RDF; NAMESPACE_RSS_090; NAMESPACE_RSS_10; TYPE_ANY; TYPE_ATOM_03; TYPE_ATOM_10; TYPE_ATOM_10_ENTRY; TYPE_ATOM_ANY; TYPE_RSS_090; TYPE_RSS_091; TYPE_RSS_091_NETSCAPE; TYPE_RSS_091_USERLAND; TYPE_RSS_092; TYPE_RSS_093; TYPE_RSS_094; TYPE_RSS_10; TYPE_RSS_20; TYPE_RSS_ANY
Properties: $_cache; $_httpClient; $_httpMethodOverride; $_httpConditionalGet; $_pluginLoader; $_prefixPaths; $_extensions
Methods: getCache; setCache; setHttpClient; getHttpClient; setHttpMethodOverride; getHttpMethodOverride; useHttpConditionalGet; import; importFeed; importString; importFile; findFeedLinks; detectType; setPluginLoader; getPluginLoader; addPrefixPath; addPrefixPaths; registerExtension; isRegistered; getExtensions; reset; _registerCoreExtensions; arrayUnique

Description

Constants

NAMESPACE_ATOM_03
jump to class

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

Namespace constants

Details

value: http://purl.org/atom/ns#

NAMESPACE_ATOM_10
jump to class

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

Details

value: http://www.w3.org/2005/Atom

NAMESPACE_RDF
jump to class

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

Details

value: http://www.w3.org/1999/02/22-rdf-syntax-ns#

NAMESPACE_RSS_090
jump to class

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

Details

value: http://my.netscape.com/rdf/simple/0.9/

NAMESPACE_RSS_10
jump to class

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

Details

value: http://purl.org/rss/1.0/

TYPE_ANY
jump to class

 TYPE_ANY = 'any'

Feed type constants

Details

value: any

TYPE_ATOM_03
jump to class

 TYPE_ATOM_03 = 'atom-03'

Details

value: atom-03

TYPE_ATOM_10
jump to class

 TYPE_ATOM_10 = 'atom-10'

Details

value: atom-10

TYPE_ATOM_10_ENTRY
jump to class

 TYPE_ATOM_10_ENTRY = 'atom-10-entry'

Details

value: atom-10-entry

TYPE_ATOM_ANY
jump to class

 TYPE_ATOM_ANY = 'atom'

Details

value: atom

TYPE_RSS_090
jump to class

 TYPE_RSS_090 = 'rss-090'

Details

value: rss-090

TYPE_RSS_091
jump to class

 TYPE_RSS_091 = 'rss-091'

Details

value: rss-091

TYPE_RSS_091_NETSCAPE
jump to class

 TYPE_RSS_091_NETSCAPE = 'rss-091n'

Details

value: rss-091n

TYPE_RSS_091_USERLAND
jump to class

 TYPE_RSS_091_USERLAND = 'rss-091u'

Details

value: rss-091u

TYPE_RSS_092
jump to class

 TYPE_RSS_092 = 'rss-092'

Details

value: rss-092

TYPE_RSS_093
jump to class

 TYPE_RSS_093 = 'rss-093'

Details

value: rss-093

TYPE_RSS_094
jump to class

 TYPE_RSS_094 = 'rss-094'

Details

value: rss-094

TYPE_RSS_10
jump to class

 TYPE_RSS_10 = 'rss-10'

Details

value: rss-10

TYPE_RSS_20
jump to class

 TYPE_RSS_20 = 'rss-20'

Details

value: rss-20

TYPE_RSS_ANY
jump to class

 TYPE_RSS_ANY = 'rss'

Details

value: rss

Properties

$_cache
jump to class

Zend_Cache_Core $_cache = 'null'

Cache instance

Details

$_cache: Zend_Cache_Core
visibility: protected
default: null
final: false
static: true

$_extensions
jump to class

$_extensions = 'array'

Details

visibility: protected
default: array
final: false
static: true

$_httpClient
jump to class

Zend_Http_Client $_httpClient = 'null'

HTTP client object to use for retrieving feeds

Details

$_httpClient: Zend_Http_Client
visibility: protected
default: null
final: false
static: true

$_httpConditionalGet
jump to class

$_httpConditionalGet = 'false'

Details

visibility: protected
default: false
final: false
static: true

$_httpMethodOverride
jump to class

boolean $_httpMethodOverride = 'false'

Override HTTP PUT and DELETE request methods?

Details

$_httpMethodOverride: boolean
visibility: protected
default: false
final: false
static: true

$_pluginLoader
jump to class

$_pluginLoader = 'null'

Details

visibility: protected
default: null
final: false
static: true

$_prefixPaths
jump to class

$_prefixPaths = 'array'

Details

visibility: protected
default: array
final: false
static: true

Methods

_registerCoreExtensions
jump to class

_registerCoreExtensions(
          
          )
        
        :
        void

Details

visibility: protected
final: false
static: true

addPrefixPath
jump to class

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

Add prefix path for loading Extensions

Arguments

$prefix: string
$path: string

Details

visibility: public
final: false
static: true

addPrefixPaths
jump to class

addPrefixPaths(
          array $spec
          )
        
        :
        void

Add multiple Extension prefix paths at once

Arguments

$spec: array

Details

visibility: public
final: false
static: true

arrayUnique
jump to class

arrayUnique(
           $array
          )
        
        :
        array

Utility method to apply array_unique operation to a multidimensional array.

Arguments

$array: array

Output

array

Details

visibility: public
final: false
static: true

detectType
jump to class

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

Detect the feed type of the provided feed

Arguments

$feed: Zend_Feed_AbstractDOMDocumentstring
$specOnly

Output

string

Details

visibility: public
final: false
static: true

findFeedLinks
jump to class

findFeedLinks(
           $uri
          )
        
        :

Arguments

$uri

Details

visibility: public
final: false
static: true

getCache
jump to class

getCache(
          
          )
        
        :
        Zend_Cache_Core

Get the Feed cache

Output

Zend_Cache_Core

Details

visibility: public
final: false
static: true

getExtensions
jump to class

getExtensions(
          
          )
        
        :
        array

Get a list of extensions

Output

array

Details

visibility: public
final: false
static: true

getHttpClient
jump to class

getHttpClient(
          
          )
        
        :
        Zend_Http_Client_Abstract

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

Output

Zend_Http_Client_Abstract

Details

visibility: public
final: false
static: true

getHttpMethodOverride
jump to class

getHttpMethodOverride(
          
          )
        
        :
        boolean

Get the HTTP override state

Output

boolean

Details

visibility: public
final: false
static: true

getPluginLoader
jump to class

getPluginLoader(
          
          )
        
        :
        Zend_Loader_PluginLoader_Interface

Get plugin loader for use with Extensions

Output

Zend_Loader_PluginLoader_Interface: $loader

Details

visibility: public
final: false
static: true

import
jump to class

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

Import a feed by providing a URL

Arguments

$uri
$etag: string
OPTIONAL Last received ETag for this resource
$lastModified: string
OPTIONAL Last-Modified value for this resource

Output

Zend_Feed_Reader_FeedInterface

Details

visibility: public
final: false
static: true

importFeed
jump to class

importFeed(
          Zend_Feed_Abstract $feed
          )
        
        :
        Zend_Feed_Reader_FeedInterface

Import a feed by providing a Zend_Feed_Abstract object

Arguments

$feed: Zend_Feed_Abstract
A fully instantiated Zend_Feed object

Output

Zend_Feed_Reader_FeedInterface

Details

visibility: public
final: false
static: true

importFile
jump to class

importFile(
          string $filename
          )
        
        :
        Zend_Feed_Reader_FeedInterface

Imports a feed from a file located at $filename.

Arguments

$filename: string

Output

Zend_Feed_Reader_FeedInterface

Details

visibility: public
final: false
static: true
throws

importString
jump to class

importString(
          string $string
          )
        
        :
        Zend_Feed_Reader_FeedInterface

Import a feed froma string

Arguments

$string: string

Output

Zend_Feed_Reader_FeedInterface

Details

visibility: public
final: false
static: true

isRegistered
jump to class

isRegistered(
          string $extensionName
          )
        
        :
        boolean

Is a given named Extension registered?

Arguments

$extensionName: string

Output

boolean

Details

visibility: public
final: false
static: true

registerExtension
jump to class

registerExtension(
          string $name
          )
        
        :
        void

Arguments

$name: string

Details

visibility: public
final: false
static: true
throws: if unable to resolve Extension class

reset
jump to class

Reset class state to defaults

Details

visibility: public
final: false
static: true

setCache
jump to class

setCache(
          Zend_Cache_Core $cache
          )
        
        :
        void

Set the feed cache

Arguments

$cache: Zend_Cache_Core

Details

visibility: public
final: false
static: true

setHttpClient
jump to class

setHttpClient(
          Zend_Http_Client $httpClient
          )
        
        :
        void

Set the HTTP client instance

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

Arguments

$httpClient: Zend_Http_Client

Details

visibility: public
final: false
static: true

setHttpMethodOverride
jump to class

setHttpMethodOverride(
          boolean $override
              =
              true
          )
        
        :
        void

Toggle using POST instead of PUT and DELETE HTTP methods

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.

Arguments

$override: boolean
Whether to override PUT and DELETE.

Details

visibility: public
final: false
static: true

setPluginLoader
jump to class

setPluginLoader(
          Zend_Loader_PluginLoader_Interface $loader
          )
        
        :

Set plugin loader for use with Extensions

Arguments

$loader: Zend_Loader_PluginLoader_Interface

Details

visibility: public
final: false
static: true

useHttpConditionalGet
jump to class

useHttpConditionalGet(
          bool $bool
              =
              true
          )
        
        :
        void

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

Arguments

$bool: bool

Details

visibility: public
final: false
static: true

API Documentation

Feed/Reader.php

Description

Zend_Feed_Readerjump to top

Description

Constants

NAMESPACE_ATOM_03jump to class

Details

NAMESPACE_ATOM_10jump to class

Details

NAMESPACE_RDFjump to class

Details

NAMESPACE_RSS_090jump to class

Details

NAMESPACE_RSS_10jump to class

Details

TYPE_ANYjump to class

Details

TYPE_ATOM_03jump to class

Details

TYPE_ATOM_10jump to class

Details

TYPE_ATOM_10_ENTRYjump to class

Details

TYPE_ATOM_ANYjump to class

Details

TYPE_RSS_090jump to class

Details

TYPE_RSS_091jump to class

Details

TYPE_RSS_091_NETSCAPEjump to class

Details

TYPE_RSS_091_USERLANDjump to class

Details

TYPE_RSS_092jump to class

Details

TYPE_RSS_093jump to class

Details

TYPE_RSS_094jump to class

Details

TYPE_RSS_10jump to class

Details

TYPE_RSS_20jump to class

Details

TYPE_RSS_ANYjump to class

Details

Properties

$_cachejump to class

Details

$_extensionsjump to class

Details

$_httpClientjump to class

Details

$_httpConditionalGetjump to class

Details

$_httpMethodOverridejump to class

Details

$_pluginLoaderjump to class

Details

$_prefixPathsjump to class

Details

Methods

_registerCoreExtensionsjump to class

Details

addPrefixPathjump to class

Arguments

Details

addPrefixPathsjump to class

Arguments

Details

arrayUniquejump to class

Arguments

Output

Details

detectTypejump to class

Arguments

Output

Details

findFeedLinksjump to class

Arguments

Zend_Feed_Reader
jump to top

NAMESPACE_ATOM_03
jump to class

NAMESPACE_ATOM_10
jump to class

NAMESPACE_RDF
jump to class

NAMESPACE_RSS_090
jump to class

NAMESPACE_RSS_10
jump to class

TYPE_ANY
jump to class

TYPE_ATOM_03
jump to class

TYPE_ATOM_10
jump to class

TYPE_ATOM_10_ENTRY
jump to class

TYPE_ATOM_ANY
jump to class

TYPE_RSS_090
jump to class

TYPE_RSS_091
jump to class

TYPE_RSS_091_NETSCAPE
jump to class

TYPE_RSS_091_USERLAND
jump to class

TYPE_RSS_092
jump to class

TYPE_RSS_093
jump to class

TYPE_RSS_094
jump to class

TYPE_RSS_10
jump to class

TYPE_RSS_20
jump to class

TYPE_RSS_ANY
jump to class

$_cache
jump to class

$_extensions
jump to class

$_httpClient
jump to class

$_httpConditionalGet
jump to class

$_httpMethodOverride
jump to class

$_pluginLoader
jump to class

$_prefixPaths
jump to class

_registerCoreExtensions
jump to class

addPrefixPath
jump to class

addPrefixPaths
jump to class

arrayUnique
jump to class

detectType
jump to class

findFeedLinks
jump to class

getCache
jump to class

getExtensions
jump to class

getHttpClient
jump to class

getHttpMethodOverride
jump to class

getPluginLoader
jump to class

import
jump to class

importFeed
jump to class

importFile
jump to class

importString
jump to class

isRegistered
jump to class

registerExtension
jump to class

reset
jump to class

setCache
jump to class

setHttpClient
jump to class

setHttpMethodOverride
jump to class

setPluginLoader
jump to class

useHttpConditionalGet
jump to class