Sitellite Application Framework
Class Tree         Index         All Elements

Class: SimpleRSS

Source Location: Program_Root/XML/RSS/Simple.php

Class Overview


As the name suggests, this is a simple class for fetching RSS data


Author(s)

Methods


Inherited Variables

Inherited Methods


Class Details

[line 18]
As the name suggests, this is a simple class for fetching RSS data

from remote sources. It consists, so far, of a single method, fetch(), which retrieves the source, and handles caching for you as well, using the saf.Database.PropertySet package for doing so (a simple but effective cache).

If you require post-rendering caching, that's for you to handle.




Tags:

access:  public


[ Top ]


Class Methods


method fetch [line 35]

object &fetch( string $url, [mixed $expires = 'auto'])

Fetches a remote XML document and returns an object structure parsed by SloppyDOM. Returns false if there is a parsing error, and sets the $error property with the error message.

$expires can be set to either 'auto' (the default), which tries to discover the cache duration based on the syn:updatePeriod and syn:updateFrequency values in the feed itself, and defaults to 1 hour (3600 seconds) if they are not present. If $expires is set to a number, that is used as the number of seconds to cache the feed for.




Tags:

access:  public


Parameters:

string   $url  
mixed   $expires  

[ Top ]


Copyright © 2007, SIMIAN systems Inc.
All rights reserved. Privacy policy
Documentation generated on Tue, 13 Feb 2007 17:19:29 -0600 by Sitellite AppDoc and phpDocumentor 1.2.2