Magento Module mit n98-magerun programmieren

In diesem Artikel wird Ihr lernen Magento Module mit n98-magerun programmieren. Voraussetzung für diesen Artikel ist das installierte Tool n98-magerun. Die Anleitung für die Installation kann hier eingesehen werden.

Das n98-magerun hilft den Entwicklern schnell und bequem bestimmte Aktion bei der Entwicklung in der Console auszuführen. Hier folgen ein paar Beispiele:

Magento Module mit n98-magerun programmieren: Cache Löschen

n98-magerun cache:flush

Installierte Module anzeigen

n98-magerun dev:module:list

Aber das Tool bietet auch eine Möglichkeit das Modul für die Installation anzulegen. Normaler Weise werden die Verzeichnisse und die xml-Datein per Hand erstellt. Hier können sich natürlich Fehler einschleichen. Ein automatische Generierung der Struktur spart Zeit und minimiert Fehler.

Schnell und bequem ein Modul mit dem Tool n98-magerun erstellen.

n98-magerun.phar dev:module:create --add-all --author-name='Ivan Gartsev' --author-email='code@zentralweb.de' --description 'My first n98-mageru created modul' Zentralweb Mymodul

Die wichtigstem Parameter sind hier –add-all, das legt alle Ordner an. Es besteht auch die Möglichkeit zu wählen, siehe Doku. Hinter dem Parameter –description kommt vendorNamespace. Dieser Parameter ist Pflicht und gibt den Namespace des Modul an. Anschließend kommt der Modulname. Nach dem Modulnamen könnte noch der codePool eingeben werden. Dieser Bezeichnet die Stelle an der sich das Modul befinden soll. Standard mäßig ist local eingestellt. Die volle Dokumentation kann hier nachgelesen werden.

Das Tool legt für uns folgende Struktur an.

Created directory: /data/web/public/app/code/local/Zentralweb/Mymodul
Created directory: /data/web/public/app/code/local/Zentralweb/Mymodul/etc
Created directory: /data/web/public/app/code/local/Zentralweb/Mymodul/Block
Created directory: /data/web/public/app/code/local/Zentralweb/Mymodul/Helper
Created directory: /data/web/public/app/code/local/Zentralweb/Mymodul/Model
Created directory: /data/web/public/app/code/local/Zentralweb/Mymodul/sql/zentralweb_mymodul_setup
Created directory: /data/web/public/app/code/local/Zentralweb/Mymodul/data/zentralweb_mymodul_setup
Created file: /data/web/public/app/etc/modules/Zentralweb_Mymodul.xml (234 bytes)
Created file: /data/web/public/app/code/local/Zentralweb/Mymodul/etc/config.xml
Created file: /data/web/public/app/code/local/Zentralweb/Mymodul/etc/readme.md
Created file: /data/web/public/app/code/local/Zentralweb/Mymodul/etc/composer.json

In dem etc/ Ordner finden wir die config.xml und die readme.md. Diese sind bereits vorausgefüllt und können für die weitere Entwicklung eingesetzt werden.

Als dieses Tool dev:module:create von mir zum ersten mal eingesetzt wurde, habe ich viel mehr Zeit benötigt, als wenn ich die Ordner per Hand angelegt hätte. Aber trotzdem lege ich seit dem die Module nur so an!