目錄模組結構

目前我認為目錄模組幾乎包含了你可以新增到模組的所有內容。

  • Api - 包含服務合同。除非次要版本更改,否則不應更改的一組介面。對於自定義模組不是強制性的,但對於商業擴充套件很有用。
    • 資料 - 資料介面。每個介面都必須有一個實現它的模型(例如:產品模型的介面)
    • ProductRepositoryInterface.php - 儲存庫的介面(還必須具有實現)
    • …… - 其他如上所述
  • - 用於前端和後端佈局的塊
    • Adminhtml - 用於後端的塊
    • 類別 - 前端相關塊。可以根據需要巢狀在任意數量的資料夾中,但不是必需的
    • …… - 與上述相同
  • 控制檯 - 包含 cli 命令的資料夾
  • 控制器 - 包含前端和後端控制器
    • Adminhtml - 後端控制器
    • 類別 - 前端相關的控制器。可以根據需要巢狀在任意數量的資料夾中,但不是必需的
    • …… - 與上述相同。
  • Cron - 應該通過 cron 執行的程式碼
  • etc - 包含模組配置 xml 檔案
    • 前端 - 包含僅在前端載入的配置檔案
    • adminhtml - 包含僅在後端載入的配置檔案
    • webapi_rest - 包含僅為其餘 api 載入的配置檔案
    • webapi_soapt - 包含僅為 SOAP api 載入的配置檔案
    • acl.xml - ACL 定義
    • catalog_attributes.xml - 目錄實體的預設屬性。
    • catalog_attributes.xsd - 上面檔案的驗證模式。
    • config.xml - 配置設定的預設值
    • crontab.xml - cron 作業排程
    • di.xml - 依賴注入首選項。 (也可以駐留在 adminhtml,前端,webapi_ *)
    • events.xml - 事件的觀察者宣告(也可以駐留在 adminhtml,前端)
    • indexer.xml - 資料更改時需要執行的不同索引的設定
    • module.xml - 模組宣告檔案
    • product_ * - 產品相關設定。
    • webapi.xml - webapi 宣告路徑。
    • widget.xml - 小部件宣告。
  • 助手 - 不同的模組助手
  • i18n - 語言翻譯檔案
  • 模型 - 模型,簡單。它們可以巢狀在任意數量的資料夾中,但並不是強制性的。
  • 觀察者 - 事件觀察者類
  • 外掛 - 用於不同公共方法的 around|before|after 外掛。
  • 定價 - 定價相關類。這是特定於模組的。如果你不想將它們放在模型資料夾中,你可以擁有任意數量的資料夾。
  • 安裝 - 安裝/升級相關檔案(安裝升級架構和資料)
  • 測試 - 單元測試
  • Ui - ui 元件相關類。
  • view - 與 html 相關的部分。MVC 中的 V.
    • adminhtml - 管理員相關檔案
      • layout - adminhtml 的 xml 佈局
      • templates - adminhtml 的 phtml 模板
      • ui_compoenent - ui 元件相關檔案(宣告)
      • 網路 - 資產(js,影象)
      • requirejs-config.js - require.js 的配置
    • base - 用於前端和後端的檔案。
      • 可以與 adminhtml 具有相同的子資料夾結構
    • 前端 - 前端相關檔案
      • 可以與 adminhtml 具有相同的子資料夾結構
  • composer.json - 不是強制性的,但如果你分發你的模組就很高興
  • registration.php - 模組註冊檔案。
  • 許可證* .txt,readme.md - 你知道這意味著什麼。它們不是強制性的