Documentation

Horde_Feed

Static class representing a feed client.

Tags
author

Chuck Hagenbuch chuck@horde.org

category

Horde

copyright

2005-2007 Zend Technologies USA Inc.

copyright

2007-2017 Horde LLC

license

http://www.horde.org/licenses/bsd BSD

Table of Contents

create()  : Horde_Feed_Base
Create a Feed object based on a DOMDocument.
read()  : Horde_Feed_Base
Reads a feed represented by $string.
readFile()  : Horde_Feed_Base
Read a feed from $filename
readUri()  : Horde_Feed_Base
Read a feed located at $uri
_exception()  : mixed
Builds an exception message from a libXMLError object.

Methods

create()

Create a Feed object based on a DOMDocument.

public static create(DOMDocument $doc[, mixed $uri = null ]) : Horde_Feed_Base
Parameters
$doc : DOMDocument

The DOMDocument object to import.

$uri : mixed = null
Tags
throws
Horde_Feed_Exception
Return values
Horde_Feed_Base

The feed object imported from $doc

read()

Reads a feed represented by $string.

public static read(string $string[, string $uri = null ]) : Horde_Feed_Base
Parameters
$string : string

The XML content of the feed.

$uri : string = null

The feed's URI location, if known.

Tags
throws
Horde_Feed_Exception
Return values
Horde_Feed_Base

readFile()

Read a feed from $filename

public static readFile(string $filename) : Horde_Feed_Base
Parameters
$filename : string

The location of the feed file on an accessible filesystem or through an available stream wrapper.

Tags
throws
Horde_Feed_Exception
Return values
Horde_Feed_Base

readUri()

Read a feed located at $uri

public static readUri(string $uri[, Horde_Http_Client $httpclient = null ]) : Horde_Feed_Base
Parameters
$uri : string

The URI to fetch the feed from.

$httpclient : Horde_Http_Client = null

The HTTP client to use.

Tags
throws
Horde_Feed_Exception
Return values
Horde_Feed_Base

_exception()

Builds an exception message from a libXMLError object.

protected static _exception(string $msg, libXMLError $error) : mixed
Parameters
$msg : string

An error message.

$error : libXMLError

An error object.

Tags
throws
Horde_Feed_Exception
Return values
mixed

Search results