[ Index ]

PHP Cross Reference of Unnamed Project

title

Body

[close]

/blocks/course_overview/ -> locallib.php (summary)

Helper functions for course_overview block

Copyright: 2012 Adam Olley <adam.olley@netspot.com.au>
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 233 lines (8 kb)
Included or required: 2 times
Referenced: 1 time
Includes or requires: 0 files

Defines 7 functions

  block_course_overview_get_overviews()
  block_course_overview_update_mynumber()
  block_course_overview_update_myorder()
  block_course_overview_get_myorder()
  block_course_overview_get_child_shortnames()
  block_course_overview_get_max_user_courses()
  block_course_overview_get_sorted_courses()

Functions
Functions that are not part of a class:

block_course_overview_get_overviews($courses)   X-Ref
Display overview for courses

param: array $courses courses for which overview needs to be shown
return: array html overview

block_course_overview_update_mynumber($number)   X-Ref
Sets user preference for maximum courses to be displayed in course_overview block

param: int $number maximum courses which should be visible

block_course_overview_update_myorder($sortorder)   X-Ref
Sets user course sorting preference in course_overview block

param: array $sortorder list of course ids

block_course_overview_get_myorder()   X-Ref
Gets user course sorting preference in course_overview block

return: array list of course ids

block_course_overview_get_child_shortnames($courseid)   X-Ref
Returns shortname of activities in course

param: int $courseid id of course for which activity shortname is needed
return: string|bool list of child shortname

block_course_overview_get_max_user_courses($showallcourses = false)   X-Ref
Returns maximum number of courses which will be displayed in course_overview block

param: bool $showallcourses if set true all courses will be visible.
return: int maximum number of courses

block_course_overview_get_sorted_courses($showallcourses = false)   X-Ref
Return sorted list of user courses

param: bool $showallcourses if set true all courses will be visible.
return: array list of sorted courses and count of courses.



Generated: Thu Aug 11 10:00:09 2016 Cross-referenced by PHPXref 0.7.1