サービスプロバイダーをオーバーライドしてみる

concrete5は自由にカスタマイズが可能なCMSです。しかしながら、コア(CMSを構成する基本ファイル一式)に直接変更を加えてはいけません。コアを変更してしまうと、セキュリティの脆弱性が残ってしまったり、メンテナンス作業を複雑化させてしまいます。
コアを変更するしか実現できない機能の場合、パッチを当てることも可能ですが、基本的には/applicationでコアのオーバーライドを行ないます。
オーバーライドの方法はいくつか存在しますが、今回は、サービスプロバイダーのオーバーライドについて紹介していきたいと思います。
 
 

サービスプロバイダーはどこで登録されている?

concrete5には、メール送信やキャッシュ、フォームなど様々な「サービス」が登録されています。各サービスプロバイダーのファイルは、/concrete/src に存在し、それらサービスプロバイダーの登録は/concrete/config/app.phpで行われています。

 
Screen Shot 2021-01-22 at 15.27.19.png
 
 

サービスプロバイダーをオーバーライド

 
例として、フォームサービスをオーバーライドする方法を紹介します。
 
まず、/application/config/app.phpにオーバーライドしたいサービスプロバイダーファイルを記載します。
 
'providers' => [
    'core_form' => '\Concrete\Core\Form\FormServiceProvider',
  ],
次に、app.phpで定義したapplicationディレクトリにサービスプロバイダーファイルをセットします
 
<?php

namespace Concrete\Core\Form;

use Concrete\Core\Application\Application;
use Concrete\Core\Form\Context\Registry\ControlRegistry;
use Concrete\Core\Form\Service\DestinationPicker;
use Concrete\Core\Foundation\Service\Provider as ServiceProvider;

class FormServiceProvider extends ServiceProvider
{
    public function register()
    {
        $singletons = [
            'helper/form' => '\Concrete\Core\Form\Service\Form',
            'helper/form/attribute' => '\Concrete\Core\Form\Service\Widget\Attribute',
            'helper/form/color' => '\Concrete\Core\Form\Service\Widget\Color',
            'helper/form/font' => '\Concrete\Core\Form\Service\Widget\Typography',
            'helper/form/typography' => '\Concrete\Core\Form\Service\Widget\Typography',
            'helper/form/date_time' => '\Concrete\Core\Form\Service\Widget\DateTime',
            'helper/form/page_selector' => '\Concrete\Core\Form\Service\Widget\PageSelector',
            'helper/form/rating' => '\Concrete\Core\Form\Service\Widget\Rating',
            'helper/form/user_selector' => '\Concrete\Core\Form\Service\Widget\UserSelector',
            'form/express/entry_selector' => '\Concrete\Core\Form\Service\Widget\ExpressEntrySelector',
        ];

        foreach ($singletons as $key => $value) {
            $this->app->singleton($key, $value);
        }

        $this->app->singleton(ControlRegistry::class);

        $this->app->bind(DestinationPicker\DestinationPicker::class, function (Application $app) {
            return $app->build(DestinationPicker\DestinationPicker::class)
                ->registerPickers([
                    'none' => $app->make(DestinationPicker\NoDestinationPicker::class),
                    'page' => $app->make(DestinationPicker\PagePicker::class),
                    'file' => $app->make(DestinationPicker\FilePicker::class),
                    'external_url' => $app->make(DestinationPicker\ExternalUrlPicker::class),
                    'email' => $app->make(DestinationPicker\EmailPicker::class),
                ])
            ;
        });
    }
}
以上の設定でオーバーライド完了です。
これでコアファイルを変更することなくサービスプロバイダーを自由にカスタマイズできるようになります。
 
 

サービスプロバイダーで登録されている一部機能をオーバーライド

上記の方法では、サービスプロバイダーをマルっと一式オーバーライドしていますが、サービスプロバイダーで登録されている一部の機能だけオーバーライドすることも可能です。小規模なカスタマイズであればこちらの方法が便利です。
 
先ほどと同じようにフォームサービスを例に手順を説明していきます。
 
例)Formクラスだけオーバーライドする
 
まず、/application/bootstrap/app.phpにオーバーライドしたいクラスとオーバーライドするクラスを記載します。
このようにバインドさせてあげることで、コアで登録されているサービスプロバイダの一部クラスだけをカスタマイズすることができます。
 
$app->bind('helper/form', \Application\Concrete\Form\Form::class);
バインドしたら、app.phpで定義したディレクトリにファイルを追加し、Formクラスをセットしてあげれば完了です。
 
<?php

  namespace Application\Concrete\Form;

  class Form
  {
    // write code
  }
こちらのページにもコアのオーバーライドについて詳しく記載されているので読んでみてください。

コメント欄を読み込み中