Package: cmi5
Generated from api/packages/cmi5
Source: api/packages/cmi5 · imported version 0.1.0. The sections after the README are extracted from the code on every docs build.
README
Section titled “README”Learner launch
Section titled “Learner launch”Students have cmi5_read and launch an AU with GET /api/cmi5/player/{auId} (?format=json returns
the launch URL). The AU is served from the tenant content origin; the URL holds a one-time launch
token that POST /api/cmi5/fetch exchanges for an LRS-only session token (see packages/lrs and
docs/decisions/0046-cmi5-content-origin-and-launch-token.md). Deleting a package needs the new
cmi5_delete permission (admins). php artisan cmi5:move-to-bucket copies packages from the old
local disk to CMI5_DISK (default: SCORM_DISK).
API endpoints
Section titled “API endpoints”| Method | Path | Auth | Action |
|---|---|---|---|
GET |
/api/cmi5/player/{auId} |
yes | Cmi5Controller@read |
GET |
/api/admin/cmi5 |
yes | Cmi5Controller@list |
POST |
/api/admin/cmi5 |
yes | Cmi5Controller@upload |
DELETE |
/api/admin/cmi5/{id} |
yes | Cmi5Controller@delete |
Permissions
Section titled “Permissions”| Permission | Seeded for roles | Constant |
|---|---|---|
cmi5_upload |
admin | Cmi5PermissionEnum::CMI5_UPLOAD |
cmi5_list |
admin | Cmi5PermissionEnum::CMI5_LIST |
cmi5_read |
admin | Cmi5PermissionEnum::CMI5_READ |
cmi5_delete |
admin | Cmi5PermissionEnum::CMI5_DELETE |
Settings
Section titled “Settings”Registered with AdministrableConfig::registerConfig (editable in the admin panel under Configuration → Settings).
None.
Events
Section titled “Events”None.
Artisan commands
Section titled “Artisan commands”| Command | Description | Signature |
|---|---|---|
cmi5:move-to-bucket |
Copy cmi5 packages from another disk to the configured cmi5 disk (idempotent) | cmi5:move-to-bucket {--from=local : Disk the packages were uploaded to} |
Scheduled jobs
Section titled “Scheduled jobs”None.
Environment variables read
Section titled “Environment variables read”CMI5_DISK