README

A teacher's open classroom on omnibase: what a colleague passing by may pick up - the way the French teachers' sites (Lutin Bazar, Charivari, Orphée) organise things, built on omnibase's own Thread and Taxon instead of a blog engine.

Entity	Is a	What
`Level`	`Taxon`	a class level, in a tree of cycles: Cycle 2 › CP, CE1, CE2
`Subject`	`Taxon`	a discipline, with its sub-domains: Français › Lecture, Grammaire…
`Purpose`	`Taxon`	"pour la classe": rituals, displays, autonomy, games, organisation
`Sequence`	`Thread`	a learning sequence: its objectives, competences, period (P1…P5), material, cover, and its `Session`s
`Session`	`Thread` (child of a Sequence)	one session: its duration and its course (EditorJS)
`Card`	`Thread`	an idea card: a picture, a few lines, one to three links - the fan of the home page
`Resource`	—	a file to download: PDF, document, spreadsheet, archive; free, for members, or paid
`Product\ResourceOffer`	marketplace `Product`	a paid resource for sale; paying it writes an `Entitlement`

Levels, subjects and purposes are the taxa of the threads, so a sequence is "CP and CE1 · Allemand" (multi-level: several levels on one thread) and every list filters by them. The text of a sequence, a session or a card is EditorJS, autosaved; with the yjs relay configured (COLLAB_RELAY_WS_URL) it is co-edited live.

Resources live outside public/ (the flysystem storage local.classroom, which the host defines) and are served through signed, short-lived links - by nginx (accel_prefix, X-Accel-Redirect) or by PHP. A spreadsheet (xlsx, xls, csv) is previewed as a table (preview_rows rows) through PhpSpreadsheet; an image through omnibase's thumbnails.

Install

composer require omnibase/classroom:dev-main

// config/bundles.php
Base\Classroom\ClassroomBundle::class => ['all' => true],

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

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

# config/packages/classroom.yaml (every key optional)
classroom:
    accel_prefix: ''        # nginx internal location, empty: PHP streams the file
    download_ttl: 600       # seconds a signed link lives
    preview_rows: 30        # rows of a spreadsheet shown in the preview
    members_role: ROLE_USER # who the MEMBERS resources are for
    per_page: 24

Then migrations and assets:install (public/css/classroom.css).

Routes

/classe/{level}, /classe/{level}/{subject}, /matiere/{subject}, /pour-la-classe/{purpose}, /sequences, /sequences/{slug}, /cartes, /cartes/{slug}, /ressources, /ressources/{slug}, /ressources/{slug}/telecharger, /rechercher?q=. Twig: classroom_levels(), classroom_subjects(), classroom_purposes(), classroom_cards(limit), classroom_sequences(limit).

The back office gets a CRUD for each entity and the dashboard widget classroom_overview (downloads of the month, drafts, resources). A sequence, a card and a resource have one picker per kind of taxa (levels, subjects, purposes), each written through its own setter (setLevels()...), which replaces the taxa of that kind and leaves the others: never two fields on taxa, which a form keeps as one. Only what a record cannot do without is required - a title, a state, a slug (a resource's file, a session's sequence) -; the links, the frames, the pictures, the texts may be left empty. The slug follows the title as it is typed (setTargetFieldName('title')). The screens are named in translations/entities+intl-icu.{fr,en,de}.yaml (the domain omnibase/admin titles a screen with), the state and the slug in the classroom's own words.

Embeds and cookies

What a sequence or a card frames (Canva, Padlet, a video...) is read by omniscient/omnibase's embed_url(). On a site with omnibase/consent a frame waits for the visitor's yes to the EMBEDS feature, which this bundle declares (on demand, with what those providers keep) and words in fr, en and de; a sentence and a button to the cookie panel stand in its place until then. See docs/downloads-and-embeds.md.

Tests

vendor/bin/phpunit          # the declaration of EMBEDS, the frames before and after the yes, every language's words,
                            # the taxa written by kind, the back office's fields (one per property, only what is needed required,
                            # CrudRequiredFieldsTest on omnibase/admin's CrudFieldsTestCase), its words in every language

These are units: saving through the back office is a host's functional test (apfelschule's tests/Functional/ClassroomAdminTest.php creates and edits cards, sequences, resources and sessions).

In omnibase's harness (omniscient/omnibase, docker/), on this checkout and omnibase/consent's:

docker compose -f compose.yml run --rm -v /path/to/consent:/srv/demo/vendor/omnibase/consent -v /path/to/classroom:/srv/demo/vendor/omnibase/classroom omnibase test classroom

The shop

/boutique (classroom_shop) lists the resources for sale, one card each, and sells them with omnibase/marketplace's quick order: an e-mail address, the payment, no account and no basket. The order's page - a signed link, shown after the payment and mailed to the buyer (classroom.from_email sets the sender) - lists the files, each behind a signed download link. A signed-in member buys in their own name and finds the file in their account as before.

License

MIT since 2026-10-09; earlier versions remain published under LGPL-3.0-or-later.

omnibase / classroom

Package info

Security

Statistics