Inheritance diagram for lesson:

Public Member Functions
	__construct ($properties, $cm=null, $course=null)
	Constructor method.

	__get ($key)
	Magic get method.

	__isset ($key)
	Stupid PHP needs an isset magic method if you use the get magic method and still want empty calls to work....

	__set ($key, $value)
	Magic property method.

	add_message ($message, $class="notifyproblem", $align='center')
	Sets a message against the session for this lesson that will displayed next time the lesson processes messages.

	add_messages_on_page_process (lesson_page $page, $result, $reviewmode)
	Add different informative messages to the given page.

	add_messages_on_page_view (lesson_page $page, $reviewmode)
	Add different informative messages to the given page.

	calculate_new_page_on_jump (lesson_page $page, $newpageid)
	This returns a real page id to jump to (or LESSON_EOL) after processing page responses.

	calculate_progress ()
	Calculate the progress of the current user in the lesson.

	can_manage ()
	Check if the user can manage the lesson activity.

	check_time ($timer)
	Check if the user is out of time in a timed lesson.

	cluster_jump ($pageid, $userid=null)
	Interprets LESSON_CLUSTERJUMP jumpto value.

	count_user_retries ($userid)
	Return the number of retries in a lesson for a given user.

	delete ()
	Deletes this lesson from the database.

	delete_all_overrides ()
	Deletes all lesson overrides from the database and clears any corresponding calendar events.

	delete_override ($overrideid)
	Deletes a lesson override from the database and clears any corresponding calendar events.

	duplicate_page ($pageid)
	Duplicate the lesson page.

	get_attempts ($retries, $correct=false, $pageid=null, $userid=null)
	Get all of the attempts for the current user.

	get_cm ()
	Return the lesson course module object.

	get_content_pages_viewed ($lessonattempt, $userid=null, $sort='', $fields=' *')
	Get a list of content pages (formerly known as branch tables) viewed in the lesson for the given user during an attempt.

	get_context ()
	Return the lesson context object.

	get_courserecord ()
	Return the lesson course object.

	get_dependencies_restriction_status ()
	Check if dependencies restrictions are applied.

	get_last_attempt (array $attempts)
	Returns the last "legal" attempt from the list of student attempts.

	get_last_page_seen ($retriescount)
	Return the last page the current user saw.

	get_lastpageid ()
	Returns the id of the last page of this lesson.

	get_next_page ($nextpageid)
	Gets the next page id to display after the one that is provided.

	get_ongoing_score_message ()
	Get the ongoing score message for the user (depending on the user permission and lesson settings).

	get_password_restriction_status ($userpassword)
	Check if password restriction is applied.

	get_sub_pages_of ($pageid, array $ends)
	Finds all pages that appear to be a subtype of the provided pageid until an end point specified within $ends is encountered or no more pages exist.

	get_time_restriction_status ()
	Check if time restriction is applied.

	get_user_timers ($userid=null, $sort='', $fields=' *', $limitfrom=0, $limitnum=0)
	Return the timers in the current lesson for the given user.

	has_pages ()
	Checks to see if the lesson has pages.

	is_accessible ()
	Check if the lesson is accessible at the present time.

	is_in_review_mode ()
	Check if the lesson is in review mode.

	is_participant ($userid)
	Checks user enrollment in the current course.

	is_sub_page_of_type ($pageid, array $types, array $ends)
	Checks to see if the specified page[id] is a subpage of a type specified in the $types array, until either there are no more pages of we find a type corresponding to that of a type specified in $ends.

	jumpto_is_correct ($pageid, $jumpto)
	Determines if a jumpto value is correct or not.

	left_during_timed_session ($retriescount)
	Check if a user left a timed session.

	link_for_activitylink ()
	Returns the link for the related activity.

	load_all_pages ()
	Loads ALL of the pages for this lesson.

	load_page ($pageid)
	Loads the requested page.

	prepare_page_and_contents ($pageid, $lessonoutput, $reviewmode, $redirect=true)
	Calculate the correct page and prepare contents for a given page id (could be a page jump id).

	process_eol_page ($outoftime)
	Process and return all the information for the end of lesson page.

	process_page_responses (lesson_page $page)
	Process page responses.

	properties ()
	If implemented should create a new instance, save it in the DB and return it.

	resort_pages ($pageid, $after)
	Move a page resorting all other pages.

	set_module_viewed ()
	Trigger module viewed event and set the module viewed for completion.

	show_only_active_users ()
	Check is only active users in course should be shown.

	start_timer ()
	Starts the lesson time for the current user.

	stop_timer ()
	Updates the timer to the current time then stops it by unsetting the user var.

	time_remaining ($starttime)
	Returns the time a user has remaining on this lesson.

	update_effective_access ($userid)
	Updates the lesson properties with override information for a user.

	update_timer ($restart=false, $continue=false, $endreached=false)
	Updates the timer to the current time and returns the new timer object.

Static Public Member Functions
static	create ($properties)
	Simply generates a lesson object given an array/object of properties Overrides {.

static	load ($lessonid)
	Generates a lesson object from the database given its id.

Protected Member Functions
	copy_page_files ($filearea, $itemid, $newitemid, $contextid)
	Copy the files from one page to another.

	get_firstpage ()
	Returns the first page for the lesson or false if there isn't one.

	get_firstpageid ()
	Returns the id of the first page of this lesson.

	get_lastpage ()
	Returns the last page for the lesson or false if there isn't one.

	get_messages ()
	Fetches messages from the session that may have been set in previous page actions.

Protected Attributes
stdClass	$cm = null
	Course module object gets set and retrieved by directly calling `$lesson->cm;`

stdClass	$context = null
	Context object gets set and retrieved by directly calling `$lesson->context;`

stdClass	$courserecord = null
	Course object gets set and retrieved by directly calling `$lesson->courserecord;`

int	$firstpageid = null
	The id of the first page (where prevpageid = 0) gets set and retrieved by {.

int	$lastpageid = null
	The id of the last page (where nextpageid = 0) gets set and retrieved by {.

bool	$loadedallpages = false
	Flag that gets set to true once all of the pages associated with the lesson have been loaded.

array	$pages = array()
	An array used to cache the pages associated with this lesson after the first time they have been loaded.

stdClass	$properties
	An object containing properties.

Constructor & Destructor Documentation

◆ __construct()

lesson::__construct	(	$properties,
		$cm = null,
		$course = null )

Constructor method.

Parameters

object	$properties
stdClass	$cm	course module object
stdClass	$course	course object

Since: Moodle 3.3

Member Function Documentation

◆ __get()

lesson_base::__get ( $key )

inherited

Magic get method.

Attempts to call a get_$key method to return the property and ralls over to return the raw property

Parameters

str $key

Return values

mixed

◆ __isset()

lesson_base::__isset ( $key )

inherited

Stupid PHP needs an isset magic method if you use the get magic method and still want empty calls to work....

blah ~!

Parameters

string $key

Return values

bool

◆ __set()

lesson_base::__set	(		$key,
			$value )

inherited

Magic property method.

Attempts to call a set_$key method if one exists otherwise falls back to simply set the property

Parameters

string	$key
mixed	$value

◆ add_message()

lesson::add_message	(	$message,
		$class = "notifyproblem",
		$align = 'center' )

Sets a message against the session for this lesson that will displayed next time the lesson processes messages.

Parameters

string	$message
string	$class
string	$align

Return values

bool

◆ add_messages_on_page_process()

lesson::add_messages_on_page_process	(	lesson_page	$page,
			$result,
			$reviewmode )

Add different informative messages to the given page.

Parameters

lesson_page	$page	page object
stdClass	$result	the page processing result object
bool	$reviewmode	whether we are in review mode or not

Since: Moodle 3.3

◆ add_messages_on_page_view()

lesson::add_messages_on_page_view	(	lesson_page	$page,
			$reviewmode )

Add different informative messages to the given page.

Parameters

lesson_page	$page	page object
reviewmode	$bool	whether we are in review mode or not

Since: Moodle 3.3

◆ calculate_new_page_on_jump()

lesson::calculate_new_page_on_jump	(	lesson_page	$page,
			$newpageid )

This returns a real page id to jump to (or LESSON_EOL) after processing page responses.

Parameters

lesson_page	$page	lesson page
int	$newpageid	the new page id

Return values

int	the real page to jump to (or end of lesson)

Since: Moodle 3.3

◆ calculate_progress()

lesson::calculate_progress ( )

Calculate the progress of the current user in the lesson.

Return values

int	the progress (scale 0-100)

Since: Moodle 3.3

◆ can_manage()

lesson::can_manage ( )

Check if the user can manage the lesson activity.

Return values

bool	true if the user can manage the lesson

Since: Moodle 3.3

◆ check_time()

lesson::check_time ( $timer )

Check if the user is out of time in a timed lesson.

Parameters

stdClass $timer timer object

Return values

bool	True if the user is on time, false is the user ran out of time

Since: Moodle 3.3

◆ cluster_jump()

lesson::cluster_jump	(		$pageid,
			$userid = null )

Interprets LESSON_CLUSTERJUMP jumpto value.

This will select a page randomly and the page selected will be inbetween a cluster page and end of clutter or end of lesson and the page selected will be a page that has not been viewed already and if any pages are within a branch table or end of branch then only 1 page within the branch table or end of branch will be randomly selected (sub clustering).

Parameters

int	$pageid	Id of the current page from which we are jumping from.
int	$userid	Id of the user.

Return values

int	The id of the next page.

◆ copy_page_files()

lesson::copy_page_files	(	$filearea,
		$itemid,
		$newitemid,
		$contextid )

protected

Copy the files from one page to another.

Parameters

string	$filearea	Area that the files are stored.
int	$itemid	Item ID.
int	$newitemid	The item ID for the new page.
int	$contextid	Context ID for this page.

Return values

void.

◆ count_user_retries()

lesson::count_user_retries ( $userid )

Return the number of retries in a lesson for a given user.

Parameters

int $userid the user id

Return values

int	the retries count

Since: Moodle 3.3

◆ create()

static lesson::create ( $properties )

static

Simply generates a lesson object given an array/object of properties Overrides {.

See also: lesson_base->create()}

Parameters

object | array $properties

Return values

lesson

◆ delete_override()

lesson::delete_override ( $overrideid )

Deletes a lesson override from the database and clears any corresponding calendar events.

Parameters

int $overrideid The id of the override being deleted

Return values

bool	true on success

◆ duplicate_page()

lesson::duplicate_page ( $pageid )

Duplicate the lesson page.

Parameters

int $pageid Page ID of the page to duplicate.

Return values

void.

◆ get_attempts()

lesson::get_attempts	(	$retries,
		$correct = false,
		$pageid = null,
		$userid = null )

Get all of the attempts for the current user.

Parameters

int	$retries
bool	$correct	Optional: only fetch correct attempts
int	$pageid	Optional: only fetch attempts at the given page
int	$userid	Optional: defaults to the current user if not set

Return values

array|false

◆ get_cm()

lesson::get_cm ( )

Return the lesson course module object.

Return values

stdClass course module

Since: Moodle 3.3

◆ get_content_pages_viewed()

lesson::get_content_pages_viewed	(	$lessonattempt,
		$userid = null,
		$sort = '',
		$fields = '*' )

Get a list of content pages (formerly known as branch tables) viewed in the lesson for the given user during an attempt.

Parameters

int	$lessonattempt	the lesson attempt number (also known as retries)
int	$userid	the user id to retrieve the data from
string	$sort	an order to sort the results in (a valid SQL ORDER BY parameter)
string	$fields	a comma separated list of fields to return

Return values

array of pages

Since: Moodle 3.3

◆ get_context()

lesson::get_context ( )

Return the lesson context object.

Return values

stdClass context

Since: Moodle 3.3

◆ get_courserecord()

lesson::get_courserecord ( )

Return the lesson course object.

Return values

stdClass course

Since: Moodle 3.3

◆ get_dependencies_restriction_status()

lesson::get_dependencies_restriction_status ( )

Check if dependencies restrictions are applied.

Return values

mixed false if there aren't restrictions or an object with the restriction information

Since: Moodle 3.3

◆ get_firstpage()

lesson::get_firstpage ( )

protected

Returns the first page for the lesson or false if there isn't one.

This method should be called via the magic method __get(); $firstpage = $lesson->firstpage;

Return values

lesson_page|bool Returns the lesson_page specialised object or false

◆ get_firstpageid()

lesson::get_firstpageid ( )

protected

Returns the id of the first page of this lesson.

(prevpageid = 0)

Return values

int

◆ get_last_attempt()

lesson::get_last_attempt ( array $attempts )

Returns the last "legal" attempt from the list of student attempts.

Parameters

array $attempts The list of student attempts.

Return values

stdClass The updated fom data.

◆ get_last_page_seen()

lesson::get_last_page_seen ( $retriescount )

Return the last page the current user saw.

Parameters

int $retriescount the number of retries for the lesson (the last retry number).

Return values

mixed false if the user didn't see the lesson or the last page id

◆ get_lastpage()

lesson::get_lastpage ( )

protected

Returns the last page for the lesson or false if there isn't one.

This method should be called via the magic method __get(); $lastpage = $lesson->lastpage;

Return values

lesson_page|bool Returns the lesson_page specialised object or false

◆ get_lastpageid()

lesson::get_lastpageid ( )

Returns the id of the last page of this lesson.

(nextpageid = 0)

Return values

int

◆ get_messages()

lesson::get_messages ( )

protected

Fetches messages from the session that may have been set in previous page actions.

// Do not call this method directly instead use $lesson->messages;

Return values

array

◆ get_next_page()

lesson::get_next_page ( $nextpageid )

Gets the next page id to display after the one that is provided.

Parameters

int $nextpageid

Return values

bool

◆ get_ongoing_score_message()

lesson::get_ongoing_score_message ( )

Get the ongoing score message for the user (depending on the user permission and lesson settings).

Return values

str	the ongoing score message

Since: Moodle 3.3

◆ get_password_restriction_status()

lesson::get_password_restriction_status ( $userpassword )

Check if password restriction is applied.

Parameters

string $userpassword the user password to check (if the restriction is set)

Return values

mixed false if there aren't restrictions or an object with the restriction information

Since: Moodle 3.3

◆ get_sub_pages_of()

lesson::get_sub_pages_of	(		$pageid,
		array	$ends )

Finds all pages that appear to be a subtype of the provided pageid until an end point specified within $ends is encountered or no more pages exist.

Parameters

int	$pageid
array	$ends	An array of LESSON_PAGE_* types that signify an end of the subtype

Return values

array An array of specialised lesson_page objects

◆ get_time_restriction_status()

lesson::get_time_restriction_status ( )

Check if time restriction is applied.

Return values

mixed false if there aren't restrictions or an object with the restriction information

Since: Moodle 3.3

◆ get_user_timers()

lesson::get_user_timers	(	$userid = null,
		$sort = '',
		$fields = '*',
		$limitfrom = 0,
		$limitnum = 0 )

Return the timers in the current lesson for the given user.

Parameters

int	$userid	the user id
string	$sort	an order to sort the results in (optional, a valid SQL ORDER BY parameter).
string	$fields	a comma separated list of fields to return
int	$limitfrom	return a subset of records, starting at this point (optional).
int	$limitnum	return a subset comprising this many records in total (optional, required if $limitfrom is set).

Return values

array list of timers for the given user in the lesson

Since: Moodle 3.3

◆ is_accessible()

lesson::is_accessible ( )

Check if the lesson is accessible at the present time.

Return values

bool	True if the lesson is accessible, false otherwise

◆ is_in_review_mode()

lesson::is_in_review_mode ( )

Check if the lesson is in review mode.

(The user already finished it and retakes are not allowed).

Return values

bool	true if is in review mode

Since: Moodle 3.3

◆ is_participant()

lesson::is_participant ( $userid )

Checks user enrollment in the current course.

Parameters

int $userid

Return values

null|stdClass user record

◆ is_sub_page_of_type()

lesson::is_sub_page_of_type	(		$pageid,
		array	$types,
		array	$ends )

Checks to see if the specified page[id] is a subpage of a type specified in the $types array, until either there are no more pages of we find a type corresponding to that of a type specified in $ends.

Parameters

int	$pageid	The id of the page to check
array	$types	An array of types that would signify this page was a subpage
array	$ends	An array of types that mean this is not a subpage

Return values

bool

◆ jumpto_is_correct()

lesson::jumpto_is_correct	(		$pageid,
			$jumpto )

Determines if a jumpto value is correct or not.

returns true if jumpto page is (logically) after the pageid page or if the jumpto value is a special value. Returns false in all other cases.

Parameters

int	$pageid	Id of the page from which you are jumping from.
int	$jumpto	The jumpto number.

Return values

boolean True or false after a series of tests.

◆ left_during_timed_session()

lesson::left_during_timed_session ( $retriescount )

Check if a user left a timed session.

Parameters

int $retriescount the number of retries for the lesson (the last retry number).

Return values

true	if the user left the timed session

Since: Moodle 3.3

◆ link_for_activitylink()

lesson::link_for_activitylink ( )

Returns the link for the related activity.

Return values

string

◆ load()

static lesson::load ( $lessonid )

static

Generates a lesson object from the database given its id.

Parameters

int $lessonid

Return values

lesson

◆ load_all_pages()

lesson::load_all_pages ( )

Loads ALL of the pages for this lesson.

Return values

array An array containing all pages from this lesson

◆ load_page()

lesson::load_page ( $pageid )

Loads the requested page.

This function will return the requested page id as either a specialised lesson_page object OR as a generic lesson_page. If the page has been loaded previously it will be returned from the pages array, otherwise it will be loaded from the database first

Parameters

int $pageid

Return values

lesson_page A lesson_page object or an object that extends it

◆ prepare_page_and_contents()

lesson::prepare_page_and_contents	(	$pageid,
		$lessonoutput,
		$reviewmode,
		$redirect = true )

Calculate the correct page and prepare contents for a given page id (could be a page jump id).

Parameters

int	$pageid	the given page id
mod_lesson_renderer	$lessonoutput	the lesson output rendered
bool	$reviewmode	whether we are in review mode or not
bool	$redirect	Optional, default to true. Set to false to avoid redirection and return the page to redirect.

Return values

array the page object and contents

Exceptions

moodle_exception

Since: Moodle 3.3

◆ process_eol_page()

lesson::process_eol_page ( $outoftime )

Process and return all the information for the end of lesson page.

Parameters

string $outoftime used to check to see if the student ran out of time

Return values

stdclass an object with all the page data ready for rendering

Since: Moodle 3.3

◆ process_page_responses()

lesson::process_page_responses ( lesson_page $page )

Process page responses.

Parameters

lesson_page $page page object

Since: Moodle 3.3

◆ properties()

lesson_base::properties ( )

inherited

If implemented should create a new instance, save it in the DB and return it.

If implemented should load an instance from the DB and return it Fetches all of the properties of the object

Return values

stdClass

Reimplemented in lesson_page.

◆ resort_pages()

lesson::resort_pages	(		$pageid,
			$after )

Move a page resorting all other pages.

Parameters

int	$pageid
int	$after

Return values

void

◆ set_module_viewed()

lesson::set_module_viewed ( )

Trigger module viewed event and set the module viewed for completion.

Since: Moodle 3.3

◆ show_only_active_users()

lesson::show_only_active_users ( )

Check is only active users in course should be shown.

Return values

bool	true if only active users should be shown.

◆ start_timer()

lesson::start_timer ( )

Starts the lesson time for the current user.

Return values

bool	Returns true

◆ stop_timer()

lesson::stop_timer ( )

Updates the timer to the current time then stops it by unsetting the user var.

Return values

bool	Returns true

◆ time_remaining()

lesson::time_remaining ( $starttime )

Returns the time a user has remaining on this lesson.

Parameters

int $starttime Starttime timestamp

Return values

string

◆ update_effective_access()

lesson::update_effective_access ( $userid )

Updates the lesson properties with override information for a user.

Algorithm: For each lesson setting, if there is a matching user-specific override, then use that otherwise, if there are group-specific overrides, return the most lenient combination of them. If neither applies, leave the quiz setting unchanged.

Special case: if there is more than one password that applies to the user, then lesson->extrapasswords will contain an array of strings giving the remaining passwords.

Parameters

int $userid The userid.

◆ update_timer()

lesson::update_timer	(	$restart = false,
		$continue = false,
		$endreached = false )

Updates the timer to the current time and returns the new timer object.

Parameters

bool	$restart	If set to true the timer is restarted
bool	$continue	If set to true AND $restart=true then the timer will continue from a previous attempt

Return values

stdClass The new timer

Member Data Documentation

◆ $cm

stdClass lesson::$cm = null

protected

Course module object gets set and retrieved by directly calling $lesson->cm;

See also: get_cm()

◆ $context

stdClass lesson::$context = null

protected

Context object gets set and retrieved by directly calling $lesson->context;

See also: get_context()

◆ $courserecord

stdClass lesson::$courserecord = null

protected

Course object gets set and retrieved by directly calling $lesson->courserecord;

See also: get_courserecord()

◆ $firstpageid

int lesson::$firstpageid = null

protected

The id of the first page (where prevpageid = 0) gets set and retrieved by {.

See also: get_firstpageid()} by directly calling $lesson->firstpageid;

◆ $lastpageid

int lesson::$lastpageid = null

protected

The id of the last page (where nextpageid = 0) gets set and retrieved by {.

See also: get_lastpageid()} by directly calling $lesson->lastpageid;

◆ $pages

array lesson::$pages = array()

protected

An array used to cache the pages associated with this lesson after the first time they have been loaded.

A note to developers: If you are going to be working with MORE than one or two pages from a lesson you should probably call {

See also: $lesson->load_all_pages()} in order to save excess database queries. An array of lesson_page objects

The documentation for this class was generated from the following file:

mod/lesson/locallib.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __get()

◆ __isset()

◆ __set()

◆ add_message()

◆ add_messages_on_page_process()

◆ add_messages_on_page_view()

◆ calculate_new_page_on_jump()

◆ calculate_progress()

◆ can_manage()

◆ check_time()

◆ cluster_jump()

◆ copy_page_files()

◆ count_user_retries()

◆ create()

◆ delete_override()

◆ duplicate_page()

◆ get_attempts()

◆ get_cm()

◆ get_content_pages_viewed()

◆ get_context()

◆ get_courserecord()

◆ get_dependencies_restriction_status()

◆ get_firstpage()

◆ get_firstpageid()

◆ get_last_attempt()

◆ get_last_page_seen()

◆ get_lastpage()

◆ get_lastpageid()

◆ get_messages()

◆ get_next_page()

◆ get_ongoing_score_message()

◆ get_password_restriction_status()

◆ get_sub_pages_of()

◆ get_time_restriction_status()

◆ get_user_timers()

◆ is_accessible()

◆ is_in_review_mode()

◆ is_participant()

◆ is_sub_page_of_type()

◆ jumpto_is_correct()

◆ left_during_timed_session()

◆ link_for_activitylink()

◆ load()

◆ load_all_pages()

◆ load_page()

◆ prepare_page_and_contents()

◆ process_eol_page()

◆ process_page_responses()

◆ properties()

◆ resort_pages()

◆ set_module_viewed()

◆ show_only_active_users()

◆ start_timer()

◆ stop_timer()

◆ time_remaining()

◆ update_effective_access()

◆ update_timer()

Member Data Documentation

◆ $cm

◆ $context

◆ $courserecord

◆ $firstpageid

◆ $lastpageid

◆ $pages