[EC-CUBE4] 既存のPurchaseFlowを維持したままProcessorを追加する

README.md

プラグインやカスタマイズで、PurchaseFlowに処理を追加したい。

だけど本体側のファイルを編集することや、他者によるカスタマイズを上書きすることは避けたい。

こんなときはSymfonyのサービスコンテナのDecorateという機能を使う。

Decorateとは

これ読んで下さい。

https://symfony.com/doc/3.4/service_container/service_decoration.html

ひと工夫

ちょっと待って！ Doctrine\Common\Collections\ArrayCollectionのコンストラクタはarrayしか受け取れないんだけど！

そんなときはラッパークラスを用意してあげて、arrayでもDoctrine\Common\Collections\ArrayCollectionでも受け取れるようにしてあげましょう。

アノテーションじゃダメなの？

ｱｯﾊｲ、それでいいです。

• @CartFlow
• @ShoppingFlow
• @OrderFlow

こんな機能があったんですねドキュメントにも書いてない機能だしこの記事を作ったあとで存在に気付きました。

単純に末尾に追加するんじゃないケース、例えば先頭に追加するとか特定のクラスインスタンスの前後に挿入するとかってときは、本稿の方法を採用したらいいんじゃないでしょうか。

DecorativeArrayCollection.php

<?php

namespace Customize\Common\Collections;

use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\Common\Collections\Collection;

class DecorativeArrayCollection extends ArrayCollection
{
    public function __construct($elements = [])
    {
        $elements = ($elements instanceof Collection)
            ? $elements->toArray()
            : $elements;

        parent::__construct($elements);
    }
}

MyValidator.php

<?php

namespace Customize\Service\PurchaseFlow\Processor;

use Eccube\Entity\ItemInterface;
use Eccube\Service\PurchaseFlow\ItemValidator;
use Eccube\Service\PurchaseFlow\PurchaseContext;

class MyValidator extends ItemValidator
{
    protected function validate(ItemInterface $item, PurchaseContext $context)
    {
        // TODO
    }
}

purchaseflow_customize.yaml

services:
  eccube.purchase.flow.cart.item_validators_decorate:
    class: Customize\Common\Collections\DecorativeArrayCollection
    decorates: eccube.purchase.flow.cart.item_validators
    arguments: ['@eccube.purchase.flow.cart.item_validators_decorate.inner']
    calls:
      - [add, ['@Customize\Service\PurchaseFlow\Processor\MyValidator']]