phil / courses-bundle
Online courses in a Symfony application: modules, enrollments, progress and completion, with SCORM and cmi5 packages and an xAPI record store.
Package info
github.com/parler-haut-interagir-librement/courses-bundle
Type:symfony-bundle
pkg:composer/phil/courses-bundle
Requires
- php: >=8.5
- ext-mbstring: *
- ext-sodium: *
- doctrine/dbal: ^4.5
- phil/elearning-packages: ^0.1@dev
- phil/url: ^0.1@dev
- psr/clock: ^1.0
- psr/event-dispatcher: ^1.0
- symfony/config: ^8.2
- symfony/dependency-injection: ^8.2
- symfony/filesystem: ^8.2
- symfony/http-foundation: ^8.2
- symfony/http-kernel: ^8.2
- symfony/routing: ^8.2
- symfony/uid: ^8.2
Requires (Dev)
- ext-pdo: *
- ext-zip: *
- doctrine/doctrine-bundle: ^3.3
- doctrine/orm: ^3.7
- phil/audit-bundle: ^0.1@dev
- phil/certificates-bundle: ^0.2@dev
- phil/privacy-bundle: ^0.1@dev
- phil/safe-http: ^0.1@dev || ^0.2@dev
- phil/ux-kit: ^0.5@dev
- phpunit/phpunit: ^13.4
- psr/log: ^3.0
- symfony/browser-kit: ^8.2
- symfony/clock: ^8.2
- symfony/console: ^8.2
- symfony/css-selector: ^8.2
- symfony/dom-crawler: ^8.2
- symfony/event-dispatcher: ^8.2
- symfony/event-dispatcher-contracts: ^3.6
- symfony/framework-bundle: ^8.2
- symfony/http-client: ^8.2
- symfony/security-core: ^8.2
- symfony/security-csrf: ^8.2
- symfony/translation: ^8.2
- symfony/twig-bridge: ^8.2
- symfony/twig-bundle: ^8.2
- symfony/ux-twig-component: ^3.7
- twig/twig: ^3.21
Suggests
- doctrine/orm: For the tables added to the schema the ORM generates
- phil/audit-bundle: To write the second chances asked for, granted, refused and waived to the audit trail
- phil/certificates-bundle: To issue certificates on the completion of a course, answered through its CourseCompletions port
- phil/privacy-bundle: To give the SCORM attempts and their tracking data in the access and erasure requests of a learner
- phil/safe-http: To send the statements to a remote xAPI learning record store
- phil/ux-kit: For the recipes Button, Badge, Progress and Textarea the pages draw, through the Symfony UX Toolkit
- symfony/asset-mapper: To serve the Stimulus controller of the SCORM run time without a build step
- symfony/console: For phil:courses:import, phil:courses:import-results and phil:courses:retries
- symfony/security-core: To name the current learner from the authenticated user, and for the administration page of the second chances
- symfony/security-csrf: For the forms of the pages
- symfony/stimulus-bundle: For the Stimulus controller of the SCORM run time, through AssetMapper
- symfony/twig-bundle: For the pages of the courses
- symfony/ux-twig-component: For the recipes of the kit the pages draw
Provides
None
Conflicts
None
Replaces
None
This package is auto-updated.
Last update: 2026-11-19 00:46:28 UTC
README
Online courses for Symfony: modules, activities, progress and completion, with SCORM and cmi5 courses run inside the platform.
phil/courses-bundle gives an application online courses. A course holds modules in order, and each module holds
activities: a page of text, a link, the content of an imported SCORM package, or a cmi5 assignable unit. Activity types
are a port with a few adapters, so that an application adds its own. A learner enrolls once in a course; each activity
records what they did — completed, passed, failed, waived, the best score — and is satisfied by the requirement it
carries, the values of cmi5's moveOn. The course is completed when every required activity is satisfied.
A module or an activity opens at once, on a date, or a number of days after the learner enrolled, counted from midnight in the site's time zone. A course may impose the order of its activities. No state is a dead end: a learner who failed every try of an activity asks for a second chance, which a teacher grants, refuses, or answers by waiving the activity, with a note, on an administration page or from the console; with phil/audit-bundle, each step is written to the audit trail.
The bundle imports SCORM 1.2, SCORM 2004 and cmi5 packages, to run them or to migrate courses from another platform,
read by phil/elearning-packages. The ZIP archive is read within bounds — its size, its number of entries, the size of
each file uncompressed, its compression ratio —, and an entry that would leave the package, a symbolic link or a corrupt
entry is refused. The manifest is parsed without any document type or entity. The files are stored apart, and served
from a content origin that is not the application's, with a content security policy.
SCORM content runs inside the platform: a Stimulus controller frames it under the run-time API of SCORM 1.2 (API) or
SCORM 2004 (API_1484_11), which answers each call at once by the data model of phil/elearning-packages and sends the
commits to an endpoint that checks them again. Attempts are kept with their tracking data — suspended and resumed,
attempted again —, and feed the learner's progress, the mastery score of the manifest included.
The tree of the blocks of a cmi5 course structure is kept: nested blocks, their order and their identifiers.
cmi5 units are launched with the parameters of cmi5, fetch their token once, and send their statements to an xAPI
endpoint of the bundle, which checks them against the rules of cmi5 before a learning record store keeps them. The
platform issues the satisfied statement of each block once its required units are satisfied, then of the course,
once for each enrollment. The store inside the bundle keeps the statements through DBAL; the bundle also sends them to
a remote xAPI learning record store through the guarded client of phil/safe-http, the state documents of the units
staying in the application's database, and an application's own store plugs into the same port.
Another part of the application — certificates, badges, a report — asks Completions whether a learner completed a
course, and keeps its own model; with phil/certificates-bundle, the bundle answers its CourseCompletions port.
The services keep no state between requests and are safe in a long-running worker. The stores use DBAL, and are tested on SQLite, MySQL 8.4 and PostgreSQL 17.
Status
| Part | State |
|---|---|
| Courses, modules and activities through DBAL; activity types as a port with the page, link, SCORM and cmi5 adapters | Implemented and tested |
| Enrollment, progress by activity, the requirement of each activity, completion by course, events of PSR-14 | Implemented and tested |
Completions, and the adapter of the CourseCompletions port of phil/certificates-bundle 0.2 |
Implemented and tested |
| Release on a date or days after the enrollment in the site's time zone; imposed order | Implemented and tested |
| Second chances asked for, granted, refused or answered by a waiver with a note, the trail of phil/audit-bundle | Implemented and tested |
| The administration page of the second chances, behind a configurable role, with the recipes of the kit, English and French | Implemented and tested |
| The import of SCORM 1.2 and 2004 packages through phil/elearning-packages, sequencing kept for information, results imported from a CSV export | Implemented and tested |
| The SCORM run time: the API of SCORM 1.2 and 2004 in the browser, every element of their data models checked in the browser and on the server, attempts suspended, resumed and attempted again, tracking data kept, progress recorded, navigation requests followed | Implemented, tested on SQLite, MySQL and PostgreSQL, and fuzzed |
| The tracking data of the SCORM attempts in the access and erasure requests of phil/privacy-bundle | Implemented and tested |
| The sequencing and navigation of SCORM 2004 beyond the flow and the choice of the outline: rules, rollup, shared objectives | Not yet: see SCORM run time |
The import of cmi5 packages and course structures, through phil/elearning-packages, the tree of the blocks kept, a unit whose moveOn is NotApplicable not required |
Implemented and tested |
| cmi5 launches, the fetch URL, the xAPI endpoint with the rules of cmi5, the learning record store as a port | Implemented and tested |
The satisfied statements of the blocks, innermost first, and of the course, once for each enrollment, named by the course structure, with the BlockSatisfied event |
Implemented and tested |
| The remote xAPI learning record store through phil/safe-http, for the statements | Implemented and tested; its integration test runs against a store the environment names |
| The state documents of the units with a remote store | Kept in the store inside the bundle, never sent: the port names no agent, which the State resource of xAPI asks for |
| A remote store on a private network | Refused by phil/safe-http: an application's own adapter of the port reaches it |
| The upgrade of the tables of an earlier schema, on SQLite, MySQL and PostgreSQL | Implemented and tested |
| The content served from its own origin, with its content security policy | Implemented and tested |
phil:courses:import, phil:courses:import-results, phil:courses:retries |
Implemented and tested |
| The pages — outline, activity, enrollment, second chance — with the recipes of the kit, English and French | Implemented and tested |
| The Flex recipe: the bundle, its configuration and its routes | Written in recipe/0.1, for the recipes repository of PHIL |
| Branching lessons through phil/story-graph, quizzes through phil/assessment, access through phil/content-access | Planned, as activity types and an access port, once those libraries are written |
| LTI 1.3 activities, hosted video with consented watch tracking | Planned, as activity types the LTI and video bundles add |
| Cohorts with live meetings, courses sold through the catalogue, dependencies between courses, learning paths | Planned |
Documentation
| Document | What it covers |
|---|---|
| Installation | Requirements, the tables and their upgrade, the routes, the content origin, the recipes of the kit, the recipe. |
| Configuration | Every option, with an example. |
| The course model | Courses, modules, blocks, activities, enrollments, progress, releases, order and second chances, with their administration page. |
| SCORM import | What a SCORM package becomes, what is kept for information, what is left out, and imported results. |
| SCORM run time | How a SCO runs: the API in the browser, the commit endpoint, attempts, progress, packages of several SCOs, what is supported and what is not yet, privacy. |
| cmi5 | The import of cmi5 packages and their blocks, the launch, the fetch URL, the xAPI endpoint, the satisfied statements and the learning record stores, inside the bundle or remote. |
| Security | The bounds of the archive and the manifest, the content origin and its headers, the SCORM run time, the remote store, the administration page. |
| Extension points | The ports, the events, the services to replace, and when they are stable. |
| Testing | The bundle's tests, the servers and the learning record store its integration tests read, and the fuzz target. |
| Reference | Every class and file of the bundle. |
Quick start
composer require phil/courses-bundle php bin/console ux:install button badge progress textarea --kit=github.com/parler-haut-interagir-librement/ux-kit
# config/packages/phil_courses.yaml phil_courses: timezone: America/Toronto content: base_url: 'https://content.example.org' application_origin: 'https://www.example.org' cmi5: actor_home_page: 'https://www.example.org'
php bin/console phil:courses:import var/import/safety-course.zip
Requirements
PHP 8.5 or later with the mbstring and sodium extensions, and those phil/elearning-packages reads packages with —
dom, libxml and zip —, Symfony 8.2 or later, and Doctrine DBAL 4.5. The remote learning record store needs
phil/safe-http, the administration page Symfony Security, and the SCORM run time symfony/stimulus-bundle with
AssetMapper.
Contributing
Contributions are welcome on the PHIL monorepo: read the contribution guide and the code of conduct. Report a vulnerability privately, as the security policy explains, never in a public issue.
License
MIT, © Philippe Gamache, doing business as Le Gnome Archiviste; a Parler Haut Interagir Librement project. See LICENSE.