Moodle APIs 3.9
Moodle 3.9.13+ (Build: 20220325)
Static Public Member Functions | Static Protected Member Functions | List of all members
core_competency\external Class Reference

External API class. More...

Inheritance diagram for core_competency\external:
external_api

Static Public Member Functions

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

Static Protected Member Functions

static get_context_from_params ($param)
 Get context from passed parameters. More...
 
static get_context_parameters ()
 Returns a prepared structure to use a context parameters. More...
 

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
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

◆ call_external_function()

static external_api::call_external_function (   $function,
  $args,
  $ajaxonly = false 
)
staticinherited

Call an external function validating all params/returns correctly.

Note that an external function may modify the state of the current page, so this wrapper saves and restores tha PAGE and COURSE global variables before/after calling the external function.

Parameters
string$functionA webservice function name.
array$argsParams array (named params)
boolean$ajaxonlyIf true, an extra check will be peformed to see if ajax is required.
Return values
arraycontaining keys for error (bool), exception and data.

◆ clean_returnvalue()

static external_api::clean_returnvalue ( external_description  $description,
  $response 
)
staticinherited

Clean response If a response attribute is unknown from the description, we just ignore the attribute.

If a response attribute is incorrect, invalid_response_exception is thrown. Note: this function is similar to validate parameters, however it is distinct because parameters validation must be distinct from cleaning return values.

Parameters
external_description$descriptiondescription of the return values
mixed$responsethe actual response
Return values
mixedresponse with added defaults for optional items, invalid_response_exception thrown if any problem found
Author
2010 Jerome Mouneyrac
Since
Moodle 2.0

◆ 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

◆ external_function_info()

static external_api::external_function_info (   $function,
  $strictness = MUST_EXIST 
)
staticinherited

Returns detailed function information.

Parameters
string | object$functionname of external function or record from external_function
int$strictnessIGNORE_MISSING means compatible mode, false returned if record not found, debug message if more found; MUST_EXIST means throw exception if no record or multiple records found
Return values
stdClassdescription or false if not found or exception thrown
Since
Moodle 2.0

◆ get_context_from_params()

static external_api::get_context_from_params (   $param)
staticprotectedinherited

Get context from passed parameters.

The passed array must either contain a contextid or a combination of context level and instance id to fetch the context. For example, the context level can be "course" and instanceid can be courseid.

See context_helper::get_all_levels() for a list of valid context levels.

Parameters
array$param
Since
Moodle 2.6
Exceptions
invalid_parameter_exception
Return values
context

◆ 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

Reimplemented from external_api.

◆ 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
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_context_restriction()

static external_api::set_context_restriction (   $context)
staticinherited

Set context restriction for all following subsequent function calls.

Parameters
stdClass$contextthe context restriction
Since
Moodle 2.0

◆ 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

◆ set_timeout()

static external_api::set_timeout (   $seconds = 360)
staticinherited

This method has to be called before every operation that takes a longer time to finish!

Parameters
int$secondsmax expected time the next operation needs
Since
Moodle 2.0

◆ 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

◆ validate_context()

static external_api::validate_context (   $context)
staticinherited

Makes sure user may execute functions in this context.

Parameters
stdClass$context
Since
Moodle 2.0

◆ validate_parameters()

static external_api::validate_parameters ( external_description  $description,
  $params 
)
staticinherited

Validates submitted function parameters, if anything is incorrect invalid_parameter_exception is thrown.

This is a simple recursive method which is intended to be called from each implementation method of external API.

Parameters
external_description$descriptiondescription of parameters
mixed$paramsthe actual parameters
Return values
mixedparams with added defaults for optional items, invalid_parameters_exception thrown if any problem found
Since
Moodle 2.0

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