| [ Index ] |
PHP Cross Reference of Unnamed Project |
[Source view] [Print] [Project Stats]
course_overview block rendrer
| Copyright: | 2012 Adam Olley <adam.olley@netspot.com.au> |
| License: | http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later |
| File Size: | 356 lines (17 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
block_course_overview_renderer:: (8 methods):
course_overview()
activity_display()
editing_bar_head()
hidden_courses()
collapsible_region()
collapsible_region_start()
collapsible_region_end()
welcome_area()
Class: block_course_overview_renderer - X-Ref
Course_overview block rendrer| course_overview($courses, $overviews) X-Ref |
| Construct contents of course_overview block param: array $courses list of courses in sorted order param: array $overviews list of course overviews return: string html to be displayed in course_overview block |
| activity_display($cid, $overview) X-Ref |
| Coustuct activities overview for a course param: int $cid course id param: array $overview overview of activities in course return: string html of activities overview |
| editing_bar_head($max = 0) X-Ref |
| Constructs header in editing mode param: int $max maximum number of courses return: string html of header bar. |
| hidden_courses($total) X-Ref |
| Show hidden courses count param: int $total count of hidden courses return: string html |
| collapsible_region($contents, $classes, $id, $caption, $userpref = '', $default = false) X-Ref |
| Creates collapsable region param: string $contents existing contents param: string $classes class names added to the div that is output. param: string $id id added to the div that is output. Must not be blank. param: string $caption text displayed at the top. Clicking on this will cause the region to expand or contract. param: string $userpref the name of the user preference that stores the user's preferred default state. param: bool $default Initial collapsed state to use if the user_preference it not set. return: bool if true, return the HTML as a string, rather than printing it. |
| collapsible_region_start($classes, $id, $caption, $userpref = '', $default = false) X-Ref |
| Print (or return) the start of a collapsible region, that has a caption that can be clicked to expand or collapse the region. If JavaScript is off, then the region will always be expanded. param: string $classes class names added to the div that is output. param: string $id id added to the div that is output. Must not be blank. param: string $caption text displayed at the top. Clicking on this will cause the region to expand or contract. param: string $userpref the name of the user preference that stores the user's preferred default state. param: bool $default Initial collapsed state to use if the user_preference it not set. return: bool if true, return the HTML as a string, rather than printing it. |
| collapsible_region_end() X-Ref |
| Close a region started with print_collapsible_region_start. return: string return the HTML as a string, rather than printing it. |
| welcome_area($msgcount) X-Ref |
| Cretes html for welcome area param: int $msgcount number of messages return: string html string for welcome area. |
| Generated: Thu Aug 11 10:00:09 2016 | Cross-referenced by PHPXref 0.7.1 |