Docs For Class Zend_Feed

## Class Zend_Feed

Description

Feed utility class

Base Zend_Feed class, containing constants and the Zend_Http_Client instance accessor.

- license: New BSD License
- copyright: Copyright (c) 2006 Zend Technologies USA Inc. (http://www.zend.com)

Located in /Zend/Feed.php (line 54)

Variable Summary
static Zend_Http_Client_Abstract $_httpClient
static boolean $_httpMethodOverride
static array $_namespaces
Method Summary
static array findFeeds (string $uri)
static Zend_Http_Client_Abstract getHttpClient ()
static boolean getHttpMethodOverride ()
static Zend_Feed_Abstract import (string $uri)
static Zend_Feed_Abstract importFile ( $filename, string $uri)
static Zend_Feed_Abstract importString (string $string)
static string lookupNamespace ( $prefix)
static void registerNamespace (string $prefix, string $namespaceURI)
static void setHttpClient ( $httpClient)
static void setHttpMethodOverride ([boolean $override = true])
Variables
static Zend_Http_Client_Abstract $_httpClient = null (line 62)

HTTP client object to use for retrieving feeds

- access: protected

static boolean $_httpMethodOverride = false (line 69)

Override HTTP PUT and DELETE request methods?

- access: protected

static array $_namespaces = array(
'opensearch' => 'http://a9.com/-/spec/opensearchrss/1.0/',
'atom' => 'http://www.w3.org/2005/Atom',
'rss' => 'http://blogs.law.harvard.edu/tech/rss',
) (line 74)

- access: protected

Methods
static method findFeeds (line 259)

Attempts to find feeds at $uri referenced by <link ... /> tags. Returns an array of the feeds referenced at $uri.

- access: public
- throws: Zend_Feed_Exception
- todo: Allow findFeeds() to follow one, but only one, code 302.

static array findFeeds (string $uri)

- string $uri

static method getHttpClient (line 100)

Gets the HTTP client object.

- access: public

static Zend_Http_Client_Abstract getHttpClient ()
static method getHttpMethodOverride (line 133)

Get the HTTP override state

- access: public

static boolean getHttpMethodOverride ()
static method import (line 180)

Imports a feed located at $uri.

- access: public
- throws: Zend_Feed_Exception

static Zend_Feed_Abstract import (string $uri)

- string $uri

static method importFile (line 237)

Imports a feed from a file located at $filename.

- access: public
- throws: Zend_Feed_Exception

static Zend_Feed_Abstract importFile ( $filename, string $uri)

- string $uri
- $filename

static method importString (line 200)

Imports a feed represented by $string.

- access: public
- throws: Zend_Feed_Exception

static Zend_Feed_Abstract importString (string $string)

- string $string

static method lookupNamespace (line 149)

Get the full version of a namespace prefix

Looks up a prefix (atom:, etc.) in the list of registered namespaces and returns the full namespace URI if available. Returns the prefix, unmodified, if it's not registered.

- access: public

static string lookupNamespace ( $prefix)

- $prefix

static method registerNamespace (line 167)

Add a namespace and prefix to the registered list

Takes a prefix and a full namespace URI and adds them to the list of registered namespaces for use by Zend_Feed::lookupNamespace().

- access: public

static void registerNamespace (string $prefix, string $namespaceURI)

- string $prefix: The namespace prefix
- string $namespaceURI: The full namespace URI

static method setHttpClient (line 89)

Set the HTTP client instance

Sets the HTTP client object to use for retrieving the feeds. If none is set, the default Zend_Http_Client will be used.

- access: public

static void setHttpClient ( $httpClient)

- Zend_Http_Client_Abstract $httpClient

static method setHttpMethodOverride (line 122)

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.

- access: public

static void setHttpMethodOverride ([boolean $override = true])

- boolean $override: Whether to override PUT and DELETE.

Documentation generated on Sun, 29 Oct 2006 21:27:13 -0600 by phpDocumentor 1.3.0RC6