Aller au contenu

Points d'extension

tilttek/friend-challenges

Le paquet est en 0.x : ses points d'extension sont stables seulement à partir de sa version 1.0. D'ici là, une version mineure peut les changer, et son CHANGELOG dit comment.

PointCe que donne une applicationFourni
Contract\ChallengeStoreOù les défis sont conservés : une table d'enregistrements, un magasin de documentsStore\InMemoryChallengeStore
Contract\PrizeEscrowOù les lots sont détenus : voir SéquestreEscrow\PointsPrizeEscrow, Escrow\InMemoryPrizeEscrow
Contract\FriendshipQui est l'ami de qui, d'après le graphe social du siteStore\InMemoryFriendship
Contract\ModerationOù vont les signalements, et qui modère : voir ModérationStore\InMemoryModeration
ChallengeRulesLa durée d'un défi, son examen, son plus gros lotses valeurs par défaut
Psr\EventDispatcher\EventDispatcherInterfaceOù vont les événementsaucun : rien n'est réparti
Psr\Clock\ClockInterfaceL'heure de chaque mouvementSymfony\Component\Clock\NativeClock

Chaque point est passé au constructeur de FriendChallenges, qui ne conserve rien entre deux appels.

Écrire un magasin

Un ChallengeStore conserve un enregistrement par défi, Challenge::toArray(), et le rend par Challenge::fromArray(). Ce que fait chaque implémentation :

  • get($id) rend le défi, ou null.
  • add($challenge) conserve un nouveau défi, et lance ChallengeConflict quand un défi du même identifiant est déjà conservé.
  • update($challenge, $expected) conserve le défi à sa version suivante si et seulement si celui qui est conservé est encore à la version $expected, sinon lance ChallengeConflict et n'écrit rien. Dans une base de données, un UPDATE … WHERE id = ? AND version = ? qui compte les lignes qu'il a changées donne exactement cela.
  • due($at, $limit) liste les identifiants des défis ouverts dont review_ends_at est à $at ou avant, les plus anciens d'abord, $limit au plus ; un index sur l'état et review_ends_at y répond.
  • involving($member, $limit) liste les identifiants des défis qui nomment le membre — voir Challenge::involves() : le créateur, les invités et les participants —, $limit au plus, pour son effacement. Une table des membres de chaque défi, écrite avec l'enregistrement, y répond.

Conservez les heures de l'enregistrement comme les textes UTC qu'il contient, ou dans des colonnes UTC. Quand les défis et le séquestre vivent dans la même base de données, conservez la création d'un défi et sa détention dans une seule transaction.

Les événements

Chaque événement est réparti une fois son mouvement conservé et réglé, jamais pour un mouvement refait :

ÉvénementQuandPorte
Event\ChallengeCreatedUn défi est créé et son lot détenuLe défi, son créateur
Event\MemberInvitedUne fois pour chaque ami invité, à la créationLe défi, le membre
Event\ParticipantJoinedUn membre participeLe défi, le membre
Event\ProofSubmittedUn participant envoie une preuveLe défi, la preuve, le participant
Event\ProofDecidedUne preuve est acceptée, rejetée ou retiréeLe défi, la preuve, son état
Event\ChallengeWonUne preuve est acceptée et le lot payéLe défi, le gagnant, la preuve, le lot, son unité
Event\ChallengeEndedUn défi est annulé, expire ou est retiré, et son lot renduLe défi, son état
Event\ChallengeFrozenUn modérateur gèle un défiLe défi
Event\ChallengeUnfrozenUn modérateur dégèle un défiLe défi

Les événements ne portent que des identifiants. Un écouteur qui avise un membre, pousse la page par Mercure ou envoie un message de Messenger envoie ces identifiants, et lit le reste dans le magasin.