locallib.php File Reference

Classes
class	lesson
class	lesson_add_page_form_base
	Abstract class that page type's MUST inherit from. More...
class	lesson_base
	Abstract class to provide a core functions to the all lesson classes. More...
class	lesson_page
class	lesson_page_answer
class	lesson_page_type_manager
	A management class for page types. More...

Functions
	lesson_add_fake_blocks ($page, $cm, $lesson, $timer=null)
	lesson_add_header_buttons ($cm, $context, $extraeditbuttons=false, $lessonpageid=null)
	Adds header buttons to the page for the lesson.
	lesson_clock_block_contents ($cmid, $lesson, $timer, $page)
	If a timed lesson and not a teacher, then return a block_contents containing the clock.
	lesson_display_teacher_warning ($lesson)
	Any other lesson functions go here.
	lesson_displayleftif ($lesson)
	Determines if a user can view the left menu.
object	lesson_get_media_html ($lesson, $context)
	This is a function used to detect media types and generate html code.
	lesson_get_overview_report_table_and_data (lesson $lesson, $currentgroup)
	Return the overview report table and data.
	lesson_get_user_deadline ($courseid)
	Return user's deadline for all lessons in a course, hereby taking into account group and user overrides.
	lesson_get_user_detailed_report_data (lesson $lesson, $userid, $attempt)
	Return information about one user attempt (including answers)
	lesson_grade ($lesson, $ntries, $userid=0)
	Calculates a user's grade for a lesson.
	lesson_mediafile_block_contents ($cmid, $lesson)
	If there is a media file associated with this lesson, return a block_contents that displays it.
	lesson_menu_block_contents ($cmid, $lesson)
	If left menu is turned on, then this will print the menu in a block.
	lesson_process_group_deleted_in_course ($courseid, $groupid=null)
	Logic to happen when a/some group(s) has/have been deleted in a course.
	lesson_random_question_jump ($lesson, $pageid)
	Handles the random jump between a branch table and end of branch or end of lesson (LESSON_RANDOMPAGE).
	lesson_unseen_branch_jump ($lesson, $userid)
	Handles the unseen branch table jump.
	lesson_unseen_question_jump ($lesson, $user, $pageid)
	Interprets the LESSON_UNSEENBRANCHPAGE jump.

Variables
const	LESSON_ANSWER_HTML "HTML"
	Answer format is HTML.
const	LESSON_CLUSTERJUMP -80
	Cluster Jump.
const	LESSON_EOL -9
	End of Lesson.
const	LESSON_MAX_EVENT_LENGTH "432000"
	LESSON_MAX_EVENT_LENGTH = 432000 ; 5 days maximum.
const	LESSON_NEXTPAGE -1
	Jump to Next Page.
const	LESSON_OTHER_ANSWERS "@#wronganswer#@"
	Placeholder answer for all other answers.
const	LESSON_PREVIOUSPAGE -40
	Jump to Previous Page.
const	LESSON_RANDOMBRANCH -70
	Jump to a random Branch.
const	LESSON_RANDOMPAGE -60
	Jump to a random page within a branch and end of branch or end of lesson.
const	LESSON_THISPAGE 0
	Include the files that are required by this module.
const	LESSON_UNANSWEREDPAGE 2
	Next page -> any page not answered correctly.
const	LESSON_UNDEFINED -99
	Undefined.
const	LESSON_UNSEENBRANCHPAGE -50
	Jump to an unseen page within a branch and end of branch or end of lesson.
const	LESSON_UNSEENPAGE 1
	Next page -> any page not seen before.