EC-CUBE のルーティング名を、エディタの右クリックメニューから素早く挿入できる Visual Studio Code 拡張機能です。
EC-CUBE 4系のフロント画面・管理画面の組み込みルーティングを網羅しており、ワークスペース内のプロジェクトファイルからルーティングを自動取得する機能も備えています。
機能
ルーティング名の挿入
エディタ上で右クリックすると、コンテキストメニューに 「EC-CUBE Routing」 サブメニューが表示されます。
「ルーティング名を挿入」 を選択すると検索可能なピッカーが開き、ルーティング名を絞り込んで選択するとカーソル位置(または選択範囲)に挿入されます。
ピッカーの表示順は次のとおりです。
- フロント画面(組み込み) — EC-CUBE 標準のフロントルーティング
- フロント画面(自動取得) — プロジェクトから自動検出したルーティング
- フロント画面(手動追加) — 右クリックメニューから手動で追加したルーティング
- 管理画面(組み込み) — EC-CUBE 標準の管理画面ルーティング
- 管理画面(自動取得) — プロジェクトから自動検出したルーティング
- 管理画面(手動追加) — 右クリックメニューから手動で追加したルーティング
右クリックサブメニュー
エディタ上で右クリックすると 「EC-CUBE Routing」 サブメニューが展開され、以下の操作をすべてメニューから実行できます。
右クリック
└─ EC-CUBE Routing ▶
├─ ルーティング名を挿入
├─ フロントのカスタムルーティングを追加
├─ 管理画面のカスタムルーティングを追加
├─ カスタムルーティングを削除
└─ ワークスペースを再スキャン
ワークスペースの自動スキャン
VS Code 起動時にワークスペース内のファイルを自動解析し、プロジェクト固有のルーティング名を取得します。
PHP ファイルや YAML ファイルを保存すると自動的に再スキャンが走ります(2秒デバウンス)。
スキャン対象ファイル
| ファイル | 抽出対象 |
|---|---|
src/**/*.php |
@Route(name="xxx") / #[Route(name: 'xxx')] |
app/**/*.php |
同上 |
Plugin/**/*.php |
プラグインのルーティング定義 |
app/config/**/routes*.yaml |
Symfony routing YAML のキー名 |
Plugin/**/Resource/config/routes*.yaml |
プラグインの routing YAML |
ステータスバー表示
VS Code 右下のステータスバーに取得件数が表示されます。
クリックすると手動で再スキャンを実行できます。
EC-CUBE Routing: 42 件取得済 ← クリックで再スキャン
カスタムルーティングの追加・削除
右クリックサブメニューからカスタムルーティングを追加・削除できます。
追加したルーティングは VS Code のグローバル設定に保存され、次回以降も挿入ピッカーに表示されます。
settings.json を直接編集して追加することもできます。
{
"eccubeRouting.customFrontRoutes": [
{ "label": "my_front_page", "description": "Front / 独自フロントページ" }
],
"eccubeRouting.customAdminRoutes": [
{ "label": "admin_my_feature", "description": "Admin / 独自管理機能" }
]
}
使い方
- EC-CUBE プロジェクトをワークスペースとして開く
- PHP・Twig・YAML などのファイルをエディタで開く
- ルーティング名を挿入したい箇所にカーソルを置く
- 右クリック → EC-CUBE Routing → ルーティング名を挿入 を選択
- 検索ボックスでルーティング名を絞り込み、選択すると挿入される
収録ルーティング一覧(組み込み)
フロント画面
| ルーティング名 | 概要 |
|---|---|
| homepage | トップページ |
| contact | お問い合わせ |
| contact_confirm | お問い合わせ確認 |
| contact_complete | お問い合わせ完了 |
| product_list | 商品一覧 |
| product_detail | 商品詳細 |
| product_add_favorite | お気に入り追加 |
| cart | カート |
| cart_add | カートに追加 |
| cart_remove | カートから削除 |
| cart_handle_error | カートエラーハンドラ |
| shopping | 注文入力 |
| shopping_login | 購入ログイン |
| shopping_nonmember | 非会員購入 |
| shopping_nonmember_confirm | 非会員購入確認 |
| shopping_redirect_to | 購入リダイレクト |
| shopping_shipping | 配送先選択 |
| shopping_shipping_edit | 配送先編集 |
| shopping_shipping_edit_delete | 配送先削除 |
| shopping_confirm | 注文確認 |
| shopping_complete | 注文完了 |
| shopping_checkout | チェックアウト |
| shopping_checkout_error | チェックアウトエラー |
| mypage | マイページ |
| mypage_login | マイページログイン |
| mypage_order | 購入履歴一覧 |
| mypage_order_detail | 購入履歴詳細 |
| mypage_favorite | お気に入り一覧 |
| mypage_favorite_delete | お気に入り削除 |
| mypage_change | 会員情報変更 |
| mypage_change_complete | 会員情報変更完了 |
| mypage_delivery | お届け先一覧 |
| mypage_delivery_new | お届け先新規登録 |
| mypage_delivery_edit | お届け先編集 |
| mypage_delivery_delete | お届け先削除 |
| mypage_withdraw | 退会 |
| mypage_withdraw_confirm | 退会確認 |
| mypage_withdraw_complete | 退会完了 |
| entry | 会員登録 |
| entry_confirm | 会員登録確認 |
| entry_complete | 会員登録完了 |
| entry_activate | 会員本登録 |
| forgot | パスワードを忘れた方 |
| forgot_complete | パスワード再発行完了 |
| forgot_reset | パスワードリセット |
| help_about | ショップについて |
| help_privacy | プライバシーポリシー |
| help_tradelaw | 特定商取引法 |
| help_guide | ご利用ガイド |
管理画面
| ルーティング名 | 概要 |
|---|---|
| admin_login | ログイン |
| admin_logout | ログアウト |
| admin_homepage | ダッシュボード |
| admin_product | 商品一覧 |
| admin_product_new | 商品新規登録 |
| admin_product_edit | 商品編集 |
| admin_product_copy | 商品コピー |
| admin_product_delete | 商品削除 |
| admin_product_display | 商品表示切替 |
| admin_product_class | 商品規格 |
| admin_product_class_name | 規格名一覧 |
| admin_product_class_name_new | 規格名新規登録 |
| admin_product_class_name_edit | 規格名編集 |
| admin_product_class_name_delete | 規格名削除 |
| admin_product_category | カテゴリ一覧 |
| admin_product_category_show | カテゴリ表示 |
| admin_product_category_delete | カテゴリ削除 |
| admin_product_category_sort | カテゴリ並び替え |
| admin_product_review | レビュー一覧 |
| admin_product_review_edit | レビュー編集 |
| admin_product_review_delete | レビュー削除 |
| admin_product_tag | タグ一覧 |
| admin_product_tag_delete | タグ削除 |
| admin_order | 受注一覧 |
| admin_order_new | 受注新規登録 |
| admin_order_edit | 受注編集 |
| admin_order_delete | 受注削除 |
| admin_order_export | 受注エクスポート |
| admin_order_search_customer | 顧客検索(受注) |
| admin_order_search_product | 商品検索(受注) |
| admin_order_shipping_export | 配送エクスポート |
| admin_shipping | 配送一覧 |
| admin_customer | 会員一覧 |
| admin_customer_new | 会員新規登録 |
| admin_customer_edit | 会員編集 |
| admin_customer_delete | 会員削除 |
| admin_customer_resend | 本登録メール再送 |
| admin_customer_export | 会員エクスポート |
| admin_content_news | 新着情報一覧 |
| admin_content_news_new | 新着情報新規登録 |
| admin_content_news_edit | 新着情報編集 |
| admin_content_news_delete | 新着情報削除 |
| admin_content_page | ページ一覧 |
| admin_content_page_new | ページ新規登録 |
| admin_content_page_edit | ページ編集 |
| admin_content_page_delete | ページ削除 |
| admin_content_block | ブロック一覧 |
| admin_content_block_new | ブロック新規登録 |
| admin_content_block_edit | ブロック編集 |
| admin_content_block_delete | ブロック削除 |
| admin_content_layout | レイアウト一覧 |
| admin_content_layout_new | レイアウト新規登録 |
| admin_content_layout_edit | レイアウト編集 |
| admin_content_layout_delete | レイアウト削除 |
| admin_content_layout_preview | レイアウトプレビュー |
| admin_content_css | CSS編集 |
| admin_content_js | JS編集 |
| admin_content_image | 画像管理 |
| admin_content_image_new | 画像アップロード |
| admin_content_image_delete | 画像削除 |
| admin_setting_shop_shop | 店舗設定 |
| admin_setting_shop_customer_agreement | 会員規約設定 |
| admin_setting_shop_trade_law | 特定商取引法設定 |
| admin_setting_shop_delivery | 配送方法一覧 |
| admin_setting_shop_delivery_new | 配送方法新規登録 |
| admin_setting_shop_delivery_edit | 配送方法編集 |
| admin_setting_shop_delivery_delete | 配送方法削除 |
| admin_setting_shop_delivery_rank | 配送方法並び替え |
| admin_setting_shop_payment | 支払方法一覧 |
| admin_setting_shop_payment_new | 支払方法新規登録 |
| admin_setting_shop_payment_edit | 支払方法編集 |
| admin_setting_shop_payment_delete | 支払方法削除 |
| admin_setting_shop_tax | 税率設定 |
| admin_setting_shop_mail | メール設定一覧 |
| admin_setting_shop_mail_edit | メール設定編集 |
| admin_setting_shop_csv | CSV設定 |
| admin_setting_shop_order_status | 受注ステータス設定 |
| admin_setting_system_system | システム情報 |
| admin_setting_system_member | メンバー一覧 |
| admin_setting_system_member_new | メンバー新規登録 |
| admin_setting_system_member_edit | メンバー編集 |
| admin_setting_system_member_delete | メンバー削除 |
| admin_setting_system_authority | 権限設定 |
| admin_setting_system_log | ログ閲覧 |
| admin_setting_system_cache | キャッシュ管理 |
| admin_setting_system_cache_clear | キャッシュ削除 |
| admin_setting_system_update | マイグレーション |
| admin_setting_system_plugin | プラグイン一覧 |
| admin_setting_system_plugin_install | プラグインインストール |
| admin_setting_system_plugin_delete | プラグイン削除 |
| admin_setting_system_plugin_enable | プラグイン有効化 |
| admin_setting_system_plugin_disable | プラグイン無効化 |
動作環境
- Visual Studio Code 1.80.0 以降
- EC-CUBE 4系
ライセンス
MIT