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

exp:collaborationsampledata

Build sample content for the collaboration tool (approvals, comments, groups), or remove it again (dry run unless --apply).

Download as PDF

Address: https://doc.exponential.earth/exphelp/viewer/examples/commands/collaborationsampledata.md

On this page

exp:collaborationsampledata

Build sample content for the collaboration tool (approvals, comments, groups), or remove it again (dry run unless --apply).

Script bin/php/collaborationsampledata.php, code in kernel/private/classes/commands/collaborationsampledata.php. Run it from the installation root, as the user the web server runs as:

./console exp:collaborationsampledata --help
./console exp:collaboration:sample-data --help
php bin/php/collaborationsampledata.php --help

Help text

Collaboration sample data
Builds a realistic set for the collaboration tool: the user group "Editors (sample)" with three
editors (e-mail addresses on example.invalid, random passwords that are not shown), the workflow
"Approval (sample)" that only reaches the section "Sample: collaboration", a folder in that
section and articles that wait for approval, were approved or were denied, with comment threads.
Everything is made through the kernel's own approval workflow and handler, and is marked
(names start with "Sample: ", remote ids with "sample-collab-") so --remove deletes exactly it.
The command is idempotent: what exists is left as it is.
Without --apply nothing is changed: the command lists what it would create (or, with --remove,
delete). --dry-run means the same as no flag; --apply together with --dry-run is a usage error
(exit 2).

./console exp:collaboration:sample-data
./console exp:collaboration:sample-data --apply
./console exp:collaboration:sample-data --remove --apply

Options

OptionValueHelp
--applyMake the changes (the default is a dry run that shows them and changes nothing)
--dry-runThe default, kept for scripts that pass it: show what would be done and change nothing
--removeDelete the sample data (and only that)

Read from the option definitions in the code (startup(), getOptions(), options() or ezcConsoleOption). Every script also takes the standard options of the script framework (--help, --siteaccess, --debug, --quiet, --allow-root-user ...).


Generated by ./console exp:help:examples from bin/php/collaborationsampledata.php, kernel/private/classes/commands/collaborationsampledata.php. Do not edit this page: change the source and generate again (how). Free documentation: GFDL 1.3 or later.

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