PHP Contracts

A curated list of mature interfaces to build components on.

Join us in the Gitter chat room:

Good interfaces behave like a contract, a promise, a documentation. They don't have an opinion about the internals of a concrete implementation. So you can use interfaces while building huge applications to decouple different parts and hopefully gain a much better level of reusability, interchangeability and maintainability.

Rules:

1. A project must only consist of interfaces that have the character of a contract.
2. The project must ship a good documentation.
3. The project could include one or more implementations.
4. The project's documentation must use english language.
5. The interface(s) must comply with PSR-1.
6. The interface(s) should comply with PSR-2.
7. There should exist implementations that show the practical benefit of the offered interface(s).
8. The project should be available through Packagist.

Stable

(Click on an item to get a list of available implementations)

Project	Packagist	Implementations
psr/log		Compatible Packages
psr/cache		Compatible Packages
psr/container		Compatible Packages
psr/http-message		Compatible Packages
psr/http-server-handler		Compatible Packages
psr/link		Compatible Packages
psr/simple-cache		Compatible Packages
container-interop/container-interop		Compatible Packages
flamecore/event-observer		Compatible Packages

Drafts

Project	Packagist	Status
adammbalogh/key-value-store		Draft
rkr/php-ioc-contract		Draft

Noteworthy projects

• illuminate/contracts – Subtree split of the Illuminate Contracts component (see laravel/framework)
• HttpKernelInterface – HttpKernelInterface handles a Request to convert it to a Response.
• FlySystem – Flysystem is a filesystem abstraction which allows you to easily swap out a local filesystem for a remote one. Reducing technical debt and chance of vendor lock-in.

Wishlist

• 3rd Party APIs (Amazon, Google etc)
• Authentication
• Communication (Email, Sms, Notifications etc.)
• (More) Date-, Time-, Interval-, Calendar-Manipulation
• (More) Dependency-Injection-Container interfaces with more methods (make, call etc.)
• E-Commerce (Payment, common order structures, common address structures etc.)
• File-System-Abstraction
• Filetype-Abstraction
• Filtering
• HTTP-Routing (Lookup and Link-Generation)
• Image-Manipulation
• Key-Value-Stores
• ORM / Data-Handling / Data-Structures
• Queues (like RabbitMQ / Gearman)
• Search-Server-Interfaces (querying, Responses, Facettes etc)
• Template-Engines
• URL-Manipulation
• Validation