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.
Differences Between: [Versions 310 and 401] [Versions 311 and 401] [Versions 39 and 401] [Versions 401 and 402] [Versions 401 and 403]
This is the external API for this tool.
| Copyright: | 2015 Damyon Wiese |
| License: | http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later |
| File Size: | 1106 lines (41 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Defines 1 class
external:: (49 methods):
get_context_parameters()
data_for_competency_frameworks_manage_page_parameters()
data_for_competency_frameworks_manage_page()
data_for_competency_frameworks_manage_page_returns()
data_for_competencies_manage_page_parameters()
data_for_competencies_manage_page()
data_for_competencies_manage_page_returns()
data_for_competency_summary_parameters()
data_for_competency_summary()
data_for_competency_summary_returns()
list_courses_using_competency_parameters()
list_courses_using_competency()
list_courses_using_competency_returns()
data_for_course_competencies_page_parameters()
data_for_course_competencies_page()
data_for_course_competencies_page_returns()
data_for_templates_manage_page_parameters()
data_for_templates_manage_page()
data_for_templates_manage_page_returns()
data_for_template_competencies_page_parameters()
data_for_template_competencies_page()
data_for_template_competencies_page_returns()
data_for_plan_page_parameters()
data_for_plan_page()
data_for_plan_page_returns()
data_for_plans_page_parameters()
data_for_plans_page()
data_for_plans_page_returns()
data_for_user_evidence_list_page_parameters()
data_for_user_evidence_list_page()
data_for_user_evidence_list_page_returns()
data_for_user_evidence_page_parameters()
data_for_user_evidence_page()
data_for_user_evidence_page_returns()
data_for_related_competencies_section_parameters()
data_for_related_competencies_section()
data_for_related_competencies_section_returns()
search_users_parameters()
search_users()
search_users_returns()
data_for_user_competency_summary_parameters()
data_for_user_competency_summary()
data_for_user_competency_summary_returns()
data_for_user_competency_summary_in_plan_parameters()
data_for_user_competency_summary_in_plan()
data_for_user_competency_summary_in_plan_returns()
data_for_user_competency_summary_in_course_parameters()
data_for_user_competency_summary_in_course()
data_for_user_competency_summary_in_course_returns()
| get_context_parameters() X-Ref |
| Returns a prepared structure to use a context parameters. return: external_single_structure |
| data_for_competency_frameworks_manage_page_parameters() X-Ref |
| Returns description of data_for_competency_frameworks_manage_page() parameters. return: \external_function_parameters |
| data_for_competency_frameworks_manage_page($pagecontext) X-Ref |
| Loads the data required to render the competency_frameworks_manage_page template. param: context $pagecontext The page context return: \stdClass |
| data_for_competency_frameworks_manage_page_returns() X-Ref |
| Returns description of data_for_competency_frameworks_manage_page() result value. return: \external_description |
| data_for_competencies_manage_page_parameters() X-Ref |
| Returns description of data_for_competencies_manage_page() parameters. return: \external_function_parameters |
| data_for_competencies_manage_page($competencyframeworkid, $search) X-Ref |
| Loads the data required to render the competencies_manage_page template. param: int $competencyframeworkid Framework id. param: string $search Text to search. return: boolean |
| data_for_competencies_manage_page_returns() X-Ref |
| Returns description of data_for_competencies_manage_page() result value. return: \external_description |
| data_for_competency_summary_parameters() X-Ref |
| Returns description of data_for_competency_summary() parameters. return: \external_function_parameters |
| data_for_competency_summary($competencyid, $includerelated = false, $includecourses = false) X-Ref |
| Loads the data required to render the competency_page template. param: int $competencyid Competency id. param: boolean $includerelated Include or not related competencies. param: boolean $includecourses Include or not competency courses. return: \stdClass |
| data_for_competency_summary_returns() X-Ref |
| Returns description of data_for_competency_summary_() result value. return: \external_description |
| list_courses_using_competency_parameters() X-Ref |
| Returns description of list_courses_using_competency() parameters. return: \external_function_parameters |
| list_courses_using_competency($competencyid) X-Ref |
| Count the courses (visible to this user) that use this competency. param: int $competencyid Competency id. return: array |
| list_courses_using_competency_returns() X-Ref |
| Returns description of list_courses_using_competency() result value. return: \external_description |
| data_for_course_competencies_page_parameters() X-Ref |
| Returns description of data_for_course_competenies_page() parameters. return: \external_function_parameters |
| data_for_course_competencies_page($courseid, $moduleid) X-Ref |
| Loads the data required to render the course_competencies_page template. param: int $courseid The course id to check. param: int $moduleid The module id to check (0 for no filter). return: boolean |
| data_for_course_competencies_page_returns() X-Ref |
| Returns description of data_for_course_competencies_page() result value. return: \external_description |
| data_for_templates_manage_page_parameters() X-Ref |
| Returns description of data_for_templates_manage_page() parameters. return: \external_function_parameters |
| data_for_templates_manage_page($pagecontext) X-Ref |
| Loads the data required to render the templates_manage_page template. param: array $pagecontext The page context info. return: boolean |
| data_for_templates_manage_page_returns() X-Ref |
| Returns description of data_for_templates_manage_page() result value. return: \external_description |
| data_for_template_competencies_page_parameters() X-Ref |
| Returns description of data_for_template_competenies_page() parameters. return: \external_function_parameters |
| data_for_template_competencies_page($templateid, $pagecontext) X-Ref |
| Loads the data required to render the template_competencies_page template. param: int $templateid Template id. param: array $pagecontext The page context info. return: boolean |
| data_for_template_competencies_page_returns() X-Ref |
| Returns description of data_for_template_competencies_page() result value. return: \external_description |
| data_for_plan_page_parameters() X-Ref |
| Returns description of data_for_plan_competenies_page() parameters. return: \external_function_parameters |
| data_for_plan_page($planid) X-Ref |
| Loads the data required to render the plan_page template. param: int $planid Learning Plan id. return: boolean |
| data_for_plan_page_returns() X-Ref |
| Returns description of data_for_plan_page() result value. return: \external_description |
| data_for_plans_page_parameters() X-Ref |
| Returns description of data_for_plans_page() parameters. return: \external_function_parameters |
| data_for_plans_page($userid) X-Ref |
| Loads the data required to render the plans_page template. param: int $userid User id. return: boolean |
| data_for_plans_page_returns() X-Ref |
| Returns description of data_for_plans_page() result value. return: \external_description |
| data_for_user_evidence_list_page_parameters() X-Ref |
| Returns description of external function parameters. return: \external_function_parameters |
| data_for_user_evidence_list_page($userid) X-Ref |
| Loads the data required to render the user_evidence_list_page template. param: int $userid User id. return: boolean |
| data_for_user_evidence_list_page_returns() X-Ref |
| Returns description of external function result value. return: \external_description |
| data_for_user_evidence_page_parameters() X-Ref |
| Returns description of external function parameters. return: \external_function_parameters |
| data_for_user_evidence_page($id) X-Ref |
| Loads the data required to render the user_evidence_page template. param: int $id User id. return: boolean |
| data_for_user_evidence_page_returns() X-Ref |
| Returns description of external function result value. return: \external_description |
| data_for_related_competencies_section_parameters() X-Ref |
| Returns the description of the data_for_related_competencies_section_parameters() parameters. return: external_function_parameters. |
| data_for_related_competencies_section($competencyid) X-Ref |
| Data to render in the related competencies section. param: int $competencyid return: array Related competencies and whether to show delete action button or not. |
| data_for_related_competencies_section_returns() X-Ref |
| Returns description of data_for_related_competencies_section_returns() result value. return: external_description |
| search_users_parameters() X-Ref |
| Returns the description of external function parameters. return: external_function_parameters. |
| search_users($query, $capability = '', $limitfrom = 0, $limitnum = 100) X-Ref |
| Search users. param: string $query param: string $capability param: int $limitfrom param: int $limitnum return: array |
| search_users_returns() X-Ref |
| Returns description of external function result value. return: external_description |
| data_for_user_competency_summary_parameters() X-Ref |
| Returns description of external function. return: \external_function_parameters |
| data_for_user_competency_summary($userid, $competencyid) X-Ref |
| Data for user competency summary. param: int $userid The user ID param: int $competencyid The competency ID return: \stdClass |
| data_for_user_competency_summary_returns() X-Ref |
| Returns description of external function. return: \external_description |
| data_for_user_competency_summary_in_plan_parameters() X-Ref |
| Returns description of data_for_user_competency_summary_in_plan() parameters. return: \external_function_parameters |
| data_for_user_competency_summary_in_plan($competencyid, $planid) X-Ref |
| Read a user competency summary. param: int $competencyid The competency id param: int $planid The plan id return: \stdClass |
| data_for_user_competency_summary_in_plan_returns() X-Ref |
| Returns description of data_for_user_competency_summary_in_plan() result value. return: \external_description |
| data_for_user_competency_summary_in_course_parameters() X-Ref |
| Returns description of data_for_user_competency_summary_in_course() parameters. return: \external_function_parameters |
| data_for_user_competency_summary_in_course($userid, $competencyid, $courseid) X-Ref |
| Read a user competency summary. param: int $userid The user id param: int $competencyid The competency id param: int $courseid The course id return: \stdClass |
| data_for_user_competency_summary_in_course_returns() X-Ref |
| Returns description of data_for_user_competency_summary_in_course() result value. return: \external_description |
