exp:addexphelpreadpolicy

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

Summary

Grant exphelp/read (the help system) to the Editor role or the roles named (dry run unless --apply)

Usage

./console exp:addexphelpreadpolicy [options]
php bin/php/addexphelpreadpolicy.php [options]

Help

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

Usage: bin/php/addexphelpreadpolicy.php [OPTION]...
Grant the policy exphelp/read, reading the help system, to the Editor role or to the roles
named with --role, so editors see the Help control and the help pages. New installations give it
to the Editor role; administrators have it through their */* policy. Roles that have it already
are left alone; the script can run again. Prints PASS or FAIL at the end.
Without --apply nothing is written: the script lists the roles it would grant the policy to.
--dry-run is still accepted and means the same as no flag; --apply together with --dry-run is a
usage error (exit 2).

Example: php bin/php/addexphelpreadpolicy.php
         php bin/php/addexphelpreadpolicy.php --apply
         php bin/php/addexphelpreadpolicy.php --apply --role=Editor --role=5


Options:
  --apply          Write the changes (the default is a dry run that lists them and changes nothing)
  --dry-run        The default, kept for scripts that pass it: list what would be granted, change nothing
  --role=VALUE...  This role (ID or name), may be repeated; the Editor role when none is named

Options

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/addexphelpreadpolicy.php, kernel/private/classes/commands/addexphelpreadpolicy.php

See also

Generated example: exp:addexphelpreadpolicy

Added to the reference for Exponential 6.0.15.