Skip to the content
Documentation

exp:collaborationsampledata

No ratings yet

Available since Exponential 6.0.15 (in development, not in a release yet).

Summary

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

Usage

./console exp:collaborationsampledata [options]
php bin/php/collaborationsampledata.php [options]
./console exp:collaboration:sample-data [options]

Aliases

exp:collaboration:sample-data

Help

The output of ./console help exp:collaborationsampledata (the script run with --help), without the standard options:

Usage: bin/php/collaborationsampledata.php [OPTION]...
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:
  --apply    Make the changes (the default is a dry run that shows them and changes nothing)
  --dry-run  The default, kept for scripts that pass it: show what would be done and change nothing
  --remove   Delete the sample data (and only that)

Options

Option Value Description
--apply - Make the changes (the default is a dry run that shows them and changes nothing)
--dry-run - The default, kept for scripts that pass it: show what would be done and change nothing
--remove - Delete the sample data (and only that)

Standard options

Every script also takes the standard options of the script framework: --help, --quiet, --siteaccess, --debug, --colors, --no-colors, --logfiles, --no-logfiles, --verbose and --allow-root-user.

Source

bin/php/collaborationsampledata.php, kernel/private/classes/commands/collaborationsampledata.php

See also

Generated example: exp:collaborationsampledata

Added to the reference for Exponential 6.0.15.

Contributors

Comments

Add a comment

Comments are read by a moderator before they appear.