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
Nicolas Grekas 581b439931 Merge branch '4.4' into 5.0
* 4.4: (26 commits)
  [HttpClient] NativeHttpClient should not send >1.1 protocol version
  [HttpClient] fix support for non-blocking resource streams
  [Mailer] Make sure you can pass custom headers to Mailgun
  [Mailer] Remove line breaks in email attachment content
  Update links to documentation
  [Validator] Add the missing translations for the Arabic (ar) locale
  ensure to expect no validation for the right reasons
  [Security-Guard] fixed 35203 missing name tag in param docblock
  [HttpClient] fix casting responses to PHP streams
  [PhpUnitBridge] Add test case for @expectedDeprecation annotation
  [PhpUnitBridge][SymfonyTestsListenerTrait] Remove $testsWithWarnings stack
  [Mailer] Fix addresses management in Sendgrid API payload
  [Mailer][MailchimpBridge] Fix missing attachments when sending via Mandrill API
  [Mailer][MailchimpBridge] Fix incorrect sender address when sender has name
  [HttpClient] fix capturing SSL certificates with NativeHttpClient
  Update year in license files
  [TwigBridge][Form] Added missing help messages in form themes
  Update year in license files
  Update year in license files
  fix version when "anonymous: lazy" was introduced
  ...
2020-01-04 15:08:26 +01:00
..
Cache Merge branch '4.4' into 5.0 2020-01-04 15:08:26 +01:00
EventDispatcher Merge branch '4.4' into 5.0 2020-01-04 15:08:26 +01:00
HttpClient Merge branch '4.4' into 5.0 2020-01-04 15:08:26 +01:00
Service Merge branch '4.4' into 5.0 2020-01-04 15:08:26 +01:00
Tests Add return types to tests and final|internal|private methods 2019-08-21 17:14:41 +02:00
Translation Merge branch '4.4' into 5.0 2020-01-04 15:08:26 +01:00
.gitignore renamed Contract to Contracts 2018-07-13 19:06:58 +02:00
CHANGELOG.md [Contracts][EventDispatcher] move the Event class to symfony/contracts 2019-03-29 19:47:03 +01:00
composer.json Allow PHP ^7.2.5 2019-11-18 18:27:11 +01:00
LICENSE Update year in license files 2020-01-01 12:51:43 +01:00
phpunit.xml.dist fix tests 2019-05-28 11:19:25 +02:00
README.md [Contracts] split in one package per sub-contracts 2019-05-22 14:23:29 +02:00

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