|
|
| (288 intermediate revisions by 14 users not shown) |
| Line 1: |
Line 1: |
| ===external_functions===
| | {{Template:Migrated|newDocId=/docs/apis/subsystems/external/description}} |
| List of external functions. Created automatically by parsing of external files.
| |
| | |
| | |
| {| class="nicetable" | |
| ! 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.
| |
| | |
| | |
| {| class="nicetable" | |
| ! 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.
| |
| | |
| {| class="nicetable"
| |
| ! 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
| |
| |}
| |
