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

External API class. More...

Inheritance diagram for core_competency\external:

Static Public Member Functions

static add_competency_to_course ($courseid, $competencyid)
 Count the competencies (visible to this user) in this course.
 
static add_competency_to_course_parameters ()
 Returns description of add_competency_to_course() parameters.
 
static add_competency_to_course_returns ()
 Returns description of add_competency_to_course() result value.
 
static add_competency_to_plan ($planid, $competencyid)
 add competency to a learning plan.
 
static add_competency_to_plan_parameters ()
 Returns description of add_competency_to_plan() parameters.
 
static add_competency_to_plan_returns ()
 Returns description of add_competency_to_plan() result value.
 
static add_competency_to_template ($templateid, $competencyid)
 Count the competencies (visible to this user) in this template.
 
static add_competency_to_template_parameters ()
 Returns description of add_competency_to_template() parameters.
 
static add_competency_to_template_returns ()
 Returns description of add_competency_to_template() result value.
 
static add_related_competency ($competencyid, $relatedcompetencyid)
 Adds a related competency.
 
static add_related_competency_parameters ()
 Returns the description of the add_related_competency_parameters() parameters.
 
static add_related_competency_returns ()
 Returns description of add_related_competency_returns() result value.
 
static approve_plan ($id)
 External function approve_plan.
 
static approve_plan_parameters ()
 Returns description of external function parameters.
 
static approve_plan_returns ()
 Returns description of external function result value.
 
static competency_framework_viewed ($id)
 Log event competency framework viewed.
 
static competency_framework_viewed_parameters ()
 Returns description of competency_framework_viewed() parameters.
 
static competency_framework_viewed_returns ()
 Returns description of competency_framework_viewed() result value.
 
static competency_viewed ($id)
 Log event competency viewed.
 
static competency_viewed_parameters ()
 Returns description of competency_viewed() parameters.
 
static competency_viewed_returns ()
 Returns description of competency_viewed() result value.
 
static complete_plan ($planid)
 Complete Learning plan.
 
static complete_plan_parameters ()
 Returns description of complete_plan() parameters.
 
static complete_plan_returns ()
 Returns description of complete_plan() result value.
 
static count_competencies ($filters)
 Count the existing competency frameworks.
 
static count_competencies_in_course ($courseid)
 Count the competencies (visible to this user) in this course.
 
static count_competencies_in_course_parameters ()
 Returns description of count_competencies_in_course() parameters.
 
static count_competencies_in_course_returns ()
 Returns description of count_competencies_in_course() result value.
 
static count_competencies_in_template ($templateid)
 Count the competencies (visible to this user) in this learning plan template.
 
static count_competencies_in_template_parameters ()
 Returns description of count_competencies_in_template() parameters.
 
static count_competencies_in_template_returns ()
 Returns description of count_competencies_in_template() result value.
 
static count_competencies_parameters ()
 Returns description of count_competencies() parameters.
 
static count_competencies_returns ()
 Returns description of count_competencies() result value.
 
static count_competency_frameworks ($context, $includes)
 Count the existing competency frameworks.
 
static count_competency_frameworks_parameters ()
 Returns description of count_competency_frameworks() parameters.
 
static count_competency_frameworks_returns ()
 Returns description of count_competency_frameworks() result value.
 
static count_course_module_competencies ($cmid)
 List the course modules using this competency (visible to this user) in this course.
 
static count_course_module_competencies_parameters ()
 Returns description of count_course_module_competencies() parameters.
 
static count_course_module_competencies_returns ()
 Returns description of count_course_module_competencies() result value.
 
static count_courses_using_competency ($competencyid)
 Count the courses (visible to this user) that use this competency.
 
static count_courses_using_competency_parameters ()
 Returns description of count_courses_using_competency() parameters.
 
static count_courses_using_competency_returns ()
 Returns description of count_courses_using_competency() result value.
 
static count_templates ($context, $includes)
 Count the existing learning plan templates.
 
static count_templates_parameters ()
 Returns description of count_templates() parameters.
 
static count_templates_returns ()
 Returns description of count_templates() result value.
 
static count_templates_using_competency ($competencyid)
 Count the learning plan templates (visible to this user) that use this competency.
 
static count_templates_using_competency_parameters ()
 Returns description of count_templates_using_competency() parameters.
 
static count_templates_using_competency_returns ()
 Returns description of count_templates_using_competency() result value.
 
static create_competency ($competency)
 Create a new competency.
 
static create_competency_framework ($competencyframework)
 Create a new competency framework.
 
static create_competency_framework_parameters ()
 Returns description of create_competency_framework() parameters.
 
static create_competency_framework_returns ()
 Returns description of create_competency_framework() result value.
 
static create_competency_parameters ()
 Returns description of create_competency() parameters.
 
static create_competency_returns ()
 Returns description of create_competency() result value.
 
static create_plan ($plan)
 Create a new learning plan.
 
static create_plan_parameters ()
 Returns description of create_plan() parameters.
 
static create_plan_returns ()
 Returns description of create_plan() result value.
 
static create_template ($template)
 Create a new learning plan template.
 
static create_template_parameters ()
 Returns description of create_template() parameters.
 
static create_template_returns ()
 Returns description of create_template() result value.
 
static create_user_evidence_competency ($userevidenceid, $competencyid)
 Delete a user evidence competency relationship.
 
static create_user_evidence_competency_parameters ()
 Returns description of external function parameters.
 
static create_user_evidence_competency_returns ()
 Returns description of external function result value.
 
static delete_competency ($id)
 Delete a competency.
 
static delete_competency_framework ($id)
 Delete a competency framework.
 
static delete_competency_framework_parameters ()
 Returns description of delete_competency_framework() parameters.
 
static delete_competency_framework_returns ()
 Returns description of delete_competency_framework() result value.
 
static delete_competency_parameters ()
 Returns description of delete_competency() parameters.
 
static delete_competency_returns ()
 Returns description of delete_competency() result value.
 
static delete_evidence ($id)
 External function delete_evidence.
 
static delete_evidence_parameters ()
 Returns description of external function parameters.
 
static delete_evidence_returns ()
 Returns description of external function result value.
 
static delete_plan ($id)
 Delete a plan.
 
static delete_plan_parameters ()
 Returns description of delete_plan() parameters.
 
static delete_plan_returns ()
 Returns description of delete_plan() result value.
 
static delete_template ($id, $deleteplans=true)
 Delete a learning plan template.
 
static delete_template_parameters ()
 Returns description of delete_template() parameters.
 
static delete_template_returns ()
 Returns description of delete_template() result value.
 
static delete_user_evidence ($id)
 Delete a user evidence.
 
static delete_user_evidence_competency ($userevidenceid, $competencyid)
 Delete a user evidence competency relationship.
 
static delete_user_evidence_competency_parameters ()
 Returns description of external function parameters.
 
static delete_user_evidence_competency_returns ()
 Returns description of external function result value.
 
static delete_user_evidence_parameters ()
 Returns description of external function parameters.
 
static delete_user_evidence_returns ()
 Returns description of external function result value.
 
static duplicate_competency_framework ($id)
 Duplicate a competency framework.
 
static duplicate_competency_framework_parameters ()
 Returns description of duplicate_competency_framework() parameters.
 
static duplicate_competency_framework_returns ()
 Returns description of duplicate_competency_framework() result value.
 
static duplicate_template ($id)
 Duplicate a learning plan template.
 
static duplicate_template_parameters ()
 Returns description of duplicate_template() parameters.
 
static duplicate_template_returns ()
 Returns description of duplicate_template() result value.
 
static get_scale_values ($scaleid)
 Get the values associated with a scale.
 
static get_scale_values_parameters ()
 Returns the description of the get_scale_values() parameters.
 
static get_scale_values_returns ()
 Returns description of get_scale_values() result value.
 
static grade_competency ($userid, $competencyid, $grade, $note=null)
 Grade a competency.
 
static grade_competency_in_course ($courseid, $userid, $competencyid, $grade, $note=null)
 Grade a competency in a course.
 
static grade_competency_in_course_parameters ()
 Returns description of grade_competency_in_course() parameters.
 
static grade_competency_in_course_returns ()
 Returns description of grade_competency_in_course() result value.
 
static grade_competency_in_plan ($planid, $competencyid, $grade, $note=null)
 Grade a competency in a plan.
 
static grade_competency_in_plan_parameters ()
 Returns description of grade_competency_in_plan() parameters.
 
static grade_competency_in_plan_returns ()
 Returns description of grade_competency_in_plan() result value.
 
static grade_competency_parameters ()
 Returns description of external function parameters.
 
static grade_competency_returns ()
 Returns description of external function result value.
 
static list_competencies ($filters, $sort, $order, $skip, $limit)
 List the existing competency.
 
static list_competencies_in_template ($templateid)
 List the competencies (visible to this user) in this learning plan template.
 
static list_competencies_in_template_parameters ()
 Returns description of list_competencies_in_template() parameters.
 
static list_competencies_in_template_returns ()
 Returns description of list_competencies_in_template() result value.
 
static list_competencies_parameters ()
 Returns description of list_competencies() parameters.
 
static list_competencies_returns ()
 Returns description of list_competencies() result value.
 
static list_competency_frameworks ($sort, $order, $skip, $limit, $context, $includes, $onlyvisible, $query='')
 List the existing competency frameworks.
 
static list_competency_frameworks_parameters ()
 Returns description of list_competency_frameworks() parameters.
 
static list_competency_frameworks_returns ()
 Returns description of list_competency_frameworks() result value.
 
static list_course_competencies ($courseid)
 List the competencies (visible to this user) in this course.
 
static list_course_competencies_parameters ()
 Returns description of list_course_competencies() parameters.
 
static list_course_competencies_returns ()
 Returns description of list_course_competencies() result value.
 
static list_course_module_competencies ($cmid)
 List the course modules using this competency (visible to this user) in this course.
 
static list_course_module_competencies_parameters ()
 Returns description of list_course_module_competencies() parameters.
 
static list_course_module_competencies_returns ()
 Returns description of list_course_module_competencies() result value.
 
static list_plan_competencies ($id)
 List plan competencies.
 
static list_plan_competencies_parameters ()
 External function parameters structure.
 
static list_plan_competencies_returns ()
 External function return structure.
 
static list_templates ($sort, $order, $skip, $limit, $context, $includes, $onlyvisible)
 List the existing learning plan templates.
 
static list_templates_parameters ()
 Returns description of list_templates() parameters.
 
static list_templates_returns ()
 Returns description of list_templates() result value.
 
static list_templates_using_competency ($competencyid)
 List the learning plan templates (visible to this user) that use this competency.
 
static list_templates_using_competency_parameters ()
 Returns description of list_templates_using_competency() parameters.
 
static list_templates_using_competency_returns ()
 Returns description of list_templates_using_competency() result value.
 
static list_user_plans ($userid)
 External function list_user_plans.
 
static list_user_plans_parameters ()
 Returns description of external function parameters.
 
static list_user_plans_returns ()
 Returns description of external function result value.
 
static move_down_competency ($competencyid)
 Change the sort order of a competency.
 
static move_down_competency_parameters ()
 Returns description of move_down_competency() parameters.
 
static move_down_competency_returns ()
 Returns description of move_down_competency() result value.
 
static move_up_competency ($competencyid)
 Change the sort order of a competency.
 
static move_up_competency_parameters ()
 Returns description of move_up_competency() parameters.
 
static move_up_competency_returns ()
 Returns description of move_up_competency() result value.
 
static plan_cancel_review_request ($id)
 External function plan_cancel_review_request.
 
static plan_cancel_review_request_parameters ()
 Returns description of external function parameters.
 
static plan_cancel_review_request_returns ()
 Returns description of external function result value.
 
static plan_request_review ($id)
 External function plan_request_review.
 
static plan_request_review_parameters ()
 Returns description of external function parameters.
 
static plan_request_review_returns ()
 Returns description of external function result value.
 
static plan_start_review ($id)
 External function plan_start_review.
 
static plan_start_review_parameters ()
 Returns description of external function parameters.
 
static plan_start_review_returns ()
 Returns description of external function result value.
 
static plan_stop_review ($id)
 External function plan_stop_review.
 
static plan_stop_review_parameters ()
 Returns description of external function parameters.
 
static plan_stop_review_returns ()
 Returns description of external function result value.
 
static read_competency ($id)
 Read a competency by id.
 
static read_competency_framework ($id)
 Read a competency framework by id.
 
static read_competency_framework_parameters ()
 Returns description of read_competency_framework() parameters.
 
static read_competency_framework_returns ()
 Returns description of read_competency_framework() result value.
 
static read_competency_parameters ()
 Returns description of read_competency() parameters.
 
static read_competency_returns ()
 Returns description of read_competency() result value.
 
static read_plan ($id)
 Read a plan by id.
 
static read_plan_parameters ()
 Returns description of read_plan() parameters.
 
static read_plan_returns ()
 Returns description of read_plan() result value.
 
static read_template ($id)
 Read a learning plan template by id.
 
static read_template_parameters ()
 Returns description of read_template() parameters.
 
static read_template_returns ()
 Returns description of read_template() result value.
 
static read_user_evidence ($id)
 Delete a user evidence.
 
static read_user_evidence_parameters ()
 Returns description of external function parameters.
 
static read_user_evidence_returns ()
 Returns description of external function result value.
 
static remove_competency_from_course ($courseid, $competencyid)
 Count the competencies (visible to this user) in this course.
 
static remove_competency_from_course_parameters ()
 Returns description of remove_competency_from_course() parameters.
 
static remove_competency_from_course_returns ()
 Returns description of remove_competency_from_course() result value.
 
static remove_competency_from_plan ($planid, $competencyid)
 Remove a competency from plan.
 
static remove_competency_from_plan_parameters ()
 Returns description of remove_competency_from_plan() parameters.
 
static remove_competency_from_plan_returns ()
 Returns description of remove_competency_from_plan() result value.
 
static remove_competency_from_template ($templateid, $competencyid)
 Count the competencies (visible to this user) in this learning plan template.
 
static remove_competency_from_template_parameters ()
 Returns description of remove_competency_from_template() parameters.
 
static remove_competency_from_template_returns ()
 Returns description of remove_competency_from_template() result value.
 
static remove_related_competency ($competencyid, $relatedcompetencyid)
 Removes a related competency.
 
static remove_related_competency_parameters ()
 Returns the description of the remove_related_competency_parameters() parameters.
 
static remove_related_competency_returns ()
 Returns description of remove_related_competency_returns() result value.
 
static reopen_plan ($planid)
 Reopen Learning plan.
 
static reopen_plan_parameters ()
 Returns description of reopen_plan() parameters.
 
static reopen_plan_returns ()
 Returns description of reopen_plan() result value.
 
static reorder_course_competency ($courseid, $competencyidfrom, $competencyidto)
 Change the order of course competencies.
 
static reorder_course_competency_parameters ()
 Returns description of reorder_course_competency() parameters.
 
static reorder_course_competency_returns ()
 Returns description of reorder_course_competency() result value.
 
static reorder_plan_competency ($planid, $competencyidfrom, $competencyidto)
 Change the order of plan competencies.
 
static reorder_plan_competency_parameters ()
 Returns description of reorder_plan_competency() parameters.
 
static reorder_plan_competency_returns ()
 Returns description of reorder_plan_competency() result value.
 
static reorder_template_competency ($templateid, $competencyidfrom, $competencyidto)
 Change the order of template competencies.
 
static reorder_template_competency_parameters ()
 Returns description of reorder_template_competency() parameters.
 
static reorder_template_competency_returns ()
 Returns description of reorder_template_competency() result value.
 
static request_review_of_user_evidence_linked_competencies ($id)
 Send user evidence competencies to review.
 
static request_review_of_user_evidence_linked_competencies_parameters ()
 Returns description of external function parameters.
 
static request_review_of_user_evidence_linked_competencies_returns ()
 Returns description of external function result value.
 
static search_competencies ($searchtext, $competencyframeworkid)
 List the existing competency frameworks.
 
static search_competencies_parameters ()
 Returns description of search_competencies() parameters.
 
static search_competencies_returns ()
 Returns description of search_competencies() result value.
 
static set_course_competency_ruleoutcome ($coursecompetencyid, $ruleoutcome)
 Change the ruleoutcome of a course competency.
 
static set_course_competency_ruleoutcome_parameters ()
 Returns description of update_ruleoutcome_course_competency() parameters.
 
static set_course_competency_ruleoutcome_returns ()
 Returns description of update_ruleoutcome_course_competency() result value.
 
static set_parent_competency ($competencyid, $parentid)
 Move the competency to a new parent.
 
static set_parent_competency_parameters ()
 Returns description of set_parent_competency() parameters.
 
static set_parent_competency_returns ()
 Returns description of set_parent_competency() result value.
 
static template_has_related_data ($templateid)
 Check if template has related data.
 
static template_has_related_data_parameters ()
 Returns description of template_has_related_data() parameters.
 
static template_has_related_data_returns ()
 Returns description of template_has_related_data() result value.
 
static template_viewed ($id)
 Log the template viewed event.
 
static template_viewed_parameters ()
 Returns description of template_viewed() parameters.
 
static template_viewed_returns ()
 Returns description of template_viewed() result value.
 
static unapprove_plan ($id)
 External function unapprove_plan.
 
static unapprove_plan_parameters ()
 Returns description of external function parameters.
 
static unapprove_plan_returns ()
 Returns description of external function result value.
 
static unlink_plan_from_template ($planid)
 Unlink the plan from the template.
 
static unlink_plan_from_template_parameters ()
 Returns description of unlink_plan_from_template_() parameters.
 
static unlink_plan_from_template_returns ()
 Returns description of unlink_plan_from_template_() result value.
 
static update_competency ($competency)
 Update an existing competency.
 
static update_competency_framework ($competencyframework)
 Update an existing competency framework.
 
static update_competency_framework_parameters ()
 Returns description of update_competency_framework() parameters.
 
static update_competency_framework_returns ()
 Returns description of update_competency_framework() result value.
 
static update_competency_parameters ()
 Returns description of update_competency() parameters.
 
static update_competency_returns ()
 Returns description of update_competency_framework() result value.
 
static update_course_competency_settings ($courseid, $settings)
 Update the course competency settings.
 
static update_course_competency_settings_parameters ()
 Returns description of update_course_competency_settings() parameters.
 
static update_course_competency_settings_returns ()
 Returns description of update_course_competency_settings() result value.
 
static update_plan ($plan)
 Updates a new learning plan.
 
static update_plan_parameters ()
 Returns description of update_plan() parameters.
 
static update_plan_returns ()
 Returns description of update_plan() result value.
 
static update_template ($template)
 Update an existing learning plan template.
 
static update_template_parameters ()
 Returns description of update_template() parameters.
 
static update_template_returns ()
 Returns description of update_template() result value.
 
static user_competency_cancel_review_request ($userid, $competencyid)
 External function user_competency_cancel_review_request.
 
static user_competency_cancel_review_request_parameters ()
 Returns description of external function parameters.
 
static user_competency_cancel_review_request_returns ()
 Returns description of external function result value.
 
static user_competency_plan_viewed ($competencyid, $userid, $planid)
 Log user competency plan viewed event.
 
static user_competency_plan_viewed_parameters ()
 Returns description of user_competency_plan_viewed() parameters.
 
static user_competency_plan_viewed_returns ()
 Returns description of user_competency_plan_viewed() result value.
 
static user_competency_request_review ($userid, $competencyid)
 External function user_competency_request_review.
 
static user_competency_request_review_parameters ()
 Returns description of external function parameters.
 
static user_competency_request_review_returns ()
 Returns description of external function result value.
 
static user_competency_start_review ($userid, $competencyid)
 External function user_competency_start_review.
 
static user_competency_start_review_parameters ()
 Returns description of external function parameters.
 
static user_competency_start_review_returns ()
 Returns description of external function result value.
 
static user_competency_stop_review ($userid, $competencyid)
 External function user_competency_stop_review.
 
static user_competency_stop_review_parameters ()
 Returns description of external function parameters.
 
static user_competency_stop_review_returns ()
 Returns description of external function result value.
 
static user_competency_viewed ($usercompetencyid)
 Log user competency viewed event.
 
static user_competency_viewed_in_course ($competencyid, $userid, $courseid)
 Log user competency viewed in course event.
 
static user_competency_viewed_in_course_parameters ()
 Returns description of user_competency_viewed_in_course() parameters.
 
static user_competency_viewed_in_course_returns ()
 Returns description of user_competency_viewed_in_course() result value.
 
static user_competency_viewed_in_plan ($competencyid, $userid, $planid)
 Log user competency viewed in plan event.
 
static user_competency_viewed_in_plan_parameters ()
 Returns description of user_competency_viewed_in_plan() parameters.
 
static user_competency_viewed_in_plan_returns ()
 Returns description of user_competency_viewed_in_plan() result value.
 
static user_competency_viewed_parameters ()
 Returns description of user_competency_viewed() parameters.
 
static user_competency_viewed_returns ()
 Returns description of user_competency_viewed() result value.
 

Static Protected Member Functions

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

Detailed Description

External API class.

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

Member Function Documentation

◆ add_competency_to_course()

static core_competency\external::add_competency_to_course ( $courseid,
$competencyid )
static

Count the competencies (visible to this user) in this course.

Parameters
int$courseidThe course id to check.
int$competencyidCompetency id.
Return values
int

◆ add_competency_to_course_parameters()

static core_competency\external::add_competency_to_course_parameters ( )
static

Returns description of add_competency_to_course() parameters.

Return values
external_function_parameters

◆ add_competency_to_course_returns()

static core_competency\external::add_competency_to_course_returns ( )
static

Returns description of add_competency_to_course() result value.

Return values
external_description

◆ add_competency_to_plan()

static core_competency\external::add_competency_to_plan ( $planid,
$competencyid )
static

add competency to a learning plan.

Parameters
int$planidPlan id.
int$competencyidCompetency id.
Return values
int

◆ add_competency_to_plan_parameters()

static core_competency\external::add_competency_to_plan_parameters ( )
static

Returns description of add_competency_to_plan() parameters.

Return values
external_function_parameters

◆ add_competency_to_plan_returns()

static core_competency\external::add_competency_to_plan_returns ( )
static

Returns description of add_competency_to_plan() result value.

Return values
external_description

◆ add_competency_to_template()

static core_competency\external::add_competency_to_template ( $templateid,
$competencyid )
static

Count the competencies (visible to this user) in this template.

Parameters
int$templateidTemplate id.
int$competencyidCompetency id.
Return values
int

◆ add_competency_to_template_parameters()

static core_competency\external::add_competency_to_template_parameters ( )
static

Returns description of add_competency_to_template() parameters.

Return values
external_function_parameters

◆ add_competency_to_template_returns()

static core_competency\external::add_competency_to_template_returns ( )
static

Returns description of add_competency_to_template() result value.

Return values
external_description

◆ add_related_competency()

static core_competency\external::add_related_competency ( $competencyid,
$relatedcompetencyid )
static

Adds a related competency.

Parameters
int$competencyid
int$relatedcompetencyid
Return values
bool

◆ add_related_competency_parameters()

static core_competency\external::add_related_competency_parameters ( )
static

Returns the description of the add_related_competency_parameters() parameters.

Return values
external_function_parameters.

◆ add_related_competency_returns()

static core_competency\external::add_related_competency_returns ( )
static

Returns description of add_related_competency_returns() result value.

Return values
core_external\external_description

◆ approve_plan()

static core_competency\external::approve_plan ( $id)
static

External function approve_plan.

Parameters
int$idThe plan ID.
Return values
boolean

◆ approve_plan_parameters()

static core_competency\external::approve_plan_parameters ( )
static

Returns description of external function parameters.

Return values
external_function_parameters

◆ approve_plan_returns()

static core_competency\external::approve_plan_returns ( )
static

Returns description of external function result value.

Return values
external_function_parameters

◆ competency_framework_viewed()

static core_competency\external::competency_framework_viewed ( $id)
static

Log event competency framework viewed.

Parameters
int$idThe competency framework ID.
Return values
boolean

◆ competency_framework_viewed_parameters()

static core_competency\external::competency_framework_viewed_parameters ( )
static

Returns description of competency_framework_viewed() parameters.

Return values
external_function_parameters

◆ competency_framework_viewed_returns()

static core_competency\external::competency_framework_viewed_returns ( )
static

Returns description of competency_framework_viewed() result value.

Return values
external_description

◆ competency_viewed()

static core_competency\external::competency_viewed ( $id)
static

Log event competency viewed.

Parameters
int$idThe competency ID.
Return values
boolean

◆ competency_viewed_parameters()

static core_competency\external::competency_viewed_parameters ( )
static

Returns description of competency_viewed() parameters.

Return values
external_function_parameters

◆ competency_viewed_returns()

static core_competency\external::competency_viewed_returns ( )
static

Returns description of competency_viewed() result value.

Return values
external_description

◆ complete_plan()

static core_competency\external::complete_plan ( $planid)
static

Complete Learning plan.

Parameters
int$planidplan id (id is required)
Return values
boolean

◆ complete_plan_parameters()

static core_competency\external::complete_plan_parameters ( )
static

Returns description of complete_plan() parameters.

Return values
external_function_parameters

◆ complete_plan_returns()

static core_competency\external::complete_plan_returns ( )
static

Returns description of complete_plan() result value.

Return values
external_description

◆ count_competencies()

static core_competency\external::count_competencies ( $filters)
static

Count the existing competency frameworks.

Parameters
string$filtersFilters to use.
Return values
boolean

◆ count_competencies_in_course()

static core_competency\external::count_competencies_in_course ( $courseid)
static

Count the competencies (visible to this user) in this course.

Parameters
int$courseidThe course id to check.
Return values
int

◆ count_competencies_in_course_parameters()

static core_competency\external::count_competencies_in_course_parameters ( )
static

Returns description of count_competencies_in_course() parameters.

Return values
external_function_parameters

◆ count_competencies_in_course_returns()

static core_competency\external::count_competencies_in_course_returns ( )
static

Returns description of count_competencies_in_course() result value.

Return values
external_description

◆ count_competencies_in_template()

static core_competency\external::count_competencies_in_template ( $templateid)
static

Count the competencies (visible to this user) in this learning plan template.

Parameters
int$templateidThe template id to check
Return values
int

◆ count_competencies_in_template_parameters()

static core_competency\external::count_competencies_in_template_parameters ( )
static

Returns description of count_competencies_in_template() parameters.

Return values
external_function_parameters

◆ count_competencies_in_template_returns()

static core_competency\external::count_competencies_in_template_returns ( )
static

Returns description of count_competencies_in_template() result value.

Return values
external_description

◆ count_competencies_parameters()

static core_competency\external::count_competencies_parameters ( )
static

Returns description of count_competencies() parameters.

Return values
external_function_parameters

◆ count_competencies_returns()

static core_competency\external::count_competencies_returns ( )
static

Returns description of count_competencies() result value.

Return values
external_description

◆ count_competency_frameworks()

static core_competency\external::count_competency_frameworks ( $context,
$includes )
static

Count the existing competency frameworks.

Parameters
array$context
string$includes
Return values
int

◆ count_competency_frameworks_parameters()

static core_competency\external::count_competency_frameworks_parameters ( )
static

Returns description of count_competency_frameworks() parameters.

Return values
external_function_parameters

◆ count_competency_frameworks_returns()

static core_competency\external::count_competency_frameworks_returns ( )
static

Returns description of count_competency_frameworks() result value.

Return values
external_description

◆ count_course_module_competencies()

static core_competency\external::count_course_module_competencies ( $cmid)
static

List the course modules using this competency (visible to this user) in this course.

Parameters
int$cmidThe course module id to check.
Return values
array

◆ count_course_module_competencies_parameters()

static core_competency\external::count_course_module_competencies_parameters ( )
static

Returns description of count_course_module_competencies() parameters.

Return values
external_function_parameters

◆ count_course_module_competencies_returns()

static core_competency\external::count_course_module_competencies_returns ( )
static

Returns description of count_course_module_competencies() result value.

Return values
external_description

◆ count_courses_using_competency()

static core_competency\external::count_courses_using_competency ( $competencyid)
static

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

Parameters
int$competencyidCompetency id.
Return values
int

◆ count_courses_using_competency_parameters()

static core_competency\external::count_courses_using_competency_parameters ( )
static

Returns description of count_courses_using_competency() parameters.

Return values
external_function_parameters

◆ count_courses_using_competency_returns()

static core_competency\external::count_courses_using_competency_returns ( )
static

Returns description of count_courses_using_competency() result value.

Return values
external_description

◆ count_templates()

static core_competency\external::count_templates ( $context,
$includes )
static

Count the existing learning plan templates.

Parameters
array$context
string$includes
Return values
int

◆ count_templates_parameters()

static core_competency\external::count_templates_parameters ( )
static

Returns description of count_templates() parameters.

Return values
external_function_parameters

◆ count_templates_returns()

static core_competency\external::count_templates_returns ( )
static

Returns description of count_templates() result value.

Return values
external_description

◆ count_templates_using_competency()

static core_competency\external::count_templates_using_competency ( $competencyid)
static

Count the learning plan templates (visible to this user) that use this competency.

Parameters
int$competencyidCompetency id.
Return values
int

◆ count_templates_using_competency_parameters()

static core_competency\external::count_templates_using_competency_parameters ( )
static

Returns description of count_templates_using_competency() parameters.

Return values
external_function_parameters

◆ count_templates_using_competency_returns()

static core_competency\external::count_templates_using_competency_returns ( )
static

Returns description of count_templates_using_competency() result value.

Return values
external_description

◆ create_competency()

static core_competency\external::create_competency ( $competency)
static

Create a new competency.

Parameters
array$competencyAll the fields for a competency record (including id)
Return values
arraythe competency

◆ create_competency_framework()

static core_competency\external::create_competency_framework ( $competencyframework)
static

Create a new competency framework.

Parameters
array$competencyframeworkA single param with all the fields for a competency framework.
Return values
stdClassThe new record

◆ create_competency_framework_parameters()

static core_competency\external::create_competency_framework_parameters ( )
static

Returns description of create_competency_framework() parameters.

Return values
external_function_parameters

◆ create_competency_framework_returns()

static core_competency\external::create_competency_framework_returns ( )
static

Returns description of create_competency_framework() result value.

Return values
external_description

◆ create_competency_parameters()

static core_competency\external::create_competency_parameters ( )
static

Returns description of create_competency() parameters.

Return values
external_function_parameters

◆ create_competency_returns()

static core_competency\external::create_competency_returns ( )
static

Returns description of create_competency() result value.

Return values
external_description

◆ create_plan()

static core_competency\external::create_plan ( $plan)
static

Create a new learning plan.

Parameters
array$planList of fields for the plan.
Return values
arrayNew plan record.

◆ create_plan_parameters()

static core_competency\external::create_plan_parameters ( )
static

Returns description of create_plan() parameters.

Return values
external_function_parameters

◆ create_plan_returns()

static core_competency\external::create_plan_returns ( )
static

Returns description of create_plan() result value.

Return values
external_description

◆ create_template()

static core_competency\external::create_template ( $template)
static

Create a new learning plan template.

Parameters
array$templateThe list of fields for the template.
Return values
stdClassRecord of new template.

◆ create_template_parameters()

static core_competency\external::create_template_parameters ( )
static

Returns description of create_template() parameters.

Return values
external_function_parameters

◆ create_template_returns()

static core_competency\external::create_template_returns ( )
static

Returns description of create_template() result value.

Return values
external_description

◆ create_user_evidence_competency()

static core_competency\external::create_user_evidence_competency ( $userevidenceid,
$competencyid )
static

Delete a user evidence competency relationship.

Parameters
int$userevidenceidThe user evidence id.
int$competencyidThe competency id.
Return values
boolean

◆ create_user_evidence_competency_parameters()

static core_competency\external::create_user_evidence_competency_parameters ( )
static

Returns description of external function parameters.

Return values
external_function_parameters

◆ create_user_evidence_competency_returns()

static core_competency\external::create_user_evidence_competency_returns ( )
static

Returns description of external function result value.

Return values
external_description

◆ delete_competency()

static core_competency\external::delete_competency ( $id)
static

Delete a competency.

Parameters
int$idThe competency id
Return values
boolean

◆ delete_competency_framework()

static core_competency\external::delete_competency_framework ( $id)
static

Delete a competency framework.

Parameters
int$idThe competency framework id
Return values
boolean

◆ delete_competency_framework_parameters()

static core_competency\external::delete_competency_framework_parameters ( )
static

Returns description of delete_competency_framework() parameters.

Return values
external_function_parameters

◆ delete_competency_framework_returns()

static core_competency\external::delete_competency_framework_returns ( )
static

Returns description of delete_competency_framework() result value.

Return values
external_description

◆ delete_competency_parameters()

static core_competency\external::delete_competency_parameters ( )
static

Returns description of delete_competency() parameters.

Return values
external_function_parameters

◆ delete_competency_returns()

static core_competency\external::delete_competency_returns ( )
static

Returns description of delete_competency() result value.

Return values
external_description

◆ delete_evidence()

static core_competency\external::delete_evidence ( $id)
static

External function delete_evidence.

Parameters
int$idThe evidence ID.
Return values
boolean

◆ delete_evidence_parameters()

static core_competency\external::delete_evidence_parameters ( )
static

Returns description of external function parameters.

Return values
external_function_parameters

◆ delete_evidence_returns()

static core_competency\external::delete_evidence_returns ( )
static

Returns description of external function result value.

Return values
external_function_parameters

◆ delete_plan()

static core_competency\external::delete_plan ( $id)
static

Delete a plan.

Parameters
int$idThe plan id
Return values
boolean

◆ delete_plan_parameters()

static core_competency\external::delete_plan_parameters ( )
static

Returns description of delete_plan() parameters.

Return values
external_function_parameters

◆ delete_plan_returns()

static core_competency\external::delete_plan_returns ( )
static

Returns description of delete_plan() result value.

Return values
external_description

◆ delete_template()

static core_competency\external::delete_template ( $id,
$deleteplans = true )
static

Delete a learning plan template.

Parameters
int$idThe learning plan template id
boolean$deleteplansTrue to delete the plans associated to template or false to unlink them
Return values
boolean

◆ delete_template_parameters()

static core_competency\external::delete_template_parameters ( )
static

Returns description of delete_template() parameters.

Return values
external_function_parameters

◆ delete_template_returns()

static core_competency\external::delete_template_returns ( )
static

Returns description of delete_template() result value.

Return values
external_description

◆ delete_user_evidence()

static core_competency\external::delete_user_evidence ( $id)
static

Delete a user evidence.

Parameters
int$idThe evidence id
Return values
boolean

◆ delete_user_evidence_competency()

static core_competency\external::delete_user_evidence_competency ( $userevidenceid,
$competencyid )
static

Delete a user evidence competency relationship.

Parameters
int$userevidenceidThe user evidence id.
int$competencyidThe competency id.
Return values
boolean

◆ delete_user_evidence_competency_parameters()

static core_competency\external::delete_user_evidence_competency_parameters ( )
static

Returns description of external function parameters.

Return values
external_function_parameters

◆ delete_user_evidence_competency_returns()

static core_competency\external::delete_user_evidence_competency_returns ( )
static

Returns description of external function result value.

Return values
external_description

◆ delete_user_evidence_parameters()

static core_competency\external::delete_user_evidence_parameters ( )
static

Returns description of external function parameters.

Return values
external_function_parameters

◆ delete_user_evidence_returns()

static core_competency\external::delete_user_evidence_returns ( )
static

Returns description of external function result value.

Return values
external_description

◆ duplicate_competency_framework()

static core_competency\external::duplicate_competency_framework ( $id)
static

Duplicate a competency framework.

Parameters
int$idThe competency framework id
Return values
boolean

◆ duplicate_competency_framework_parameters()

static core_competency\external::duplicate_competency_framework_parameters ( )
static

Returns description of duplicate_competency_framework() parameters.

Return values
external_function_parameters

◆ duplicate_competency_framework_returns()

static core_competency\external::duplicate_competency_framework_returns ( )
static

Returns description of duplicate_competency_framework() result value.

Return values
external_description

◆ duplicate_template()

static core_competency\external::duplicate_template ( $id)
static

Duplicate a learning plan template.

Parameters
int$idthe id of the learning plan template to duplicate
Return values
booleanRecord of new template.

◆ duplicate_template_parameters()

static core_competency\external::duplicate_template_parameters ( )
static

Returns description of duplicate_template() parameters.

Return values
external_function_parameters

◆ duplicate_template_returns()

static core_competency\external::duplicate_template_returns ( )
static

Returns description of duplicate_template() result value.

Return values
external_description

◆ get_context_parameters()

static core_competency\external::get_context_parameters ( )
staticprotected

Returns a prepared structure to use a context parameters.

Return values
external_single_structure

◆ get_scale_values()

static core_competency\external::get_scale_values ( $scaleid)
static

Get the values associated with a scale.

Parameters
int$scaleidScale ID
Return values
arrayValues for a scale.

◆ get_scale_values_parameters()

static core_competency\external::get_scale_values_parameters ( )
static

Returns the description of the get_scale_values() parameters.

Return values
external_function_parameters.

◆ get_scale_values_returns()

static core_competency\external::get_scale_values_returns ( )
static

Returns description of get_scale_values() result value.

Return values
external_multiple_structure

◆ grade_competency()

static core_competency\external::grade_competency ( $userid,
$competencyid,
$grade,
$note = null )
static

Grade a competency.

Parameters
int$useridThe user ID.
int$competencyidThe competency id
int$gradeThe new grade value
string$noteA note to attach to the evidence
Return values
bool

◆ grade_competency_in_course()

static core_competency\external::grade_competency_in_course ( $courseid,
$userid,
$competencyid,
$grade,
$note = null )
static

Grade a competency in a course.

Parameters
int$courseidThe course id
int$useridThe user id
int$competencyidThe competency id
int$gradeThe new grade value
string$noteA note to add to the evidence
Return values
bool

◆ grade_competency_in_course_parameters()

static core_competency\external::grade_competency_in_course_parameters ( )
static

Returns description of grade_competency_in_course() parameters.

Return values
external_function_parameters

◆ grade_competency_in_course_returns()

static core_competency\external::grade_competency_in_course_returns ( )
static

Returns description of grade_competency_in_course() result value.

Return values
external_value

◆ grade_competency_in_plan()

static core_competency\external::grade_competency_in_plan ( $planid,
$competencyid,
$grade,
$note = null )
static

Grade a competency in a plan.

Parameters
int$planidThe plan id
int$competencyidThe competency id
int$gradeThe new grade value
string$noteA note to add to the evidence
Return values
bool

◆ grade_competency_in_plan_parameters()

static core_competency\external::grade_competency_in_plan_parameters ( )
static

Returns description of grade_competency_in_plan() parameters.

Return values
external_function_parameters

◆ grade_competency_in_plan_returns()

static core_competency\external::grade_competency_in_plan_returns ( )
static

Returns description of grade_competency_in_plan() result value.

Return values
external_value

◆ grade_competency_parameters()

static core_competency\external::grade_competency_parameters ( )
static

Returns description of external function parameters.

Return values
external_function_parameters

◆ grade_competency_returns()

static core_competency\external::grade_competency_returns ( )
static

Returns description of external function result value.

Return values
external_value

◆ list_competencies()

static core_competency\external::list_competencies ( $filters,
$sort,
$order,
$skip,
$limit )
static

List the existing competency.

Parameters
string$filters
int$sort
string$order
string$skip
int$limit
Return values
array
Exceptions
required_capability_exception
invalid_parameter_exception

◆ list_competencies_in_template()

static core_competency\external::list_competencies_in_template ( $templateid)
static

List the competencies (visible to this user) in this learning plan template.

Parameters
int$templateidTemplate id.
Return values
array

◆ list_competencies_in_template_parameters()

static core_competency\external::list_competencies_in_template_parameters ( )
static

Returns description of list_competencies_in_template() parameters.

Return values
external_function_parameters

◆ list_competencies_in_template_returns()

static core_competency\external::list_competencies_in_template_returns ( )
static

Returns description of list_competencies_in_template() result value.

Return values
external_description

◆ list_competencies_parameters()

static core_competency\external::list_competencies_parameters ( )
static

Returns description of list_competencies() parameters.

Return values
external_function_parameters

◆ list_competencies_returns()

static core_competency\external::list_competencies_returns ( )
static

Returns description of list_competencies() result value.

Return values
external_description

◆ list_competency_frameworks()

static core_competency\external::list_competency_frameworks ( $sort,
$order,
$skip,
$limit,
$context,
$includes,
$onlyvisible,
$query = '' )
static

List the existing competency frameworks.

Parameters
int$sort
string$order
string$skip
int$limit
array$context
bool$includes
bool$onlyvisible
string$query
Return values
array
Exceptions
required_capability_exception
invalid_parameter_exception

◆ list_competency_frameworks_parameters()

static core_competency\external::list_competency_frameworks_parameters ( )
static

Returns description of list_competency_frameworks() parameters.

Return values
external_function_parameters

◆ list_competency_frameworks_returns()

static core_competency\external::list_competency_frameworks_returns ( )
static

Returns description of list_competency_frameworks() result value.

Return values
external_description

◆ list_course_competencies()

static core_competency\external::list_course_competencies ( $courseid)
static

List the competencies (visible to this user) in this course.

Parameters
int$courseidThe course id to check.
Return values
array

◆ list_course_competencies_parameters()

static core_competency\external::list_course_competencies_parameters ( )
static

Returns description of list_course_competencies() parameters.

Return values
external_function_parameters

◆ list_course_competencies_returns()

static core_competency\external::list_course_competencies_returns ( )
static

Returns description of list_course_competencies() result value.

Return values
external_description

◆ list_course_module_competencies()

static core_competency\external::list_course_module_competencies ( $cmid)
static

List the course modules using this competency (visible to this user) in this course.

Parameters
int$cmidThe course module id to check.
Return values
array

◆ list_course_module_competencies_parameters()

static core_competency\external::list_course_module_competencies_parameters ( )
static

Returns description of list_course_module_competencies() parameters.

Return values
external_function_parameters

◆ list_course_module_competencies_returns()

static core_competency\external::list_course_module_competencies_returns ( )
static

Returns description of list_course_module_competencies() result value.

Return values
external_description

◆ list_plan_competencies()

static core_competency\external::list_plan_competencies ( $id)
static

List plan competencies.

Parameters
int$idThe plan ID.
Return values
array

◆ list_plan_competencies_parameters()

static core_competency\external::list_plan_competencies_parameters ( )
static

External function parameters structure.

Return values
external_description

◆ list_plan_competencies_returns()

static core_competency\external::list_plan_competencies_returns ( )
static

External function return structure.

Return values
external_description

◆ list_templates()

static core_competency\external::list_templates ( $sort,
$order,
$skip,
$limit,
$context,
$includes,
$onlyvisible )
static

List the existing learning plan templates.

Parameters
string$sortField to sort by.
string$orderSort order.
int$skipLimitstart.
int$limitNumber of rows to return.
array$context
bool$includes
bool$onlyvisible
Return values
array

◆ list_templates_parameters()

static core_competency\external::list_templates_parameters ( )
static

Returns description of list_templates() parameters.

Return values
external_function_parameters

◆ list_templates_returns()

static core_competency\external::list_templates_returns ( )
static

Returns description of list_templates() result value.

Return values
external_description

◆ list_templates_using_competency()

static core_competency\external::list_templates_using_competency ( $competencyid)
static

List the learning plan templates (visible to this user) that use this competency.

Parameters
int$competencyidCompetency id.
Return values
array

◆ list_templates_using_competency_parameters()

static core_competency\external::list_templates_using_competency_parameters ( )
static

Returns description of list_templates_using_competency() parameters.

Return values
external_function_parameters

◆ list_templates_using_competency_returns()

static core_competency\external::list_templates_using_competency_returns ( )
static

Returns description of list_templates_using_competency() result value.

Return values
external_description

◆ list_user_plans()

static core_competency\external::list_user_plans ( $userid)
static

External function list_user_plans.

Parameters
int$useridThe user ID.
Return values
boolean

◆ list_user_plans_parameters()

static core_competency\external::list_user_plans_parameters ( )
static

Returns description of external function parameters.

Return values
external_function_parameters

◆ list_user_plans_returns()

static core_competency\external::list_user_plans_returns ( )
static

Returns description of external function result value.

Return values
external_function_parameters

◆ move_down_competency()

static core_competency\external::move_down_competency ( $competencyid)
static

Change the sort order of a competency.

Parameters
int$competencyidCompetency id.
Return values
boolean

◆ move_down_competency_parameters()

static core_competency\external::move_down_competency_parameters ( )
static

Returns description of move_down_competency() parameters.

Return values
external_function_parameters

◆ move_down_competency_returns()

static core_competency\external::move_down_competency_returns ( )
static

Returns description of move_down_competency() result value.

Return values
external_description

◆ move_up_competency()

static core_competency\external::move_up_competency ( $competencyid)
static

Change the sort order of a competency.

Parameters
int$competencyidCompetency id.
Return values
boolean

◆ move_up_competency_parameters()

static core_competency\external::move_up_competency_parameters ( )
static

Returns description of move_up_competency() parameters.

Return values
external_function_parameters

◆ move_up_competency_returns()

static core_competency\external::move_up_competency_returns ( )
static

Returns description of move_up_competency() result value.

Return values
external_description

◆ plan_cancel_review_request()

static core_competency\external::plan_cancel_review_request ( $id)
static

External function plan_cancel_review_request.

Parameters
int$idThe plan ID.
Return values
boolean

◆ plan_cancel_review_request_parameters()

static core_competency\external::plan_cancel_review_request_parameters ( )
static

Returns description of external function parameters.

Return values
external_function_parameters

◆ plan_cancel_review_request_returns()

static core_competency\external::plan_cancel_review_request_returns ( )
static

Returns description of external function result value.

Return values
external_function_parameters

◆ plan_request_review()

static core_competency\external::plan_request_review ( $id)
static

External function plan_request_review.

Parameters
int$idThe plan ID.
Return values
boolean

◆ plan_request_review_parameters()

static core_competency\external::plan_request_review_parameters ( )
static

Returns description of external function parameters.

Return values
external_function_parameters

◆ plan_request_review_returns()

static core_competency\external::plan_request_review_returns ( )
static

Returns description of external function result value.

Return values
external_function_parameters

◆ plan_start_review()

static core_competency\external::plan_start_review ( $id)
static

External function plan_start_review.

Parameters
int$idThe plan ID.
Return values
boolean

◆ plan_start_review_parameters()

static core_competency\external::plan_start_review_parameters ( )
static

Returns description of external function parameters.

Return values
external_function_parameters

◆ plan_start_review_returns()

static core_competency\external::plan_start_review_returns ( )
static

Returns description of external function result value.

Return values
external_function_parameters

◆ plan_stop_review()

static core_competency\external::plan_stop_review ( $id)
static

External function plan_stop_review.

Parameters
int$idThe plan ID.
Return values
boolean

◆ plan_stop_review_parameters()

static core_competency\external::plan_stop_review_parameters ( )
static

Returns description of external function parameters.

Return values
external_function_parameters

◆ plan_stop_review_returns()

static core_competency\external::plan_stop_review_returns ( )
static

Returns description of external function result value.

Return values
external_function_parameters

◆ read_competency()

static core_competency\external::read_competency ( $id)
static

Read a competency by id.

Parameters
int$idThe id of the competency
Return values
stdClass

◆ read_competency_framework()

static core_competency\external::read_competency_framework ( $id)
static

Read a competency framework by id.

Parameters
int$idThe id of the framework.
Return values
stdClass

◆ read_competency_framework_parameters()

static core_competency\external::read_competency_framework_parameters ( )
static

Returns description of read_competency_framework() parameters.

Return values
external_function_parameters

◆ read_competency_framework_returns()

static core_competency\external::read_competency_framework_returns ( )
static

Returns description of read_competency_framework() result value.

Return values
external_description

◆ read_competency_parameters()

static core_competency\external::read_competency_parameters ( )
static

Returns description of read_competency() parameters.

Return values
external_function_parameters

◆ read_competency_returns()

static core_competency\external::read_competency_returns ( )
static

Returns description of read_competency() result value.

Return values
external_description

◆ read_plan()

static core_competency\external::read_plan ( $id)
static

Read a plan by id.

Parameters
int$idThe id of the plan.
Return values
stdClass

◆ read_plan_parameters()

static core_competency\external::read_plan_parameters ( )
static

Returns description of read_plan() parameters.

Return values
external_function_parameters

◆ read_plan_returns()

static core_competency\external::read_plan_returns ( )
static

Returns description of read_plan() result value.

Return values
external_description

◆ read_template()

static core_competency\external::read_template ( $id)
static

Read a learning plan template by id.

Parameters
int$idThe id of the template.
Return values
stdClass

◆ read_template_parameters()

static core_competency\external::read_template_parameters ( )
static

Returns description of read_template() parameters.

Return values
external_function_parameters

◆ read_template_returns()

static core_competency\external::read_template_returns ( )
static

Returns description of read_template() result value.

Return values
external_description

◆ read_user_evidence()

static core_competency\external::read_user_evidence ( $id)
static

Delete a user evidence.

Parameters
int$idThe evidence id
Return values
boolean

◆ read_user_evidence_parameters()

static core_competency\external::read_user_evidence_parameters ( )
static

Returns description of external function parameters.

Return values
external_description

◆ read_user_evidence_returns()

static core_competency\external::read_user_evidence_returns ( )
static

Returns description of external function result value.

Return values
external_description

◆ remove_competency_from_course()

static core_competency\external::remove_competency_from_course ( $courseid,
$competencyid )
static

Count the competencies (visible to this user) in this course.

Parameters
int$courseidThe course id to check.
int$competencyidCompetency id.
Return values
int

◆ remove_competency_from_course_parameters()

static core_competency\external::remove_competency_from_course_parameters ( )
static

Returns description of remove_competency_from_course() parameters.

Return values
external_function_parameters

◆ remove_competency_from_course_returns()

static core_competency\external::remove_competency_from_course_returns ( )
static

Returns description of remove_competency_from_course() result value.

Return values
external_description

◆ remove_competency_from_plan()

static core_competency\external::remove_competency_from_plan ( $planid,
$competencyid )
static

Remove a competency from plan.

Parameters
int$planidPlan id.
int$competencyidCompetency id.
Return values
int

◆ remove_competency_from_plan_parameters()

static core_competency\external::remove_competency_from_plan_parameters ( )
static

Returns description of remove_competency_from_plan() parameters.

Return values
external_function_parameters

◆ remove_competency_from_plan_returns()

static core_competency\external::remove_competency_from_plan_returns ( )
static

Returns description of remove_competency_from_plan() result value.

Return values
external_description

◆ remove_competency_from_template()

static core_competency\external::remove_competency_from_template ( $templateid,
$competencyid )
static

Count the competencies (visible to this user) in this learning plan template.

Parameters
int$templateidTemplate id.
int$competencyidCompetency id.
Return values
int

◆ remove_competency_from_template_parameters()

static core_competency\external::remove_competency_from_template_parameters ( )
static

Returns description of remove_competency_from_template() parameters.

Return values
external_function_parameters

◆ remove_competency_from_template_returns()

static core_competency\external::remove_competency_from_template_returns ( )
static

Returns description of remove_competency_from_template() result value.

Return values
external_description

◆ remove_related_competency()

static core_competency\external::remove_related_competency ( $competencyid,
$relatedcompetencyid )
static

Removes a related competency.

Parameters
int$competencyid
int$relatedcompetencyid
Return values
bool

◆ remove_related_competency_parameters()

static core_competency\external::remove_related_competency_parameters ( )
static

Returns the description of the remove_related_competency_parameters() parameters.

Return values
external_function_parameters.

◆ remove_related_competency_returns()

static core_competency\external::remove_related_competency_returns ( )
static

Returns description of remove_related_competency_returns() result value.

Return values
core_external\external_description

◆ reopen_plan()

static core_competency\external::reopen_plan ( $planid)
static

Reopen Learning plan.

Parameters
int$planidplan id (id is required)
Return values
boolean

◆ reopen_plan_parameters()

static core_competency\external::reopen_plan_parameters ( )
static

Returns description of reopen_plan() parameters.

Return values
external_function_parameters

◆ reopen_plan_returns()

static core_competency\external::reopen_plan_returns ( )
static

Returns description of reopen_plan() result value.

Return values
external_description

◆ reorder_course_competency()

static core_competency\external::reorder_course_competency ( $courseid,
$competencyidfrom,
$competencyidto )
static

Change the order of course competencies.

Parameters
int$courseidThe course id
int$competencyidfromThe competency to move.
int$competencyidtoThe competency to move to.
Return values
bool

◆ reorder_course_competency_parameters()

static core_competency\external::reorder_course_competency_parameters ( )
static

Returns description of reorder_course_competency() parameters.

Return values
external_function_parameters

◆ reorder_course_competency_returns()

static core_competency\external::reorder_course_competency_returns ( )
static

Returns description of reorder_course_competency() result value.

Return values
external_description

◆ reorder_plan_competency()

static core_competency\external::reorder_plan_competency ( $planid,
$competencyidfrom,
$competencyidto )
static

Change the order of plan competencies.

Parameters
int$planidThe plan id
int$competencyidfromThe competency to move.
int$competencyidtoThe competency to move to.
Return values
bool

◆ reorder_plan_competency_parameters()

static core_competency\external::reorder_plan_competency_parameters ( )
static

Returns description of reorder_plan_competency() parameters.

Return values
external_function_parameters

◆ reorder_plan_competency_returns()

static core_competency\external::reorder_plan_competency_returns ( )
static

Returns description of reorder_plan_competency() result value.

Return values
external_description

◆ reorder_template_competency()

static core_competency\external::reorder_template_competency ( $templateid,
$competencyidfrom,
$competencyidto )
static

Change the order of template competencies.

Parameters
int$templateidThe template id
int$competencyidfromThe competency to move.
int$competencyidtoThe competency to move to.
Return values
bool

◆ reorder_template_competency_parameters()

static core_competency\external::reorder_template_competency_parameters ( )
static

Returns description of reorder_template_competency() parameters.

Return values
external_function_parameters

◆ reorder_template_competency_returns()

static core_competency\external::reorder_template_competency_returns ( )
static

Returns description of reorder_template_competency() result value.

Return values
external_description

◆ request_review_of_user_evidence_linked_competencies()

static core_competency\external::request_review_of_user_evidence_linked_competencies ( $id)
static

Send user evidence competencies to review.

Parameters
int$idThe user evidence id.
Return values
boolean

◆ request_review_of_user_evidence_linked_competencies_parameters()

static core_competency\external::request_review_of_user_evidence_linked_competencies_parameters ( )
static

Returns description of external function parameters.

Return values
external_function_parameters

◆ request_review_of_user_evidence_linked_competencies_returns()

static core_competency\external::request_review_of_user_evidence_linked_competencies_returns ( )
static

Returns description of external function result value.

Return values
external_description

◆ search_competencies()

static core_competency\external::search_competencies ( $searchtext,
$competencyframeworkid )
static

List the existing competency frameworks.

Parameters
string$searchtextText to search.
int$competencyframeworkidFramework id.
Return values
array

◆ search_competencies_parameters()

static core_competency\external::search_competencies_parameters ( )
static

Returns description of search_competencies() parameters.

Return values
external_function_parameters

◆ search_competencies_returns()

static core_competency\external::search_competencies_returns ( )
static

Returns description of search_competencies() result value.

Return values
external_description

◆ set_course_competency_ruleoutcome()

static core_competency\external::set_course_competency_ruleoutcome ( $coursecompetencyid,
$ruleoutcome )
static

Change the ruleoutcome of a course competency.

Parameters
int$coursecompetencyidThe course competency id
int$ruleoutcomeThe ruleoutcome value
Return values
bool

◆ set_course_competency_ruleoutcome_parameters()

static core_competency\external::set_course_competency_ruleoutcome_parameters ( )
static

Returns description of update_ruleoutcome_course_competency() parameters.

Return values
external_function_parameters

◆ set_course_competency_ruleoutcome_returns()

static core_competency\external::set_course_competency_ruleoutcome_returns ( )
static

Returns description of update_ruleoutcome_course_competency() result value.

Return values
external_value

◆ set_parent_competency()

static core_competency\external::set_parent_competency ( $competencyid,
$parentid )
static

Move the competency to a new parent.

Parameters
int$competencyidCompetency id.
int$parentidParent id.
Return values
bool

◆ set_parent_competency_parameters()

static core_competency\external::set_parent_competency_parameters ( )
static

Returns description of set_parent_competency() parameters.

Return values
external_function_parameters

◆ set_parent_competency_returns()

static core_competency\external::set_parent_competency_returns ( )
static

Returns description of set_parent_competency() result value.

Return values
external_description

◆ template_has_related_data()

static core_competency\external::template_has_related_data ( $templateid)
static

Check if template has related data.

Parameters
int$templateidTemplate id.
Return values
boolean

◆ template_has_related_data_parameters()

static core_competency\external::template_has_related_data_parameters ( )
static

Returns description of template_has_related_data() parameters.

Return values
external_function_parameters

◆ template_has_related_data_returns()

static core_competency\external::template_has_related_data_returns ( )
static

Returns description of template_has_related_data() result value.

Return values
external_description

◆ template_viewed()

static core_competency\external::template_viewed ( $id)
static

Log the template viewed event.

Parameters
int$idthe template id
Return values
arrayof warnings and status result
Exceptions
moodle_exception

◆ template_viewed_parameters()

static core_competency\external::template_viewed_parameters ( )
static

Returns description of template_viewed() parameters.

Return values
external_function_parameters

◆ template_viewed_returns()

static core_competency\external::template_viewed_returns ( )
static

Returns description of template_viewed() result value.

Return values
external_value

◆ unapprove_plan()

static core_competency\external::unapprove_plan ( $id)
static

External function unapprove_plan.

Parameters
int$idThe plan ID.
Return values
boolean

◆ unapprove_plan_parameters()

static core_competency\external::unapprove_plan_parameters ( )
static

Returns description of external function parameters.

Return values
external_function_parameters

◆ unapprove_plan_returns()

static core_competency\external::unapprove_plan_returns ( )
static

Returns description of external function result value.

Return values
external_function_parameters

◆ unlink_plan_from_template()

static core_competency\external::unlink_plan_from_template ( $planid)
static

Unlink the plan from the template.

Parameters
int$planidThe plan id
Return values
bool

◆ unlink_plan_from_template_parameters()

static core_competency\external::unlink_plan_from_template_parameters ( )
static

Returns description of unlink_plan_from_template_() parameters.

Return values
external_function_parameters

◆ unlink_plan_from_template_returns()

static core_competency\external::unlink_plan_from_template_returns ( )
static

Returns description of unlink_plan_from_template_() result value.

Return values
external_value

◆ update_competency()

static core_competency\external::update_competency ( $competency)
static

Update an existing competency.

Parameters
array$competencyThe array of competency fields (id is required).
Return values
boolean

◆ update_competency_framework()

static core_competency\external::update_competency_framework ( $competencyframework)
static

Update an existing competency framework.

Parameters
array$competencyframeworkAn array with all the fields for a competency framework.
Return values
boolean

◆ update_competency_framework_parameters()

static core_competency\external::update_competency_framework_parameters ( )
static

Returns description of update_competency_framework() parameters.

Return values
external_function_parameters

◆ update_competency_framework_returns()

static core_competency\external::update_competency_framework_returns ( )
static

Returns description of update_competency_framework() result value.

Return values
external_description

◆ update_competency_parameters()

static core_competency\external::update_competency_parameters ( )
static

Returns description of update_competency() parameters.

Return values
external_function_parameters

◆ update_competency_returns()

static core_competency\external::update_competency_returns ( )
static

Returns description of update_competency_framework() result value.

Return values
external_description

◆ update_course_competency_settings()

static core_competency\external::update_course_competency_settings ( $courseid,
$settings )
static

Update the course competency settings.

Parameters
int$courseidthe course id
stdClass$settingsThe list of settings (currently only pushratingstouserplans).
Exceptions
moodle_exception

◆ update_course_competency_settings_parameters()

static core_competency\external::update_course_competency_settings_parameters ( )
static

Returns description of update_course_competency_settings() parameters.

Return values
external_function_parameters

◆ update_course_competency_settings_returns()

static core_competency\external::update_course_competency_settings_returns ( )
static

Returns description of update_course_competency_settings() result value.

Return values
external_value

◆ update_plan()

static core_competency\external::update_plan ( $plan)
static

Updates a new learning plan.

Parameters
array$planFields for the plan (id is required)
Return values
mixed

◆ update_plan_parameters()

static core_competency\external::update_plan_parameters ( )
static

Returns description of update_plan() parameters.

Return values
external_function_parameters

◆ update_plan_returns()

static core_competency\external::update_plan_returns ( )
static

Returns description of update_plan() result value.

Return values
external_description

◆ update_template()

static core_competency\external::update_template ( $template)
static

Update an existing learning plan template.

Parameters
array$templateThe list of fields for the template.
Return values
boolean

◆ update_template_parameters()

static core_competency\external::update_template_parameters ( )
static

Returns description of update_template() parameters.

Return values
external_function_parameters

◆ update_template_returns()

static core_competency\external::update_template_returns ( )
static

Returns description of update_template() result value.

Return values
external_description

◆ user_competency_cancel_review_request()

static core_competency\external::user_competency_cancel_review_request ( $userid,
$competencyid )
static

External function user_competency_cancel_review_request.

Parameters
int$useridThe user ID.
int$competencyidThe competency ID.
Return values
boolean

◆ user_competency_cancel_review_request_parameters()

static core_competency\external::user_competency_cancel_review_request_parameters ( )
static

Returns description of external function parameters.

Return values
external_function_parameters

◆ user_competency_cancel_review_request_returns()

static core_competency\external::user_competency_cancel_review_request_returns ( )
static

Returns description of external function result value.

Return values
external_function_parameters

◆ user_competency_plan_viewed()

static core_competency\external::user_competency_plan_viewed ( $competencyid,
$userid,
$planid )
static

Log user competency plan viewed event.

Parameters
int$competencyidThe competency ID.
int$useridThe user ID.
int$planidThe plan ID.
Return values
boolean

◆ user_competency_plan_viewed_parameters()

static core_competency\external::user_competency_plan_viewed_parameters ( )
static

Returns description of user_competency_plan_viewed() parameters.

Return values
external_function_parameters

◆ user_competency_plan_viewed_returns()

static core_competency\external::user_competency_plan_viewed_returns ( )
static

Returns description of user_competency_plan_viewed() result value.

Return values
external_description

◆ user_competency_request_review()

static core_competency\external::user_competency_request_review ( $userid,
$competencyid )
static

External function user_competency_request_review.

Parameters
int$useridThe user ID.
int$competencyidThe competency ID.
Return values
boolean

◆ user_competency_request_review_parameters()

static core_competency\external::user_competency_request_review_parameters ( )
static

Returns description of external function parameters.

Return values
external_function_parameters

◆ user_competency_request_review_returns()

static core_competency\external::user_competency_request_review_returns ( )
static

Returns description of external function result value.

Return values
external_function_parameters

◆ user_competency_start_review()

static core_competency\external::user_competency_start_review ( $userid,
$competencyid )
static

External function user_competency_start_review.

Parameters
int$useridThe user ID.
int$competencyidThe competency ID.
Return values
boolean

◆ user_competency_start_review_parameters()

static core_competency\external::user_competency_start_review_parameters ( )
static

Returns description of external function parameters.

Return values
external_function_parameters

◆ user_competency_start_review_returns()

static core_competency\external::user_competency_start_review_returns ( )
static

Returns description of external function result value.

Return values
external_function_parameters

◆ user_competency_stop_review()

static core_competency\external::user_competency_stop_review ( $userid,
$competencyid )
static

External function user_competency_stop_review.

Parameters
int$useridThe user ID.
int$competencyidThe competency ID.
Return values
boolean

◆ user_competency_stop_review_parameters()

static core_competency\external::user_competency_stop_review_parameters ( )
static

Returns description of external function parameters.

Return values
external_function_parameters

◆ user_competency_stop_review_returns()

static core_competency\external::user_competency_stop_review_returns ( )
static

Returns description of external function result value.

Return values
external_function_parameters

◆ user_competency_viewed()

static core_competency\external::user_competency_viewed ( $usercompetencyid)
static

Log user competency viewed event.

Parameters
int$usercompetencyidThe user competency ID.
Return values
boolean

◆ user_competency_viewed_in_course()

static core_competency\external::user_competency_viewed_in_course ( $competencyid,
$userid,
$courseid )
static

Log user competency viewed in course event.

Parameters
int$competencyidThe competency ID.
int$useridThe user ID.
int$courseidThe course ID.
Return values
boolean

◆ user_competency_viewed_in_course_parameters()

static core_competency\external::user_competency_viewed_in_course_parameters ( )
static

Returns description of user_competency_viewed_in_course() parameters.

Return values
external_function_parameters

◆ user_competency_viewed_in_course_returns()

static core_competency\external::user_competency_viewed_in_course_returns ( )
static

Returns description of user_competency_viewed_in_course() result value.

Return values
external_description

◆ user_competency_viewed_in_plan()

static core_competency\external::user_competency_viewed_in_plan ( $competencyid,
$userid,
$planid )
static

Log user competency viewed in plan event.

Parameters
int$competencyidThe competency ID.
int$useridThe user ID.
int$planidThe plan ID.
Return values
boolean

◆ user_competency_viewed_in_plan_parameters()

static core_competency\external::user_competency_viewed_in_plan_parameters ( )
static

Returns description of user_competency_viewed_in_plan() parameters.

Return values
external_function_parameters

◆ user_competency_viewed_in_plan_returns()

static core_competency\external::user_competency_viewed_in_plan_returns ( )
static

Returns description of user_competency_viewed_in_plan() result value.

Return values
external_description

◆ user_competency_viewed_parameters()

static core_competency\external::user_competency_viewed_parameters ( )
static

Returns description of user_competency_viewed() parameters.

Return values
external_function_parameters

◆ user_competency_viewed_returns()

static core_competency\external::user_competency_viewed_returns ( )
static

Returns description of user_competency_viewed() result value.

Return values
external_description

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