phil/doctrine-behaviours

phil/doctrine-behaviours donne douze comportements aux entités de Doctrine ORM. L'horodatage note quand une entité est créée et modifiée, en UTC. L'auteur garde qui l'a créée et qui l'a changée en dernier, comme identifiant d'utilisateur. La suppression douce cache une entité supprimée derrière un filtre au lieu de l'effacer, et la supprimer une seconde fois l'efface. Les arbres gardent le chemin matérialisé et la profondeur de chaque nœud, et le lecteur Tree donne les racines, les enfants, les descendants, les ancêtres et la hiérarchie. La désactivation éteint un enregistrement et le rallume derrière un filtre qui lui est propre. Un propriétaire est un identifiant stable, jamais une adresse courriel. La publication est un état de symfony/workflow avec ses dates. Une position ordonne les enregistrements dans un groupe, et un enregistrement se déplace avant ou après un autre. Un slug fait par phil/slug reste unique dans sa table, ou dans une portée comme un locataire, une locale ou un parent. Les traductions gardent le texte d'un enregistrement dans une ligne par locale, lue le long d'une chaîne de repli déclarée et jamais recopiée d'une locale à l'autre. Les versions figent ce que tenait un enregistrement, créent la version suivante à la modification d'après, et reviennent en arrière sous un droit qui leur est propre. Un identifiant daté est un UUID v7.

Elle s'adresse à toute application sur Doctrine ORM qui a besoin de ces colonnes sans écrire ses propres écouteurs. Chaque comportement est indépendant : une application n'enregistre que les écouteurs qu'utilisent ses entités. Les arbres sont des chemins matérialisés : déplacer une branche est une seule mise à jour au lieu d'une renumérotation de l'arbre. Dans une application Symfony, phil/doctrine-behaviours-bundle enregistre les écouteurs, le filtre et l'auteur qu'est l'utilisateur authentifié. Un enregistrement qui doit quitter sa table, prêt à être ramené, va plutôt dans phil/trash-bundle.

C'est une librairie PHP simple sur Doctrine ORM, DBAL, psr/clock et phil/locale-dimensions ; phil/slug, symfony/uid et symfony/workflow ne servent qu'aux comportements qui les nomment. Chaque comportement est une interface, un trait qui mappe ses colonnes, et un écouteur qui les tient. Qui agit vient d'un BlameResolver que fournit l'application, comme FixedBlame pour une commande qui agit pour un compte connu, ou pour un test.

État

Documentation

Démarrage rapide

#[ORM\Entity]
class Category implements Timestampable, Blameable, SoftDeletable, TreeNode
{
    use TimestampableEntity;
    use BlameableEntity;
    use SoftDeletableEntity;
    use TreeNodeEntity;

    #[ORM\ManyToOne(targetEntity: self::class)]
    private ?self $parent = null;

    public function treeId(): string { return (string) $this->id; }
    public function treeParent(): ?self { return $this->parent; }
}

$tree->hierarchy(Category::class);    // list<Branch>, each node with its children
$tree->ancestors($category);          // the root down to the parent

Dans une application Symfony, phil/doctrine-behaviours-bundle enregistre les écouteurs et le filtre.

Prérequis

PHP 8.5 ou une version plus récente, Doctrine ORM 3.7 ou plus récent, DBAL 4.5, doctrine/collections, psr/clock et phil/locale-dimensions ; phil/slug pour les slugs, symfony/uid pour les identifiants datés, et symfony/workflow pour la publication.

Contribuer

Les contributions sont les bienvenues sur le monodépôt 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 Parler Haut Interagir Librement project. Voyez LICENSE.