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

Spannende Neuerungen im Zikula Core
- In Zikula 3 werden endlich weitere hilfreiche Funktionen von Symfony verwendet. Zikula 2.x hat bereits auf Symfony 3.4.x aufgesetzt, aber aus Rücksicht auf die Abwärtskompatibilität noch nicht alle …
Neue Versionen von Content und MultiHook
- Seit gestern steht das Content-Modul in der Version 5.1.0 zum Download bereit. Zu den neuen Funktionen zählen neben kleineren Verbesserungen, etwa für den Inhaltstyp zur Integration von Informationen …
Flexible Einstellung von Sichtbarkeiten im Content-Modul
- Schon in einer sehr frühen Generation des Content-Moduls zur Inhaltsverwaltung gab es die Möglichkeit, ein Inhaltselement nicht für alle Besucher, sondern entweder nur für alle angemeldeten Nutzer …
Neuer private-Modus im Generator zur alleinigen Anzeige eigener Daten
- In ModuleStudio gibt es für jede Entität eine Einstellung namens ownerPermission. Dieser Schalter legt fest, ob Benutzer in der Lage sein sollen, (lediglich) ihre eigenen Daten zu verwalten und zu …
Zikula Core 3 bietet Mittel für dynamische Formularelemente
- Das Profile-Modul von Zikula bietet seit langer Zeit die Möglichkeit, die einzelnen Angaben der Benutzerprofile flexibel zu verändern und nach Belieben zu konfigurieren. Diese Funktionalität wurde im …