Search moodle.org's
Developer Documentation
Developer Documentation
See Release Notes
Long Term Support Release
- Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
- Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
- PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
/competency/classes/ -> external.php (source)
Differences Between: [Versions 401 and 402] [Versions 401 and 403]
External API.
| Copyright: | 2016 Frédéric Massart - FMCorz.net |
| License: | http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later |
| File Size: | 4353 lines (138 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Defines 1 class
external:: (250 methods):
get_context_parameters()
create_competency_framework_parameters()
create_competency_framework()
create_competency_framework_returns()
read_competency_framework_parameters()
read_competency_framework()
read_competency_framework_returns()
competency_viewed_parameters()
competency_viewed()
competency_viewed_returns()
duplicate_competency_framework_parameters()
duplicate_competency_framework()
duplicate_competency_framework_returns()
delete_competency_framework_parameters()
delete_competency_framework()
delete_competency_framework_returns()
update_competency_framework_parameters()
update_competency_framework()
update_competency_framework_returns()
list_competency_frameworks_parameters()
list_competency_frameworks()
list_competency_frameworks_returns()
count_competency_frameworks_parameters()
count_competency_frameworks()
count_competency_frameworks_returns()
competency_framework_viewed_parameters()
competency_framework_viewed()
competency_framework_viewed_returns()
create_competency_parameters()
create_competency()
create_competency_returns()
read_competency_parameters()
read_competency()
read_competency_returns()
delete_competency_parameters()
delete_competency()
delete_competency_returns()
update_competency_parameters()
update_competency()
update_competency_returns()
list_competencies_parameters()
list_competencies()
list_competencies_returns()
search_competencies_parameters()
search_competencies()
search_competencies_returns()
count_competencies_parameters()
count_competencies()
count_competencies_returns()
set_parent_competency_parameters()
set_parent_competency()
set_parent_competency_returns()
move_up_competency_parameters()
move_up_competency()
move_up_competency_returns()
move_down_competency_parameters()
move_down_competency()
move_down_competency_returns()
count_courses_using_competency_parameters()
count_courses_using_competency()
count_courses_using_competency_returns()
count_competencies_in_course_parameters()
count_competencies_in_course()
count_competencies_in_course_returns()
list_course_module_competencies_parameters()
list_course_module_competencies()
list_course_module_competencies_returns()
list_course_competencies_parameters()
count_course_module_competencies_parameters()
count_course_module_competencies()
count_course_module_competencies_returns()
list_course_competencies()
list_course_competencies_returns()
add_competency_to_course_parameters()
add_competency_to_course()
add_competency_to_course_returns()
remove_competency_from_course_parameters()
remove_competency_from_course()
remove_competency_from_course_returns()
reorder_course_competency_parameters()
reorder_course_competency()
reorder_course_competency_returns()
reorder_template_competency_parameters()
reorder_template_competency()
reorder_template_competency_returns()
create_template_parameters()
create_template()
create_template_returns()
read_template_parameters()
read_template()
read_template_returns()
delete_template_parameters()
delete_template()
delete_template_returns()
update_template_parameters()
update_template()
update_template_returns()
duplicate_template_parameters()
duplicate_template()
duplicate_template_returns()
list_templates_parameters()
list_templates()
list_templates_returns()
count_templates_parameters()
count_templates()
count_templates_returns()
count_templates_using_competency_parameters()
count_templates_using_competency()
count_templates_using_competency_returns()
list_templates_using_competency_parameters()
list_templates_using_competency()
list_templates_using_competency_returns()
count_competencies_in_template_parameters()
count_competencies_in_template()
count_competencies_in_template_returns()
list_competencies_in_template_parameters()
list_competencies_in_template()
list_competencies_in_template_returns()
add_competency_to_template_parameters()
add_competency_to_template()
add_competency_to_template_returns()
add_competency_to_plan_parameters()
add_competency_to_plan()
add_competency_to_plan_returns()
remove_competency_from_plan_parameters()
remove_competency_from_plan()
remove_competency_from_plan_returns()
remove_competency_from_template_parameters()
reorder_plan_competency_parameters()
reorder_plan_competency()
reorder_plan_competency_returns()
user_competency_cancel_review_request_parameters()
user_competency_cancel_review_request()
user_competency_cancel_review_request_returns()
user_competency_request_review_parameters()
user_competency_request_review()
user_competency_request_review_returns()
user_competency_start_review_parameters()
user_competency_start_review()
user_competency_start_review_returns()
user_competency_stop_review_parameters()
user_competency_stop_review()
user_competency_stop_review_returns()
template_has_related_data_parameters()
template_has_related_data()
template_has_related_data_returns()
remove_competency_from_template()
remove_competency_from_template_returns()
create_plan_parameters()
create_plan()
create_plan_returns()
update_plan_parameters()
update_plan()
update_plan_returns()
complete_plan_parameters()
complete_plan()
complete_plan_returns()
reopen_plan_parameters()
reopen_plan()
reopen_plan_returns()
read_plan_parameters()
read_plan()
read_plan_returns()
delete_plan_parameters()
delete_plan()
delete_plan_returns()
plan_cancel_review_request_parameters()
plan_cancel_review_request()
plan_cancel_review_request_returns()
plan_request_review_parameters()
plan_request_review()
plan_request_review_returns()
plan_start_review_parameters()
plan_start_review()
plan_start_review_returns()
plan_stop_review_parameters()
plan_stop_review()
plan_stop_review_returns()
approve_plan_parameters()
approve_plan()
approve_plan_returns()
unapprove_plan_parameters()
unapprove_plan()
unapprove_plan_returns()
list_plan_competencies_parameters()
list_plan_competencies()
list_plan_competencies_returns()
list_user_plans_parameters()
list_user_plans()
list_user_plans_returns()
read_user_evidence_parameters()
read_user_evidence()
read_user_evidence_returns()
delete_user_evidence_parameters()
delete_user_evidence()
delete_user_evidence_returns()
create_user_evidence_competency_parameters()
create_user_evidence_competency()
create_user_evidence_competency_returns()
delete_user_evidence_competency_parameters()
delete_user_evidence_competency()
delete_user_evidence_competency_returns()
request_review_of_user_evidence_linked_competencies_parameters()
request_review_of_user_evidence_linked_competencies()
request_review_of_user_evidence_linked_competencies_returns()
get_scale_values_parameters()
get_scale_values()
get_scale_values_returns()
add_related_competency_parameters()
add_related_competency()
add_related_competency_returns()
remove_related_competency_parameters()
remove_related_competency()
remove_related_competency_returns()
set_course_competency_ruleoutcome_parameters()
set_course_competency_ruleoutcome()
set_course_competency_ruleoutcome_returns()
grade_competency_parameters()
grade_competency()
grade_competency_returns()
grade_competency_in_plan_parameters()
grade_competency_in_plan()
grade_competency_in_plan_returns()
user_competency_viewed_parameters()
user_competency_viewed()
user_competency_viewed_returns()
user_competency_viewed_in_plan_parameters()
user_competency_viewed_in_plan()
user_competency_viewed_in_plan_returns()
user_competency_viewed_in_course_parameters()
user_competency_viewed_in_course()
user_competency_viewed_in_course_returns()
user_competency_plan_viewed_parameters()
user_competency_plan_viewed()
user_competency_plan_viewed_returns()
grade_competency_in_course_parameters()
grade_competency_in_course()
grade_competency_in_course_returns()
unlink_plan_from_template_parameters()
unlink_plan_from_template()
unlink_plan_from_template_returns()
template_viewed_parameters()
template_viewed()
template_viewed_returns()
update_course_competency_settings_parameters()
update_course_competency_settings()
update_course_competency_settings_returns()
delete_evidence_parameters()
delete_evidence()
delete_evidence_returns()
External API class.
| get_context_parameters() X-Ref |
| Returns a prepared structure to use a context parameters. return: external_single_structure |
| create_competency_framework_parameters() X-Ref |
| Returns description of create_competency_framework() parameters. return: \external_function_parameters |
| create_competency_framework($competencyframework) X-Ref |
| Create a new competency framework param: array $competencyframework A single param with all the fields for a competency framework. return: \stdClass The new record |
| create_competency_framework_returns() X-Ref |
| Returns description of create_competency_framework() result value. return: \external_description |
| read_competency_framework_parameters() X-Ref |
| Returns description of read_competency_framework() parameters. return: \external_function_parameters |
| read_competency_framework($id) X-Ref |
| Read a competency framework by id. param: int $id The id of the framework. return: \stdClass |
| read_competency_framework_returns() X-Ref |
| Returns description of read_competency_framework() result value. return: \external_description |
| competency_viewed_parameters() X-Ref |
| Returns description of competency_viewed() parameters. return: \external_function_parameters |
| competency_viewed($id) X-Ref |
| Log event competency viewed. param: int $id The competency ID. return: boolean |
| competency_viewed_returns() X-Ref |
| Returns description of competency_viewed() result value. return: \external_description |
| duplicate_competency_framework_parameters() X-Ref |
| Returns description of duplicate_competency_framework() parameters. return: \external_function_parameters |
| duplicate_competency_framework($id) X-Ref |
| Duplicate a competency framework param: int $id The competency framework id return: boolean |
| duplicate_competency_framework_returns() X-Ref |
| Returns description of duplicate_competency_framework() result value. return: \external_description |
| delete_competency_framework_parameters() X-Ref |
| Returns description of delete_competency_framework() parameters. return: \external_function_parameters |
| delete_competency_framework($id) X-Ref |
| Delete a competency framework param: int $id The competency framework id return: boolean |
| delete_competency_framework_returns() X-Ref |
| Returns description of delete_competency_framework() result value. return: \external_description |
| update_competency_framework_parameters() X-Ref |
| Returns description of update_competency_framework() parameters. return: \external_function_parameters |
| update_competency_framework($competencyframework) X-Ref |
| Update an existing competency framework param: array $competencyframework An array with all the fields for a competency framework. return: boolean |
| update_competency_framework_returns() X-Ref |
| Returns description of update_competency_framework() result value. return: \external_description |
| list_competency_frameworks_parameters() X-Ref |
| Returns description of list_competency_frameworks() parameters. return: \external_function_parameters |
| list_competency_frameworks($sort, $order, $skip, $limit, $context, $includes, $onlyvisible,$query = '') X-Ref |
| List the existing competency frameworks param: int $sort param: string $order param: string $skip param: int $limit param: array $context param: bool $includes param: bool $onlyvisible param: string $query return: array |
| list_competency_frameworks_returns() X-Ref |
| Returns description of list_competency_frameworks() result value. return: \external_description |
| count_competency_frameworks_parameters() X-Ref |
| Returns description of count_competency_frameworks() parameters. return: \external_function_parameters |
| count_competency_frameworks($context, $includes) X-Ref |
| Count the existing competency frameworks param: array $context param: string $includes return: int |
| count_competency_frameworks_returns() X-Ref |
| Returns description of count_competency_frameworks() result value. return: \external_description |
| competency_framework_viewed_parameters() X-Ref |
| Returns description of competency_framework_viewed() parameters. return: \external_function_parameters |
| competency_framework_viewed($id) X-Ref |
| Log event competency framework viewed. param: int $id The competency framework ID. return: boolean |
| competency_framework_viewed_returns() X-Ref |
| Returns description of competency_framework_viewed() result value. return: \external_description |
| create_competency_parameters() X-Ref |
| Returns description of create_competency() parameters. return: \external_function_parameters |
| create_competency($competency) X-Ref |
| Create a new competency param: array $competency All the fields for a competency record (including id) return: array the competency |
| create_competency_returns() X-Ref |
| Returns description of create_competency() result value. return: \external_description |
| read_competency_parameters() X-Ref |
| Returns description of read_competency() parameters. return: \external_function_parameters |
| read_competency($id) X-Ref |
| Read a competency by id. param: int $id The id of the competency return: \stdClass |
| read_competency_returns() X-Ref |
| Returns description of read_competency() result value. return: \external_description |
| delete_competency_parameters() X-Ref |
| Returns description of delete_competency() parameters. return: \external_function_parameters |
| delete_competency($id) X-Ref |
| Delete a competency param: int $id The competency id return: boolean |
| delete_competency_returns() X-Ref |
| Returns description of delete_competency() result value. return: \external_description |
| update_competency_parameters() X-Ref |
| Returns description of update_competency() parameters. return: \external_function_parameters |
| update_competency($competency) X-Ref |
| Update an existing competency param: array $competency The array of competency fields (id is required). return: boolean |
| update_competency_returns() X-Ref |
| Returns description of update_competency_framework() result value. return: \external_description |
| list_competencies_parameters() X-Ref |
| Returns description of list_competencies() parameters. return: \external_function_parameters |
| list_competencies($filters, $sort, $order, $skip, $limit) X-Ref |
| List the existing competency. param: string $filters param: int $sort param: string $order param: string $skip param: int $limit return: array |
| list_competencies_returns() X-Ref |
| Returns description of list_competencies() result value. return: \external_description |
| search_competencies_parameters() X-Ref |
| Returns description of search_competencies() parameters. return: \external_function_parameters |
| search_competencies($searchtext, $competencyframeworkid) X-Ref |
| List the existing competency frameworks param: string $searchtext Text to search. param: int $competencyframeworkid Framework id. return: array |
| search_competencies_returns() X-Ref |
| Returns description of search_competencies() result value. return: \external_description |
| count_competencies_parameters() X-Ref |
| Returns description of count_competencies() parameters. return: \external_function_parameters |
| count_competencies($filters) X-Ref |
| Count the existing competency frameworks. param: string $filters Filters to use. return: boolean |
| count_competencies_returns() X-Ref |
| Returns description of count_competencies() result value. return: \external_description |
| set_parent_competency_parameters() X-Ref |
| Returns description of set_parent_competency() parameters. return: \external_function_parameters |
| set_parent_competency($competencyid, $parentid) X-Ref |
| Move the competency to a new parent. param: int $competencyid Competency id. param: int $parentid Parent id. return: bool |
| set_parent_competency_returns() X-Ref |
| Returns description of set_parent_competency() result value. return: \external_description |
| move_up_competency_parameters() X-Ref |
| Returns description of move_up_competency() parameters. return: \external_function_parameters |
| move_up_competency($competencyid) X-Ref |
| Change the sort order of a competency. param: int $competencyid Competency id. return: boolean |
| move_up_competency_returns() X-Ref |
| Returns description of move_up_competency() result value. return: \external_description |
| move_down_competency_parameters() X-Ref |
| Returns description of move_down_competency() parameters. return: \external_function_parameters |
| move_down_competency($competencyid) X-Ref |
| Change the sort order of a competency. param: int $competencyid Competency id. return: boolean |
| move_down_competency_returns() X-Ref |
| Returns description of move_down_competency() result value. return: \external_description |
| count_courses_using_competency_parameters() X-Ref |
| Returns description of count_courses_using_competency() parameters. return: \external_function_parameters |
| count_courses_using_competency($competencyid) X-Ref |
| Count the courses (visible to this user) that use this competency. param: int $competencyid Competency id. return: int |
| count_courses_using_competency_returns() X-Ref |
| Returns description of count_courses_using_competency() result value. return: \external_description |
| count_competencies_in_course_parameters() X-Ref |
| Returns description of count_competencies_in_course() parameters. return: \external_function_parameters |
| count_competencies_in_course($courseid) X-Ref |
| Count the competencies (visible to this user) in this course. param: int $courseid The course id to check. return: int |
| count_competencies_in_course_returns() X-Ref |
| Returns description of count_competencies_in_course() result value. return: \external_description |
| list_course_module_competencies_parameters() X-Ref |
| Returns description of list_course_module_competencies() parameters. return: \external_function_parameters |
| list_course_module_competencies($cmid) X-Ref |
| List the course modules using this competency (visible to this user) in this course. param: int $cmid The course module id to check. return: array |
| list_course_module_competencies_returns() X-Ref |
| Returns description of list_course_module_competencies() result value. return: \external_description |
| list_course_competencies_parameters() X-Ref |
| Returns description of list_course_competencies() parameters. return: \external_function_parameters |
| count_course_module_competencies_parameters() X-Ref |
| Returns description of count_course_module_competencies() parameters. return: \external_function_parameters |
| count_course_module_competencies($cmid) X-Ref |
| List the course modules using this competency (visible to this user) in this course. param: int $cmid The course module id to check. return: array |
| count_course_module_competencies_returns() X-Ref |
| Returns description of count_course_module_competencies() result value. return: \external_description |
| list_course_competencies($courseid) X-Ref |
| List the competencies (visible to this user) in this course. param: int $courseid The course id to check. return: array |
| list_course_competencies_returns() X-Ref |
| Returns description of list_course_competencies() result value. return: \external_description |
| add_competency_to_course_parameters() X-Ref |
| Returns description of add_competency_to_course() parameters. return: \external_function_parameters |
| add_competency_to_course($courseid, $competencyid) X-Ref |
| Count the competencies (visible to this user) in this course. param: int $courseid The course id to check. param: int $competencyid Competency id. return: int |
| add_competency_to_course_returns() X-Ref |
| Returns description of add_competency_to_course() result value. return: \external_description |
| remove_competency_from_course_parameters() X-Ref |
| Returns description of remove_competency_from_course() parameters. return: \external_function_parameters |
| remove_competency_from_course($courseid, $competencyid) X-Ref |
| Count the competencies (visible to this user) in this course. param: int $courseid The course id to check. param: int $competencyid Competency id. return: int |
| remove_competency_from_course_returns() X-Ref |
| Returns description of remove_competency_from_course() result value. return: \external_description |
| reorder_course_competency_parameters() X-Ref |
| Returns description of reorder_course_competency() parameters. return: \external_function_parameters |
| reorder_course_competency($courseid, $competencyidfrom, $competencyidto) X-Ref |
| Change the order of course competencies. param: int $courseid The course id param: int $competencyidfrom The competency to move. param: int $competencyidto The competency to move to. return: bool |
| reorder_course_competency_returns() X-Ref |
| Returns description of reorder_course_competency() result value. return: \external_description |
| reorder_template_competency_parameters() X-Ref |
| Returns description of reorder_template_competency() parameters. return: \external_function_parameters |
| reorder_template_competency($templateid, $competencyidfrom, $competencyidto) X-Ref |
| Change the order of template competencies. param: int $templateid The template id param: int $competencyidfrom The competency to move. param: int $competencyidto The competency to move to. return: bool |
| reorder_template_competency_returns() X-Ref |
| Returns description of reorder_template_competency() result value. return: \external_description |
| create_template_parameters() X-Ref |
| Returns description of create_template() parameters. return: \external_function_parameters |
| create_template($template) X-Ref |
| Create a new learning plan template param: array $template The list of fields for the template. return: \stdClass Record of new template. |
| create_template_returns() X-Ref |
| Returns description of create_template() result value. return: \external_description |
| read_template_parameters() X-Ref |
| Returns description of read_template() parameters. return: \external_function_parameters |
| read_template($id) X-Ref |
| Read a learning plan template by id. param: int $id The id of the template. return: \stdClass |
| read_template_returns() X-Ref |
| Returns description of read_template() result value. return: \external_description |
| delete_template_parameters() X-Ref |
| Returns description of delete_template() parameters. return: \external_function_parameters |
| delete_template($id, $deleteplans = true) X-Ref |
| Delete a learning plan template param: int $id The learning plan template id param: boolean $deleteplans True to delete the plans associated to template or false to unlink them return: boolean |
| delete_template_returns() X-Ref |
| Returns description of delete_template() result value. return: \external_description |
| update_template_parameters() X-Ref |
| Returns description of update_template() parameters. return: \external_function_parameters |
| update_template($template) X-Ref |
| Update an existing learning plan template param: array $template The list of fields for the template. return: boolean |
| update_template_returns() X-Ref |
| Returns description of update_template() result value. return: \external_description |
| duplicate_template_parameters() X-Ref |
| Returns description of duplicate_template() parameters. return: \external_function_parameters |
| duplicate_template($id) X-Ref |
| Duplicate a learning plan template. param: int $id the id of the learning plan template to duplicate return: boolean Record of new template. |
| duplicate_template_returns() X-Ref |
| Returns description of duplicate_template() result value. return: \external_description |
| list_templates_parameters() X-Ref |
| Returns description of list_templates() parameters. return: \external_function_parameters |
| list_templates($sort, $order, $skip, $limit, $context, $includes, $onlyvisible) X-Ref |
| List the existing learning plan templates param: string $sort Field to sort by. param: string $order Sort order. param: int $skip Limitstart. param: int $limit Number of rows to return. param: array $context param: bool $includes param: bool $onlyvisible return: array |
| list_templates_returns() X-Ref |
| Returns description of list_templates() result value. return: \external_description |
| count_templates_parameters() X-Ref |
| Returns description of count_templates() parameters. return: \external_function_parameters |
| count_templates($context, $includes) X-Ref |
| Count the existing learning plan templates param: array $context param: string $includes return: int |
| count_templates_returns() X-Ref |
| Returns description of count_templates() result value. return: \external_description |
| count_templates_using_competency_parameters() X-Ref |
| Returns description of count_templates_using_competency() parameters. return: \external_function_parameters |
| count_templates_using_competency($competencyid) X-Ref |
| Count the learning plan templates (visible to this user) that use this competency. param: int $competencyid Competency id. return: int |
| count_templates_using_competency_returns() X-Ref |
| Returns description of count_templates_using_competency() result value. return: \external_description |
| list_templates_using_competency_parameters() X-Ref |
| Returns description of list_templates_using_competency() parameters. return: \external_function_parameters |
| list_templates_using_competency($competencyid) X-Ref |
| List the learning plan templates (visible to this user) that use this competency. param: int $competencyid Competency id. return: array |
| list_templates_using_competency_returns() X-Ref |
| Returns description of list_templates_using_competency() result value. return: \external_description |
| count_competencies_in_template_parameters() X-Ref |
| Returns description of count_competencies_in_template() parameters. return: \external_function_parameters |
| count_competencies_in_template($templateid) X-Ref |
| Count the competencies (visible to this user) in this learning plan template. param: int $templateid The template id to check return: int |
| count_competencies_in_template_returns() X-Ref |
| Returns description of count_competencies_in_template() result value. return: \external_description |
| list_competencies_in_template_parameters() X-Ref |
| Returns description of list_competencies_in_template() parameters. return: \external_function_parameters |
| list_competencies_in_template($templateid) X-Ref |
| List the competencies (visible to this user) in this learning plan template. param: int $templateid Template id. return: array |
| list_competencies_in_template_returns() X-Ref |
| Returns description of list_competencies_in_template() result value. return: \external_description |
| add_competency_to_template_parameters() X-Ref |
| Returns description of add_competency_to_template() parameters. return: \external_function_parameters |
| add_competency_to_template($templateid, $competencyid) X-Ref |
| Count the competencies (visible to this user) in this template. param: int $templateid Template id. param: int $competencyid Competency id. return: int |
| add_competency_to_template_returns() X-Ref |
| Returns description of add_competency_to_template() result value. return: \external_description |
| add_competency_to_plan_parameters() X-Ref |
| Returns description of add_competency_to_plan() parameters. return: \external_function_parameters |
| add_competency_to_plan($planid, $competencyid) X-Ref |
| add competency to a learning plan. param: int $planid Plan id. param: int $competencyid Competency id. return: int |
| add_competency_to_plan_returns() X-Ref |
| Returns description of add_competency_to_plan() result value. return: \external_description |
| remove_competency_from_plan_parameters() X-Ref |
| Returns description of remove_competency_from_plan() parameters. return: \external_function_parameters |
| remove_competency_from_plan($planid, $competencyid) X-Ref |
| Remove a competency from plan. param: int $planid Plan id. param: int $competencyid Competency id. return: int |
| remove_competency_from_plan_returns() X-Ref |
| Returns description of remove_competency_from_plan() result value. return: \external_description |
| remove_competency_from_template_parameters() X-Ref |
| Returns description of remove_competency_from_template() parameters. return: \external_function_parameters |
| reorder_plan_competency_parameters() X-Ref |
| Returns description of reorder_plan_competency() parameters. return: \external_function_parameters |
| reorder_plan_competency($planid, $competencyidfrom, $competencyidto) X-Ref |
| Change the order of plan competencies. param: int $planid The plan id param: int $competencyidfrom The competency to move. param: int $competencyidto The competency to move to. return: bool |
| reorder_plan_competency_returns() X-Ref |
| Returns description of reorder_plan_competency() result value. return: \external_description |
| user_competency_cancel_review_request_parameters() X-Ref |
| Returns description of external function parameters. return: \external_function_parameters |
| user_competency_cancel_review_request($userid, $competencyid) X-Ref |
| External function user_competency_cancel_review_request. param: int $userid The user ID. param: int $competencyid The competency ID. return: boolean |
| user_competency_cancel_review_request_returns() X-Ref |
| Returns description of external function result value. return: \external_function_parameters |
| user_competency_request_review_parameters() X-Ref |
| Returns description of external function parameters. return: \external_function_parameters |
| user_competency_request_review($userid, $competencyid) X-Ref |
| External function user_competency_request_review. param: int $userid The user ID. param: int $competencyid The competency ID. return: boolean |
| user_competency_request_review_returns() X-Ref |
| Returns description of external function result value. return: \external_function_parameters |
| user_competency_start_review_parameters() X-Ref |
| Returns description of external function parameters. return: \external_function_parameters |
| user_competency_start_review($userid, $competencyid) X-Ref |
| External function user_competency_start_review. param: int $userid The user ID. param: int $competencyid The competency ID. return: boolean |
| user_competency_start_review_returns() X-Ref |
| Returns description of external function result value. return: \external_function_parameters |
| user_competency_stop_review_parameters() X-Ref |
| Returns description of external function parameters. return: \external_function_parameters |
| user_competency_stop_review($userid, $competencyid) X-Ref |
| External function user_competency_stop_review. param: int $userid The user ID. param: int $competencyid The competency ID. return: boolean |
| user_competency_stop_review_returns() X-Ref |
| Returns description of external function result value. return: \external_function_parameters |
| template_has_related_data_parameters() X-Ref |
| Returns description of template_has_related_data() parameters. return: \external_function_parameters |
| template_has_related_data($templateid) X-Ref |
| Check if template has related data. param: int $templateid Template id. return: boolean |
| template_has_related_data_returns() X-Ref |
| Returns description of template_has_related_data() result value. return: \external_description |
| remove_competency_from_template($templateid, $competencyid) X-Ref |
| Count the competencies (visible to this user) in this learning plan template. param: int $templateid Template id. param: int $competencyid Competency id. return: int |
| remove_competency_from_template_returns() X-Ref |
| Returns description of remove_competency_from_template() result value. return: \external_description |
| create_plan_parameters() X-Ref |
| Returns description of create_plan() parameters. return: \external_function_parameters |
| create_plan($plan) X-Ref |
| Create a new learning plan. param: array $plan List of fields for the plan. return: array New plan record. |
| create_plan_returns() X-Ref |
| Returns description of create_plan() result value. return: \external_description |
| update_plan_parameters() X-Ref |
| Returns description of update_plan() parameters. return: \external_function_parameters |
| update_plan($plan) X-Ref |
| Updates a new learning plan. param: array $plan Fields for the plan (id is required) return: mixed |
| update_plan_returns() X-Ref |
| Returns description of update_plan() result value. return: \external_description |
| complete_plan_parameters() X-Ref |
| Returns description of complete_plan() parameters. return: \external_function_parameters |
| complete_plan($planid) X-Ref |
| Complete Learning plan. param: int $planid plan id (id is required) return: boolean |
| complete_plan_returns() X-Ref |
| Returns description of complete_plan() result value. return: \external_description |
| reopen_plan_parameters() X-Ref |
| Returns description of reopen_plan() parameters. return: \external_function_parameters |
| reopen_plan($planid) X-Ref |
| Reopen Learning plan. param: int $planid plan id (id is required) return: boolean |
| reopen_plan_returns() X-Ref |
| Returns description of reopen_plan() result value. return: \external_description |
| read_plan_parameters() X-Ref |
| Returns description of read_plan() parameters. return: \external_function_parameters |
| read_plan($id) X-Ref |
| Read a plan by id. param: int $id The id of the plan. return: \stdClass |
| read_plan_returns() X-Ref |
| Returns description of read_plan() result value. return: \external_description |
| delete_plan_parameters() X-Ref |
| Returns description of delete_plan() parameters. return: \external_function_parameters |
| delete_plan($id) X-Ref |
| Delete a plan. param: int $id The plan id return: boolean |
| delete_plan_returns() X-Ref |
| Returns description of delete_plan() result value. return: \external_description |
| plan_cancel_review_request_parameters() X-Ref |
| Returns description of external function parameters. return: \external_function_parameters |
| plan_cancel_review_request($id) X-Ref |
| External function plan_cancel_review_request. param: int $id The plan ID. return: boolean |
| plan_cancel_review_request_returns() X-Ref |
| Returns description of external function result value. return: \external_function_parameters |
| plan_request_review_parameters() X-Ref |
| Returns description of external function parameters. return: \external_function_parameters |
| plan_request_review($id) X-Ref |
| External function plan_request_review. param: int $id The plan ID. return: boolean |
| plan_request_review_returns() X-Ref |
| Returns description of external function result value. return: \external_function_parameters |
| plan_start_review_parameters() X-Ref |
| Returns description of external function parameters. return: \external_function_parameters |
| plan_start_review($id) X-Ref |
| External function plan_start_review. param: int $id The plan ID. return: boolean |
| plan_start_review_returns() X-Ref |
| Returns description of external function result value. return: \external_function_parameters |
| plan_stop_review_parameters() X-Ref |
| Returns description of external function parameters. return: \external_function_parameters |
| plan_stop_review($id) X-Ref |
| External function plan_stop_review. param: int $id The plan ID. return: boolean |
| plan_stop_review_returns() X-Ref |
| Returns description of external function result value. return: \external_function_parameters |
| approve_plan_parameters() X-Ref |
| Returns description of external function parameters. return: \external_function_parameters |
| approve_plan($id) X-Ref |
| External function approve_plan. param: int $id The plan ID. return: boolean |
| approve_plan_returns() X-Ref |
| Returns description of external function result value. return: \external_function_parameters |
| unapprove_plan_parameters() X-Ref |
| Returns description of external function parameters. return: \external_function_parameters |
| unapprove_plan($id) X-Ref |
| External function unapprove_plan. param: int $id The plan ID. return: boolean |
| unapprove_plan_returns() X-Ref |
| Returns description of external function result value. return: \external_function_parameters |
| list_plan_competencies_parameters() X-Ref |
| External function parameters structure. return: \external_description |
| list_plan_competencies($id) X-Ref |
| List plan competencies. param: int $id The plan ID. return: array |
| list_plan_competencies_returns() X-Ref |
| External function return structure. return: \external_description |
| list_user_plans_parameters() X-Ref |
| Returns description of external function parameters. return: \external_function_parameters |
| list_user_plans($userid) X-Ref |
| External function list_user_plans. param: int $userid The user ID. return: boolean |
| list_user_plans_returns() X-Ref |
| Returns description of external function result value. return: \external_function_parameters |
| read_user_evidence_parameters() X-Ref |
| Returns description of external function parameters. return: \external_description |
| read_user_evidence($id) X-Ref |
| Delete a user evidence. param: int $id The evidence id return: boolean |
| read_user_evidence_returns() X-Ref |
| Returns description of external function result value. return: \external_description |
| delete_user_evidence_parameters() X-Ref |
| Returns description of external function parameters. return: \external_function_parameters |
| delete_user_evidence($id) X-Ref |
| Delete a user evidence. param: int $id The evidence id return: boolean |
| delete_user_evidence_returns() X-Ref |
| Returns description of external function result value. return: \external_description |
| create_user_evidence_competency_parameters() X-Ref |
| Returns description of external function parameters. return: \external_function_parameters |
| create_user_evidence_competency($userevidenceid, $competencyid) X-Ref |
| Delete a user evidence competency relationship. param: int $userevidenceid The user evidence id. param: int $competencyid The competency id. return: boolean |
| create_user_evidence_competency_returns() X-Ref |
| Returns description of external function result value. return: \external_description |
| delete_user_evidence_competency_parameters() X-Ref |
| Returns description of external function parameters. return: \external_function_parameters |
| delete_user_evidence_competency($userevidenceid, $competencyid) X-Ref |
| Delete a user evidence competency relationship. param: int $userevidenceid The user evidence id. param: int $competencyid The competency id. return: boolean |
| delete_user_evidence_competency_returns() X-Ref |
| Returns description of external function result value. return: \external_description |
| request_review_of_user_evidence_linked_competencies_parameters() X-Ref |
| Returns description of external function parameters. return: \external_function_parameters |
| request_review_of_user_evidence_linked_competencies($id) X-Ref |
| Send user evidence competencies to review. param: int $id The user evidence id. return: boolean |
| request_review_of_user_evidence_linked_competencies_returns() X-Ref |
| Returns description of external function result value. return: \external_description |
| get_scale_values_parameters() X-Ref |
| Returns the description of the get_scale_values() parameters. return: external_function_parameters. |
| get_scale_values($scaleid) X-Ref |
| Get the values associated with a scale. param: int $scaleid Scale ID return: array Values for a scale. |
| get_scale_values_returns() X-Ref |
| Returns description of get_scale_values() result value. return: external_multiple_structure |
| add_related_competency_parameters() X-Ref |
| Returns the description of the add_related_competency_parameters() parameters. return: external_function_parameters. |
| add_related_competency($competencyid, $relatedcompetencyid) X-Ref |
| Adds a related competency. param: int $competencyid param: int $relatedcompetencyid return: bool |
| add_related_competency_returns() X-Ref |
| Returns description of add_related_competency_returns() result value. return: external_description |
| remove_related_competency_parameters() X-Ref |
| Returns the description of the remove_related_competency_parameters() parameters. return: external_function_parameters. |
| remove_related_competency($competencyid, $relatedcompetencyid) X-Ref |
| Removes a related competency. param: int $competencyid param: int $relatedcompetencyid return: bool |
| remove_related_competency_returns() X-Ref |
| Returns description of remove_related_competency_returns() result value. return: external_description |
| set_course_competency_ruleoutcome_parameters() X-Ref |
| Returns description of update_ruleoutcome_course_competency() parameters. return: \external_function_parameters |
| set_course_competency_ruleoutcome($coursecompetencyid, $ruleoutcome) X-Ref |
| Change the ruleoutcome of a course competency. param: int $coursecompetencyid The course competency id param: int $ruleoutcome The ruleoutcome value return: bool |
| set_course_competency_ruleoutcome_returns() X-Ref |
| Returns description of update_ruleoutcome_course_competency() result value. return: \external_value |
| grade_competency_parameters() X-Ref |
| Returns description of external function parameters. return: \external_function_parameters |
| grade_competency($userid, $competencyid, $grade, $note = null) X-Ref |
| Grade a competency. param: int $userid The user ID. param: int $competencyid The competency id param: int $grade The new grade value param: string $note A note to attach to the evidence return: bool |
| grade_competency_returns() X-Ref |
| Returns description of external function result value. return: \external_value |
| grade_competency_in_plan_parameters() X-Ref |
| Returns description of grade_competency_in_plan() parameters. return: \external_function_parameters |
| grade_competency_in_plan($planid, $competencyid, $grade, $note = null) X-Ref |
| Grade a competency in a plan. param: int $planid The plan id param: int $competencyid The competency id param: int $grade The new grade value param: string $note A note to add to the evidence return: bool |
| grade_competency_in_plan_returns() X-Ref |
| Returns description of grade_competency_in_plan() result value. return: \external_value |
| user_competency_viewed_parameters() X-Ref |
| Returns description of user_competency_viewed() parameters. return: \external_function_parameters |
| user_competency_viewed($usercompetencyid) X-Ref |
| Log user competency viewed event. param: int $usercompetencyid The user competency ID. return: boolean |
| user_competency_viewed_returns() X-Ref |
| Returns description of user_competency_viewed() result value. return: \external_description |
| user_competency_viewed_in_plan_parameters() X-Ref |
| Returns description of user_competency_viewed_in_plan() parameters. return: \external_function_parameters |
| user_competency_viewed_in_plan($competencyid, $userid, $planid) X-Ref |
| Log user competency viewed in plan event. param: int $competencyid The competency ID. param: int $userid The user ID. param: int $planid The plan ID. return: boolean |
| user_competency_viewed_in_plan_returns() X-Ref |
| Returns description of user_competency_viewed_in_plan() result value. return: \external_description |
| user_competency_viewed_in_course_parameters() X-Ref |
| Returns description of user_competency_viewed_in_course() parameters. return: \external_function_parameters |
| user_competency_viewed_in_course($competencyid, $userid, $courseid) X-Ref |
| Log user competency viewed in course event. param: int $competencyid The competency ID. param: int $userid The user ID. param: int $courseid The course ID. return: boolean |
| user_competency_viewed_in_course_returns() X-Ref |
| Returns description of user_competency_viewed_in_course() result value. return: \external_description |
| user_competency_plan_viewed_parameters() X-Ref |
| Returns description of user_competency_plan_viewed() parameters. return: \external_function_parameters |
| user_competency_plan_viewed($competencyid, $userid, $planid) X-Ref |
| Log user competency plan viewed event. param: int $competencyid The competency ID. param: int $userid The user ID. param: int $planid The plan ID. return: boolean |
| user_competency_plan_viewed_returns() X-Ref |
| Returns description of user_competency_plan_viewed() result value. return: \external_description |
| grade_competency_in_course_parameters() X-Ref |
| Returns description of grade_competency_in_course() parameters. return: \external_function_parameters |
| grade_competency_in_course($courseid, $userid, $competencyid, $grade, $note = null) X-Ref |
| Grade a competency in a course. param: int $courseid The course id param: int $userid The user id param: int $competencyid The competency id param: int $grade The new grade value param: string $note A note to add to the evidence return: bool |
| grade_competency_in_course_returns() X-Ref |
| Returns description of grade_competency_in_course() result value. return: \external_value |
| unlink_plan_from_template_parameters() X-Ref |
| Returns description of unlink_plan_from_template_() parameters. return: \external_function_parameters |
| unlink_plan_from_template($planid) X-Ref |
| Unlink the plan from the template. param: int $planid The plan id return: bool |
| unlink_plan_from_template_returns() X-Ref |
| Returns description of unlink_plan_from_template_() result value. return: \external_value |
| template_viewed_parameters() X-Ref |
| Returns description of template_viewed() parameters. return: \external_function_parameters |
| template_viewed($id) X-Ref |
| Log the template viewed event. param: int $id the template id return: array of warnings and status result |
| template_viewed_returns() X-Ref |
| Returns description of template_viewed() result value. return: \external_value |
| update_course_competency_settings_parameters() X-Ref |
| Returns description of update_course_competency_settings() parameters. return: \external_function_parameters |
| update_course_competency_settings($courseid, $settings) X-Ref |
| Update the course competency settings param: int $courseid the course id param: stdClass $settings The list of settings (currently only pushratingstouserplans). |
| update_course_competency_settings_returns() X-Ref |
| Returns description of update_course_competency_settings() result value. return: \external_value |
| delete_evidence_parameters() X-Ref |
| Returns description of external function parameters. return: \external_function_parameters |
| delete_evidence($id) X-Ref |
| External function delete_evidence. param: int $id The evidence ID. return: boolean |
| delete_evidence_returns() X-Ref |
| Returns description of external function result value. return: \external_function_parameters |
