Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
tool_lp\external Class Reference

This is the external API for this tool. More...

Inheritance diagram for tool_lp\external:

Static Public Member Functions

static data_for_competencies_manage_page ($competencyframeworkid, $search)
 Loads the data required to render the competencies_manage_page template.
 
static data_for_competencies_manage_page_parameters ()
 Returns description of data_for_competencies_manage_page() parameters.
 
static data_for_competencies_manage_page_returns ()
 Returns description of data_for_competencies_manage_page() result value.
 
static data_for_competency_frameworks_manage_page ($pagecontext)
 Loads the data required to render the competency_frameworks_manage_page template.
 
static data_for_competency_frameworks_manage_page_parameters ()
 Returns description of data_for_competency_frameworks_manage_page() parameters.
 
static data_for_competency_frameworks_manage_page_returns ()
 Returns description of data_for_competency_frameworks_manage_page() result value.
 
static data_for_competency_summary ($competencyid, $includerelated=false, $includecourses=false)
 Loads the data required to render the competency_page template.
 
static data_for_competency_summary_parameters ()
 Returns description of data_for_competency_summary() parameters.
 
static data_for_competency_summary_returns ()
 Returns description of data_for_competency_summary_() result value.
 
static data_for_course_competencies_page ($courseid, $moduleid)
 Loads the data required to render the course_competencies_page template.
 
static data_for_course_competencies_page_parameters ()
 Returns description of data_for_course_competenies_page() parameters.
 
static data_for_course_competencies_page_returns ()
 Returns description of data_for_course_competencies_page() result value.
 
static data_for_plan_page ($planid)
 Loads the data required to render the plan_page template.
 
static data_for_plan_page_parameters ()
 Returns description of data_for_plan_competenies_page() parameters.
 
static data_for_plan_page_returns ()
 Returns description of data_for_plan_page() result value.
 
static data_for_plans_page ($userid)
 Loads the data required to render the plans_page template.
 
static data_for_plans_page_parameters ()
 Returns description of data_for_plans_page() parameters.
 
static data_for_plans_page_returns ()
 Returns description of data_for_plans_page() result value.
 
static data_for_related_competencies_section ($competencyid)
 Data to render in the related competencies section.
 
static data_for_related_competencies_section_parameters ()
 Returns the description of the data_for_related_competencies_section_parameters() parameters.
 
static data_for_related_competencies_section_returns ()
 Returns description of data_for_related_competencies_section_returns() result value.
 
static data_for_template_competencies_page ($templateid, $pagecontext)
 Loads the data required to render the template_competencies_page template.
 
static data_for_template_competencies_page_parameters ()
 Returns description of data_for_template_competenies_page() parameters.
 
static data_for_template_competencies_page_returns ()
 Returns description of data_for_template_competencies_page() result value.
 
static data_for_templates_manage_page ($pagecontext)
 Loads the data required to render the templates_manage_page template.
 
static data_for_templates_manage_page_parameters ()
 Returns description of data_for_templates_manage_page() parameters.
 
static data_for_templates_manage_page_returns ()
 Returns description of data_for_templates_manage_page() result value.
 
static data_for_user_competency_summary ($userid, $competencyid)
 Data for user competency summary.
 
static data_for_user_competency_summary_in_course ($userid, $competencyid, $courseid)
 Read a user competency summary.
 
static data_for_user_competency_summary_in_course_parameters ()
 Returns description of data_for_user_competency_summary_in_course() parameters.
 
static data_for_user_competency_summary_in_course_returns ()
 Returns description of data_for_user_competency_summary_in_course() result value.
 
static data_for_user_competency_summary_in_plan ($competencyid, $planid)
 Read a user competency summary.
 
static data_for_user_competency_summary_in_plan_parameters ()
 Returns description of data_for_user_competency_summary_in_plan() parameters.
 
static data_for_user_competency_summary_in_plan_returns ()
 Returns description of data_for_user_competency_summary_in_plan() result value.
 
static data_for_user_competency_summary_parameters ()
 Returns description of external function.
 
static data_for_user_competency_summary_returns ()
 Returns description of external function.
 
static data_for_user_evidence_list_page ($userid)
 Loads the data required to render the user_evidence_list_page template.
 
static data_for_user_evidence_list_page_parameters ()
 Returns description of external function parameters.
 
static data_for_user_evidence_list_page_returns ()
 Returns description of external function result value.
 
static data_for_user_evidence_page ($id)
 Loads the data required to render the user_evidence_page template.
 
static data_for_user_evidence_page_parameters ()
 Returns description of external function parameters.
 
static data_for_user_evidence_page_returns ()
 Returns description of external function result value.
 
static list_courses_using_competency ($competencyid)
 Count the courses (visible to this user) that use this competency.
 
static list_courses_using_competency_parameters ()
 Returns description of list_courses_using_competency() parameters.
 
static list_courses_using_competency_returns ()
 Returns description of list_courses_using_competency() result value.
 
static search_users ($query, $capability='', $limitfrom=0, $limitnum=100)
 Search users.
 
static search_users_parameters ()
 Returns the description of external function parameters.
 
static search_users_returns ()
 Returns description of external function result value.
 

Static Protected Member Functions

static get_context_parameters ()
 Returns a prepared structure to use a context parameters.
 

Detailed Description

This is the external API for this tool.

License
http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Member Function Documentation

◆ data_for_competencies_manage_page()

static tool_lp\external::data_for_competencies_manage_page ( $competencyframeworkid,
$search )
static

Loads the data required to render the competencies_manage_page template.

Parameters
int$competencyframeworkidFramework id.
string$searchText to search.
Return values
boolean

◆ data_for_competencies_manage_page_parameters()

static tool_lp\external::data_for_competencies_manage_page_parameters ( )
static

Returns description of data_for_competencies_manage_page() parameters.

Return values
external_function_parameters

◆ data_for_competencies_manage_page_returns()

static tool_lp\external::data_for_competencies_manage_page_returns ( )
static

Returns description of data_for_competencies_manage_page() result value.

Return values
external_description

◆ data_for_competency_frameworks_manage_page()

static tool_lp\external::data_for_competency_frameworks_manage_page ( $pagecontext)
static

Loads the data required to render the competency_frameworks_manage_page template.

Parameters
context$pagecontextThe page context
Return values
stdClass

◆ data_for_competency_frameworks_manage_page_parameters()

static tool_lp\external::data_for_competency_frameworks_manage_page_parameters ( )
static

Returns description of data_for_competency_frameworks_manage_page() parameters.

Return values
external_function_parameters

◆ data_for_competency_frameworks_manage_page_returns()

static tool_lp\external::data_for_competency_frameworks_manage_page_returns ( )
static

Returns description of data_for_competency_frameworks_manage_page() result value.

Return values
external_description

◆ data_for_competency_summary()

static tool_lp\external::data_for_competency_summary ( $competencyid,
$includerelated = false,
$includecourses = false )
static

Loads the data required to render the competency_page template.

Parameters
int$competencyidCompetency id.
boolean$includerelatedInclude or not related competencies.
boolean$includecoursesInclude or not competency courses.
Return values
stdClass

◆ data_for_competency_summary_parameters()

static tool_lp\external::data_for_competency_summary_parameters ( )
static

Returns description of data_for_competency_summary() parameters.

Return values
external_function_parameters

◆ data_for_competency_summary_returns()

static tool_lp\external::data_for_competency_summary_returns ( )
static

Returns description of data_for_competency_summary_() result value.

Return values
external_description

◆ data_for_course_competencies_page()

static tool_lp\external::data_for_course_competencies_page ( $courseid,
$moduleid )
static

Loads the data required to render the course_competencies_page template.

Parameters
int$courseidThe course id to check.
int$moduleidThe module id to check (0 for no filter).
Return values
boolean

◆ data_for_course_competencies_page_parameters()

static tool_lp\external::data_for_course_competencies_page_parameters ( )
static

Returns description of data_for_course_competenies_page() parameters.

Return values
external_function_parameters

◆ data_for_course_competencies_page_returns()

static tool_lp\external::data_for_course_competencies_page_returns ( )
static

Returns description of data_for_course_competencies_page() result value.

Return values
external_description

◆ data_for_plan_page()

static tool_lp\external::data_for_plan_page ( $planid)
static

Loads the data required to render the plan_page template.

Parameters
int$planidLearning Plan id.
Return values
boolean

◆ data_for_plan_page_parameters()

static tool_lp\external::data_for_plan_page_parameters ( )
static

Returns description of data_for_plan_competenies_page() parameters.

Return values
external_function_parameters

◆ data_for_plan_page_returns()

static tool_lp\external::data_for_plan_page_returns ( )
static

Returns description of data_for_plan_page() result value.

Return values
external_description

◆ data_for_plans_page()

static tool_lp\external::data_for_plans_page ( $userid)
static

Loads the data required to render the plans_page template.

Parameters
int$useridUser id.
Return values
boolean

◆ data_for_plans_page_parameters()

static tool_lp\external::data_for_plans_page_parameters ( )
static

Returns description of data_for_plans_page() parameters.

Return values
external_function_parameters

◆ data_for_plans_page_returns()

static tool_lp\external::data_for_plans_page_returns ( )
static

Returns description of data_for_plans_page() result value.

Return values
external_description

◆ data_for_related_competencies_section()

static tool_lp\external::data_for_related_competencies_section ( $competencyid)
static

Data to render in the related competencies section.

Parameters
int$competencyid
Return values
arrayRelated competencies and whether to show delete action button or not.

◆ data_for_related_competencies_section_parameters()

static tool_lp\external::data_for_related_competencies_section_parameters ( )
static

Returns the description of the data_for_related_competencies_section_parameters() parameters.

Return values
external_function_parameters.

◆ data_for_related_competencies_section_returns()

static tool_lp\external::data_for_related_competencies_section_returns ( )
static

Returns description of data_for_related_competencies_section_returns() result value.

Return values
core_external\external_description

◆ data_for_template_competencies_page()

static tool_lp\external::data_for_template_competencies_page ( $templateid,
$pagecontext )
static

Loads the data required to render the template_competencies_page template.

Parameters
int$templateidTemplate id.
array$pagecontextThe page context info.
Return values
boolean

◆ data_for_template_competencies_page_parameters()

static tool_lp\external::data_for_template_competencies_page_parameters ( )
static

Returns description of data_for_template_competenies_page() parameters.

Return values
external_function_parameters

◆ data_for_template_competencies_page_returns()

static tool_lp\external::data_for_template_competencies_page_returns ( )
static

Returns description of data_for_template_competencies_page() result value.

Return values
external_description

◆ data_for_templates_manage_page()

static tool_lp\external::data_for_templates_manage_page ( $pagecontext)
static

Loads the data required to render the templates_manage_page template.

Parameters
array$pagecontextThe page context info.
Return values
boolean

◆ data_for_templates_manage_page_parameters()

static tool_lp\external::data_for_templates_manage_page_parameters ( )
static

Returns description of data_for_templates_manage_page() parameters.

Return values
external_function_parameters

◆ data_for_templates_manage_page_returns()

static tool_lp\external::data_for_templates_manage_page_returns ( )
static

Returns description of data_for_templates_manage_page() result value.

Return values
external_description

◆ data_for_user_competency_summary()

static tool_lp\external::data_for_user_competency_summary ( $userid,
$competencyid )
static

Data for user competency summary.

Parameters
int$useridThe user ID
int$competencyidThe competency ID
Return values
stdClass

◆ data_for_user_competency_summary_in_course()

static tool_lp\external::data_for_user_competency_summary_in_course ( $userid,
$competencyid,
$courseid )
static

Read a user competency summary.

Parameters
int$useridThe user id
int$competencyidThe competency id
int$courseidThe course id
Return values
stdClass

◆ data_for_user_competency_summary_in_course_parameters()

static tool_lp\external::data_for_user_competency_summary_in_course_parameters ( )
static

Returns description of data_for_user_competency_summary_in_course() parameters.

Return values
external_function_parameters

◆ data_for_user_competency_summary_in_course_returns()

static tool_lp\external::data_for_user_competency_summary_in_course_returns ( )
static

Returns description of data_for_user_competency_summary_in_course() result value.

Return values
external_description

◆ data_for_user_competency_summary_in_plan()

static tool_lp\external::data_for_user_competency_summary_in_plan ( $competencyid,
$planid )
static

Read a user competency summary.

Parameters
int$competencyidThe competency id
int$planidThe plan id
Return values
stdClass

◆ data_for_user_competency_summary_in_plan_parameters()

static tool_lp\external::data_for_user_competency_summary_in_plan_parameters ( )
static

Returns description of data_for_user_competency_summary_in_plan() parameters.

Return values
external_function_parameters

◆ data_for_user_competency_summary_in_plan_returns()

static tool_lp\external::data_for_user_competency_summary_in_plan_returns ( )
static

Returns description of data_for_user_competency_summary_in_plan() result value.

Return values
external_description

◆ data_for_user_competency_summary_parameters()

static tool_lp\external::data_for_user_competency_summary_parameters ( )
static

Returns description of external function.

Return values
external_function_parameters

◆ data_for_user_competency_summary_returns()

static tool_lp\external::data_for_user_competency_summary_returns ( )
static

Returns description of external function.

Return values
external_description

◆ data_for_user_evidence_list_page()

static tool_lp\external::data_for_user_evidence_list_page ( $userid)
static

Loads the data required to render the user_evidence_list_page template.

Parameters
int$useridUser id.
Return values
boolean

◆ data_for_user_evidence_list_page_parameters()

static tool_lp\external::data_for_user_evidence_list_page_parameters ( )
static

Returns description of external function parameters.

Return values
external_function_parameters

◆ data_for_user_evidence_list_page_returns()

static tool_lp\external::data_for_user_evidence_list_page_returns ( )
static

Returns description of external function result value.

Return values
external_description

◆ data_for_user_evidence_page()

static tool_lp\external::data_for_user_evidence_page ( $id)
static

Loads the data required to render the user_evidence_page template.

Parameters
int$idUser id.
Return values
boolean

◆ data_for_user_evidence_page_parameters()

static tool_lp\external::data_for_user_evidence_page_parameters ( )
static

Returns description of external function parameters.

Return values
external_function_parameters

◆ data_for_user_evidence_page_returns()

static tool_lp\external::data_for_user_evidence_page_returns ( )
static

Returns description of external function result value.

Return values
external_description

◆ get_context_parameters()

static tool_lp\external::get_context_parameters ( )
staticprotected

Returns a prepared structure to use a context parameters.

Return values
external_single_structure

◆ list_courses_using_competency()

static tool_lp\external::list_courses_using_competency ( $competencyid)
static

Count the courses (visible to this user) that use this competency.

Parameters
int$competencyidCompetency id.
Return values
array

◆ list_courses_using_competency_parameters()

static tool_lp\external::list_courses_using_competency_parameters ( )
static

Returns description of list_courses_using_competency() parameters.

Return values
external_function_parameters

◆ list_courses_using_competency_returns()

static tool_lp\external::list_courses_using_competency_returns ( )
static

Returns description of list_courses_using_competency() result value.

Return values
external_description

◆ search_users()

static tool_lp\external::search_users ( $query,
$capability = '',
$limitfrom = 0,
$limitnum = 100 )
static

Search users.

Parameters
string$query
string$capability
int$limitfrom
int$limitnum
Return values
array

◆ search_users_parameters()

static tool_lp\external::search_users_parameters ( )
static

Returns the description of external function parameters.

Return values
external_function_parameters.

◆ search_users_returns()

static tool_lp\external::search_users_returns ( )
static

Returns description of external function result value.

Return values
core_external\external_description

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