omnibase/classroom

Installation

Requirements

What composer.json requires: PHP 8.2 or later, doctrine/orm 2.15 or 3, omnisense/omnibase 3.0 or 4.0, omnibridge/symfony 1.x, omnibase/admin, phpoffice/phpspreadsheet 1.23 to 5, and symfony/config, dependency-injection, form, http-kernel and security-bundle 6, 7 or 8. It suggests omnibase/marketplace (selling resources) and omnibase/blog (comments under a sequence); it works with omnibase/consent when the site has it.

The bundle

// config/bundles.php
return [
    // ...
    Base\BaseBundle::class => ['all' => true],
    Base\Admin\AdminBundle::class => ['all' => true],
    Base\Classroom\ClassroomBundle::class => ['all' => true],
];

ClassroomBundle aliases Base\Classroom\Entity\* to App\Entity\Classroom\* and the repositories to App\Repository\Classroom\* (unless the application declares its own), and registers Compiler\EmbedsConsentPass. Its templates/ is @Classroom, its public/ bundles/classroom/.

The routes

# config/routes.yaml
classroom_controller:
    resource: "@ClassroomBundle/src/Controller/Client"
    type: attribute
    prefix: /

The paths are French (The pages); /boutique exists only with omnibase/marketplace's quick order.

The storage

The files go to the flysystem storage local.classroom (the Resource::$file uploader), which the host defines, outside public/ (classroom.storage_dir is not read: the storage's own directory is what counts):

# config/packages/flysystem.yaml
flysystem:
    storages:
        local.classroom:
            local:
                directory: '%kernel.project_dir%/var/storage/classroom'

Configuration

# config/packages/classroom.yaml (every key optional)
classroom:
    accel_prefix: ''
    download_ttl: 600
    preview_rows: 30
    members_role: ROLE_USER
    per_page: 24
    from_email: null

The schema and the public files

bin/console doctrine:migrations:diff
bin/console doctrine:migrations:migrate
bin/console assets:install

Tables classroom_sequence, classroom_session, classroom_card (joined to the core's thread table), classroom_resource, classroom_resource_taxon, classroom_sequence_resource, classroom_entitlement, and the taxa's discriminator entries; the stylesheet bundles/classroom/css/classroom.css.

What the layout provides

The pages extend layout1.html.twig and fill its title, description, content and stylesheets blocks.

Levels, sequences, cards and resources

The taxa

Level, Subject and Purpose extend the core's Base\Entity\Thread\Taxon (a translated label and description, an icon, a slug, a parent and children):

The threads (sequences, cards) and the resources keep their levels, subjects and purposes in one association, taxa, read and written by kind (ClassifiedTrait, TaxaOfKindTrait): getLevels() (by position), getSubjects(), getPurposes(), and setLevels(), setSubjects(), setPurposes(), each replacing the taxa of its kind and leaving the others; a value of another kind is ignored. isMultiLevel(), getLevelsLabel() ("CP · CE1").

Sequence

Extends Thread (classroom_sequence); title, headline, excerpt, the presentation (content), slug, state and publishedAt are the thread's.

getSessions() - its children that are sessions, by position then id.

Session

Extends Thread (classroom_session), a child of its sequence (setSequence() sets the parent): position (1 at least), durationMinutes, materials (a list, one per line). Its headline is its aim, its text the course. Its link is the sequence's page at #seance-<position>. A session created in the back office is published.

Card

Extends Thread (classroom_card): image (8 MB), links (up to the author: {label, url}, "label | url" per line in linksText; a line without label is its own label), featured (on the fan), position, icon (a Font Awesome class, big on a card without picture, a badge on one with), color, embeds, and its levels and subjects.

Resource

classroom_resource:

getExtension() (from the name, else from the type), isSpreadsheet() (xlsx, xls, xlsm, csv, ods), hasFile().

Entitlement and ResourceOffer

Entitlement (classroom_entitlement, unique on user and resource): the buyer, the resource, the order's reference, downloads, createdAt. It never expires.

Product\ResourceOffer extends omnibase/marketplace's Product (discriminator classroom_resource_offer): its resource; not shippable; one at most per order.

Repositories

$taxa are slugs, all required. A published thread is PUBLISH with a publishedAt past or none. Base\Classroom\Service\Taxa: cycles(), levels() (the levels alone), subjects(), purposes() (the top ones, in order), and one by slug: level(), subject(), purpose().

The pages

An unknown slug is a 404.

The listings

The level, subject, purpose, sequences, cards and resources pages are one listing (@Classroom/client/listing.html.twig), filtered by the taxa in the path (all required):

The page gets the level, subject and purpose chosen, every level, subject and purpose (the pills), the periods and the counts for the pager.

Downloads and embeds

Signed downloads

A resource's file is downloaded through a signed link (omnisense/omnibase's Base\Service\DownloadLinks): ResourceController signs classroom_download_file for classroom.download_ttl seconds once ResourceVoter let the visitor through, and checks the signature when the file is asked for; after a quick order, QuickOrderFilesListener signs a link for a day. The bundle no longer has a DownloadLinks of its own.

Who may download

Base\Classroom\Security\ResourceVoter decides CLASSROOM_DOWNLOAD on a Resource: an unpublished one only for ROLE_ADMIN; then a free one for anyone, a members' one for classroom.members_role (ROLE_USER), a paid one for ROLE_ADMIN or whoever holds an Entitlement to it. classroom_may_download(resource) asks it in Twig.

The download, in two steps

1. /ressources/{slug}/telecharger (classroom_download): a resource without file is a 404; refused, an anonymous visitor goes to the sign-in (back here after), a signed-in one back to the resource's page with the flash "paid only" or "members only"; allowed, a redirect to classroom_download_file signed for classroom.download_ttl seconds (with the entitlement's id, when there is one).
2. /ressources/fichier/{id}/{filename} (classroom_download_file): an invalid or expired signature is a plain 403 (signing in would not help); a file missing from the storage a 404. A GET without Range counts one download on the resource and on the entitlement. The file is sent as an attachment under its saved name - by nginx when classroom.accel_prefix is set (X-Accel-Redirect: <prefix>/<path under the storage>), else by PHP (BinaryFileResponse, private).

The spreadsheet preview

Base\Classroom\Service\SpreadsheetPreview::sheets(Resource): for a spreadsheet (xlsx, xls, xlsm, ods through PhpSpreadsheet, data only; csv read directly - semicolons when the first line has more of them than commas), the first classroom.preview_rows (30) rows of each sheet, empty rows dropped, with whether there are more; cached a day, until the resource changes. A file that cannot be read gives nothing.

What a sequence or a card frames

The "Intégrations" of a sequence or a card (one address per line, "Label | https://…") are framed by omnisense/omnibase's Twig function embed_url(): Canva, Padlet, YouTube, Vimeo, LearningApps, Genially and Google Slides are read from the address; any other site is asked for its player (embed/embed, oEmbed) and framed when it has one, a plain link otherwise. classroom_embed() and Base\Classroom\Service\Embeds are gone; @Classroom/client/_embeds.html.twig uses embed_url() (embed.open.other labels a provider not known by name).

Behind the cookie answer

A frame brings its provider's cookies (Canva, Padlet, YouTube, Vimeo...). On a site with omnibase/consent, it waits for the visitor's yes to the EMBEDS feature - the name omnibase/video's platform frames use: the iframe carries its address in data-consent-src and has none until then, and a sentence (embed.consent.text, the provider's name) stands in its place with a button that opens the detailed section of the cookie panel (data-consent-open="details"), where EMBEDS is listed; the link to the provider's page stays under the frame. Accepted, the frame loads; refused again, it is emptied.

Compiler\EmbedsConsentPass adds the feature to the ones every site starts from (omnibase/consent's consent.defaults) - on demand: listed on the pages that frame something, never a reason to ask a visitor again - with what these providers were seen to keep on their own domain (Canva's CDI and CL, Vimeo's vuid, the YouTube player's yt-remote-*); its words are translations/consent+intl-icu.*.yaml (features.embeds.*, storage.embeds_*). A site lays its own consent.features.EMBEDS over it, field by field (declared there, it is listed on every page unless it says on_demand: true), and its own words over the bundle's; defaults: false leaves it out. It is not put in the site's consent: configuration, whose features are the site's own list (data-consent-groups). Without omnibase/consent the frames load with the page (classroom_consent() is null).

The shop

With omnibase/marketplace, a paid resource is sold as a Product\ResourceOffer.

Putting a resource on sale

The resource's Mettre en vente (/admin/resources/{entityId}/sell) finds its offer, or makes one in the first store - titled and described as the resource, a draft - and sets the resource paid; then opens the offer's screen (ResourceOfferCrudController, omnibase/marketplace's product screen plus the resource) for its price and publication.

Selling

/boutique (classroom_shop, loaded only with omnibase/marketplace's QuickOrder) lists the offers for sale whose resource is published and has a file, newest first, sold with the marketplace's quick order: an e-mail address, the payment, no account, no basket. A signed-in member buys in their own name.

Delivering

• EventSubscriber\OrderPaidSubscriber (on OrderPaidEvent): for each item of the order that is a resource offer, an Entitlement for the customer (one per resource and buyer: a webhook and a redirect confirming the same order write it once); then a mail (@Classroom/email/files.html.twig, from classroom.from_email) with the link of the order's page (QuickOrder::doneUrl()). An offer without resource is logged as an error; a mail that fails is logged, never a reason to undo the confirmation.
• EventSubscriber\QuickOrderFilesListener (on QuickOrderDoneEvent): the quick order's page, reached by its own signed link, renders @Classroom/client/thanks.html.twig with the files - once paid, each behind a signed download link valid a day.

Both are loaded only with omnibase/marketplace (and its quick order for the second).

In a host page

Twig functions and filters

Base\Classroom\Twig\ClassroomExtension:

Templates

@Classroom/client/: index, listing, sequence, card, resource, search, shop, thanks, and the partials _card, _sequence_card, _resource_card, _pills, _embeds; @Classroom/email/files; @Classroom/admin/widget/overview. An application overrides one in templates/bundles/ClassroomBundle/....

Translations

The domains classroom (the pages, the back office's words), entities (the screens' names) and consent (the EMBEDS feature's words for omnibase/consent's panel), ICU, in French, English and German.

The back office

Loaded when omnibase/admin is installed. The screens open creating, editing and deleting to ROLE_ADMIN (OpenToAdminsTrait: a teacher writes, not only the super-administrator).

A sequence, a card or a resource created here has the signed-in user as owner. Saving a resource keeps its file's size, type and - when empty - its name. Only what a record cannot do without is required (a title, a state, a slug; a resource's file, a session's sequence).

The tile classroom_overview (ClassroomOverviewWidgetType): sequences online and in draft, cards online, resources published, downloads, entitlements bought since the first of the month, each linking to its screen.

Configuration reference

classroom:

Base\Classroom\DependencyInjection\ClassroomConfiguration, dumped with Symfony's YamlReferenceDumper in omnisense/omnibase's harness image:

classroom:

    # Where the resources are (the local.classroom flysystem storage points there).
    storage_dir:          '%kernel.project_dir%/var/storage/classroom'

    # nginx internal location streaming the files (X-Accel-Redirect); empty: PHP streams them.
    accel_prefix:         ''

    # Seconds a signed download link stays valid.
    download_ttl:         600

    # Rows of a spreadsheet shown in a resource's preview.
    preview_rows:         30

    # Who the MEMBERS resources are for.
    members_role:         ROLE_USER
    per_page:             24

    # Sender of the mail a paid order gets (the link to its files); null: the mailer's default sender.
    from_email:           null

storage_dir is deprecated: it was read by nothing. The files go to the flysystem storage local.classroom, whose directory the site sets in its flysystem.yaml; a site that still sets storage_dir gets Symfony's deprecation notice.

The extension also sets classroom.consent: whether the container has omnibase/consent's extension.

Services

config/services.php autowires and autoconfigures src/ but DependencyInjection/, Entity/, Enum/, Controller/Admin/, Admin/, EventSubscriber/ and the bundle class; Controller/Client/ is tagged controller.service_arguments (ShopController only with omnibase/marketplace's QuickOrder); with omnibase/admin, Controller/Admin/ (ResourceOfferCrudController only with omnibase/marketplace's Product) and Admin/; with omnibase/marketplace's OrderPaidEvent, EventSubscriber/ (QuickOrderFilesListener only with its QuickOrderDoneEvent).

Compiler\EmbedsConsentPass adds EMBEDS to omnibase/consent's consent.defaults: on demand, with the storage these providers keep - Canva's CDI (a year) and CL (60 days), Vimeo's vuid (two years), the YouTube player's yt-remote-* (local storage). Another bundle's EMBEDS keeps its fields; the entries it does not name are added.

Testing

vendor/bin/phpunit

The tests are units. In omnisense/omnibase's harness, with this checkout and omnibase/consent's:

docker run --rm --network none \
    -v "$PWD":/srv/demo/vendor/omnibase/classroom:ro -v "$PWD/../consent":/srv/demo/vendor/omnibase/consent:ro \
    omnisense/omnibase-harness test classroom

Run on 2026-10-27 with both at HEAD: 27 tests, 1 error.

EmbedsConsentTest takes omnibase/consent's own features from ConsentPanel::features(), not from a path guessed beside a class's file.

Saving through the back office is a host's functional test (a site's own).