【EC-CUBE 4】10分でできる！独自プラグイン作成

php bin/console eccube:plugin:generate

2：プラグイン名を決める

以下のようにプラグイン名を聞かれるので、今回は「LoveYouSukohi」として（笑）、エンターキーを押します。

3：Code名を決める

これはプラグインの名前というよりは、他とかぶらないコードです。ここも「LoveYouSukohi」にして進めます。

4：バージョンを決める

バージョンはそのまま1.0.0でいいでしょう。

そのままエンターキーを押します。

すると、app/Plugin/LoveYouSukohiというフォルダを用意してくれます。

これで本体ができました！

5：有効化する

早速インストールして有効化してみましょう。

php bin/console cache:clear --no-warmup

php bin/console eccube:plugin:install --code=LoveYouSukohi

php bin/console eccube:plugin:enable --code=LoveYouSukohi

コントローラーをチェックしてURLを確認しましょう。
今回はこうなっていました。

app/Plugin/LoveYouSukohi/Controller/Admin/ConfigController.php

/**
 * @Route("/%eccube_admin_route%/love_you_sukohi/config", name="love_you_sukohi_admin_config")
 * @Template("@LoveYouSukohi/admin/config.twig")
 */

以下のURLへアクセスしてみます。

https://rabbit0_shop.test/admin/love_you_sukohi/config

こうなりました。

【EC-CUBE】プラグイン開発の基礎。管理者ページの作成は3ステップ

コンフィグページは自動で作成されるものの、他にもほしい機能がある場合は自分で作成しないといけません。

ここでは、ゼロから独自のページをつくっていく手順を紹介します。
今回は個人的に「学んできたスキル」を表示してみます。

1：コントローラーをつくる

コントローラーには以下の内容を設定します。

• どのURLを有効にするか
• テンプレートはどこに設置するか
• パラメータは何が必要なのか

app/Plugin/LoveYouSukohi/Controller/Admin/IntroductionController.php

<?php

namespace Plugin\LoveYouSukohi\Controller\Admin;

use Eccube\Controller\AbstractController;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Template;
use Symfony\Component\Routing\Annotation\Route;

class IntroductionController extends AbstractController
{
    // ↓↓↓ ここにルートやテンプレート場所を記述します

    /**
     * @Route("/%eccube_admin_route%/love_you_sukohi/introduction", name="love_you_sukohi_admin_introduction_index")
     * @Template("@LoveYouSukohi/admin/introduction/index.twig")
     */
    public function index()
    {
        $skill_names = [
            'プログラミング',
            '英語',
            'マーケティング',
            'SNS運用',
            'ラインティング',
        ];

        // テンプレートに渡すパラメータ
        return [
            'skill_names' => $skill_names,
        ];
    }
}

2：テンプレートをつくる

さっきコントローラーにセットしたテンプレートをつくっていきます。
EC-CUBEでは、テンプレートに「twig」が使われています。

<?php

namespace Plugin\LoveYouSukohi;

use Eccube\Common\EccubeNav;

class Nav implements EccubeNav
{
    /**
     * @return array
     */
    public static function getNav()
    {
        return [
            'love_you_sukohi' => [
                'name' => 'Love You Sukohi',
                'icon' => 'fa-heart',
                'children' => [
                    'admin_introduction' => [
                        'name' => '自己紹介',
                        'url' => 'love_you_sukohi_admin_introduction_index',
                    ],
                ],
            ],
        ];
    }
}

php bin/console cache:clear --no-warmup

これでOKです。
ページをリロードしてみてください。

php bin/console eccube:plugin:install --code=LoveYouSukohi

php bin/console eccube:plugin:enable --code=LoveYouSukohi

では、今回は手動で

• プログラミング
• 英語
• マーケティング
• SNS運用
• ラインティング

をテーブルに登録します。（違いがわかるようにfrom DBを入れてます）

さっきのコントローラーを変更してDBからスキル名を取得してみましょう。

app/Plugin/LoveYouSukohi/Controller/Admin/IntroductionController.php

<?php

namespace Plugin\LoveYouSukohi\Controller\Admin;

use Eccube\Controller\AbstractController;
use Plugin\LoveYouSukohi\Repository\LoveYouSukohiSkillRepository;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Template;
use Symfony\Component\Routing\Annotation\Route;

class IntroductionController extends AbstractController
{
    private $loveYouSukohiSkillRepository;

    public function __construct(LoveYouSukohiSkillRepository $loveYouSukohiSkillRepository)
    {
        $this->loveYouSukohiSkillRepository = $loveYouSukohiSkillRepository;
    }

    /**
     * @Route("/%eccube_admin_route%/love_you_sukohi/introduction", name="love_you_sukohi_admin_introduction_index")
     * @Template("@LoveYouSukohi/admin/introduction/index.twig")
     */
    public function index()
    {
        $skills = $this->loveYouSukohiSkillRepository->getAll();
        $skill_names = array_map(function($skill) { // スキル名を取得

            return $skill->getName();

        }, $skills);

        return [
            'skill_names' => $skill_names,
        ];
    }
}

【EC-CUBE】プラグインでテストデータをつくり、面倒な作業をショートカット！

EC-CUBEプラグインのインストールまで完了しましたが、さっきは手動でテストデータを追加しました。

ただ、プラグイン開発をしていると何度もアンインストールやインストールを繰り返すわけで、毎回そんなことをしてると時間の無駄です。

テストデータは自動で作成するようにしましょう！

EC-CUBEのプラグインにPluginManagerを作成すると、以下のタイミングでコード実行できるようになります。

• install: インストールしたとき
• uninstall: アンインストールしたとき
• enable: 有効になったとき
• disable: 無効になったとき
• update: アップデートしたとき

今回はプラグインがインストールされたときにテストデータを自動でDBへ追加できるようにします。

※ただし、本番環境でテストデータが入ってはいけないので開発環境のみで実行できるようにします。

app/Plugin/LoveYouSukohi/PluginManager.php

<?php

namespace Plugin\LoveYouSukohi;

use Eccube\Plugin\AbstractPluginManager;
use Plugin\LoveYouSukohi\Entity\LoveYouSukohiSkill;
use Symfony\Component\DependencyInjection\ContainerInterface;

class PluginManager extends AbstractPluginManager
{
    public function install(array $meta, ContainerInterface $container)
    {
        $this->addDevelopmentData($container); // テストデータの追加
    }

    public function uninstall(array $meta, ContainerInterface $container)
    {
        // アンインストールしたとき;
    }

    public function enable(array $meta, ContainerInterface $container)
    {
        // 有効化したとき
    }

    public function disable(array $meta, ContainerInterface $container)
    {
        // 無効化したとき
    }

    public function update(array $meta, ContainerInterface $container)
    {
        // 更新したとき
    }

    private function addDevelopmentData(ContainerInterface $container)
    {
        $environment = $container->get('kernel')->getEnvironment();
        $debug = $container->get('kernel')->isDebug();

        if($environment === 'dev' && $debug === true) { // 開発環境のみ

            $em = $container->get('doctrine.orm.default_entity_manager');
            $em->beginTransaction();

            $skill_names = [
                'プログラミング',
                '英語',
                'マーケティング',
                'SNS運用',
                'ラインティング',
            ];

            foreach ($skill_names as $skill_name) {

                $skill = new LoveYouSukohiSkill();
                $skill->setName($skill_name .' from PluginManager');
                $em->persist($skill);
                $em->flush($skill);

            }

        }
    }
}

これで、再度アンインストール、インストール、有効化すると以下のようになります。

ページも確認してみます。

うまくいきました！

【EC-CUBE】プラグイン開発でコマンドエラーが出たら試すべきコマンド

私も何度もエラーを経験していますが、どうしても理由がわからない時は以下のコマンドで強制的にキャッシュをクリアしています。

sudo chmod 777 ./var -R && bin/console cache:clear --no-warmup