[ Index ]

PHP Cross Reference of moodle-2.8

title

Body

[close]

/blocks/rss_client/ -> block_rss_client.php (summary)

(no description)

File Size: 335 lines (11 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

block_rss_client:: (12 methods):
  init()
  preferred_width()
  applicable_formats()
  specialization()
  get_content()
  instance_allow_multiple()
  has_config()
  instance_allow_config()
  get_feed_html()
  get_item_html()
  format_title()
  cron()


Class: block_rss_client  - X-Ref

A block which displays Remote feeds

init()   X-Ref
No description

preferred_width()   X-Ref
No description

applicable_formats()   X-Ref
No description

specialization()   X-Ref
No description

get_content()   X-Ref
No description

instance_allow_multiple()   X-Ref
No description

has_config()   X-Ref
No description

instance_allow_config()   X-Ref
No description

get_feed_html($feedrecord, $maxentries, $showtitle)   X-Ref
Returns the html of a feed to be displaed in the block

param: mixed feedrecord The feed record from the database
param: int maxentries The maximum number of entries to be displayed
param: boolean showtitle Should the feed title be displayed in html
return: string html representing the rss feed content

get_item_html($item)   X-Ref
Returns the html list item of a feed item

param: mixed item simplepie_item representing the feed item
return: string html li representing the rss feed item

format_title($title,$max=64)   X-Ref
Strips a large title to size and adds ... if title too long

param: string title to shorten
param: int max character length of title
return: string title s() quoted and shortened if necessary

cron()   X-Ref
cron - goes through all feeds and retrieves them with the cache
duration set to 0 in order to force the retrieval of the item and
refresh the cache

return: boolean true if all feeds were retrieved succesfully



Generated: Fri Nov 28 20:29:05 2014 Cross-referenced by PHPXref 0.7.1