phil / virtual-classroom-bundle
Live classes in Symfony on BigBlueButton or Jitsi: join links by role, attendance and recordings from signed webhooks, attendance counted as course completion.
Package info
github.com/parler-haut-interagir-librement/virtual-classroom-bundle
Type:symfony-bundle
pkg:composer/phil/virtual-classroom-bundle
Requires
- php: >=8.5
- ext-mbstring: *
- ext-sodium: *
- doctrine/dbal: ^4.5
- phil/url: ^0.1.3@dev
- phil/virtual-classroom: ^0.1@dev
- psr/clock: ^1.0
- psr/container: ^2.0
- psr/event-dispatcher: ^1.0
- symfony/config: ^8.2
- symfony/dependency-injection: ^8.2
- symfony/http-foundation: ^8.2
- symfony/http-kernel: ^8.2
- symfony/routing: ^8.2
- symfony/service-contracts: ^3.6
Requires (Dev)
- ext-pdo: *
- doctrine/doctrine-bundle: ^3.3
- doctrine/orm: ^3.7
- phil/courses-bundle: ^0.1@dev || ^0.2@dev
- phil/privacy-bundle: ^0.1@dev || ^0.2@dev
- phpunit/phpunit: ^13.4
- psr/log: ^3.0
- symfony/browser-kit: ^8.2
- symfony/clock: ^8.2
- symfony/console: ^8.2
- symfony/event-dispatcher: ^8.2
- symfony/framework-bundle: ^8.2
- symfony/http-client: ^8.2
- symfony/messenger: ^8.2
- symfony/security-bundle: ^8.2
- symfony/security-core: ^8.2
- symfony/security-http: ^8.2
- symfony/twig-bundle: ^8.2
- symfony/yaml: ^8.2
Suggests
- doctrine/orm: To add the tables to the schema the ORM generates, for doctrine:migrations:diff
- phil/courses-bundle: To offer a live class as an activity of a course, completed by the share of the session attended
- phil/privacy-bundle: To give the attendance of a participant in the access and erasure requests
- symfony/console: For phil:virtual-classroom:sync, which asks the servers who is in the open rooms and what they recorded
- symfony/http-client: For the HTTP client the BigBlueButton servers are called with, the http_client service of FrameworkBundle
- symfony/messenger: To sync a room from a message, SyncRoom, which carries its identifier only
- symfony/security-core: To name the participant from the authenticated user and give the moderator role by a Symfony role
Provides
None
Conflicts
None
Replaces
None
This package is auto-updated.
Last update: 2026-11-21 03:04:30 UTC
README
Live classes in a Symfony application: rooms on BigBlueButton or Jitsi, a join link written for each participant's role, the attendance — who arrived and left, when — and the recordings read from the servers' signed notifications, and, with phil/courses-bundle, a live class as an activity of a course, completed by the share of the session attended.
phil/virtual-classroom-bundle wires phil/virtual-classroom into an application. The providers — BigBlueButton
servers, Jitsi servers of the application's own, JaaS accounts, or a VirtualClassroom service of the application —
are named in the configuration. Classrooms schedules a room on one of them, owned by what the application says;
the room opens on its server when its first participant follows the join link of the bundle, which sends them,
by their role, to the link the server trusts. A moderator is whoever has a configurable Symfony role.
The servers call back the webhook of the bundle at addresses it signs, one per room and channel, or one per
account: the end of a room, participants arriving and leaving, a recording ready, the attendance of a session.
phil:virtual-classroom:sync, from a scheduler, asks the servers that can say who is in the open rooms and what they
recorded. The stays of the participants are kept, an arrival reported twice counted once, and Classrooms
reports what each participant attended of a session, in seconds and in whole percents.
With phil/courses-bundle, the activity type virtual_classroom schedules the room of an activity at its first
launch, and completes the activity for each enrolled learner whose attendance reaches the threshold once the room has
ended. With phil/privacy-bundle, the stays of a person are in their access and erasure requests.
It is a Symfony bundle on phil/virtual-classroom, Doctrine DBAL, HttpKernel and Routing, with Symfony's HTTP client for BigBlueButton; the console, Messenger, Security, phil/courses-bundle and phil/privacy-bundle are optional. The rooms, the stays and the recordings live in three tables on SQLite, MySQL, MariaDB or PostgreSQL, their identifiers compared byte for byte. Its services keep no state between requests and serve a long-running worker.
Status
| Part | State |
|---|---|
Room, RoomStatus, the events and the exceptions |
Implemented and tested |
Classrooms: schedule, join, end, sync, notifications, attendance, recordings |
Implemented and tested |
Providers, WebhookSigner, AttendeeReport |
Implemented and tested |
DbalClassroomStore, ClassroomTables, ClassroomSchemaListener, InMemoryClassroomStore |
Implemented and tested |
JoinController, WebhookController, RoutedCallbackUrls, SecurityCurrentParticipant |
Implemented and tested |
VirtualClassroomActivity, CoursesCompletion: the activity type of phil/courses-bundle |
Implemented and tested |
ClassroomPrivacy, the commands sync and webhook-url, SyncRoom and its handler, the Flex recipe |
Implemented and tested |
The signed learning analytics callback of BigBlueButton — the attendance posted with its bearer token — is verified against simulated BigBlueButton responses only: it has not yet been checked against a real BigBlueButton 3.x server.
Documentation
| Document | What it covers |
|---|---|
| Installation | Requirements, installing, the routes, the tables. |
| Configuration | Every option, with an example for each provider. |
| Rooms | Scheduling, joining, ending, syncing; the owner of a room. |
| Webhooks | The addresses, their proof, what each provider sends, the answers. |
| Attendance and recordings | The stays, the report of a session, the recordings. |
| Courses | The activity type virtual_classroom and its completion. |
| Privacy | The access and erasure requests, and the retention. |
| Console and Messenger | phil:virtual-classroom:sync, phil:virtual-classroom:webhook-url, SyncRoom. |
| Security | What the bundle protects against, and what is left to the application. |
| Extension points | The services to replace, the events, and when they are stable. |
| Testing | The bundle's tests and the servers its integration tests read. |
| Reference | Every class and service of the bundle. |
Quick start
// config/bundles.php Phil\VirtualClassroomBundle\PhilVirtualClassroomBundle::class => ['all' => true],
# config/packages/phil_virtual_classroom.yaml phil_virtual_classroom: providers: main: { type: bigbluebutton, url: '%env(BBB_URL)%', secret: '%env(BBB_SECRET)%' } # config/routes/phil_virtual_classroom.yaml phil_virtual_classroom: resource: '@PhilVirtualClassroomBundle/config/routes.php' prefix: /virtual-classroom
$room = $classrooms->schedule('Algebra, week 3', record: true, owner: 'workshop:42'); // Send the participants to /virtual-classroom/{room}/join.
Requirements
PHP 8.5 or later, Symfony 8.2 or later and Doctrine DBAL 4.5 or later.
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.