Specification: the xrowextract extension #

This page is the reference for the xrowextract extension (content export, import, packages, schedules and delivery), release line 2.5 (2.5.0 to 2.5.6, September to October 2026). It lists every view, policy, setting, preset field, table, class and command line option. Read it when you configure exports for a site, grant permissions, or script exports. How to use it is on the feature page.

Example: export articles from the command line #

Run in the installation root (read-only for your content; it writes the output file):

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 runs the same command. Replace ng_article with a class identifier of your site. Exit code 0 means the file was written.

Module, views and policies #

Module xrowextract (modules/xrowextract/module.php), navigation part ezextractnavigationpart, top menu tab xrowextract (name "Export", menu.ini [Topmenu_xrowextract], URL xrowextract/csv).

Policy functions not bound to a single view: all_jobs (see and manage everyone's jobs and shared presets; without it a user sees only their own) and password_hash (export the hash and hash type of user accounts). A link to the contents browser is added to the kernel's own package/view/full/<name>.

Settings #

All keys are read with eZINI::instance( <file> ). Scope is the whole installation unless noted; override them in settings/override/<file>.append.php or in a siteaccess.

csv.ini #

export.ini #

xrowextract.ini #

Other files #

Preset definition #

Definition is one JSON object. Fields read by XrowExtractPreset::resolve(): scope, subtree, subtree_remote_id, class_id, class_identifier, mainnodeonly, limit, offset, languages, attributes, filters (an XrowExtractFilters values array), sort_field, sort_ascending, sort_field2, sort_ascending2, output_format, separator, line_separator, escape. A string may contain {name}; Placeholders is {"name": {"default": "..."}}. Extends is alias:<fetchalias name>[:<siteaccess>] or user:<id>. A person's own presets are stored as JSON in ezsite_data under the name xrowextract_preset_<20 hex>. The Audience groups are Site, Editors, Developers, Partners, Users and Maintenance; a preset without one is grouped under Site.

Tables #

Created on first use from share/db_schema.dba (the engine-neutral schema; sql/mysql, sql/oracle, sql/postgresql, sql/sqlite carry the same for a manual install).

Classes #

Since 2.5.5 the command line scripts, the cronjob part and the module views are classes that the files call (Exponential\Command\Extension\Xrowextract\...); see CLI, cronjob and view abstractions. Behaviour did not change.

Command line options #

ext:xrowextract:csv (extension/xrowextract/bin/php/csv.php) takes the options class, node, scope (node or all), depth and depth operator (eq, le, ge), main-only, offset, limit, columns, add, sets (identity, urls, publishing, location, migration), names, separator, line endings (win32/crlf, unix/lf, mac/cr), unquoted, languages, format (csv, json, xml, ezpkg), date filters (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 (- is stdout), preview, list-classes, list-columns, user, progress-file, keep, changed-since, lenient, no-manifest, schedule and run-mode.

Exit codes: 0 success, 1 failure (bad option, unresolvable class or node), 3 --lenient and nothing was left to export. Warnings are printed as WARNING: ... lines; with --output=- they go to stderr so stdout stays the file.

The check script bin/check.sh is the release gate (lint, translations, duplicate sources, PHPStan level 8, unit tests, requirements, CLI, view and POST tests); .github/workflows/check.yml runs it on PHP 8.1 to 8.5. It needs EXPONENTIAL_ROOT to point at an Exponential root.

Related pages #

• Feature page, behaviour changes of the extensions, CLI, cronjob and view abstractions
• Chronicle, release notes
• Months: 2024-01, 2024-02, 2024-03, 2024-04, 2024-07, 2024-08, 2026-03, 2026-09, 2026-10