Permalink
Switch branches/tags
Nothing to show
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
77 lines (68 sloc) 2.64 KB
title keywords tags sidebar permalink
ディレクトリ
plugin
plugin
home_sidebar
plugin_bp_directory

プラグインのディレクトリ構成ですが、極力EC-CUBE3本体のディレクトリ構成に合わせる事を推奨します。但し、全てのディレクトリが必要ではなく必要に応じてディレクトリをプラグイン側に作成してください。

標準的なディレクトリ構成について

標準でプラグインを以下のようなディレクトリ構成になります。

  • ディレクトリ例
[プラグインコード]
  ├── Controller
  │   └── XXXXController.php
  ├── Entity
  │   └── XXXX.php
  ├── Form
  │   ├── Extension
  │   │   └── XXXXTypeExtension.php
  │   └── Type
  │           └── XXXXType.php
  ├── Repository
  │   └── XXXXRepository.php
  ├── Resource
  │   ├── assets
  │   │   ├── css
  │   │   │   └── xxxx.css
  │   │   ├── img
  │   │   │   ├── xxxx.gif
  │   │   │   ├── xxxx.jpg
  │   │   │   └── xxxx.png
  │   │   └── js
  │   │       └── xxxx.js
  │   ├── doctrine
  │   │   └── Plugin.XXXX.Entity.XXXX.dcm.yml
  │   │   └── migration
  │   │       └── VersionYYYYMMDDHHMMSS.php
  │   ├── locale
  │   │   └── message.ja.yml
  │   └── template
  │           ├── Block
  │           │   └── XXXX.twig
  │           ├── admin
  │           │   └── XXXX.twig
  │           └── XXXX.twig
  ├── Service
  │   └── XXXXService.php
  ├── ServiceProvider
  │   └── XXXXServiceProvider.php
  ├── PluginManager.php
  ├── LICENSE.txt
  ├── XXXXEvent.php
  ├── config.yml
  └── event.yml

共通関数をまとめたクラス等が必要になった場合、

[プラグインコード]
  ├── Event
  │   └── XXXXEvent.php
  ├── Common
  │   └── XXXX.php
  ├── Util
  │   └── XXXX.php

と本体側と極力合わせるようにディレクトリを作成してください。本体側に存在しないようなものについては自由に作成しても問題ありませんが、極力似たようなディレクトリ構成を心がけてください。

本体側のディレクトリ構成は ディレクトリ・ファイル構成 を参照してください。