tool_lp

Files
file	behat_tool_lp.php
	Step definition to generate database fixtures for learning plan system.
file	behat_tool_lp_data_generators.php
	Step definition to generate database fixtures for learning plan system.
file	competency.php
	This file contains the form add/update a competency framework.
file	competency_framework.php
	This file contains the form add/update a competency framework.
file	competency_path_exporter.php
	Class for exporting competency_path data.
file	competency_plan_navigation.php
	User competency plan page class.
file	competency_summary.php
	Class containing data for competency_page page.
file	competency_summary_exporter.php
	Class for exporting competency data with the set of linked courses.
file	course_competencies_form_element.php
	Course competencies element.
file	course_competencies_page.php
	Class containing data for course competencies page.
file	course_competency_rule_form_element.php
	Course competency rule element.
file	course_competency_statistics.php
	Course competency statistics class.
file	course_competency_statistics_exporter.php
	Class for exporting a course competency statistics summary.
file	external.php
	This is the external API for this tool.
file	framework_autocomplete.php
	Framework selector field.
file	lib.php
	This page contains navigation hooks for learning plans.
file	manage_competencies_page.php
	Class containing data for managecompetencyframeworks page.
file	manage_competency_frameworks_page.php
	Class containing data for managecompetencyframeworks page.
file	manage_templates_page.php
	Class containing data for managelearningplans page.
file	module_navigation.php
	User navigation class.
file	page_helper.php
	Page helper.
file	path_node_exporter.php
	Class for exporting path_node data.
file	plan.php
	This file contains the form add/update a learning plan.
file	plan_page.php
	Plan page output.
file	plans_page.php
	Class containing data for a user learning plans list page.
file	provider.php
	Privacy Subsystem implementation for tool_lp.
file	related_competencies.php
	Class containing data for a competency.
file	renderer.php
	Renderer class for learning plans.
file	services.php
	Learning plan webservice functions.
file	settings.php
	Links and settings.
file	site_competencies_form_element.php
	Site competencies element.
file	template.php
	This file contains the form add/update a competency framework.
file	template_cohorts.php
	Template cohorts form.
file	template_cohorts_page.php
	Template cohorts page renderable.
file	template_cohorts_table.php
	Template cohorts table.
file	template_competencies_page.php
	Class containing data for learning plan template competencies page.
file	template_plans.php
	Template plans form.
file	template_plans_page.php
	Template plans renderable.
file	template_plans_table.php
	Template plans table.
file	template_statistics.php
	Template statistics class.
file	template_statistics_exporter.php
	Class for exporting a template statistics summary.
file	url_resolver.php
	URL resolver.
file	user_competency_course_navigation.php
	User competency page class.
file	user_competency_summary.php
	User competency summary.
file	user_competency_summary_exporter.php
	Class for exporting user competency data with all the evidence.
file	user_competency_summary_in_course.php
	User competency page class.
file	user_competency_summary_in_course_exporter.php
	Class for exporting user competency data with all the evidence in a course.
file	user_competency_summary_in_plan.php
	User competency page class.
file	user_competency_summary_in_plan_exporter.php
	Class for exporting user competency data with all the evidence in a plan.
file	user_evidence.php
	User evidence form.
file	user_evidence_competency_summary_exporter.php
	Class for exporting user evidence competency data.
file	user_evidence_list_page.php
	Page listing the evidence of prior learning of a user.
file	user_evidence_page.php
	User evidence page output.
file	user_evidence_summary_exporter.php
	Class for exporting user evidence with all competencies.
file	version.php
	Plugin version info.

Namespaces
namespace	tool_lp
namespace	tool_lp\external
namespace	tool_lp\form
namespace	tool_lp\output
namespace	tool_lp\privacy

Classes
class	behat_tool_lp
class	behat_tool_lp_data_generators
class	tool_lp\course_competency_statistics
	Course competency statistics class. More...
class	tool_lp\external
	This is the external API for this tool. More...
class	tool_lp\external\competency_path_exporter
	Class for exporting competency_path data. More...
class	tool_lp\external\competency_summary_exporter
	Class for exporting competency data with additional related data. More...
class	tool_lp\external\course_competency_statistics_exporter
	Class for exporting a course competency statistics summary. More...
class	tool_lp\external\path_node_exporter
	Class for exporting path_node data. More...
class	tool_lp\external\template_statistics_exporter
	Class for exporting a cohort summary from an stdClass. More...
class	tool_lp\external\user_competency_summary_exporter
	Class for exporting user competency data with additional related data. More...
class	tool_lp\external\user_competency_summary_in_course_exporter
	Class for exporting user competency data with additional related data in a plan. More...
class	tool_lp\external\user_competency_summary_in_plan_exporter
	Class for exporting user competency data with additional related data in a plan. More...
class	tool_lp\external\user_evidence_competency_summary_exporter
	Class for exporting user evidence competency data. More...
class	tool_lp\external\user_evidence_summary_exporter
	Class for exporting user evidence with all competencies. More...
class	tool_lp\form\competency
	Competency framework form. More...
class	tool_lp\form\competency_framework
	Competency framework form. More...
class	tool_lp\form\framework_autocomplete
	Form field type for choosing a framework. More...
class	tool_lp\form\plan
	Learning plan form. More...
class	tool_lp\form\template
	Learning plan template form. More...
class	tool_lp\form\template_cohorts
	Template cohorts form class. More...
class	tool_lp\form\template_plans
	Template plans form class. More...
class	tool_lp\form\user_evidence
	User evidence form class. More...
class	tool_lp\output\competency_plan_navigation
	User competency plan navigation class. More...
class	tool_lp\output\competency_summary
	Class containing data for competency summary. More...
class	tool_lp\output\course_competencies_page
	Class containing data for course competencies page. More...
class	tool_lp\output\manage_competencies_page
	Class containing data for managecompetencies page. More...
class	tool_lp\output\manage_competency_frameworks_page
	Class containing data for managecompetencyframeworks page. More...
class	tool_lp\output\manage_templates_page
	Class containing data for managecompetencyframeworks page. More...
class	tool_lp\output\module_navigation
	User course navigation class. More...
class	tool_lp\output\plan_page
	Plan page class. More...
class	tool_lp\output\plans_page
	Class containing data for a user learning plans list page. More...
class	tool_lp\output\related_competencies
	Class containing data for related competencies. More...
class	tool_lp\output\renderer
	Renderer class for learning plans. More...
class	tool_lp\output\template_cohorts_page
	Template cohorts renderable. More...
class	tool_lp\output\template_cohorts_table
	Template cohorts table class. More...
class	tool_lp\output\template_competencies_page
	Class containing data for learning plan template competencies page. More...
class	tool_lp\output\template_plans_page
	Template plans renderable. More...
class	tool_lp\output\template_plans_table
	Template plans table class. More...
class	tool_lp\output\user_competency_course_navigation
	User competency course navigation class. More...
class	tool_lp\output\user_competency_summary
	User competency summary class. More...
class	tool_lp\output\user_competency_summary_in_course
	User competency page class. More...
class	tool_lp\output\user_competency_summary_in_plan
	User competency page class. More...
class	tool_lp\output\user_evidence_list_page
	Class for the page listing the evidence of prior learning of a user. More...
class	tool_lp\output\user_evidence_page
	User evidence page class. More...
class	tool_lp\page_helper
	Page helper. More...
class	tool_lp\privacy\provider
	Privacy Subsystem for tool_lp implementing null_provider. More...
class	tool_lp\template_statistics
	Template statistics class. More...
class	tool_lp\url_resolver
	URL resolver class. More...
class	tool_lp_course_competencies_form_element
	Course competencies element. More...
class	tool_lp_course_competency_rule_form_element
	Course competency rule element. More...
class	tool_lp_site_competencies_form_element
	Site competencies element. More...

Functions
	tool_lp_competency_picker ($mform, $courseid, $context, $elementname)
	Inject a course competency picker into the form. More...
	tool_lp_coursemodule_edit_post_actions ($data, $course)
	Hook the add/edit of the course module. More...
	tool_lp_coursemodule_standard_elements ($formwrapper, $mform)
	Inject the competencies elements into all moodle module settings forms. More...
	tool_lp_extend_navigation_category_settings ($navigation, $coursecategorycontext)
	This function extends the category navigation to add learning plan links. More...
	tool_lp_extend_navigation_user ($navigation, $user, $usercontext, $course, $coursecontext)
	This function extends the user navigation. More...
	tool_lp_get_fontawesome_icon_map ()
	Map icons for font-awesome themes.
	tool_lp_myprofile_navigation (core_user\output\myprofile\tree $tree, $user, $iscurrentuser, $course)
	Add nodes to myprofile page. More...
	tool_lp_render_competency_summary (\core_competency\competency $competency, core_competency\competency_framework $framework, $includerelated, $includecourses, $skipenabled=false)
	Render a short bit of information about a competency. More...

Variables
global	$CFG
global	$CFG
global	tool_lp\form::$CFG
global	$CFG
	$functions
	$parentname = 'competencies'
	$plugin = 2020060900
$plugin	component = 'tool_lp'
$plugin	version = 2020061500

Detailed Description

Function Documentation

tool_lp_competency_picker()

tool_lp_competency_picker	(		$mform,
			$courseid,
			$context,
			$elementname
	)

Inject a course competency picker into the form.

Parameters

MoodleQuickForm	$mform	The actual form object (required to modify the form).
integer	$courseid	- SITEID or a course id
context	$context	- The page context
string	$elementname	- The name of the form element to create

tool_lp_coursemodule_edit_post_actions()

tool_lp_coursemodule_edit_post_actions	(		$data,
			$course
	)

Hook the add/edit of the course module.

Parameters

stdClass	$data	Data from the form submission.
stdClass	$course	The course.

tool_lp_coursemodule_standard_elements()

tool_lp_coursemodule_standard_elements	(		$formwrapper,
			$mform
	)

Inject the competencies elements into all moodle module settings forms.

Parameters

moodleform	$formwrapper	The moodle quickforms wrapper object.
MoodleQuickForm	$mform	The actual form object (required to modify the form).

tool_lp_extend_navigation_category_settings()

tool_lp_extend_navigation_category_settings	(		$navigation,
			$coursecategorycontext
	)

This function extends the category navigation to add learning plan links.

Parameters

navigation_node	$navigation	The navigation node to extend
context	$coursecategorycontext	The context of the course category

tool_lp_extend_navigation_user()

tool_lp_extend_navigation_user	(		$navigation,
			$user,
			$usercontext,
			$course,
			$coursecontext
	)

This function extends the user navigation.

Parameters

navigation_node	$navigation	The navigation node to extend
stdClass	$user	The user object
context_user	$usercontext	The user context
stdClass	$course	The course object
context_course	$coursecontext	The context of the course

tool_lp_myprofile_navigation()

tool_lp_myprofile_navigation	(	core_user\output\myprofile\tree	$tree,
			$user,
			$iscurrentuser,
			$course
	)

Add nodes to myprofile page.

Parameters

core_user::output::myprofile::tree	$tree	Tree object
stdClass	$user	user object
bool	$iscurrentuser
stdClass	$course	Course object

Return values

bool

tool_lp_render_competency_summary()

tool_lp_render_competency_summary	(	\core_competency\competency	$competency,
		core_competency\competency_framework	$framework,
			$includerelated,
			$includecourses,
			$skipenabled = false
	)

Render a short bit of information about a competency.

Parameters

core_competency::competency	$competency	The competency to show.
core_competency::competency_framework	$framework	The competency framework.
boolean	$includerelated	If true, show related competencies.
boolean	$includecourses	If true, show courses using this competency.
boolean	$skipenabled	If true, show this competency even if competencies are disabled.

Return values

string

The html summary for the competency.