magento2
Modulstruktur

Katalogmodulstruktur

För närvarande tror jag att katalogmodulen innehåller nästan allt du kan lägga till i en modul.

• Api - Innehåller serviceavtal. En uppsättning gränssnitt som inte bör ändras om inte den mindre versionen ändras. Inte obligatoriskt för en anpassad modul men trevligt att ha för comercial-tillägg.
  • Data - Data gränssnitt. Varje gränssnitt måste ha en modell som implementerar den (exempel: gränssnitt för produktmodell)
  • ProductRepositoryInterface.php - gränssnitt för förvar (måste också ha en implementering)
  • ... - andra som ovan
• Block - block som används i layouten för frontend och backend
  • Adminhtml - block som används för backend
  • Kategori - frontend-relaterade block. Kan kapslas i så många mappar som du vill, men inte obligatoriskt
  • ... - samma som ovan
• Konsol - mapp som innehåller cli-kommandon
• Controller - innehåller frontend- och backend-kontroller
  • Adminhtml - backend-kontroller
  • Kategori - frontend-relaterade kontroller. Kan kapslas i så många mappar som du vill, men inte obligatoriskt
  • ... - samma som ovan.
• Cron - kod som ska köras via cron
• etc - innehåller modulkonfiguration xml-filer
  • frontend - innehåller konfigurationsfiler som bara laddas på frontend
  • adminhtml - innehåller konfigurationsfiler som bara laddas på backend
  • webapi_rest - innehåller konfigurationsfiler som laddas bara för resten api
  • webapi_soapt - innehåller konfigurationsfiler som bara laddas för SOAP-api
  • acl.xml - ACL-definitioner
  • catalog_attribut.xml - standardattribut för katalogenheter.
  • catalog_attribut.xsd - valideringsschema för filen ovan.
  • config.xml - standardvärden för konfigurationsinställningar
  • crontab.xml - schema för cronjobb
  • di.xml - inställningar för beroendeinsprutning. (kan också ligga i adminhtml, frontend, webapi_ *)
  • events.xml - observatörsdeklaration för händelser (kan också ligga i adminhtml, frontend)
  • indexer.xml - inställningar för olika index som måste köras när data ändras
  • module.xml - moduldeklarationsfilen
  • produkt_ * - produktrelaterade inställningar.
  • webapi.xml - webapi-deklarationsvägar.
  • widget.xml - widgetsdeklarationer.
• Hjälpare - olika modulhjälpare
• i18n - språköversättningsfiler
• Modell - modeller, enkla som det. de kan kapslas i så många mappar som du vill, men det är inte obligatoriskt.
• Observatör - händelseobservatörskurser
• Plugin - around|before|after plugins för olika offentliga metoder.
• Prissättning - prissättningsrelaterade klasser. Detta är modulspecifikt. Du kan ha så många mappar som du vill som detta om du inte vill placera dem i modellmappen.
• Setup - installera / uppgradera relaterade filer (installera uppgraderingsschema och data)
• Test - enhetstester
• Ui - ui komponenter relaterade klasser.
• Visa - den html-relaterade delen. V i MVC.
  • adminhtml - adminrelaterade filer
    • layout - xml-layouter för adminhtml
    • mallar - phtml-mallar för adminhtml
    • ui_compoenent - ui-komponenter relaterade filer (deklaration)
    • web - tillgångar (js, bilder)
    • requiredjs-config.js - konfiguration för required.js
  • base - filer som används för både frontend och backend.
    • kan ha samma undermappstruktur som adminhtml
  • frontend - frontend-relaterade filer
    • kan ha samma undermappstruktur som adminhtml
• composer.json - inte obligatoriskt, men trevligt att ha om du distribuerar din modul
• registrering.php - modulens registreringsfil.
• Licens * .txt, readme.md - du vet vad detta betyder. De är inte obligatoriska