| [ Index ] |
PHP Cross Reference of Unnamed Project |
[Source view] [Print] [Project Stats]
Contains block_rss_client
| Copyright: | Daryl Hawes |
| License: | http://www.gnu.org/copyleft/gpl.html GNU GPL |
| File Size: | 363 lines (13 kb) |
| Included or required: | 1 time |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
block_rss_client:: (12 methods):
init()
applicable_formats()
specialization()
get_footer()
get_content()
instance_allow_multiple()
has_config()
instance_allow_config()
get_feed()
format_title()
cron()
calculate_skiptime()
Class: block_rss_client - X-Ref
A block which displays Remote feeds| init() X-Ref |
| No description |
| applicable_formats() X-Ref |
| No description |
| specialization() X-Ref |
| No description |
| get_footer($feedrecords) X-Ref |
| Gets the footer, which is the channel link of the last feed in our list of feeds param: array $feedrecords The feed records from the database. return: block_rss_client\output\footer|null The renderable footer or null if none should be displayed. |
| 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($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: block_rss_client\output\feed|null The renderable feed or null of there is an error |
| 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 the feeds. If the feed has a skipuntil value that is less than the current time cron will attempt to retrieve it with the cache duration set to 0 in order to force the retrieval of the item and refresh the cache. If a feed fails then the skipuntil time of that feed is set to be later than the next expected cron time. The amount of time will increase each time the fetch fails until the maximum is reached. If a feed that has been failing is successfully retrieved it will go back to being handled as though it had never failed. CRON should therefor process requests for permanently broken RSS feeds infrequently, and temporarily unavailable feeds will be tried less often until they become available again. return: boolean Always returns true |
| calculate_skiptime($currentskip) X-Ref |
| Calculates a new skip time for a record based on the current skip time. param: int $currentskip The curreent skip time of a record. return: int A new skip time that should be set. |
| Generated: Thu Aug 11 10:00:09 2016 | Cross-referenced by PHPXref 0.7.1 |