Spezifikation: die Extension xrowextract #

Diese Seite ist die Referenz für die Extension xrowextract (Export und Import von Inhalten, Pakete, Zeitpläne und Zustellung), Release-Linie 2.5 (2.5.0 bis 2.5.6, September bis Oktober 2026). Sie führt jede View, jede Richtlinie, jede Einstellung, jedes Feld einer Vorlage, jede Tabelle, jede Klasse und jede Kommandozeilenoption auf. Lesen Sie sie, wenn Sie Exporte für eine Site einrichten, Berechtigungen vergeben oder Exporte per Skript ausführen. Wie Sie die Extension benutzen, steht auf der Funktionsseite.

Beispiel: Artikel über die Kommandozeile exportieren #

Im Wurzelverzeichnis der Installation ausführen (für Ihre Inhalte nur lesend; geschrieben wird nur die Ausgabedatei):

php extension/xrowextract/bin/php/csv.php --list-classes --node=2                 # classes below node 2
php extension/xrowextract/bin/php/csv.php --list-columns --class=ng_article       # columns of one class
php extension/xrowextract/bin/php/csv.php --class=ng_article --node=2 --preview=10 # first 10 rows on screen
php extension/xrowextract/bin/php/csv.php --class=ng_article --node=2 --output=articles.csv

./console ext:xrowextract:csv führt denselben Befehl aus. Ersetzen Sie ng_article durch einen Klassen-Identifier Ihrer Site. Der Exit-Code 0 bedeutet, dass die Datei geschrieben wurde.

Modul, Views und Richtlinien #

Modul xrowextract (modules/xrowextract/module.php), Navigationsteil ezextractnavigationpart, Reiter im oberen Menü xrowextract (Name „Export“, menu.ini [Topmenu_xrowextract], URL xrowextract/csv).

Richtlinienfunktionen, die an keine einzelne View gebunden sind: all_jobs (die Jobs und geteilten Vorlagen aller sehen und verwalten; ohne sie sieht ein Benutzer nur seine eigenen) und password_hash (Hash und Hash-Typ von Benutzerkonten exportieren). Ein Link zum Browser für Paketinhalte wird in die kernel-eigene View package/view/full/<name> eingefügt.

Einstellungen #

Alle Schlüssel werden mit eZINI::instance( <file> ) gelesen. Sie gelten für die ganze Installation, sofern nicht anders angegeben; überschreiben Sie sie in settings/override/<file>.append.php oder in einem Siteaccess.

csv.ini #

export.ini #

xrowextract.ini #

Weitere Dateien #

Definition einer Vorlage #

Definition ist ein JSON-Objekt. Von XrowExtractPreset::resolve() gelesene Felder: scope, subtree, subtree_remote_id, class_id, class_identifier, mainnodeonly, limit, offset, languages, attributes, filters (ein Werte-Array von XrowExtractFilters), sort_field, sort_ascending, sort_field2, sort_ascending2, output_format, separator, line_separator, escape. Eine Zeichenkette darf {name} enthalten; Placeholders ist {"name": {"default": "..."}}. Extends ist alias:<fetchalias name>[:<siteaccess>] oder user:<id>. Die eigenen Vorlagen einer Person werden als JSON in ezsite_data unter dem Namen xrowextract_preset_<20 hex> gespeichert. Die Audience-Gruppen sind Site, Editors, Developers, Partners, Users und Maintenance; eine Vorlage ohne Gruppe wird unter Site eingeordnet.

Tabellen #

Bei der ersten Verwendung aus share/db_schema.dba angelegt (dem engine-neutralen Schema; sql/mysql, sql/oracle, sql/postgresql und sql/sqlite enthalten dasselbe für eine manuelle Installation).

Klassen #

Seit 2.5.5 sind die Kommandozeilenskripte, der Cronjob-Teil und die Modul-Views Klassen, die von den Dateien aufgerufen werden (Exponential\Command\Extension\Xrowextract\...); siehe Abstraktionen für CLI, Cronjobs und Views. Das Verhalten hat sich nicht geändert.

Kommandozeilenoptionen #

ext:xrowextract:csv (extension/xrowextract/bin/php/csv.php) nimmt die Optionen class, node, scope (node oder all), depth und den Tiefen-Operator (eq, le, ge), main-only, offset, limit, columns, add, sets (identity, urls, publishing, location, migration), names, separator, Zeilenenden (win32/crlf, unix/lf, mac/cr), unquoted, languages, format (csv, json, xml, ezpkg), Datumsfilter (date-field, since, before, date), section, state, visibility, name, where, sort, order, sort2, order2, extended-filter, extended-params, fetch-alias, alias-param, preset, param, list-presets, show-preset, output (- ist stdout), preview, list-classes, list-columns, user, progress-file, keep, changed-since, lenient, no-manifest, schedule und run-mode entgegen.

Exit-Codes: 0 Erfolg, 1 Fehler (ungültige Option, nicht auflösbare Klasse oder nicht auflösbarer Knoten), 3 --lenient und es blieb nichts zu exportieren. Warnungen werden als Zeilen WARNING: ... ausgegeben; mit --output=- gehen sie nach stderr, damit stdout die Datei bleibt.

Das Prüfskript bin/check.sh ist die Freigabeprüfung der Release (Lint, Übersetzungen, doppelte Quellen, PHPStan Level 8, Unit-Tests, Voraussetzungen, CLI-, View- und POST-Tests); .github/workflows/check.yml führt es auf PHP 8.1 bis 8.5 aus. Es braucht EXPONENTIAL_ROOT, das auf ein Exponential-Wurzelverzeichnis zeigt.

Siehe auch #

• Funktionsseite, Verhaltensänderungen der Extensions, Abstraktionen für CLI, Cronjobs und Views
• Chronik, Release Notes
• Monate: 2024-01, 2024-02, 2024-03, 2024-04, 2024-07, 2024-08, 2026-03, 2026-09, 2026-10