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:addexphelpreadpolicy

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

Download as PDF

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

On this page

exp:addexphelpreadpolicy

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

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

./console exp:addexphelpreadpolicy --help
./console exp:help-grant --help
php bin/php/addexphelpreadpolicy.php --help

Help text

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

OptionValueHelp
--applyWrite the changes (the default is a dry run that lists them and changes nothing)
--dry-runThe default, kept for scripts that pass it: list what would be granted, change nothing
--rolerequiredThis role (ID or name), may be repeated; the Editor role when none is named

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