Pflichtfelder in package.xml
Diese Seite ist für Entwickler, die die package.xml eines Seitenpakets von Hand schreiben oder bearbeiten. Sie führt auf, ohne was der Code
ein Paket abweist, und warum, damit ein Paket nicht bei der ersten Installation scheitert, die es nutzt. Die Bedeutung jedes Elements
steht in Referenz zu package.xml; diese Seite behandelt nur, was vorhanden sein muss und in welcher
Form.
Inhalt
- Was jeder Import prüft
- Der Name
- Version, Release und Typ
- Der Hersteller
- Die Elemente ezpublish und packaging
- Was nicht geprüft wird
- Eine minimale Definition, die besteht
- Verwandte Seiten
Was jeder Import prüft
Jeder Weg, ein Paket zu importieren, geht durch eZPackage::import() in kernel/classes/ezpackage.php: der Download und das Hochladen im
Setup-Assistenten, php ezpm.php import und package/upload in der Administration. Es liest die Definition und hält an, wenn:
| Problem | Ergebnis |
|---|---|
Keine package.xml oder package.json als einfache Datei oben im Archiv | Die Definition lässt sich nicht lesen, der Import scheitert |
Kein <name> oder ein leerer | A package definition without a name was not read im Debug-Log |
| Eine Version, ein Release oder ein Typ, die kein einfaches Token sind | A package definition with an invalid version / release / type was not read |
Ein Name, den die Transformation identifier ändern würde | STATUS_INVALID_NAME: „Der Paketname ... ist ungültig, konnte das Paket nicht importieren“ |
| Ein Paket dieses Namens ist bereits importiert | STATUS_ALREADY_EXISTS: „Paket ... existier bereits, kann Paket nicht importieren“ |
| Der Hersteller ergibt keinen brauchbaren Verzeichnisnamen | The package ... names no usable repository, not imported |
Die Seite zum Hochladen in der Administration prüft mehr, bevor irgendetwas entpackt wird (eZPackageUploadInspector::definition()); siehe
Die Elemente ezpublish und packaging.
Der Name
Erzwungen. eZPackage::isValidName() akzeptiert einen Namen, der:
- nur Buchstaben in Groß- oder Kleinschreibung (
abisz,AbisZ), Ziffern0bis9,_und-hat; - nicht mit
-beginnt und höchstens 200 Zeichen lang ist; - also kein Leerzeichen, keinen Punkt, keinen
/, keinen umgekehrten Schrägstrich und kein Steuerzeichen enthält: nichts, was einen Pfad bilden könnte.
Der Name ist das Verzeichnis des Pakets und bleibt, wie er ist, sodass infoProf und infoprof auf einem Dateisystem, das
Groß- und Kleinschreibung unterscheidet, zwei Pakete sind. Pakete, die eZ Publish 4.x mit der Schreibweise ihrer Inhaltsklasse
exportierte (RSSFeed_content_class, infoProf), werden so importiert, wie sie sind. Die Assistenten zum Erstellen von Paketen
schlagen weiterhin einen Namen aus Kleinbuchstaben, Ziffern und _ vor (die Transformation identifier aus settings/transform.ini).
| Name | Gültig | Warum |
|---|---|---|
sevenx_multisite | ja | |
cjw_multisite_democontent | ja | |
MySite | ja | |
my-site | ja | |
-site | nein | führendes - |
my.site | nein | Punkt |
my site | nein | Leerzeichen |
Das Hochladen in der Administration wendet außerdem eZPackageRequestGuard::isSafeName() an, das den Namen auf 200 Zeichen begrenzt. Der
Assistent zum Erstellen von Paketen weist einen ungültigen Namen mit „Der Paketname %packagename ist nicht gültig. Er kann nur Zeichen von
a-z, 0-9 und Unterstriche enthalten.“ ab (kernel/classes/ezpackagecreationhandler.php).
Tipp Namen sind auf einer Installation global: Ein Import wird abgewiesen, wenn irgendein Repository bereits ein Paket dieses Namens enthält. Stellen Sie Ihren Paketen einen eigenen kurzen Namen voran (wie
sevenx_undcjw_es tun), statt einen ausgelieferten Namen wiederzuverwenden.
Version, Release und Typ
Erzwungen. Seit der Prüfung vom 15. Oktober 2026 weist eZPackage::parseDOMTree() eine Definition ab, deren <version><number>,
<version><release> oder <type value="..."> kein einfaches Token ist (eZPackage::isValidDefinitionToken()): leer oder 1 bis 64 Zeichen
aus 0-9 A-Z a-z . _ + -. Leerraum um den Wert wird vorher entfernt.
| Wert | Akzeptiert |
|---|---|
6.0 | ja |
15-stable | ja |
1.0.0-beta.1+20261018 | ja |
6.0 final | nein, Leerzeichen |
<b>1.0</b> | nein, Markup |
Wie die Version aussehen sollte, steht auf Versionsnummern. Für ein Seitenpaket muss der Typ außerdem genau site sein,
sonst führt der Setup-Assistent es nicht auf (Pakettypen).
Der Hersteller
Erzwungen. <vendor> wird nach der Transformation urlalias zum Repository-Verzeichnis unter var/storage/packages/; ohne Hersteller
geht das Paket nach local. Ein Hersteller, der keinen brauchbaren Verzeichnisnamen übrig lässt (zum Beispiel ..), wird abgewiesen. Die
ausgelieferten Pakete sagen alle <vendor>7x</vendor>, den Wert von [RepositorySettings] Vendor in settings/package.ini, und landen so
in var/storage/packages/7x/.
Die Elemente ezpublish und packaging
Erzwungen bei package/upload. Der Upload-Inspektor weist eine Definition ab, die kein Element <ezpublish> oder kein Element
<packaging> hat, mit der Meldung, dass der package.xml des Archivs ihre Versions- oder Paketierungsangaben fehlen
(definition_incomplete). Er weist auch ein anderes Wurzelelement als <package> und jeden DOCTYPE ab. Der eigene Download des
Setup-Assistenten führt diese Prüfung nicht aus, sodass ein Paket ohne sie sich über den Assistenten installieren lässt und dennoch von der
Seite zum Hochladen abgewiesen wird.
<ezpublish>
<version>6.0.15-stable</version>
<named-version>6.0</named-version>
</ezpublish>
<packaging>
<timestamp>1705211779</timestamp>
<host>packages.example.com</host>
</packaging><ezpublish> ist der Name, den das Format schon immer für die Produktversion nutzt; Exponential behält ihn, wie er ist.
Was nicht geprüft wird
Diese werden gelesen und gezeigt, aber nichts weist ein Paket ab, weil sie fehlen. Alle sind Konventionen der ausgelieferten Pakete:
| Element | Ausgelieferte Pakete von 7x | Wo es erscheint |
|---|---|---|
<summary> | immer | Paketliste, Paketseite, Setup-Assistent |
<description> | immer | Paketseite, Setup-Assistent |
Attribut install_type | import für Seiten- und Seitenstil-Pakete, install für die anderen | Paketseite (Importiert oder Installieren) |
<licence>, <state> | GPL, stable | Paketseite |
<maintainers> | 15 von 16 | Paketseite |
Die Attribute version und is_active von <package> (die ausgelieferten Pakete schreiben version="6.0.15-0" oder version="3.5.2")
liest parseDOMTree() nicht. Wenn der Kernel ein Paket schreibt, setzt er dort die Formatversion 3.5.2 (eZPackage::VERSION).
Eine minimale Definition, die besteht
Diese besteht jede Prüfung oben, einschließlich der Seite zum Hochladen. Sie ist die Untergrenze, nicht die Empfehlung: Die ausgelieferten Pakete bringen auch alles mit, was unter Was nicht geprüft wird aufgeführt ist.
<package version="3.5.2" development="false" install_type="import">
<name>example_site</name>
<summary>Example site</summary>
<vendor>example</vendor>
<type value="site" />
<ezpublish>
<version>6.0.15-stable</version>
<named-version>6.0</named-version>
</ezpublish>
<packaging>
<timestamp>1791331200</timestamp>
<host>packages.example.com</host>
</packaging>
<version>
<number>1.0.0</number>
<release>1</release>
</version>
</package>Verwandte Seiten
- Anforderungen an die Dokumentation von Seitenpaketen
- Die Checkliste der Anforderungen
- Referenz zu package.xml
- Ein Paket vor der Veröffentlichung prüfen
- Ihr Seitenpaket beitragen
- Seitenpakete: hier beginnen
- Freie Dokumentation: Diese Seite darf unter der GNU FDL 1.3 frei kopiert, übersetzt und verbessert werden.
Werden Sie Exponential-Partner
Partner teilen ihre Informationen, stellen Mittel bereit, geben Beiträge zurück und entwickeln die Produkte mit uns, und so wächst Exponential. Eine Partner-Website und ein Dashboard sind für Mitte 2027 geplant: Werden Sie noch heute Partner, damit wir schneller wachsen und neue Funktionen früher liefern.