| [ Index ] |
PHP Cross Reference of Unnamed Project |
[Source view] [Print] [Project Stats]
External course API
| Copyright: | 2009 Petr Skodak |
| License: | http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later |
| File Size: | 2614 lines (119 kb) |
| Included or required: | 0 times |
| Referenced: | 18 times |
| Includes or requires: | 0 files |
core_course_external:: (53 methods):
get_course_contents_parameters()
get_course_contents()
get_course_contents_returns()
get_courses_parameters()
get_courses()
get_courses_returns()
create_courses_parameters()
create_courses()
create_courses_returns()
update_courses_parameters()
update_courses()
update_courses_returns()
delete_courses_parameters()
delete_courses()
delete_courses_returns()
duplicate_course_parameters()
duplicate_course()
duplicate_course_returns()
import_course_parameters()
import_course()
import_course_returns()
get_categories_parameters()
get_categories()
compare_categories_by_path()
compare_categories_by_sortorder()
get_categories_returns()
create_categories_parameters()
create_categories()
create_categories_returns()
update_categories_parameters()
update_categories()
update_categories_returns()
delete_categories_parameters()
delete_categories()
delete_categories_returns()
delete_modules_parameters()
delete_modules()
delete_modules_returns()
view_course_parameters()
view_course()
view_course_returns()
search_courses_parameters()
search_courses()
search_courses_returns()
get_course_module_parameters()
get_course_module()
get_course_module_returns()
get_course_module_by_instance_parameters()
get_course_module_by_instance()
get_course_module_by_instance_returns()
get_activities_overview_parameters()
get_activities_overview()
get_activities_overview_returns()
Class: core_course_external - X-Ref
Course external functions| get_course_contents_parameters() X-Ref |
| Returns description of method parameters return: external_function_parameters |
| get_course_contents($courseid, $options = array() X-Ref |
| Get course contents param: int $courseid course id param: array $options Options for filtering the results, used since Moodle 2.9 return: array |
| get_course_contents_returns() X-Ref |
| Returns description of method result value return: external_description |
| get_courses_parameters() X-Ref |
| Returns description of method parameters return: external_function_parameters |
| get_courses($options = array() X-Ref |
| Get courses param: array $options It contains an array (list of ids) return: array |
| get_courses_returns() X-Ref |
| Returns description of method result value return: external_description |
| create_courses_parameters() X-Ref |
| Returns description of method parameters return: external_function_parameters |
| create_courses($courses) X-Ref |
| Create courses param: array $courses return: array courses (id and shortname only) |
| create_courses_returns() X-Ref |
| Returns description of method result value return: external_description |
| update_courses_parameters() X-Ref |
| Update courses return: external_function_parameters |
| update_courses($courses) X-Ref |
| Update courses param: array $courses |
| update_courses_returns() X-Ref |
| Returns description of method result value return: external_description |
| delete_courses_parameters() X-Ref |
| Returns description of method parameters return: external_function_parameters |
| delete_courses($courseids) X-Ref |
| Delete courses param: array $courseids A list of course ids |
| delete_courses_returns() X-Ref |
| Returns description of method result value return: external_description |
| duplicate_course_parameters() X-Ref |
| Returns description of method parameters return: external_function_parameters |
| duplicate_course($courseid, $fullname, $shortname, $categoryid, $visible = 1, $options = array() X-Ref |
| Duplicate a course param: int $courseid param: string $fullname Duplicated course fullname param: string $shortname Duplicated course shortname param: int $categoryid Duplicated course parent category id param: int $visible Duplicated course availability param: array $options List of backup options return: array New course info |
| duplicate_course_returns() X-Ref |
| Returns description of method result value return: external_description |
| import_course_parameters() X-Ref |
| Returns description of method parameters for import_course return: external_function_parameters |
| import_course($importfrom, $importto, $deletecontent = 0, $options = array() X-Ref |
| Imports a course param: int $importfrom The id of the course we are importing from param: int $importto The id of the course we are importing to param: bool $deletecontent Whether to delete the course we are importing to content param: array $options List of backup options return: null |
| import_course_returns() X-Ref |
| Returns description of method result value return: external_description |
| get_categories_parameters() X-Ref |
| Returns description of method parameters return: external_function_parameters |
| get_categories($criteria = array() X-Ref |
| Get categories param: array $criteria Criteria to match the results param: booln $addsubcategories obtain only the category (false) or its subcategories (true - default) return: array list of categories |
| compare_categories_by_path($category1, $category2) X-Ref |
| Sort categories array by path private function: only used by get_categories param: array $category1 param: array $category2 return: int result of strcmp |
| compare_categories_by_sortorder($category1, $category2) X-Ref |
| Sort categories array by sortorder private function: only used by get_categories param: array $category1 param: array $category2 return: int result of strcmp |
| get_categories_returns() X-Ref |
| Returns description of method result value return: external_description |
| create_categories_parameters() X-Ref |
| Returns description of method parameters return: external_function_parameters |
| create_categories($categories) X-Ref |
| Create categories param: array $categories - see create_categories_parameters() for the array structure return: array - see create_categories_returns() for the array structure |
| create_categories_returns() X-Ref |
| Returns description of method parameters return: external_function_parameters |
| update_categories_parameters() X-Ref |
| Returns description of method parameters return: external_function_parameters |
| update_categories($categories) X-Ref |
| Update categories param: array $categories The list of categories to update return: null |
| update_categories_returns() X-Ref |
| Returns description of method result value return: external_description |
| delete_categories_parameters() X-Ref |
| Returns description of method parameters return: external_function_parameters |
| delete_categories($categories) X-Ref |
| Delete categories param: array $categories A list of category ids return: array |
| delete_categories_returns() X-Ref |
| Returns description of method parameters return: external_function_parameters |
| delete_modules_parameters() X-Ref |
| Describes the parameters for delete_modules. return: external_external_function_parameters |
| delete_modules($cmids) X-Ref |
| Deletes a list of provided module instances. param: array $cmids the course module ids |
| delete_modules_returns() X-Ref |
| Describes the delete_modules return value. return: external_single_structure |
| view_course_parameters() X-Ref |
| Returns description of method parameters return: external_function_parameters |
| view_course($courseid, $sectionnumber = 0) X-Ref |
| Trigger the course viewed event. param: int $courseid id of course param: int $sectionnumber sectionnumber (0, 1, 2...) return: array of warnings and status result |
| view_course_returns() X-Ref |
| Returns description of method result value return: external_description |
| search_courses_parameters() X-Ref |
| Returns description of method parameters return: external_function_parameters |
| search_courses($criterianame,$criteriavalue,$page=0,$perpage=0,$requiredcapabilities=array() X-Ref |
| Search courses following the specified criteria. param: string $criterianame Criteria name (search, modulelist (only admins), blocklist (only admins), tagid) param: string $criteriavalue Criteria value param: int $page Page number (for pagination) param: int $perpage Items per page param: array $requiredcapabilities Optional list of required capabilities (used to filter the list). param: int $limittoenrolled Limit to only enrolled courses return: array of course objects and warnings |
| search_courses_returns() X-Ref |
| Returns description of method result value return: external_description |
| get_course_module_parameters() X-Ref |
| Returns description of method parameters return: external_function_parameters |
| get_course_module($cmid) X-Ref |
| Return information about a course module. param: int $cmid the course module id return: array of warnings and the course module |
| get_course_module_returns() X-Ref |
| Returns description of method result value return: external_description |
| get_course_module_by_instance_parameters() X-Ref |
| Returns description of method parameters return: external_function_parameters |
| get_course_module_by_instance($module, $instance) X-Ref |
| Return information about a course module. param: string $module the module name param: int $instance the activity instance id return: array of warnings and the course module |
| get_course_module_by_instance_returns() X-Ref |
| Returns description of method result value return: external_description |
| get_activities_overview_parameters() X-Ref |
| Returns description of method parameters return: external_function_parameters |
| get_activities_overview($courseids) X-Ref |
| Return activities overview for the given courses. param: array $courseids a list of course ids return: array of warnings and the activities overview |
| get_activities_overview_returns() X-Ref |
| Returns description of method result value return: external_description |
| Generated: Thu Aug 11 10:00:09 2016 | Cross-referenced by PHPXref 0.7.1 |