Laravelのバッチのコンストラクタでinterfaceのインジェクションを行いたい

Question

前提・実現したいこと

複数種類のxmlファイルを読み込み、それぞれに対応したテーブルに格納するバッチをLaravelで実装しています。

各xmlの構成はバラバラですが、基本的な処理の流れは以下の通りです。
1.xmlを読み込む
↓
2.解析と整形
↓
3.テーブルにinsert
そのため１つのinterfaceファイルに対して、それをimplementsした各xmlファイル用の実装ファイルを用意し
Commandをextendsした各xmlファイル用のバッチのコンストラクタでinterfaceを引数に取ってインジェクションしたいと考えていますが、以下のエラーが発生するため実現できておりません。
小規模なプロジェクトですのでinterfaceではなく抽象クラスをextendsし、コンストラクタではこのクラスをインジェクションするという実装でも要件は満たせるのですが、せっかくなのでLaravelでよく見る実装で実現できればと思い質問させていただきました。

発生している問題・エラーメッセージ

Illuminate\Contracts\Container\BindingResolutionException  : Target [App\Repositories\xxxx\Interfaceのクラス名] is not instantiable while building [App\Console\Commands\xxxx\バッチのクラス名].

該当のソースコード

// interface
namespace App\Repositories\xxxx;
interface InterfaceA
{
 public function aaa();
}

// interfaceの実装
namespace App\Repositories\xxxx;
class ImplementsA implements InterfaceA
{
 public function aaa(){}
}

// バッチ
namespace App\Console\Commands\xxxx;
class BatchA extends Command
{
 private $obj;
 public function __construct(InterfaceA $param)
 {
  $this->obj = $param;
 }
 public function handle()
  {
   $this->obj->aaa();
  }
}

Answer 1

インターフェイスをタイプヒントに指定した時にどの実装クラスのインスタンスを生成するかについて、紐付けを記述する必要があります。
上記のサンプルコードで言うと、「InterfaceAクラスがタイプヒントに指定された際にはImplementsAクラスのインスタンスを生成する」と指定してあげる必要があるということになります。

どこにその紐付けの記述をするかというと、
詳しくはLaravelドキュメントに記載があるのでそちらを参考にしていただければと思いますが、ServiceProviderクラスを作成して定義 or すでに用意されているAppServiceProviderクラス内に定義します。

具体的には、

app/Providers/AppServiceProvider.php

...（中略）

    public function register()
    {
        $this->app->bind(
            (インターフェイス),
            (実装クラス)
        );
    }
...（中略）

のように紐付け（ドキュメントや書籍では「バインド」、「結合」など呼ばれています）を記述すると、今回の目的であるコンストラクタインジェクションができるようになります。

これはLaravelのサービスコンテナという機能を用いたもので、
詳しくはドキュメントや、『PHPフレームワーク Laravel Webアプリケーション開発』という書籍にも解説が記載されていますので、ぜひご参照ください。

web検索でも「Laravel サービスコンテナ」と調べると、色々出てくると思います。

Comments

[eito_t]

ありがとうございます。
解決しました。