This repository has been archived on 2023-08-20. You can view files and clone it, but cannot push or open issues or pull requests.
symfony/src/Symfony/Contracts
Fabien Potencier 40408230f0 Merge branch '5.4' into 6.0
* 5.4:
  Bump license year
  Bump license year
  [Validator] Error using CssColor with doctrine annotations
  [HttpClient] Turn negative timeout to a very long timeout
  Features goes to 6.x branch
  [Translation] [LocoProvider] Fix use of asset ids
  fix lowest required PropertyInfo component release
  [Validator] throw when Constraint::_construct() has not been called
  Bump Symfony version to 5.4.3
  Update VERSION for 5.4.2
  Update CHANGELOG for 5.4.2
  Bump Symfony version to 5.3.14
  Update VERSION for 5.3.13
  Update CHANGELOG for 5.3.13
  Bump Symfony version to 4.4.37
  Update VERSION for 4.4.36
  Update CONTRIBUTORS for 4.4.36
  Update CHANGELOG for 4.4.36
  Allow symfony/runtime plugin
2022-01-02 10:55:41 +01:00
..
Cache Merge branch '5.4' into 6.0 2022-01-02 10:55:41 +01:00
Deprecation Merge branch '5.4' into 6.0 2022-01-02 10:55:41 +01:00
EventDispatcher Merge branch '5.4' into 6.0 2022-01-02 10:55:41 +01:00
HttpClient Merge branch '5.4' into 6.0 2022-01-02 10:55:41 +01:00
Service Merge branch '5.4' into 6.0 2022-01-02 10:55:41 +01:00
Tests [DependencyInjection] remove deprecation layer 2021-11-04 13:53:12 -04:00
Translation Merge branch '5.4' into 6.0 2022-01-02 10:55:41 +01:00
.gitignore renamed Contract to Contracts 2018-07-13 19:06:58 +02:00
CHANGELOG.md [Contracts] update changelog 2021-11-22 16:19:30 +01:00
LICENSE Bump license year 2022-01-02 10:41:36 +01:00
README.md Fix CS in README files 2021-05-26 19:39:37 +02:00
composer.json [Contracts] add return types and bump to v3 2021-07-14 19:12:34 +02:00
phpunit.xml.dist Update phpunit.xml.dist files for phpunit >= 9.3 2021-06-02 18:16:25 +02:00

README.md

Symfony Contracts

A set of abstractions extracted out of the Symfony components.

Can be used to build on semantics that the Symfony components proved useful - and that already have battle tested implementations.

Design Principles

  • contracts are split by domain, each into their own sub-namespaces;
  • contracts are small and consistent sets of PHP interfaces, traits, normative docblocks and reference test suites when applicable;
  • all contracts must have a proven implementation to enter this repository;
  • they must be backward compatible with existing Symfony components.

Packages that implement specific contracts should list them in the "provide" section of their "composer.json" file, using the symfony/*-implementation convention (e.g. "provide": { "symfony/cache-implementation": "1.0" }).

FAQ

How to use this package?

The abstractions in this package are useful to achieve loose coupling and interoperability. By using the provided interfaces as type hints, you are able to reuse any implementations that match their contracts. It could be a Symfony component, or another one provided by the PHP community at large.

Depending on their semantics, some interfaces can be combined with autowiring to seamlessly inject a service in your classes.

Others might be useful as labeling interfaces, to hint about a specific behavior that could be enabled when using autoconfiguration or manual service tagging (or any other means provided by your framework.)

How is this different from PHP-FIG's PSRs?

When applicable, the provided contracts are built on top of PHP-FIG's PSRs. But the group has different goals and different processes. Here, we're focusing on providing abstractions that are useful on their own while still compatible with implementations provided by Symfony. Although not the main target, we hope that the declared contracts will directly or indirectly contribute to the PHP-FIG.

Resources