アドオンのディレクトリ構造

アドオンが持つ各種ディレクトリについて解説します。

アドオンの必須ファイル・ディレクトリ

app/addons/<アドオン名> ディレクトリは、すべてのアドオンに必須です。
テンプレートを除くすべてのアドオンファイルは、次のディレクトリに存在しなくてはなりません。

  • addon.xml-アドオンのインストールやアンインストールに必要なアドオンについてのデータを記述します。

  • func.php-アドオンのコントローラーなどで使用する関数が記述されています。このファイルに書いた関数はテンプレートなどからも利用可能です。

  • init.php-アドオンで使用するPHPフックのリストの登録を行うファイルです。

  • config.php-アドオンの設定データが格納されています。(定数の宣言など)

  • var/langs/<言語コード>/addons/<アドオン名>.po - アドオンでの言語変数

次のディレクトリも必要に応じて準備する必要があるかもしれません。

  • controllers-このディレクトリには、アドオンコントローラーのファイルと、コアのコントローラーを拡張するPREコントローラーとPOSTコントローラーのファイルが含まれます。
  • schemas -標準のスキーマーを拡張するファイルを含むディレクトリ。

追加のテンプレートディレクトリ

アドオンは、上記のディレクトリに加えて次のテンプレート用のディレクトリを使用できます。

  • var/themes_repository/basic/templates/addons/<アドオン名> - ショップフロントのテンプレート
  • design/backend/templates/addons/<アドオン名> - 管理パネルテンプレート
  • var/themes_repository/basic/mail/templates/addons/<アドオン名> - メールテンプレート

👍

開発者の裁量で、これらディレクトリにさらにサブディレクトリやファイルを作成できます。プリインストールされている他のアドオンを確認することをお勧めします。