Moodle  2.2.1
http://www.collinsharper.com
C:/xampp/htdocs/moodle/lib/db/services.php
Go to the documentation of this file.
00001 <?php
00002 
00003 // This file is part of Moodle - http://moodle.org/
00004 //
00005 // Moodle is free software: you can redistribute it and/or modify
00006 // it under the terms of the GNU General Public License as published by
00007 // the Free Software Foundation, either version 3 of the License, or
00008 // (at your option) any later version.
00009 //
00010 // Moodle is distributed in the hope that it will be useful,
00011 // but WITHOUT ANY WARRANTY; without even the implied warranty of
00012 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00013 // GNU General Public License for more details.
00014 //
00015 // You should have received a copy of the GNU General Public License
00016 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
00017 
00027 $functions = array(
00028 
00029     // === group related functions ===
00030 
00031     'moodle_group_create_groups' => array(
00032         'classname'   => 'core_group_external',
00033         'methodname'  => 'create_groups',
00034         'classpath'   => 'group/externallib.php',
00035         'description' => 'DEPRECATED: this deprecated function will be removed in a future version. This function has be renamed as core_group_create_groups(). ',
00036         'type'        => 'write',
00037         'capabilities'=> 'moodle/course:managegroups',
00038     ),
00039 
00040     'core_group_create_groups' => array(
00041         'classname'   => 'core_group_external',
00042         'methodname'  => 'create_groups',
00043         'classpath'   => 'group/externallib.php',
00044         'description' => 'Creates new groups.',
00045         'type'        => 'write',
00046         'capabilities'=> 'moodle/course:managegroups',
00047     ),
00048 
00049     'moodle_group_get_groups' => array(
00050         'classname'   => 'core_group_external',
00051         'methodname'  => 'get_groups',
00052         'classpath'   => 'group/externallib.php',
00053         'description' => 'DEPRECATED: this deprecated function will be removed in a future version. This function has be renamed as core_group_get_groups()',
00054         'type'        => 'read',
00055         'capabilities'=> 'moodle/course:managegroups',
00056     ),
00057 
00058     'core_group_get_groups' => array(
00059         'classname'   => 'core_group_external',
00060         'methodname'  => 'get_groups',
00061         'classpath'   => 'group/externallib.php',
00062         'description' => 'Returns group details.',
00063         'type'        => 'read',
00064         'capabilities'=> 'moodle/course:managegroups',
00065     ),
00066 
00067     'moodle_group_get_course_groups' => array(
00068         'classname'   => 'core_group_external',
00069         'methodname'  => 'get_course_groups',
00070         'classpath'   => 'group/externallib.php',
00071         'description' => 'DEPRECATED: this deprecated function will be removed in a future version. This function has be renamed as core_group_get_course_groups()',
00072         'type'        => 'read',
00073         'capabilities'=> 'moodle/course:managegroups',
00074     ),
00075 
00076     'core_group_get_course_groups' => array(
00077         'classname'   => 'core_group_external',
00078         'methodname'  => 'get_course_groups',
00079         'classpath'   => 'group/externallib.php',
00080         'description' => 'Returns all groups in specified course.',
00081         'type'        => 'read',
00082         'capabilities'=> 'moodle/course:managegroups',
00083     ),
00084 
00085     'moodle_group_delete_groups' => array(
00086         'classname'   => 'core_group_external',
00087         'methodname'  => 'delete_groups',
00088         'classpath'   => 'group/externallib.php',
00089         'description' => 'DEPRECATED: this deprecated function will be removed in a future version. This function has be renamed as core_group_delete_groups()',
00090         'type'        => 'delete',
00091         'capabilities'=> 'moodle/course:managegroups',
00092     ),
00093 
00094     'core_group_delete_groups' => array(
00095         'classname'   => 'core_group_external',
00096         'methodname'  => 'delete_groups',
00097         'classpath'   => 'group/externallib.php',
00098         'description' => 'Deletes all specified groups.',
00099         'type'        => 'delete',
00100         'capabilities'=> 'moodle/course:managegroups',
00101     ),
00102 
00103     'moodle_group_get_groupmembers' => array(
00104         'classname'   => 'core_group_external',
00105         'methodname'  => 'get_group_members',
00106         'classpath'   => 'group/externallib.php',
00107         'description' => 'DEPRECATED: this deprecated function will be removed in a future version. This function has be renamed as core_group_get_group_members()',
00108         'type'        => 'read',
00109         'capabilities'=> 'moodle/course:managegroups',
00110     ),
00111 
00112     'core_group_get_group_members' => array(
00113         'classname'   => 'core_group_external',
00114         'methodname'  => 'get_group_members',
00115         'classpath'   => 'group/externallib.php',
00116         'description' => 'Returns group members.',
00117         'type'        => 'read',
00118         'capabilities'=> 'moodle/course:managegroups',
00119     ),
00120 
00121     'moodle_group_add_groupmembers' => array(
00122         'classname'   => 'core_group_external',
00123         'methodname'  => 'add_group_members',
00124         'classpath'   => 'group/externallib.php',
00125         'description' => 'DEPRECATED: this deprecated function will be removed in a future version. This function has be renamed as core_group_add_group_members()',
00126         'type'        => 'write',
00127         'capabilities'=> 'moodle/course:managegroups',
00128     ),
00129 
00130     'core_group_add_group_members' => array(
00131         'classname'   => 'core_group_external',
00132         'methodname'  => 'add_group_members',
00133         'classpath'   => 'group/externallib.php',
00134         'description' => 'Adds group members.',
00135         'type'        => 'write',
00136         'capabilities'=> 'moodle/course:managegroups',
00137     ),
00138 
00139     'moodle_group_delete_groupmembers' => array(
00140         'classname'   => 'core_group_external',
00141         'methodname'  => 'delete_group_members',
00142         'classpath'   => 'group/externallib.php',
00143         'description' => 'DEPRECATED: this deprecated function will be removed in a future version. This function has be renamed as core_group_delete_group_members()',
00144         'type'        => 'delete',
00145         'capabilities'=> 'moodle/course:managegroups',
00146     ),
00147 
00148     'core_group_delete_group_members' => array(
00149         'classname'   => 'core_group_external',
00150         'methodname'  => 'delete_group_members',
00151         'classpath'   => 'group/externallib.php',
00152         'description' => 'Deletes group members.',
00153         'type'        => 'delete',
00154         'capabilities'=> 'moodle/course:managegroups',
00155     ),
00156 
00157     // === file related functions ===
00158 
00159     'moodle_file_get_files' => array(
00160         'classname'   => 'core_files_external',
00161         'methodname'  => 'get_files',
00162         'description' => 'DEPRECATED: this deprecated function will be removed in a future version. This function has be renamed as core_files_get_files()',
00163         'type'        => 'read',
00164         'classpath'   => 'files/externallib.php',
00165     ),
00166 
00167     'core_files_get_files' => array(
00168         'classname'   => 'core_files_external',
00169         'methodname'  => 'get_files',
00170         'description' => 'browse moodle files',
00171         'type'        => 'read',
00172         'classpath'   => 'files/externallib.php',
00173     ),
00174 
00175     'moodle_file_upload' => array(
00176         'classname'   => 'core_files_external',
00177         'methodname'  => 'upload',
00178         'description' => 'DEPRECATED: this deprecated function will be removed in a future version. This function has be renamed as core_files_upload()',
00179         'type'        => 'write',
00180         'classpath'   => 'files/externallib.php',
00181     ),
00182 
00183     'core_files_upload' => array(
00184         'classname'   => 'core_files_external',
00185         'methodname'  => 'upload',
00186         'description' => 'upload a file to moodle',
00187         'type'        => 'write',
00188         'classpath'   => 'files/externallib.php',
00189     ),
00190 
00191     // === user related functions ===
00192 
00193     'moodle_user_create_users' => array(
00194         'classname'   => 'core_user_external',
00195         'methodname'  => 'create_users',
00196         'classpath'   => 'user/externallib.php',
00197         'description' => 'DEPRECATED: this deprecated function will be removed in a future version. This function has be renamed as core_user_create_users()',
00198         'type'        => 'write',
00199         'capabilities'=> 'moodle/user:create',
00200     ),
00201 
00202     'core_user_create_users' => array(
00203         'classname'   => 'core_user_external',
00204         'methodname'  => 'create_users',
00205         'classpath'   => 'user/externallib.php',
00206         'description' => 'Create users.',
00207         'type'        => 'write',
00208         'capabilities'=> 'moodle/user:create',
00209     ),
00210 
00211     'moodle_user_get_users_by_id' => array(
00212         'classname'   => 'core_user_external',
00213         'methodname'  => 'get_users_by_id',
00214         'classpath'   => 'user/externallib.php',
00215         'description' => 'DEPRECATED: this deprecated function will be removed in a future version. This function has be renamed as core_user_get_users_by_id()',
00216         'type'        => 'read',
00217         'capabilities'=> 'moodle/user:viewdetails, moodle/user:viewhiddendetails, moodle/course:useremail, moodle/user:update',
00218     ),
00219 
00220     'core_user_get_users_by_id' => array(
00221         'classname'   => 'core_user_external',
00222         'methodname'  => 'get_users_by_id',
00223         'classpath'   => 'user/externallib.php',
00224         'description' => 'Get users by id.',
00225         'type'        => 'read',
00226         'capabilities'=> 'moodle/user:viewdetails, moodle/user:viewhiddendetails, moodle/course:useremail, moodle/user:update',
00227     ),
00228 
00229     'moodle_user_get_users_by_courseid' => array(
00230         'classname'   => 'core_enrol_external',
00231         'methodname'  => 'get_enrolled_users',
00232         'classpath'   => 'enrol/externallib.php',
00233         'description' => 'DEPRECATED: this deprecated function will be removed in a future version. This function has be renamed as core_enrol_get_enrolled_users()',
00234         'type'        => 'read',
00235         'capabilities'=> 'moodle/user:viewdetails, moodle/user:viewhiddendetails, moodle/course:useremail, moodle/user:update, moodle/site:accessallgroups',
00236     ),
00237 
00238     'moodle_user_get_course_participants_by_id' => array(
00239         'classname'   => 'core_user_external',
00240         'methodname'  => 'get_course_user_profiles',
00241         'classpath'   => 'user/externallib.php',
00242         'description' => 'DEPRECATED: this deprecated function will be removed in a future version. This function has be renamed as core_user_get_course_user_profiles()',
00243         'type'        => 'read',
00244         'capabilities'=> 'moodle/user:viewdetails, moodle/user:viewhiddendetails, moodle/course:useremail, moodle/user:update, moodle/site:accessallgroups',
00245     ),
00246 
00247     'core_user_get_course_user_profiles' => array(
00248         'classname'   => 'core_user_external',
00249         'methodname'  => 'get_course_user_profiles',
00250         'classpath'   => 'user/externallib.php',
00251         'description' => 'Get course user profiles (each of the profils matching a course id and a user id).',
00252         'type'        => 'read',
00253         'capabilities'=> 'moodle/user:viewdetails, moodle/user:viewhiddendetails, moodle/course:useremail, moodle/user:update, moodle/site:accessallgroups',
00254     ),
00255 
00256     'moodle_user_delete_users' => array(
00257         'classname'   => 'core_user_external',
00258         'methodname'  => 'delete_users',
00259         'classpath'   => 'user/externallib.php',
00260         'description' => 'DEPRECATED: this deprecated function will be removed in a future version. This function has be renamed as core_user_delete_users()',
00261         'type'        => 'write',
00262         'capabilities'=> 'moodle/user:delete',
00263     ),
00264 
00265     'core_user_delete_users' => array(
00266         'classname'   => 'core_user_external',
00267         'methodname'  => 'delete_users',
00268         'classpath'   => 'user/externallib.php',
00269         'description' => 'Delete users.',
00270         'type'        => 'write',
00271         'capabilities'=> 'moodle/user:delete',
00272     ),
00273 
00274     'moodle_user_update_users' => array(
00275         'classname'   => 'core_user_external',
00276         'methodname'  => 'update_users',
00277         'classpath'   => 'user/externallib.php',
00278         'description' => 'DEPRECATED: this deprecated function will be removed in a future version. This function has be renamed as core_user_update_users()',
00279         'type'        => 'write',
00280         'capabilities'=> 'moodle/user:update',
00281     ),
00282 
00283     'core_user_update_users' => array(
00284         'classname'   => 'core_user_external',
00285         'methodname'  => 'update_users',
00286         'classpath'   => 'user/externallib.php',
00287         'description' => 'Update users.',
00288         'type'        => 'write',
00289         'capabilities'=> 'moodle/user:update',
00290     ),
00291 
00292     // === enrol related functions ===
00293 
00294     'moodle_enrol_get_enrolled_users' => array(
00295         'classname'   => 'moodle_enrol_external',
00296         'methodname'  => 'get_enrolled_users',
00297         'classpath'   => 'enrol/externallib.php',
00298         'description' => 'DEPRECATED: this deprecated function will be removed in a future version. Please use core_enrol_get_enrolled_users() (previously known as moodle_user_get_users_by_courseid).',
00299         'type'        => 'read',
00300         'capabilities'=> 'moodle/site:viewparticipants, moodle/course:viewparticipants,
00301             moodle/role:review, moodle/site:accessallgroups, moodle/course:enrolreview',
00302     ),
00303 
00304     'core_enrol_get_enrolled_users' => array(
00305         'classname'   => 'core_enrol_external',
00306         'methodname'  => 'get_enrolled_users',
00307         'classpath'   => 'enrol/externallib.php',
00308         'description' => 'Get enrolled users by course id.',
00309         'type'        => 'read',
00310         'capabilities'=> 'moodle/user:viewdetails, moodle/user:viewhiddendetails, moodle/course:useremail, moodle/user:update, moodle/site:accessallgroups',
00311     ),
00312 
00313     'moodle_enrol_get_users_courses' => array(
00314         'classname'   => 'core_enrol_external',
00315         'methodname'  => 'get_users_courses',
00316         'classpath'   => 'enrol/externallib.php',
00317         'description' => 'DEPRECATED: this deprecated function will be removed in a future version. This function has be renamed as core_enrol_get_users_courses()',
00318         'type'        => 'read',
00319         'capabilities'=> 'moodle/course:viewparticipants',
00320     ),
00321 
00322     'core_enrol_get_users_courses' => array(
00323         'classname'   => 'core_enrol_external',
00324         'methodname'  => 'get_users_courses',
00325         'classpath'   => 'enrol/externallib.php',
00326         'description' => 'Get the list of courses where a user is enrolled in',
00327         'type'        => 'read',
00328         'capabilities'=> 'moodle/course:viewparticipants',
00329     ),
00330 
00331     // === Role related functions ===
00332 
00333     'moodle_role_assign' => array(
00334         'classname'   => 'core_role_external',
00335         'methodname'  => 'assign_roles',
00336         'classpath'   => 'enrol/externallib.php',
00337         'description' => 'DEPRECATED: this deprecated function will be removed in a future version. This function has be renamed as core_role_assign_role()',
00338         'type'        => 'write',
00339         'capabilities'=> 'moodle/role:assign',
00340     ),
00341 
00342     'core_role_assign_roles' => array(
00343         'classname'   => 'core_role_external',
00344         'methodname'  => 'assign_roles',
00345         'classpath'   => 'enrol/externallib.php',
00346         'description' => 'Manual role assignments.',
00347         'type'        => 'write',
00348         'capabilities'=> 'moodle/role:assign',
00349     ),
00350 
00351     'moodle_role_unassign' => array(
00352         'classname'   => 'core_role_external',
00353         'methodname'  => 'unassign_roles',
00354         'classpath'   => 'enrol/externallib.php',
00355         'description' => 'DEPRECATED: this deprecated function will be removed in a future version. This function has be renamed as core_role_unassign_role()',
00356         'type'        => 'write',
00357         'capabilities'=> 'moodle/role:assign',
00358     ),
00359 
00360     'core_role_unassign_roles' => array(
00361         'classname'   => 'core_role_external',
00362         'methodname'  => 'unassign_roles',
00363         'classpath'   => 'enrol/externallib.php',
00364         'description' => 'Manual role unassignments.',
00365         'type'        => 'write',
00366         'capabilities'=> 'moodle/role:assign',
00367     ),
00368 
00369     // === course related functions ===
00370 
00371     'moodle_course_get_courses' => array(
00372         'classname'   => 'core_course_external',
00373         'methodname'  => 'get_courses',
00374         'classpath'   => 'course/externallib.php',
00375         'description' => 'DEPRECATED: this deprecated function will be removed in a future version. This function has be renamed as core_course_get_courses()',
00376         'type'        => 'read',
00377         'capabilities'=> 'moodle/course:view,moodle/course:update,moodle/course:viewhiddencourses',
00378     ),
00379 
00380     'core_course_get_courses' => array(
00381         'classname'   => 'core_course_external',
00382         'methodname'  => 'get_courses',
00383         'classpath'   => 'course/externallib.php',
00384         'description' => 'Return course details',
00385         'type'        => 'read',
00386         'capabilities'=> 'moodle/course:view,moodle/course:update,moodle/course:viewhiddencourses',
00387     ),
00388 
00389     'moodle_course_create_courses' => array(
00390         'classname'   => 'core_course_external',
00391         'methodname'  => 'create_courses',
00392         'classpath'   => 'course/externallib.php',
00393         'description' => 'DEPRECATED: this deprecated function will be removed in a future version. This function has be renamed as core_course_create_courses()',
00394         'type'        => 'write',
00395         'capabilities'=> 'moodle/course:create,moodle/course:visibility',
00396     ),
00397 
00398     'core_course_create_courses' => array(
00399         'classname'   => 'core_course_external',
00400         'methodname'  => 'create_courses',
00401         'classpath'   => 'course/externallib.php',
00402         'description' => 'Create new courses',
00403         'type'        => 'write',
00404         'capabilities'=> 'moodle/course:create,moodle/course:visibility',
00405     ),
00406 
00407     'core_course_get_contents' => array(
00408         'classname'   => 'core_course_external',
00409         'methodname'  => 'get_course_contents',
00410         'classpath'   => 'course/externallib.php',
00411         'description' => 'Get course contents',
00412         'type'        => 'read',
00413         'capabilities'=> 'moodle/course:update,moodle/course:viewhiddencourses',
00414     ),
00415 
00416     // === message related functions ===
00417 
00418     'moodle_message_send_instantmessages' => array(
00419         'classname'   => 'core_message_external',
00420         'methodname'  => 'send_instant_messages',
00421         'classpath'   => 'message/externallib.php',
00422         'description' => 'DEPRECATED: this deprecated function will be removed in a future version. This function has be renamed as core_message_send_instant_messages()',
00423         'type'        => 'write',
00424         'capabilities'=> 'moodle/site:sendmessage',
00425     ),
00426 
00427     'core_message_send_instant_messages' => array(
00428         'classname'   => 'core_message_external',
00429         'methodname'  => 'send_instant_messages',
00430         'classpath'   => 'message/externallib.php',
00431         'description' => 'Send instant messages',
00432         'type'        => 'write',
00433         'capabilities'=> 'moodle/site:sendmessage',
00434     ),
00435 
00436     // === notes related functions ===
00437 
00438     'moodle_notes_create_notes' => array(
00439         'classname'   => 'core_notes_external',
00440         'methodname'  => 'create_notes',
00441         'classpath'   => 'notes/externallib.php',
00442         'description' => 'DEPRECATED: this deprecated function will be removed in a future version. This function has be renamed as core_notes_create_notes()',
00443         'type'        => 'write',
00444         'capabilities'=> 'moodle/notes:manage',
00445     ),
00446 
00447     'core_notes_create_notes' => array(
00448         'classname'   => 'core_notes_external',
00449         'methodname'  => 'create_notes',
00450         'classpath'   => 'notes/externallib.php',
00451         'description' => 'Create notes',
00452         'type'        => 'write',
00453         'capabilities'=> 'moodle/notes:manage',
00454     ),
00455 
00456     // === webservice related functions ===
00457 
00458     'moodle_webservice_get_siteinfo' => array(
00459         'classname'   => 'core_webservice_external',
00460         'methodname'  => 'get_site_info',
00461         'classpath'   => 'webservice/externallib.php',
00462         'description' => 'DEPRECATED: this deprecated function will be removed in a future version. This function has be renamed as core_webservice_get_site_info()',
00463         'type'        => 'read',
00464     ),
00465 
00466     'core_webservice_get_site_info' => array(
00467         'classname'   => 'core_webservice_external',
00468         'methodname'  => 'get_site_info',
00469         'classpath'   => 'webservice/externallib.php',
00470         'description' => 'Return some site info / user info / list web service functions',
00471         'type'        => 'read',
00472     ),
00473 
00474 );
00475 
00476 $services = array(
00477    'Moodle mobile web service'  => array(
00478         'functions' => array (
00479             'moodle_enrol_get_users_courses',
00480             'moodle_enrol_get_enrolled_users',
00481             'moodle_user_get_users_by_id',
00482             'moodle_webservice_get_siteinfo',
00483             'moodle_notes_create_notes',
00484             'moodle_user_get_course_participants_by_id',
00485             'moodle_user_get_users_by_courseid',
00486             'moodle_message_send_instantmessages',
00487             'core_course_get_contents'),
00488         'enabled' => 0,
00489         'restrictedusers' => 0,
00490         'shortname' => MOODLE_OFFICIAL_MOBILE_SERVICE,
00491         'downloadfiles' => 1
00492     ),
00493 );
 All Data Structures Namespaces Files Functions Variables Enumerations