Commit 64e27d36 authored by Francois Gannaz's avatar Francois Gannaz
Browse files

DEV documentation

parent d358d67d
Developing the Moodle module for LabNbook
The core process is the communication between Moodle (M) and LabNbook (L).
It is handled by PHP classes in `classes/fetch`, notably `institution` and `user`.
Main files:
- `lib.php` implements the Moodle mod API,
e.g. `labnbook_add_instance()` that creates a new activity in a course.
- `mod_form` is the form that creates and updates an activity.
- `db/` contains the DB install (XML) and upgrade process (PHP).
Adding a new instance
Every request to the LabNbook API uses a token:
- an institution token (I), through the class `fetch\institution`,
- or a user token (U), through the class `fetch\user`.
participant H as Human (web browser)
participant M as Moodle
participant L as LabNbook API
Note over H: Add new activity
H->>M: /course/modedit.php
activate M
Note over M: require labnbook/mod_form.php
M->>L: /v1/auth/login (I)
alt user unknown
L-->>M: HTTP 403
M-->>H: redirect user-binding.php ➀
Note right of H: see next sequence diagram
else user found by M ID
L-->>M: HTTP 200 user token
M-->>H: HTML form
deactivate M
activate H
Note over H: display the form
H-xL: AJAX /v1/mission (U)
L--xH: list of allowed missions
Note over H: user submits form
deactivate H
H->>M: /course/modedit.php
activate M
Note over M: require labnbook/mod_form.php
Note over M: parses input
Note over M: calls lib.php add_instance()
M-->>H: HTTP 302 redirect ➁
deactivate M
➀: see next sequence diagram
➁: The destination of the final redirection depends on the submit button
that was chosen.
The AJAX request is sent by the web browser,
but prepared by the PHP server using the (U) token.
Binding Moodle and LabNbook accounts
Moodle documentation
- <>
- [Official tutorial for a mod](
Moodle conventions and code style are very different from PHP standards.
PHP classes must be in sub-directories of `classes/`,
see [Automatic class loading](Automatic class loading).
Texts should be inserted with `get_string(<stringid>, "labnbook")` so that translations are possible.
The string IDs are mapped to strings through the file `lang/en/labnbook.php`.
See [Strings API]( (sic) for l10n.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment