Erweitern: warum, wo und wie
Kapitel 5 geht davon aus, dass fast jeder Bereich des Systems für Erweiterungen offen ist: Module, Datentypen,
Template-Operatoren, Workflow-Ereignisse, Aktionen und Benachrichtigungen. Eine Erweiterung ist ein Ordner unter
extension/, der eines oder mehrere davon hinzufügt, ohne den Kernel anzufassen.
Warum Sie eine schreiben
Das Buch nennt Gründe; sie gelten weiterhin:
- Die Funktion, die Sie brauchen, gibt es nicht.
- Eine ähnliche gibt es, aber nicht genau so: Fragen Sie danach oder senden Sie einen Pull Request.
- Eine Funktion hat einen Fehler, und die Behebung kann nicht warten: Eine kleine Erweiterung (oder ein Kernel-Override) ist eine vorübergehende Lösung.
- Die Funktion gehört allein Ihrem Unternehmen.
- Sie bewegt Daten in ein anderes System hinein oder aus ihm heraus.
Bevor Sie beginnen, sehen Sie sich an, was es gibt. Das Buch schickt Sie in die Foren und auf einen Subversion-Server seiner Zeit; heute sind der Erweiterungskatalog von se7enxweb, Packagist und GitHub die richtigen Orte.
Benennung
Wählen Sie einen eindeutigen Namen, damit er später nicht kollidiert. Verwenden Sie Buchstaben, Ziffern und einen
Unterstrich; keinen Bindestrich (das Buch sagt das, und es stimmt immer noch: Der Name wird Teil von Klassennamen und
Einstellungswerten). Das Beispiel des Buchs: eZ Systems stellte seinen eigenen ein ez voran. Neue Namen in Exponential
verwenden exp (Die Erweiterung benennen).
Sie aktivieren
Legen Sie einen Ordner extension/<name> an und teilen Sie es dem System in einer Einstellungsdatei mit. Die
Einstellung des Buchs ist die, die heute verwendet wird, und sie hat eine zweite Form für einen einzelnen Siteaccess:
# settings/override/site.ini.append.php: for every siteaccess
[ExtensionSettings]
ActiveExtensions[]=newextension
# settings/siteaccess/<site>/site.ini.append.php: for one siteaccess only
[ExtensionSettings]
ActiveAccessExtensions[]=newextensionDie Reihenfolge der Liste ist wichtig, wenn zwei Erweiterungen dieselbe Einstellung oder dasselbe Template bereitstellen (Ladereihenfolge der Erweiterungen). Die Administration zeigt sie ebenfalls an und schaltet sie um (Die Seite Erweiterungen, Eine Erweiterung aktivieren).
Die Ordner
| Buch | Exponential 6 | Was er enthält |
|---|---|---|
actions/ | (selten verwendet) | Neue Aktionen für Formulare |
datatypes/ | datatypes/<type>/<type>type.php | Neue Datentypen (Datentypen) |
eventtypes/ | eventtypes/event/<type>/<type>type.php | Neue Workflow-Ereignistypen (Ereignistypen) |
modules/ | modules/<module>/module.php und View-Skripte | Neue Module und Views (Module und Views) |
settings/ | settings/ | Einstellungen der Erweiterung (Einstellungen in einer Erweiterung) |
translations/ | translations/<locale>/translation.ts | Übersetzungen |
| (keiner) | design/<design>/ | Templates, Stile, Bilder eines Designs (Ein Design in einer Erweiterung) |
| (keiner) | classes/ | Ihre PHP-Klassen, die über die Autoloads gefunden werden |
| (keiner) | autoloads/eztemplateautoload.php | Template-Operatoren und -Funktionen |
| (keiner) | cronjobs/, bin/php/ | Cronjob-Skripte und Kommandozeilenskripte |
| (keiner) | ezinfo.php, extension.xml | Name, Version und Lizenz (ezinfo.php) |
Den vollständigen Baum, mit dem, was der Kernel mit jedem Ordner tut, finden Sie unter Der Verzeichnisaufbau einer Erweiterung.
Führen Sie nach dem Hinzufügen einer Klasse php bin/php/ezpgenerateautoloads.php -e aus (Autoloads und Klassenbenennung).
Weiter: Die Bausteine einer Erweiterung.
Quelle und Lizenz
Bearbeitet nach Kapitel 5, „Extending eZ publish“, von Learning eZ publish: Building Content Management Solutions von Paul Borgermans, Tony Wood, Paul Forsyth, Martin Bauer, Björn Dieding und Ben Pirt (zusätzliches Material von Bruce Morrison), zweite Auflage, 2024, Book-Learning-eZPublish. Copyright (c) 2004-2024 7x und Graham Brookins. Lizenziert unter der GNU Free Documentation License, Version 1.3 oder einer späteren Version, ohne unveränderliche Abschnitte, ohne vordere und ohne hintere Umschlagtexte (die Lizenz). Änderungen: als Wegweiser zu den aktuellen Entwicklerseiten umgestellt; Ordnernamen, Einstellungen und Konstanten gegen Exponential 6 geprüft; SOAP durch die REST-API ersetzt.