Specifies the parametersof the http conection used to obtain the xml data. |
Signature: setConnection($host, $path = '/', $port = 80, $timeout = 0, $user = null, $password = null) |
Parameters:
String host - The ip address or domain name of the connection.
String path - The path of the connection.
int port - The port that the connection is listening on.
int timeout - The timeout value for the connection.
String user - The user name, if authentication is required.
String password - The password, if authentication is required.
|
Example:
A manual HTTP connection is specified: $rssdoc->setConnection('http://www.engageinteractive.com'); |
Specifies basic authentication for an http connection. |
Signature: setAuthorization($user, $password) |
Parameters:
String user - The user name.
String password - The password.
|
Example:
Authorization is specified for the HTTP connection: $rssdoc->setAuthorization('johndoe', 'xyzzy'); |
Specifies the parameters of the http conection used to obtain the xml data. |
Signature: setProxyConnection($host, $path = '/', $port = 80, $timeout = 0, $user = null, $password = null) |
Parameters:
String host - The ip address or domain name of the connection.
String path - The path of the connection.
int port - The port that the connection is listening on.
int timeout - The timeout value for the connection.
String user - The user name, if authentication is required.
String password - The password, if authentication is required.
|
Example:
A HTTP proxy connection is specified: $rssdoc->setProxyConnection('http://www.engageinteractive.com'); |
Specifies basic authentication for an http connection. |
Signature: setProxyAuthorization($user, $password) |
Parameters:
String user - The user name.
String password - The password.
|
Example:
Authorization is specified for the HTTP connection: $rssdoc->setProxyAuthorization('johndoe', 'xyzzy'); |
Returns the name of the parser. |
Signature: parsedBy() |
Returns:
string - Either 'DOMIT_RSS' or 'DOMIT_RSS_LITE'.
|
Substitutes PEAR::Cache_Lite for the default php_text_cache. |
Signature: useCacheLite($doUseCacheLite, $pathToLibrary = './Lite.php', $cacheDir = './', $cacheTime = 3600) |
Parameters:
boolean doUseCacheLite - True if Cache Lite is to be used.
String pathToLibrary - Absolute or relative path to the Cache Lite library.
String cacheDir - Directory for cache files.
int cacheTime - Expiration time for a cache file.
|
Example:
Cache Lite is used. $rssdoc->useCacheLite(true, './cache/Lite.php', 'tmp/', 1800); |
Loads and parses the RSS at the specified url. |
Signature: loadRSS($url) |
Parameters:
String url - The url for the RSS data.
|
Returns:
boolean - True if parsing is successful.
|
Example:
Load and parse an RSS feed. $rssdoc->loadRSS('http://www.somefeed.com/somefeed.rss'); |
Parses the RSS text provided. |
Signature: parseRSS($rssText) |
Parameters:
String rssText - The RSS text.
|
Returns:
boolean - True if parsing is successful.
|
Example:
Parse some RSS text. $rssdoc->parseRSS('<rss version="0.91">...</rss>'); |
Gets a reference to the underlying DOM document. |
Signature: &getDocument() |
Returns:
Object - A reference to the underlying DOM document.
|
Example:
The underlying DOM document is returned. $xmldoc = $rssdoc->getDocument(); |
Gets a reference to the root DOM element. |
Signature: &getNode() |
Returns:
Object - A reference to the root DOM element.
|
Example:
The underlying root DOM element is returned. $docElement = $rssdoc->getNode(); |
Returns the version of RSS used to format the data. |
Signature: getRSSVersion() |
Returns:
String - The version of RSS used to format the data .
|
Example:
Returns the version of RSS used to format the data. $version = $rssdoc->getRSSVersion(); |
Returns the number of channels in the document. |
Signature: getChannelCount() |
Returns:
int - The number of channels in the document.
|
Example:
Returns the number of channels in the document. $numChannels = $rssdoc->getChannelCount(); |
Returns a reference to the channel located at the specified index. |
Signature: &getChannel($index) |
Returns:
Object - A reference to the channel located at the specified index.
|
Example:
Returns the first channel. $firstChannel = $rssdoc->getChannel(0); |