Naming Conventions

Der MMLC arbeiten nach dem Prinzip "Convention over configuration". Da der MMLC auf unterschiedlichen Technologien aufbaut und das modified eCommerce System keine Conventions festlegt, gibt es leider einige unterschiedliche Naming Conventions, an die du dich bei der Entwicklung von Modulen mit dem MMLC halten solltest oder sogar musst. Das ist aber immernoch besser als keine Conventions festzulegen. Hier ein Überblick, damit du schnell die passende Naming Convention findest:

Verwendung und Beispiele

Verwendung	Convention	Beispiele
VendorPrefix	snake_case	`mc` `cn`
VendorName	lisp-case	`mycompany` `cool-nickname`
ModulName	lisp-case	`my-first-module` `newsletter`
ArchiveName (VendorName/ModulName)	lisp-case	`mycompany/my-first-module` `cool-nickname/newsletter`
HookFileName	snake_case	`mc_my_first_module.php` `cn_newsletter.php`
Namespace	PascalCase	`MyCompany` `CoolNickname`
vendor-no-composer	PascalCase	`MyCompany` `CoolNickname`
Modul-Konstanten	Screaming Case	`MODULE_MC_MY_FIRST_MODULE` `MODULE_CN_NEWSLETTER`

Beschreibung der Conventions

snake_case

Bei snake_case werden alle Zeichen in kleinen Buchstaben geschrieben. Als Trennzeichen zwischen den Wörtern kann der Unterstrich verwendet werden. Beispiele: mc_my_first_module, cn_newsletter

lisp-case

Bei lisp-case werden alle Zeichen in kleinen Buchstaben geschrieben. Als Trennzeichen zwischen den Wörtern kann der Bindestrich verwendet werden. Beispiele: super-company, cool-nickname

camelCase

Bei camelCase (auch lower camel case) werden alle Wörter zusammengeschrieben ohne Trennzeichen. Der erste Buchstabe des ersten Worts wird klein geschrieben. Die Anfangsbuchstaben der weiteren Wörter verwenden Großbuchstaben. Beispiele: myVariable, mySuperNiceModule

PascalCase

Bei PascalCase werden alle Wörter zusammengeschrieben ohne Trennzeichen. Der erste Buchstabe des ersten Worts wird groß geschrieben. Die Anfangsbuchstaben der weiteren Wörter verwenden ebenfalls Großbuchstaben. Beispiele: MyCompany, CoolNickname

Screaming Case

Alle Zeichen werden in Großbuchstaben geschrieben. Als Trennzeichen zwischen Wörtern kann der Unterstrich verwendet werden. Beispiele: MODULE_MC_MY_FIRST_MODULE, MODULE_CN_NEWSLETTER.