contracts

Contrats Symfony

Un ensemble d'abstractions extraites des composants Symfony.

Peut être utilisé pour s'appuyer sur une sémantique que les composants Symfony se sont révélés utiles - et qui ont déjà des implémentations testées au combat.

Principes de conception

• les contrats sont divisés par domaine, chacun dans ses propres sous-espaces de noms ;
• les contrats sont des ensembles petits et cohérents d'interfaces PHP, de traits, de docblocks normatifs et de suites de tests de référence, le cas échéant ;
• tous les contrats doivent avoir une mise en œuvre éprouvée pour entrer dans ce référentiel ;
• ils doivent être rétrocompatibles avec les composants Symfony existants.

Les packages qui implémentent des contrats spécifiques doivent les lister dans la section "provide" de leur fichier "composer.json", en utilisant la convention symfony/*-implementation (par exemple "provide": { "symfony/cache-implementation": "1.0" } ).

FAQ

Comment utiliser ce forfait ?

Les abstractions de ce package sont utiles pour obtenir un couplage lâche et une interopérabilité. En utilisant les interfaces fournies comme indications de type, vous pouvez réutiliser toutes les implémentations qui correspondent à leurs contrats. Il peut s'agir d'un composant Symfony, ou d'un autre fourni par la communauté PHP dans son ensemble.

En fonction de leur sémantique, certaines interfaces peuvent être combinées avec l'autowiring pour injecter un service de manière transparente dans vos classes.

D'autres peuvent être utiles en tant qu'interfaces d'étiquetage, pour faire allusion à un comportement spécifique qui pourrait être activé lors de l'utilisation de la configuration automatique ou du marquage manuel des services (ou de tout autre moyen fourni par votre infrastructure.)

En quoi est-ce différent des PSR de PHP-FIG ?

Le cas échéant, les contrats fournis sont construits sur les PSR de PHP-FIG. Mais le groupe a des objectifs et des processus différents. Ici, nous nous concentrons sur la fourniture d'abstractions utiles en elles-mêmes tout en restant compatibles avec les implémentations fournies par Symfony. Bien que ce ne soit pas l'objectif principal, nous espérons que les contrats déclarés contribueront directement ou indirectement au PHP-FIG.

Ressources

• Documentation
• Contribuer
• Signaler les problèmes et envoyer des Pull Requests dans le référentiel Symfony principal