Feed.php
Show:
inherited
inherited
Classes
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-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Feed
- Version
- $Id$
\Zend_Feed
Package: Zend_Feed
Returns
Throws
Details
Returns
Feed utility class
Base Zend_Feed class, containing constants and the Zend_Http_Client instance
accessor.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
\Zend_Http_Client $_httpClient = nullstatic
HTTP client object to use for retrieving feeds
Default value
nullDetailsboolean $_httpMethodOverride = falsestatic
Override HTTP PUT and DELETE request methods?
Default value
falseDetails- Type
- boolean
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')static
Default value
array('opensearch' => 'http://a9.com/-/spec/opensearchrss/1.0/', 'atom' => 'http://www.w3.org/2005/Atom', 'rss' => 'http://blogs.law.harvard.edu/tech/rss')Details- Type
- array
Methods
findFeeds(string $uri) : arraystatic
Attempts to find feeds at $uri referenced by
.. /> tags. Returns an
array of the feeds referenced at $uri.
Parameters| Name | Type | Description |
|---|---|---|
| $uri | string |
| Type | Description |
|---|---|
| array |
| Exception | Description |
|---|---|
| \Zend_Feed_Exception |
- Todo
- Allow findFeeds() to follow one, but only one, code 302.
getHttpClient() : \Zend_Http_Client_Abstractstatic
Gets the HTTP client object. If none is set, a new Zend_Http_Client will be used.
Returns
| Type | Description |
|---|---|
| \Zend_Http_Client_Abstract |
getHttpMethodOverride() : booleanstatic
Get the HTTP override state
Returns
| Type | Description |
|---|---|
| boolean |
import(string $uri) : \Zend_Feed_Abstractstatic
Imports a feed located at $uri.
Parameters
Returns
Throws
| Name | Type | Description |
|---|---|---|
| $uri | string |
| Type | Description |
|---|---|
| \Zend_Feed_Abstract |
| Exception | Description |
|---|---|
| \Zend_Feed_Exception |
importArray(array $data, string $format = 'atom') : \Zend_Feed_Abstractstatic
Construct a new Zend_Feed_Abstract object from a custom array
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $data | array | |
| $format | string | (rss|atom) the requested output format |
| Type | Description |
|---|---|
| \Zend_Feed_Abstract |
importBuilder(\Zend_Feed_Builder_Interface $builder, string $format = 'atom') : \Zend_Feed_Abstractstatic
Construct a new Zend_Feed_Abstract object from a Zend_Feed_Builder_Interface data source
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $builder | \Zend_Feed_Builder_Interface | this object will be used to extract the data of the feed |
| $format | string | (rss|atom) the requested output format |
| Type | Description |
|---|---|
| \Zend_Feed_Abstract |
importFile(string $filename) : \Zend_Feed_Abstractstatic
Imports a feed from a file located at $filename.
Parameters
Returns
Throws
| Name | Type | Description |
|---|---|---|
| $filename | string |
| Type | Description |
|---|---|
| \Zend_Feed_Abstract |
| Exception | Description |
|---|---|
| \Zend_Feed_Exception |
importString(string $string) : \Zend_Feed_Abstractstatic
Imports a feed represented by $string.
Parameters
Returns
Throws
| Name | Type | Description |
|---|---|---|
| $string | string |
| Type | Description |
|---|---|
| \Zend_Feed_Abstract |
| Exception | Description |
|---|---|
| \Zend_Feed_Exception |
lookupNamespace( $prefix) : stringstatic
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.
Parameters| Name | Type | Description |
|---|---|---|
| $prefix |
| Type | Description |
|---|---|
| string |
registerNamespace(string $prefix, string $namespaceURI) : voidstatic
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().
Parameters| Name | Type | Description |
|---|---|---|
| $prefix | string | The namespace prefix |
| $namespaceURI | string | The full namespace URI |
setHttpClient(\Zend_Http_Client $httpClient) : voidstatic
Set the HTTP client instance
Sets the HTTP client object to use for retrieving the feeds.
Parameters| Name | Type | Description |
|---|---|---|
| $httpClient | \Zend_Http_Client |
setHttpMethodOverride(boolean $override = true) : voidstatic
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.
Parameters| Name | Type | Description |
|---|---|---|
| $override | boolean | Whether to override PUT and DELETE. |