Pakete importieren und exportieren #

Diese Seite ist für Integratoren, die Struktur und Inhalte zwischen Installationen übertragen: Inhaltsklassen von einer Entwicklungs- auf eine Produktionswebsite, einen Beispielteilbaum für eine Demo, die Startinhalte einer neuen Website oder einen anderswo vorbereiteten Migrationsstapel. Ein Paket (.ezpkg, ein gzip-komprimiertes Tar-Archiv) kann Inhaltsklassen, Inhaltsobjekte mit ihren Dateien, Template-Overrides und Einstellungen enthalten. Die Seite der Administration steht in Pakete; auf der Kommandozeile ist es ezpm.php (ezpm: der Paketmanager auf der Kommandozeile).

Inhalt #

1. Wofür Pakete in einer Integration gut sind
2. Einen Teilbaum exportieren
3. Ein Paket installieren
4. Das JSON-Paketformat für Werkzeuge
5. Remote-IDs in Paketen
6. Vorsicht

Wofür Pakete in einer Integration gut sind #

Einen Teilbaum exportieren #

Führen Sie dies im Wurzelverzeichnis der Installation aus (als root mit --allow-root-user):

php ezpm.php create mypackage 'Starting content for the product area' 1.0.0 install
php ezpm.php add mypackage ezcontentsubtree /products --exclude-templates --language=eng-US
php ezpm.php export mypackage -d var/tmp

add ezcontentobject (Alias ezcontentsubtree) nimmt eine Knoten-ID oder einen URL-Pfad und die Optionen --include-classes/--exclude-classes, --include-templates/--exclude-templates, --node-main/--node-selected, --siteaccess=, --language=, --current-version/--all-versions und --minimal-template-set. Die Konsole kennt dasselbe Werkzeug als php bin/php/console ezpm.

Ein Paket installieren #

php ezpm.php import var/tmp/mypackage-1.0.0-1.ezpkg        # into the package repository, with the archive checks
php ezpm.php install mypackage --destination-node-id 61    # objects below node 61 (default: node 2)
php bin/php/updatesearchindex.php --allow-root-user        # the installer delays indexing
php bin/php/ezcache.php --clear-all --allow-root-user

Was Sie über das Installationsprogramm wissen sollten:

• Ein Lauf zur Zeit: install und add setzen eine Sperre (ezpm.lock im var-Verzeichnis).
• Commits in Stapeln alle 50 Objekte, damit große Pakete nicht für den ganzen Lauf Sperren halten; ein fehlgeschlagenes Objekt wird mit seiner Remote-ID genannt.
• Keine Duplikate: Wiederholte Elemente werden einmal installiert.
• Die Suchindizierung wird verzögert während des Laufs: Bauen Sie den Index danach neu auf.
• Abhängigkeiten zuerst: Unter requires aufgeführte Pakete werden vor dem Paket installiert.
• Nicht interaktive Läufe überspringen das zerstörerische Ersetzen von Klassen, sodass eine unbeaufsichtigte Installation nie eine Klasse ersetzt.

Das JSON-Paketformat für Werkzeuge #

ezpm.php export --format=json schreibt dasselbe Paket als JSON (package.json, Dokumente als JsonML, SHA-256 jeder Datei), und install --as-drafts installiert Objekte als Entwürfe zur Prüfung. convert, validate und check arbeiten mit JSON-Paketen. Ein eigenes Werkzeug oder ein Skript auf Seite des Kunden kann ein Paket in diesem Format erzeugen und es vor der Übergabe gegen share/package/schema/package-v1.json prüfen (Das JSON-Paketformat).

Remote-IDs in Paketen #

Objekte in einem Paket tragen ihre Remote-IDs (ein Dokument pro Objekt heißt object-<remote id>.xml). Dadurch kann ein Paket, das in mehreren Installationen installiert wird, Objekte erzeugen, die derselbe Import später mit eZContentObject::fetchByRemoteID() findet, obwohl ihre Objekt-IDs sich unterscheiden.

Vorsicht #

• Installieren Sie zuerst in eine Kopie. Das Installationsprogramm schreibt Inhalte und Klassen.
• Legen Sie nie Zugangsdaten in ein Paket. Ein Paket ist eine Datei, die zwischen Installationen und Menschen wandert.
• Upload-Grenzen. Die Upload-Seite weist Archive mit Links oder Pfaden außerhalb des Pakets ab; bauen Sie Archive mit ezpm export, nicht von Hand.
• Klassen sind der Vertrag Ihrer Integration. Liefern Sie Klassenänderungen als neue Paketversion zusammen mit der Version der Erweiterung aus, die sie braucht, und schreiben Sie beides in die Release Notes.

Verwandte Seiten #

• Pakete
• ezpm: der Paketmanager auf der Kommandozeile
• In ein Paket hineinsehen, es vergleichen, einzelne Elemente importieren
• Pakete und ezpkg für App-Ersteller
• Massendatenaustausch mit xrowextract
• Freie Dokumentation: Diese Seite darf unter der GNU FDL 1.3 frei kopiert, übersetzt und verbessert werden.