index.md

layout	author_profile	title	description	keywords	sidebar	permalink
single	false	EC-CUBE 4 開発者向けドキュメント	EC-CUBE 4 の開発者向けドキュメントサイトです。EC-CUBEのインストール方法、本体カスタマイズやプラグイン開発についての情報を提供しています。	このサイトについて, QuickStart	nav docs	/

EC-CUBE 4 の開発者向けドキュメントサイトです。 EC-CUBEのインストール方法、開発ガイドラインや要素技術の概念、本体開発やプラグイン開発のチュートリアル、Cookbookなどの情報を提供しています。

{: .notice--danger}

• 2021/05/10 プラグイン開発者の方へ ソースコード確認の御願い{:target="_blank"} を公開いたしました。
• 2021/06/29 EC-CUBE 4.0.6 以前には 危険度「高」の脆弱性{:target="_blank"} が含まれています。必ず EC-CUBE 4.0.6-p1 以降のバージョンへバージョンアップをお願いします。
• 2023/02/28 4.2系でプラグインがインストールできない問題の対応策を公開いたしました。特にレンタルサーバーで4.2系のプラグインがインストール出来ない方はご参考下さい。 {: .notice--danger}

ドキュメント内容や、カスタマイズについて不明な点がございましたら、以下をご検討ください。

• EC-CUBE本体と同様にGitHub{:target="_blank"}へIssueをご投稿いただく 詳細はこちらをご覧ください
• 実施予定のUGや勉強会{:target="_blank"}を探して参加する

ドキュメントへの追記、記載内容の修正についてもGitHub{:target="_blank"}にて受け付けております。 追加方法はこちらをご覧ください。

ec-cube.coについて

ec-cube.co

クラウド版「ec-cube.co」の技術情報についてまとめました。

• ec-cube.coとは
• セキュリティ対策について
• アップデート指針
• Console
• ネーミングルール
• Git管理機能の仕様
• カスタマイズディレクトリ利用方法
• テスト環境の構築
• ログの取得
• FAQ

EC-CUBE本体について

はじめに

EC-CUBEの基本情報やご確認いただきたいことについてまとめました。

• 最新バージョン
• システム要件
• 本番環境での注意事項

初学者向け情報

初めてEC-CUBEを触られる方向けの学習情報についてまとめました。

• 学習のステップ

インストール

インストール方法についてまとめました。

• 各種インストール方法
• コマンドラインインターフェイス

バージョンアップ

本体のバージョンアップやマイグレーションについてまとめました。

• 4.2から4.3への本体バージョンアップ
• 4.2から4.3へのマイグレーション
• 4.1から4.2へのマイグレーション
• 4.0から4.1への本体バージョンアップ
• 4.0から4.1へのマイグレーション
• 4.2本体バージョンアップ
• 4.1本体バージョンアップ
• 4.0本体バージョンアップ
• 4.0.3での注意点
• SameSite Cookie 対応

本体の仕様

本体仕様、機能仕様についてまとめました。

• ER図{:target="_blank"}
• 結合試験項目書{:target="_blank"}
• WebAPI仕様{:target="_blank"}

機能仕様

• 機能一覧{:target="_blank"}
• 受注関連
• 税率設定
• 支払方法設定

本体カスタマイズ

本体のカスタマイズ方法についてまとめました。

• ディレクトリ構成
• Controllerのカスタマイズ
• Entityのカスタマイズ
• Repositoryのカスタマイズ
• FormTypeのカスタマイズ
• 購入フローのカスタマイズ
• 受注ステータスのカスタマイズ
• テンプレートのカスタマイズ
• スロットリング機能のカスタマイズ
• Twig Sandboxにおける許可リスト制御
• Symfonyの機能を使った拡張
• Symfonyの機能を使った拡張 Commandの開発

デザインカスタマイズ

画面のデザインカスタマイズについてまとめました。

• デザインテンプレートの基礎

• フォームレイアウトの変更

• ブロックの利用

• レイアウト管理の利用

• CSSの利用

• Sass(scss)の利用

• フロント画面デザイン参考資料（スタイルガイド）{:target="_blank"}

• 管理画面デザイン参考資料（デザインガイド）{:target="_blank"}

• フロント画面テンプレート for Adobe XD{:target="_blank"}

• 管理画面テンプレート for Adobe XD{:target="_blank"}

プラグイン開発

プラグインの開発方法についてまとめました。

• プラグイン仕様
• プラグインのインストール
• プラグインのトラブル対処法
• プラグインサンプル
• プラグインを開発する
• オーナーズストア経由のインストールをテストする
• プラグインで推奨の命名規則
• 管理画面ナビの拡張

設定変更

本体の設定変更方法についてまとめました。

• 多言語化
• 通貨
• タイムゾーン
• 環境設定
• デバッグモード
• セッション情報保存方法の変更

開発ツール

開発時に役立つツールについてまとめました。

• MailCatcher

セキュリティテストの実施

セキュリティテストについての情報をまとめました。

• はじめに
• Quick Start
• イントロダクション
• OWASP ZAP について
• テスト計画
• テストの実施
• テスト評価
• セキュリティの改善

セキュリティガイドライン

セキュリティガイドラインについてまとめました。

• コーディングについて
• プラグイン開発におけるセキュリティ強化

逆引きリファレンス

知っているとちょっと便利な情報をまとめました。

• Tips
• カスタマイズサンプル集

運用者向け情報

運用のマニュアルはこちらを御覧ください。

• EC-CUBE 4管理・運用 マニュアル{:target="_blank"}

開発に参加する

開発に参加したい方向けの情報をまとめました。

• EC-CUBEの開発に参加するには？（公式サイト）{:target="_blank"}
• 開発の概要
• プルリクエストの作り方

ドキュメントがみつからないときは

開発ドキュメントの作成やメンテナンスに参加する方法をまとめました。

• ドキュメントのリクエスト
• ドキュメントの追加・書き方
• ドキュメントの投稿

Supporters

EC-CUBEは以下のサポートを受けています。

• SAKURA internet{:target="_blank"} {:target="_blank"}

• VAddy{:target="_blank"} {:target="_blank"}