Contracts

• Introduction
  • Contracts Vs. Facades
• When To Use Contracts
• How To Use Contracts
• Contract Reference

Introduction

Laravel's "contracts" are a set of interfaces that define the core services provided by the framework. For example, an Illuminate\Contracts\Queue\Queue contract defines the methods needed for queueing jobs, while the Illuminate\Contracts\Mail\Mailer contract defines the methods needed for sending e-mail.

Each contract has a corresponding implementation provided by the framework. For example, Laravel provides a queue implementation with a variety of drivers, and a mailer implementation that is powered by Symfony Mailer.

All of the Laravel contracts live in their own GitHub repository. This provides a quick reference point for all available contracts, as well as a single, decoupled package that may be utilized when building packages that interact with Laravel services.

Contracts Vs. Facades

Laravel's facades and helper functions provide a simple way of utilizing Laravel's services without needing to type-hint and resolve contracts out of the service container. In most cases, each facade has an equivalent contract.

Unlike facades, which do not require you to require them in your class' constructor, contracts allow you to define explicit dependencies for your classes. Some developers prefer to explicitly define their dependencies in this way and therefore prefer to use contracts, while other developers enjoy the convenience of facades. In general, most applications can use facades without issue during development.

When To Use Contracts

The decision to use contracts or facades will come down to personal taste and the tastes of your development team. Both contracts and facades can be used to create robust, well-tested Laravel applications. Contracts and facades are not mutually exclusive. Some parts of your applications may use facades while others depend on contracts. As long as you are keeping your class' responsibilities focused, you will notice very few practical differences between using contracts and facades.

In general, most applications can use facades without issue during development. If you are building a package that integrates with multiple PHP frameworks you may wish to use the illuminate/contracts package to define your integration with Laravel's services without the need to require Laravel's concrete implementations in your package's composer.json file.

How To Use Contracts

So, how do you get an implementation of a contract? It's actually quite simple.

Many types of classes in Laravel are resolved through the service container, including controllers, event listeners, middleware, queued jobs, and even route closures. So, to get an implementation of a contract, you can just "type-hint" the interface in the constructor of the class being resolved.

For example, take a look at this event listener:

 1<?php
 2 
 3namespace App\Listeners;
 4 
 5use App\Events\OrderWasPlaced;
 6use App\Models\User;
 7use Illuminate\Contracts\Redis\Factory;
 8 
 9class CacheOrderInformation
10{
11    /**
12     * The Redis factory implementation.
13     *
14     * @var \Illuminate\Contracts\Redis\Factory
15     */
16    protected $redis;
17 
18    /**
19     * Create a new event handler instance.
20     *
21     * @param  \Illuminate\Contracts\Redis\Factory  $redis
22     * @return void
23     */
24    public function __construct(Factory $redis)
25    {
26        $this->redis = $redis;
27    }
28 
29    /**
30     * Handle the event.
31     *
32     * @param  \App\Events\OrderWasPlaced  $event
33     * @return void
34     */
35    public function handle(OrderWasPlaced $event)
36    {
37        //
38    }
39}
 1<?php
 2 
 3namespace App\Listeners;
 4 
 5use App\Events\OrderWasPlaced;
 6use App\Models\User;
 7use Illuminate\Contracts\Redis\Factory;
 8 
 9class CacheOrderInformation
10{
11    /**
12     * The Redis factory implementation.
13     *
14     * @var \Illuminate\Contracts\Redis\Factory
15     */
16    protected $redis;
17 
18    /**
19     * Create a new event handler instance.
20     *
21     * @param  \Illuminate\Contracts\Redis\Factory  $redis
22     * @return void
23     */
24    public function __construct(Factory $redis)
25    {
26        $this->redis = $redis;
27    }
28 
29    /**
30     * Handle the event.
31     *
32     * @param  \App\Events\OrderWasPlaced  $event
33     * @return void
34     */
35    public function handle(OrderWasPlaced $event)
36    {
37        //
38    }
39}

When the event listener is resolved, the service container will read the type-hints on the constructor of the class, and inject the appropriate value. To learn more about registering things in the service container, check out its documentation.

Contract Reference

This table provides a quick reference to all of the Laravel contracts and their equivalent facades: