Skip to the content
Documentation
Help Start
Reading in:
  • German: 9,090 of 9,090 pages
About the help in other languages
All help pages

Pflichtfelder in package.xml

Die Felder von package.xml, ohne die der Code ein Paket abweist, mit den genauen Regeln für den Namen, die Tokens für Version und Typ, den Hersteller, die Elemente ezpublish und packaging, und die Felder, die…

Download as PDF

Address: https://doc.exponential.earth/exphelp/viewer/help/site-packages/requirements/package-xml-required-fields.md

On this page

This page is a translation. Read the English original

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

  1. Was jeder Import prüft
  2. Der Name
  3. Version, Release und Typ
  4. Der Hersteller
  5. Die Elemente ezpublish und packaging
  6. Was nicht geprüft wird
  7. Eine minimale Definition, die besteht
  8. 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:

ProblemErgebnis
Keine package.xml oder package.json als einfache Datei oben im ArchivDie Definition lässt sich nicht lesen, der Import scheitert
Kein <name> oder ein leererA package definition without a name was not read im Debug-Log
Eine Version, ein Release oder ein Typ, die kein einfaches Token sindA package definition with an invalid version / release / type was not read
Ein Name, den die Transformation identifier ändern würdeSTATUS_INVALID_NAME: „Der Paketname ... ist ungültig, konnte das Paket nicht importieren“
Ein Paket dieses Namens ist bereits importiertSTATUS_ALREADY_EXISTS: „Paket ... existier bereits, kann Paket nicht importieren“
Der Hersteller ergibt keinen brauchbaren VerzeichnisnamenThe 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 (a bis z, A bis Z), Ziffern 0 bis 9, _ 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).

NameGültigWarum
sevenx_multisiteja
cjw_multisite_democontentja
MySiteja
my-siteja
-siteneinführendes -
my.siteneinPunkt
my siteneinLeerzeichen

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_ und cjw_ 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.

WertAkzeptiert
6.0ja
15-stableja
1.0.0-beta.1+20261018ja
6.0 finalnein, 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:

ElementAusgelieferte Pakete von 7xWo es erscheint
<summary>immerPaketliste, Paketseite, Setup-Assistent
<description>immerPaketseite, Setup-Assistent
Attribut install_typeimport für Seiten- und Seitenstil-Pakete, install für die anderenPaketseite (Importiert oder Installieren)
<licence>, <state>GPL, stablePaketseite
<maintainers>15 von 16Paketseite

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.

<?xml version="1.0" encoding="UTF-8"?>
<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

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.

Something wrong on this page? Report an error

Documentation license

This documentation is free documentation, licensed under the GNU Free Documentation License 1.3 or later.

Exponential Copyright © 1998-2026 Exponential Foundation and 7x