Klassenbenennung und das Präfix exp #

Diese Seite richtet sich an PHP-Entwickler, die Klassen, Funktionen, Einstellungen oder Tabellen hinzufügen. Namen in Exponential folgen einigen Regeln, die verhindern, dass Tausende von Klassen in einer Klassen-Map kollidieren, und die vorhandene Erweiterungen funktionsfähig halten. Die maßgebliche Darstellung ist Namenspräfixe: sevenx und exp.

Inhalt #

1. Die Regeln in einer Tabelle
2. Ihr Präfix
3. exp und sevenx
4. Kernel-Bezeichner eZ bleiben
5. Dateien und Klassennamen
6. Klassen mit Namespace
7. Andere Bezeichner

Die Regeln in einer Tabelle #

Ihr Präfix #

Alle Klassen teilen sich eine Klassen-Map, sodass zwei gleichnamige Klassen in zwei Erweiterungen einander stören: Der Generator warnt vor einem Duplikat, und eine von beiden gewinnt. Beginnen Sie jede Klasse, Funktion, jeden Template-Operator, jede Fetch-Funktion, jeden Einstellungsblock und jede Tabelle Ihrer Erweiterung mit einem Präfix, das Ihnen gehört: acmeReportService, acme_report (Tabelle), acmereport_total (Operator), [AcmeReportSettings] (Block).

exp und sevenx #

• exp ist das Präfix des Projekts. Neuer Code im Kernel und in Projekterweiterungen verwendet es: explayouts, expai, expqueue, expHelpAudience, die Konsolenbefehle exp:. Verwenden Sie exp nur für Code, den Sie zum Projekt beitragen.
• sevenx ist das offizielle öffentliche PHP-Code-Präfix von 7x; „7x“ kann keines sein, weil ein PHP-Bezeichner nicht mit einer Ziffer beginnen kann (class 7xFoo ist ein Parse-Fehler).
• Vorhandene Namen sevenx_* und exp* werden nicht umbenannt, nur damit die Präfixe einheitlich aussehen; der Ordnername einer Erweiterung ist ihre Identität in den Einstellungen.

Kernel-Bezeichner eZ bleiben #

eZContentObject, eZINI, eZDB, eZPersistentObject, ezpKernelWeb, die Dateinamen ez*, Modulnamen, Template-Operatoren, Einstellungen und Datenbanktabellen sind echte Bezeichner. Sie werden nie umbenannt: Eine Umbenennung würde jede Erweiterung und jedes Template brechen, das für sie geschrieben wurde. eZ ist das Präfix dieser Bezeichner, nicht der Name des Produkts.

Zwei Folgen für Ihren Code:

• Legen Sie keine neuen Klassen mit dem Präfix eZ oder ezp an; sie sehen aus wie Kernel-Klassen und können mit künftigen kollidieren.
• In Kommentaren, Meldungen und Dokumentation heißt das Produkt Exponential. Der alte Produktname erscheint nur als vergangene Geschichte; ein Klassenname wie eZContentObject ist nicht der Produktname und bleibt, wie er ist.

Dateien und Klassennamen #

Der Klassen-Map-Generator findet Klassen, indem er Dateien durchsucht, sodass auch eine Klasse in einer anders benannten Datei gefunden wird; die Regel ist für Menschen, die acmereportservice.php suchen, wenn sie acmeReportService lesen.

Klassen mit Namespace #

Der Kernel verwendet Namespaces nur für die Runnable-Klassen (Befehle, Cronjob-Teile, Modul-Views) und ihre Dienste:

Alles andere sind globale Klassennamen mit Präfix (Modul-Views als Klassen).

Andere Bezeichner #

• INI-Dateien und -Blöcke: Ihre eigene Datei (acmereport.ini) mit Ihren eigenen Blöcken; Änderungen an Kernel-Dateien gehören in *.ini.append.php Ihrer Erweiterung.
• Tabellen: acme_*, Kleinbuchstaben, Namen ohne Anführungszeichen, die auf jeder unterstützten Datenbank funktionieren (Code für jede unterstützte Datenbank).
• Template-Operatoren und Fetch-Funktionen: mit Präfix (acmereport_money, fetch( 'acmereport', 'items' )).
• Übersetzungskontexte: extension/acmereport.
• CSS-Klassen und globale JavaScript-Variablen: ebenfalls Ihr Präfix.

Verwandte Seiten #

• Schichtung und Benennung
• Autoloads und Klassen-Maps
• Benennung und Branding bei einem Upgrade
• Freie Dokumentation: diese Seite darf unter der GNU FDL 1.3 frei kopiert, übersetzt und verbessert werden.