Obsolete:MNET 1.0 RPC: Difference between revisions
From MoodleDocs
| Line 21: | Line 21: | ||
The rpc layer expects one of several prefixes in the method name | The rpc layer expects one of several prefixes in the method name | ||
* mod_ | * <code>mod_</code> | ||
* auth_ | * <code>auth_</code> | ||
* enrol_ | * <code>enrol_</code> | ||
For example and RPC call to mod_forum_dofoobar() rpc call triggers: | For example and RPC call to <code>mod_forum_dofoobar()</code> rpc call triggers: | ||
* load of mod/forum/lib.php | * load of <code>mod/forum/lib.php</code> | ||
* check for function_exists("forum_mnet_dofoobar_enabled") | * check for <code>function_exists("forum_mnet_dofoobar_enabled")</code> | ||
* if (forum_mnet_dofoobar_enabled()) | * <code>if (forum_mnet_dofoobar_enabled())</code> | ||
* then invoke forum_mnet_dofoobar() with the parameters received... | * then invoke <code>forum_mnet_dofoobar()</code> with the parameters received... | ||
::: | :::<code>mnet_</code> is an arbitrary prefix (could be rpc instead) that makes it clear that the function is for remote invocation. The <code>_enabled()</code> function must exist and return true for added security. make it really hard for a develper to expose something accidentally | ||
Revision as of 04:13, 4 September 2006
As part of the [Community hub] infrastructure, we need to define RPC calling conventions...
Moodle's APIs follow several principles that make them scalable annd flexible.
- They are "Just In Time discoverable" rather than all registered at runtime. This is a good optimization for HTTP's statelesness.
- Once an entry point is hit (a webpage in moodle, for instance) the module code author is in control. The framework doesn't limit what kinds of interactions can happen.
So we want to preserve those capabilities... Additionally, we want to make sure the RPC calls are safe, and cannot be exposed by accident.
Outline of a new mnet API
Calls can be exposed via the mnet API by
- Moodle core
- Moodle auth plugins
- Moodle enrol plugins
- Moodle modules
How the RPC calls are processed
The rpc layer expects one of several prefixes in the method name
mod_auth_enrol_
For example and RPC call to mod_forum_dofoobar() rpc call triggers:
- load of
mod/forum/lib.php - check for
function_exists("forum_mnet_dofoobar_enabled") if (forum_mnet_dofoobar_enabled())- then invoke
forum_mnet_dofoobar()with the parameters received...
mnet_is an arbitrary prefix (could be rpc instead) that makes it clear that the function is for remote invocation. The_enabled()function must exist and return true for added security. make it really hard for a develper to expose something accidentally
