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.3
- Vor zwei Tagen wurde Symfony 5.3.0-BETA4 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 …
Symfony Messenger - Behandlung erneut fehlgeschlagener Nachrichten
- Im Symfony Messenger gibt die Möglichkeit, fehlgeschlagene Nachrichten an eine failed queue zu leiten. In diesem Sammelbecken können diese dann inspiziert und nach Korrektur des zu Grunde liegenden …
Response-Eigenschaften im Zikula Theme-Layer anpassen
- In Zikula gibt es eine Besonderheit zu beachten, welche Einfluss darauf nimmt, wie die aus einem Request resultierende Response zum anfragenden Client gelangt. Per Standard wird die Response in …
Tabellennamen mit Doctrine dynamisch anpassen
- Mit Hilfe der Metadaten von Doctrine lassen sich jegliche Daten zu einer Entität zur Laufzeit verändern. Allerdings kann das in manchen Anwendungsfällen fortwährend notwendig sein, zum Beispiel in …
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 …