Note:

If you want to create a new page for developers, you should create it on the Moodle Developer Resource site.

External services description

From MoodleDocs
Revision as of 01:54, 18 June 2009 by jerome mouneyrac (talk | contribs) (New page: ===external_functions=== List of external functions. Created automatically by parsing of external files. {| class="nicetable" ! Field ! Type ! Default ! Description |- | '''id''' | int(...)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

external_functions

List of external functions. Created automatically by parsing of external files.


Field Type Default Description
id int(10) auto-incrementing
component varchar(100) Component where function defined, needed for automatic updates.
name varchar(150) Name of function
enabled int(1) function enabled, functiosn might be disabled for security reasons
phpfile varchar(255) location where function defined
functionparams? text null ?some form of param description?
requireslogin int(1) extra information - some external functions may not require $USER
contextrestriction int(1) extra information - some functions may support context restrictions

external_services

Service is defined as a group of functions.


Field Type Default Description
id int(10) auto-incrementing
component varchar(100) Component where service defined, needed for automatic updates.
name varchar(150) Name of service (gradeexport/xml/export, mod/chat/export)
enabled int(1) service enabled, for security reasons some services may be disabled
version varchar(10) version string
requiredcapability varchar(150) null Required capability (tested in security context or system context if no security context specified)
custom int(1) 0 Custom local service, created manually by admin or some other way == not parsed automatically.

external_services_functions

Specifies functions used by services.

Field Type Default Description
id int(10) auto-incrementing
externalserviceid int(10) foreign key, reference external_services.id
externalfunctionid int(10) foreign key, reference external_functions.id