Changelog
tilttek/quizAll notable changes to tilttek/quiz will be documented in this file.
Updates should follow the Keep a CHANGELOG principles.
0.1.0-alpha - 2026-11-14
Added
Quiz: 1 to 200 questions with distinct identifiers, a default time limit of 5 to 600 seconds, its scoring, the grading and scoring of an answer against its timer,maxScore(), andQuiz::fromSource()composing a quiz from a bank of aContract\QuestionSource.- Questions, behind
Contract\Question:SingleChoiceQuestionwithtrueOrFalse(),MultipleChoiceQuestionwith optional partial credit,OrderingQuestionwith optional partial credit,TypedAnswerQuestioncomparing folded text — case, spaces and, unless kept, accents — andNumericQuestionwith a tolerance; 2 to 12 choices, prompts of 1 to 1 000 bytes, 0 to 10 000 points. - Answers, behind
Contract\Answer:ChoiceAnswer,OrderAnswer,TextAnswerof at most 200 bytes of UTF-8 andNumberAnswer; a question refuses an answer of another kind. Gradein thousandths,ScoringandScoringMode: accuracy by default, or speed with a bonus of 0 to 100 percent of the points falling in a straight line to nothing at the end of the time.QuestionTimer: milliseconds read from the PSR-20 clock of the application;AnswerResult, timed out included.SelfPacedQuizzesandSelfPaced\Play: a member's run at their own pace, each question shown when the previous one is answered; a guest refused; each play bound to its member, who alone answers, reads and sees its result; the results held back until the play is over unlessSelfPaced\Feedback::AfterEachAnswer; each play at an attempt, only the first counting, later ones practice or refused bySelfPaced\Replays, two plays started at once never both first;PerfectScoreonce per quiz and member by default, or for every perfect play bySelfPaced\PerfectScoreRule;erasePlayer()deleting a member's plays.LiveQuizzes,Live\LiveSessionandLive\LiveState: a six-digit PIN drawn from a secure source and free among the sessions not over, up to 1 000 players, members and guests, each question shown, answered once per player in time, closed with the absent timed out, then reviewed; the changes made again on a conflict, up to eight times. The PIN is taken byContract\LiveSessionStore::add()only while no session that is not over holds it, in one atomic step, and drawn again otherwise, up toLiveQuizzes::PIN_DRAWStimes. The events of the end are kept in the session until each was dispatched without an exception:LiveSession::undelivered()andmarkDelivered(), the events left dispatched byfinish()called again or byLiveQuizzes::deliver(), a failed listener never stopping the others.Pin: the PIN a player types, spaces and hyphens left out, at most 16 bytes read, refused withInvalidQuizunless six ASCII digits, read byLiveQuizzes::join()before any store is asked.- Teams: 2 to 50 per session, by identifier; a player joins the team given or the smallest;
Team\TeamLeaderboardandTeam\TeamStandingrank them byTeam\TeamScoring— the total of their players, or their mean rounded half up — then by time, with shared ranks; a guest's team follows the member they became. Player: a member by opaque reference, or a guest under a pseudonym of 1 to 24 characters without control or invisible characters, unique per session whatever its case, filtered by an optionalContract\PseudonymFilter;LiveQuizzes::claimGuest()gives a guest's place and answers to the member they became, and the session forgets the pseudonym.Pseudonym\WordListFilter, its file opening on a content warning: whole words and terms anywhere, folded — case, accents, digit and symbol stand-ins —, up to 10 000 words, withdefaults(), the library's short list in English and in French, andwith()for the application's words;Pseudonym\ChainFilterasks several filters in order.LeaderboardandStanding: the highest score first, then the fewer milliseconds of the scoring answers, shared ranks (1, 1, 3),top()with ties at the edge.- Events carrying identifiers only:
QuizCompletedandPerfectScore, both saying whether a play is practice,LiveQuizFinished,TeamWon,GuestInvited, and the moves of a live session,PlayerJoined,QuestionShownandQuestionClosed, each dispatched once the change is saved; the events of the end of a live session carry a stablekey()for idempotent listeners. Mercure\LiveSessionPublisher: the moves of a live session pushed as private Mercure updates on the session's topic, naming the session and the position of a question only;symfony/mercuresuggested.View\ResultViewandtemplates/result.html.twig: the score out of the most, the rank of a live run and of the player's team, whether a play is practice, the blockssummaryandcelebration; the Stimulus controllerresultdispatchingquiz:completed,quiz:perfectandquiz:team-wonon the window once per run in a browser tab, for the celebration of the PHIL UX kit.Contract\QuizCatalog,Contract\PlayStore— with the count of a member's plays of a quiz, one play per attempt and the erasure of a member — andContract\LiveSessionStore, with versions and one session not over per PIN, and their stores in memory, withStore\InMemoryQuestionSource.- Exceptions under
Exception\QuizException:InvalidQuiz,QuizRefusedandQuizConflict. - Benchmarks of an answer in a session of 1 000 players, of its standings, of the standings of its players in ten teams and of a pseudonym through the word list.
- Fuzz targets of the PIN and of a pseudonym through the word list.
- The documentation in
doc/, one file per topic, indexed by the README;CONTRIBUTING.md,SECURITY.mdandCODE_OF_CONDUCT.md.