Optimierung im Detail - Schreibweisen von Entitäten und Feldern im Modell

in  Zikula Apps , , ,

Optimierung im Detail - Schreibweisen von Entitäten und Feldern im Modell

In der modellgetriebenen Softwareentwicklung werden die fachlichen Anforderungen in der Regel sehr prägnant formuliert. Schließlich ist eines der Ziele einer domänenspezifischen Sprache eine lesbare und verständliche Beschreibung eines Softwaresystems, wozu auch die Vermeidung von Redundanzen und unnötigem Boilerplate-Code gehört.

Dies führt dazu, dass selbst kleine Veränderungen in einem Modell größere Unterschiede im generierten Quelltext zur Folge haben können. Ein Beispiel für solche, auf den ersten Blick unscheinbare Differenzierungen betrifft die Schreibweise von Modellelementen. Dieser Beitrag zeigt auf, was es bedeutet, ob der Name einer Entität oder eines Feldes so oder so geschrieben wird.

Zunächst einmal reagiert die Validierung von ModuleStudio mit einem Fehler, wenn man Bezeichnungen mit einem Großbuchstaben startet. Dies hat den einfachen Hintergrund, dass die Modellierung möglichst einfach bleiben soll (in dem Fall ohne unnötigerweise die Shift-Taste benutzen zu müssen). Wenn es erforderlich sein sollte, kann der Generator special selbstständig zu Special umwandeln.

Im Folgenden nehmen wir als Beispiel ein Modell an, welches eine Entität für Produkte enthält. Diese Entität soll ein neues Feld für etwaige zusätzliche Versandkosten erhalten.

Natürlich kann man das Feld einfach additionalshippingcosts nennen. Das wird ganz normal funktionieren und führt auch nicht zu einem Fehler. Es nimmt dem Generator aber die Möglichkeit, den Namen je nach Einsatzzweck unterschiedlich zu formatieren.

Mixed case to the rescue

Empfohlen für ModuleStudio wird die sogenannte mixed case Schreibweise: das obige Feld würde also additionalShippingCosts getauft. Dies ist erstens wesentlich lesbarer für Menschen, die sich mit dem Modell und/oder dem Quellcode auseinandersetzen. Zweitens kann der Generator mit dieser Bezeichnung etwas flexibler arbeiten - hier einige Beispiele:

  • Name des Feldes für Code und Doctrine: additionalShippingCosts
  • Lesbarer Name mit Großschreibung, z. B. für ein Form-Label: Additional shipping costs:
  • Lesbarer Name ohne Großschreibung, z. B. für einen Hilfetext: Please enter the additional shipping costs

Man erhält damit out of the box ansprechendere Oberflächen in den generierten Anwendungen, da die Oberflächen mit lesbaren Zeichenketten ausgestattet werden. Dies vereinfacht dann übrigens auch den Übersetzungsprozess mit Gettext, da der Übersetzer leichter versteht, wofür eine bestimmte Schreibweise gedacht ist.

Weitere Beiträge in Kategorie Zikula Apps

Kommende Neuerungen in Symfony 5.2
- Vor zwei Tagen wurde Symfony 5.2.0-BETA2 veröffentlicht. Dies nehme ich zum Anlass, um einmal einen Überblick über die wichtigsten neuen Funktionen zu geben, auf die wir uns im Rahmen dieses Updates …
Zikula Core 3.0.3 mit Sicherheits-Update von Symfony 5
- Vor kurzem hatten wir über das Release von Zikula 3.0.1 berichtet, welches wichtige Korrekturen für Zikula 3 bereitgestellt hat. Vor einer Woche wurde die nächste Version 3.0.2 veröffentlicht. …
Symfony Services asynchron im Hintergrund aufrufen
- Oftmals greift man in Symfony-Projekten auf CLI-Kommandos mit Hilfe der Symfony Console-Komponente zurück, um länger laufende Prozesse außerhalb des Webservers durchzuführen. In komplexeren Vorhaben …
Zikula 3.0.1 veröffentlicht - erstes Bugfix Release für Zikula Core 3
- Genau einen Monat nach der Veröffentlichung von Zikula 3.0.0 ist nun das erste Update erschienen. Zikula 3.0.1 bringt wichtige Korrekturen und sorgt somit für ein Stück mehr Stabilität in der neuen …
Zikula Framework in Version 3 veröffentlicht
- Heute haben wir das finale Release von Zikula Core 3.0.0 veröffentlicht. Es basiert auf Symfony 5.1 sowie Twig 3 und verwendet unter anderem Bootstrap 4 und Font Awesome 5. Einen grundlegenden …