Aller au contenu

tilttek/leaderboards-bundle

✅ publié

Des classements pour une application Symfony, tenus à jour à partir de l'activité de ses membres, chaque membre montré seulement selon son choix.

tilttek/leaderboards-bundle intègre tilttek/leaderboards à Symfony. Les classements (leurs mesures, leurs verbes et leurs conditions de contexte, leurs périodes et leurs fuseaux horaires, leurs saisons et leurs fenêtres glissantes, leurs égalités et leurs critères de départage, la taille de leurs instantanés, leurs ligues, leurs classements par objet, leurs titres et la chance des équipes) s'écrivent dans la configuration et sont vérifiés à la compilation du conteneur. Les contributions, les scores, les instantanés, les choix d'apparence des membres, ainsi que les paliers et les divisions des ligues et les premières places prises sont gardés dans Doctrine DBAL, dans neuf tables que le bundle ajoute au schéma que génère l'ORM, pour que les migrations de l'application les créent ; les scores peuvent plutôt vivre dans les ensembles triés de Valkey, connecté par Symfony Cache ou par le client de l'application. La projection qui tient les scores à jour porte l'étiquette de tilttek/activity-bundle, qui suit le journal à chaque geste, la rattrape et la reconstruit. Un instantané pris, une semaine de ligue réglée et un membre qui a atteint le sommet (premier une fois la période close, ou en tête à mesure que son score change, selon le choix du site) deviennent des événements du répartiteur de l'application, pour récompenser les premiers et féliciter ceux qui sont montés, chacun portant la façon dont le membre a choisi de paraître ; l'écran que le membre ouvre ensuite célèbre le sommet par la recette Celebration accessible du kit PHIL UX. Des fonctions et des gabarits Twig affichent un classement, un instantané, la division d'un membre ou son écran de ligue tels qu'un membre les voit, et un classement d'équipes (l'écran de ligue et les équipes sont construits des recettes d'un kit de l'UX Toolkit). Des commandes prennent les instantanés dus, règlent les semaines dues, font glisser les fenêtres et affichent un classement tel que le public le voit ; Symfony Scheduler peut exécuter les trois premières. Enfin, les scores, les lignes, le choix, les paliers, les divisions et les premières places d'un membre sont exportés et effacés avec son compte par phil/privacy-bundle.

Il s'adresse à une application Symfony qui classe ses membres selon ce qu'ils font et qui ne doit pas exposer ceux qui n'ont pas choisi d'être montrés. La bibliothèque seule convient à une application sans Symfony.

Il exige tilttek/leaderboards, Doctrine DBAL, le répartiteur d'événements PSR, et la configuration et le conteneur de Symfony. L'ORM, la console, Twig, les composants Twig, le traducteur, Symfony Scheduler, Symfony Cache et phil/privacy-bundle sont facultatifs, et le bundle n'enregistre ce qui s'en sert que s'ils sont installés.

La conception suit celle de la bibliothèque : les stockages implémentent ses quatre contrats, LeaderboardsServices assemble les services, DispatchingObserver change un instantané et un règlement en événements SnapshotTaken, LeagueSettled et TopReached, LeadWatch surveille les scores gardés pour la première place quand le site célèbre à un changement de score, LeaderboardsExtension est le côté Twig et LeaderboardsSchedule le côté planifié.

État

PartieÉtat
Configuration des classements, des fuseaux horaires et des stockages, vérifiée à la compilationImplémentée et testée
Critères de départage, fenêtres glissantes, classements par objet, titres et chance des équipes dans la configurationImplémentés et testés
Les scores dans Valkey par la connexion de Symfony Cache ou par le client de l'applicationImplémentés et testés
DbalScoreStore, DbalSnapshotStore, DbalAppearanceStore, DbalLeagueStore, DbalLeadStore et les neuf tables, avec l'écouteur du schéma, sur SQLite, MySQL et PostgreSQLImplémentés et testés
La projection étiquetée pour tilttek/activity-bundleImplémentée et testée
Les ligues hebdomadaires des classements qui en déclarent uneImplémentées et testées
Les événements SnapshotTaken, LeagueSettled et TopReachedImplémentés et testés
La célébration du sommet, sur la recette Celebration du kit, à la clôture de la période ou à un changement de scoreImplémentée et testée
Fonctions Twig et gabarits de classement et de division, en anglais et en françaisImplémentés et testés
L'écran de ligue et le classement d'équipes, construits des recettes Card, Badge et Empty du kitImplémentés et testés
Commandes tilttek:leaderboards:snapshot, tilttek:leaderboards:settle, tilttek:leaderboards:slide et tilttek:leaderboards:showImplémentées et testées
Le calendrier tilttek_leaderboards sur Symfony SchedulerImplémenté et testé
Exportation et effacement d'un membre pour phil/privacy-bundleImplémentés et testés

Documentation

DocumentCe qu'il couvre
InstallationPrérequis, installation, les tables, la projection et les instantanés planifiés.
ConfigurationChaque option, avec un exemple.
Base de donnéesLes neuf tables, leurs clés, l'insertion écrite une seule fois et les scores dans Valkey.
ÉvénementsLes événements que transmettent un instantané, une semaine réglée et un sommet atteint, et comment récompenser les premiers.
GabaritsLes fonctions Twig, les gabarits de classement, de division, de ligue, d'équipes et de célébration, les recettes du kit, les noms des membres nommés et les traductions.
CommandesPrendre les instantanés dus, régler les semaines dues, faire glisser les fenêtres et afficher un classement.
PlanificationLes instantanés, les règlements et les fenêtres dus exécutés par Symfony Scheduler ou par un cron.
Vie privéeCe que contient l'exportation d'un membre et ce que retire son effacement.
Points d'extensionRemplacer un stockage, le client Valkey, les classements, l'observateur, les écrans.
ExceptionsCe que le bundle lève.
TestsLes tests du bundle, et tester une application qui s'en sert.
RéférenceChaque classe et chaque service du bundle.

Démarrage rapide

// config/bundles.php
Tilttek\ActivityBundle\TilttekActivityBundle::class => ['all' => true],
Tilttek\LeaderboardsBundle\TilttekLeaderboardsBundle::class => ['all' => true],
# config/packages/tilttek_leaderboards.yaml
tilttek_leaderboards:
    timezone: America/Toronto
    boards:
        games-month: { measure: count, verbs: ['game.played'], period: month }
        level: { measure: latest }
        weekly-xp: { measure: total, verbs: ['lesson.done'], period: week, league: { tiers: [bronze, silver, gold] } }
    schedule: true
{{ include('@TilttekLeaderboards/standing.html.twig', {standing: tilttek_leaderboards_standing('games-month', 'member:44'), names: names}) }}

Prérequis

PHP 8.5 ou plus récent, Symfony 8.2, Doctrine DBAL 4.5.

Contribuer

Les contributions sont les bienvenues sur le monodépôt de PHIL : lisez le guide de contribution et le code de conduite. Signalez une vulnérabilité en privé, comme l'explique la politique de sécurité, jamais dans un ticket public.

Licence

MIT, © Philippe Gamache, doing business as Le Gnome Archiviste; a Tilttek project. Voir LICENSE.