Class RSS

__construct()

__construct(string $module_id, string $feed_name = \Feed::DEFAULT_FEED_NAME, integer $id_cat) 

Builds a new RSS object

Parameters

string	$module_id	its module_id
string	$feed_name	the feeds name / type. default is Feed::DEFAULT_FEED_NAME
integer	$id_cat	the feed category id

• Inherited from \RSS

Tags

None found

load_data()

load_data(\FeedData $data) 

Loads a FeedData element

Parameters

\FeedData

$data

the element to load

• Inherited from \Feed

Tags

None found

load_file()

load_file(string $url) 

Loads a feed by its url

Parameters

string

$url

the feed url

• Inherited from \RSS

Tags

None found

export()

export(mixed $template = false, integer $number = 10, integer $begin_at) : string

Exports the feed as a string parsed by the <$tpl> template

Parameters

mixed	$template	If false, uses de default tpl. If an associative array, uses the default tpl but assigns it the array vars first. It could also be a Template object
integer	$number	the number of item to display
integer	$begin_at	the first item to display

Returns

string —

The exported feed

• Inherited from \Feed

Tags

None found

read()

read() : string

Loads the feed data in cache and export it

Returns

string —

the exported feed

• Inherited from \Feed

Tags

None found

cache()

cache() 

Send the feed data in the cache

• Inherited from \Feed

Tags

None found

is_in_cache()

is_in_cache() : boolean

Returns true if the feed data are in the cache

Returns

boolean —

true if the feed data are in the cache

• Inherited from \Feed

Tags

None found

get_cache_file_name()

get_cache_file_name() : string

Returns the feed data cache filename

Returns

string —

the feed data cache filename

• Inherited from \Feed

Tags

None found

clear_cache()

clear_cache(mixed $module_id = false) 

Clear the cache of the specified module_id.

Parameters

mixed

$module_id

the module module_id or false. If false, Clear all feeds data from the cache

static

• Inherited from \Feed

Tags

static

get_parsed()

get_parsed(string $module_id, string $name = self::DEFAULT_FEED_NAME, integer $idcat,  $template = false, integer $number = 10, integer $begin_at) : string

Export a feed

Parameters

string	$module_id	the module id
string	$name	the feed name / type
integer	$idcat	the feed data category
	$template
integer	$number	the number of item to display
integer	$begin_at	the first item to display

Returns

string —

The exported feed

static

• Inherited from \Feed

Tags

static

get_feed_menu()

get_feed_menu( $module_id,  $id_cat) : string

Parameters

	$module_id
	$id_cat

Returns

string —

The HTML code to display.

static

• Inherited from \Feed

Tags

static

Generates the code which shows all the feeds formats.

update_cache()

update_cache(string $module_id, string $name, \&FeedData $data, integer $idcat) 

Update the cache of the $module_id, $name, $idcat feed with $data

Parameters

string	$module_id	the module id
string	$name	the feed name / type
\&FeedData	$data	the data to put in the cache
integer	$idcat	the feed data category

static

• Inherited from \Feed

Tags

static