プラグインのテンプレートを上書きできるように対応

[chihiro-adachi]

概要(Overview・Refs Issue)

#4521 の対応

方針(Policy)

app/template/plugin/[Plugin Code]以下にテンプレートが配置されている場合に、プラグインのテンプレートより優先して読み込むように対応

実装に関する補足(Appendix)

以下のようなプラグインの場合、

[app/Plugin/Sample]
│ 
├── Controller
│   └── Admin
│       └── ConfigController.php
├── Resource
│   └── template
│       └── admin
│           └── config.twig

class ConfigController extends AbstractController
{
    /**
     * @Route("/%eccube_admin_route%/sample/config", name="sample_admin_config")
     * @Template("@Sample/admin/config.twig")
     */
    public function index(Request $request)

app/template/plugin/Sample/admin/config.twig に配置することで、こちらを優先して読み込まれます。

[app/template]
│
├── admin
├── default
├── plugin
│   └── Sample
│       └── admin
│           └── config.twig
└── user_data

ディレクトリの新規作成時は、キャッシュのクリアが必要です。

テスト（Test)

• ファイルを設置し、上書きされていることを確認
• E2Eテストを作成

相談（Discussion）

マイナーバージョン互換性保持のための制限事項チェックリスト

• 既存機能の仕様変更
• フックポイントの呼び出しタイミングの変更
• フックポイントのパラメータの削除・データ型の変更
• twigファイルに渡しているパラメータの削除・データ型の変更
• Serviceクラスの公開関数の、引数の削除・データ型の変更
• 入出力ファイル(CSVなど)のフォーマット変更

レビュワー確認項目

• 動作確認
• コードレビュー
• E2E/Unit テスト確認(テストの追加・変更が必要かどうか)
• 互換性が保持されているか
• セキュリティ上の問題がないか

[okazy]

クーポンプラグインでプラグインのテンプレートを上書きできるプルリクをいただいていました。
EC-CUBE/coupon-plugin#126

本プルリクとリンク先のプルリクでテンプレートの配置構造が異なっています。
既存のプラグインへの影響を含めて確認が必要かと思いました。

[okazy]

ありがとうございます。問題ないと思います。

[okazy]

ありがとうございます。マージしました。