EC-CUBE Snippets

EC-CUBE 4系の開発を効率化するVSCode拡張機能です。
ec と打ち始めるだけで、Twig・PHP・YAMLのスニペットが補完候補に表示されます。
各スニペットには日本語・英語の説明がツールチップで表示されます。

対応ファイル

• .twig
• .html
• .php
• .yaml
• .yml

使い方

1. .twig / .html / .php / .yaml / .yml ファイルを開く
2. ec と入力する
3. eccube_ から始まる補完候補が一覧表示される
4. 選択するとスニペットが展開され、Tab キーで次の入力箇所に移動できる

PHPスニペットについて
PHPスニペットには <?php が含まれていません。<?php タグの内側で使用してください。

Twigスニペット一覧

アセット（Asset）

テンプレート構造（Template）

条件・ループ（Control Flow）

フォーム（Form）

カート（Cart）

パンくずリスト（Breadcrumb）

URL・ルーティング（URL / Routing）

認証・セキュリティ（Auth / Security）

価格・日付・翻訳（Filters）

フラッシュ・ページネーション（UI）

リクエスト・デバッグ・その他（Misc）

PHPスニペット一覧

クラス雛形（Class Scaffolding）

actionメソッド（Action Methods）

EC-CUBE 4.3（Symfony 6.4）の書き方に準拠したactionメソッドの雛形スニペットです。
@Route / @Template アノテーションと isCsrfTokenValid() によるCSRF検証がセットで展開されます。

EC-CUBE 4.3 / Symfony 6.4 の主な記述ルール

• ルーティングは @Route アノテーション形式（Symfony\Component\Routing\Annotation\Route）
• テンプレート指定は @Template アノテーション（Sensio\Bundle\FrameworkExtraBundle\Configuration\Template）
• CSRFトークン検証は $this->isCsrfTokenValid('intention', $token) を使用
• コンストラクターインジェクションは private readonly プロモーション形式

展開例（eccube_action_get_post）

/**
 * @Route("/plugin/route_path", name="route_name", methods={"GET", "POST"})
 * @Template("@PluginCode/template.twig")
 */
public function index(Request $request): array|RedirectResponse
{
    $form = $this->createForm(FormType::class);
    $form->handleRequest($request);

    if ($form->isSubmitted() && $form->isValid()) {
        $this->addSuccess('登録しました。', 'admin');

        return $this->redirectToRoute('route_name');
    }

    return [
        'form' => $form->createView(),
    ];
}

展開例（eccube_action_delete）

/**
 * @Route("/plugin/route_path/{id}/delete", name="route_name_delete", methods={"DELETE"})
 */
public function delete(Request $request, Entity $entity): RedirectResponse
{
    $token = $request->request->get('_token');
    if (!$this->isCsrfTokenValid('delete', $token)) {
        throw $this->createAccessDeniedException();
    }

    $this->entityManager->remove($entity);
    $this->entityManager->flush();

    $this->addSuccess('削除しました。', 'admin');

    return $this->redirectToRoute('route_name');
}

Entityプロパティ（Entity Properties）

QueryBuilder

Controllerユーティリティ（Controller Utilities）

YAMLスニペット一覧

設定ファイル（Config）

動作要件

• Visual Studio Code 1.75.0 以上
• EC-CUBE 4系

ライセンス

MIT

リポジトリ・不具合報告

https://github.com/TakashiHishiki/eccube-snippets