【PHP】PSR-11 Container Interface（コンテナインタフェース）

仕様

基本仕様を以下に示します。

class BadExample
{
    public function __construct(ContainerInterface $container)
    {
        $this->db = $container->get('db');
    }
}

class GoodExample
{
    public function __construct($db)
    {
        $this->db = $db;
    }
}

パッケージ

説明されているインタフェースとクラス、および関連する例外は、psr/containerパッケージの一部として提供されています。

PSRコンテナ実装を提供するパッケージは、psr/container-implementation 1.0.0を提供することを宣言する必要があります。

実装が必要なプロジェクトでは、psr/container-implementation 1.0.0が必要です。

インターフェイス

Psr\Container\ContainerInterface

<?php
namespace Psr\Container;

/**
 * エントリを読み取るメソッドを公開するコンテナのインターフェイス
 */
interface ContainerInterface
{
    /**
     * 識別子によるコンテナのエントリを見つけて返す
     *
     * @param string $id 検索するエントリの識別子
     * @throws NotFoundExceptionInterface （この識別子のエントリは見つかりませんでした）
     * @throws ContainerExceptionInterface （エントリの取得中にエラーが発生しました）
     *
     * @return mixed Entry.
     */
    public function get($id);

    /**
     * コンテナが指定された識別子のエントリを返すことができる場合はtrueを返す
     * そうでない場合はfalseを返す
     *
     * has($id)がtrueを返せばget($id)では例外をスローしないという事ではないが、
     * NotFoundExceptionInterfaceは投げない。
     *
     * @param string $id 検索するエントリの識別子
     *
     * @return bool
     */
    public function has($id);
}

Psr\Container\ContainerExceptionInterface

<?php
namespace Psr\Container;

/**
 * コンテナ内の汎用例外を表す基本インタフェース
 */
interface ContainerExceptionInterface
{
}

Psr\Container\NotFoundExceptionInterface

<?php
namespace Psr\Container;

/**
 * コンテナにエントリが見つからない場合の例外インターフェイス
 */
interface NotFoundExceptionInterface extends ContainerExceptionInterface
{
}