This is a test site. Any changes will be lost!

Development:Moodle API: Difference between revisions

From MoodleDocs
← Older edit
VisualWikitext
 
(28 intermediate revisions by 2 users not shown)
Line 15: Line 15:
=Implementation=
=Implementation=
==Convention==
==Convention==
A new '''api.php''' file should be created into each module/block folder, and also the current admin/user/course/... common moodle folders. <br>This file should contains a class named from the module:
A new '''api.php''' file can be created for each module/block folder, and also the current admin/user/course/... common moodle folders. These files must contain a class named after the unique module path:
     ''class mod_forum_api''
     ''class mod_forum_api''
     ''class user_api''
     ''class user_api''
     ''class course_api''
     ''class course_api''
     ...
     ...
Into this class, static function will provide requested information and operation:
In this class, static methods will provide information and operations to external callers, eg:
     ''create_forum()''
     ''create_forum()''
     ''get_user()''
     ''get_user()''
Line 28: Line 28:


=== Standard function names ===
=== Standard function names ===
In order to manipulate object and to be consistent for all API, we recommend to use:
So that the whole API is consistent, we recommend to use methods with names like this:
<code php>
<code php>
get_xxx() //for retrieving one or more objects named xxx
get_xxx() //for retrieving one or more objects named xxx
set_xxx() //for updating or creating one or more object xxx
set_xxx() //for updating OR creating one or more object xxx (ie when you don't care if it exists yet)
update_xxx() //for updating one or more xxx objects, throws an exception if the object doesn't exist
update_xxx() //for updating one or more xxx objects, throws an exception if the object doesn't exist
create_xxx() //for creating an object, throws an exception if the object (primary key) already exist
create_xxx() //for creating an object, throws an exception if the object (primary key) already exist
Line 38: Line 38:


==API functions must be defined/declared==
==API functions must be defined/declared==
The web services module needs to know what parameter are required and what information are returned. So we need a way to generate all these information. <br>
The web services module needs to know what parameters are required and what information are returned. We need a way to define these parameters so that web service descriptions can be automatically generated and so that incoming data can be cleaned/checked.
'''TO BE DEFINED:''' have a look at PHPdoc if we can generate all needed information from the documentation. Then we cache it in a file. The web services module will look at this file in order to create a WSDL file for soap, in order to know what function are available in REST,...
 
 
'''TODO:''' Look closely at PHPdoc to see if we can represent all required information as part of the standard function documentation. We can scan all these whenever files change, and then store the result as XML or something in dataroot/cache. The web services module will look at this file in order to create a WSDL file for soap, in order to know what function are available in REST, to check the range and types of incoming parameters, etc.


==Call the API functions==
==Call the API functions==
These functions are called inside Moodle by the modules, block and others plugin, and also web services module. As they are static function, they should be called as:
The API functions will not only be used by web services, but by any code that needs to talk to those modules. As they are static methods, they should be called as:
 
     mod_forum_api::get_discussions
     mod_forum_api::get_discussions
     user_api::create_users
     user_api::create_users
Line 49: Line 52:


=Functions List=
=Functions List=
All following paragraph matches a Moodle folder. All described functions should be included in a class named from the folder path, into an api.php file.
The names of each of the sections below represent a pathname in Moodle, where the api.php for that code will be located.<br>
== admin ==
In order to keep this Moodle API page easy to read, we wrote the [https://docs.moodle.org/en/Development:Moodle_API_Function_List Moodle API functions] on another page. Please review them as well.
These API would be used in order to configurate Moodle.
<code php>
///Plugins > Activities
get_activity_module_config(...)
set_activity_module_config(...)
get_activity_modules(...)
 
///Plugins > Repository
get_repository_plugins(...)
add_repository_plugins(...)
remove_repository_plugins(...)
get_repository_plugin_config(...)
set_repository_plugin_config(...)
get_repository_instances(...)
add_repository_instances(...)
remove_repository_instances(...)
get_repository_instance_config(...)
set_repository_instance_config(...)
</code>
 
== blocks ==
== blog ==
== calendar ==
<code php>
create_calendar_events(...)
delete_calendar_events(...)
get_calendar_events(...)  //return in an "exportable" format (iCal, vCal ...)an event recorded in Moodle database (site, course, private ...)
</code>
 
== course ==
<code php>
create_courses($arrayCourses)
create_course_enrolments($role,$criteria_course,$course,$criteria_user,$users)
delete_courses($criteria, $arrayCourses)
delete_course_enrolments($role,$criteria_course,$course,$criteria_user,$users)
get_courses($criteria, $arraySearch)
get_course_enrolments($criteria_user,$user)
get_courses_recent_activities($criteria, $arrayCourses)
</code>
 
== grade ==
<code php>
get_grades(...)
</code>
 
== group ==
<code php>
add_group_members($criteriaCourse, $course, $criteriaUser, $arrayUsers, $groupname)
create_groups($criteria, $course, $groupnames)
delete_groups($criteria, $course, $groupnames)   
get_groups($criteria, $course)
get_groups_by_course($courseid)
get_group_members($criteria, $course, $groupname)
remove_group_members($criteriaCourse, $course, $criteriaUser, $arrayUsers, $groupname)       
set_group(...)       
update_group(...)   
</code>
 
== mod ==
=== assignment ===
=== chat ===
=== choice ===
=== data ===
=== feedback ===
=== forum ===
=== glossary ===
=== lesson ===
=== quiz ===
 
=== resource ===
=== scorm ===
=== survey ===
=== wiki ===
== portfolio ==
== repository ==
== search ==
<code php>
search($string);
</code>
 
==tag==
 
== user ==
<code php>
create_users($users)            //$users is an array of $user
                                //$user is an array(username, password, forcechangepwd, firstname,
                                //                  lastname, email, emaildisplay, emailactivated,
                                //                  city, country, timezone, language, description,...)
delete_users($criteria, $users)
get_users($criteria, $users)
set_user($user)                //$user is an array(...)
update_user($user)              //$user is an array(...)
</code>

Latest revision as of 01:49, 12 November 2008

Note: This article is a work in progress. Please use the page comments for any recommendations/suggestions for improvement.

Moodle 2.0


Introduction

This document is about the Moodle API introduced in Moodle 2.0, which is intended to standardise and streamline methods for calling common control functions in Moodle core and modules. This is most useful for web services (where external systems want to control Moodle) but also for alternative interfaces such as Flex and so on.

To do this, Moodle 2.0 relocates important functions into new api.php files within each module, with standard documentation and structure to help reduce code redundancy and maintenance, while improving readability and functionality.

Over time we expect more and more Moodle functionality to move into these files.

Related documents

Implementation

Convention

A new api.php file can be created for each module/block folder, and also the current admin/user/course/... common moodle folders. These files must contain a class named after the unique module path: 

   class mod_forum_api
   class user_api
   class course_api
   ...

In this class, static methods will provide information and operations to external callers, eg: 

   create_forum()
   get_user()
   get_content()
   get_discussions()
   ...

Standard function names

So that the whole API is consistent, we recommend to use methods with names like this: get_xxx() //for retrieving one or more objects named xxx set_xxx() //for updating OR creating one or more object xxx (ie when you don't care if it exists yet) update_xxx() //for updating one or more xxx objects, throws an exception if the object doesn't exist create_xxx() //for creating an object, throws an exception if the object (primary key) already exist delete_xxx() //for deleting an object, TO BE DEFINED: throws an exception if the object doesn't exist

API functions must be defined/declared

The web services module needs to know what parameters are required and what information are returned. We need a way to define these parameters so that web service descriptions can be automatically generated and so that incoming data can be cleaned/checked.


TODO: Look closely at PHPdoc to see if we can represent all required information as part of the standard function documentation. We can scan all these whenever files change, and then store the result as XML or something in dataroot/cache. The web services module will look at this file in order to create a WSDL file for soap, in order to know what function are available in REST, to check the range and types of incoming parameters, etc.

Call the API functions

The API functions will not only be used by web services, but by any code that needs to talk to those modules. As they are static methods, they should be called as: 

   mod_forum_api::get_discussions
   user_api::create_users
   course_api::get_course
   ...

Functions List

The names of each of the sections below represent a pathname in Moodle, where the api.php for that code will be located.
In order to keep this Moodle API page easy to read, we wrote the Moodle API functions on another page. Please review them as well.

Retrieved from "https://docs.moodle.org/test/index.php?title=Development:Moodle_API&oldid=46605"
Powered by MediaWiki