ini.ini [IniCommandSettings] #

The block [IniCommandSettings] of settings/ini.ini, with 3 setting(s).

Never edit settings/ini.ini itself: an update replaces it. Put the settings you change in an override, which wins over the shipped file:

• settings/override/ini.ini.append.php for every siteaccess,
• settings/siteaccess/<siteaccess>/ini.ini.append.php for one siteaccess,
• extension/<extension>/settings/ini.ini.append.php in an extension (read when the extension is active).

Actions #

The actions of the command: Actions[<name>]=<class>. The class implements
expIniAction (kernel/classes/ini/actions/expiniaction.php): name(),
description(), usage() and run( expIniCommandContext $c ), which returns the
exit code. "exp:ini <name> ..." makes the class and runs it.

An extension adds an action by an INI append of its own, e.g.
extension/myext/settings/ini.ini.append.php:

[IniCommandSettings]
Actions[dump]=myExtIniActionDump

then regenerates the extension autoloads (php bin/php/ezpgenerateautoloads.php -e)
so the class is found. The same name as a built-in replaces the built-in;
an empty value (Actions[copy]=) switches an action off.

Default: a hash of 13: get=expIniActionGet, set=expIniActionSet, add=expIniActionAdd, rem=expIniActionRem, clear=expIniActionClear, toggle=expIniActionToggle, copy=expIniActionCopy, move=expIniActionMove, move-all=expIniActionMoveAll, where=expIniActionWhere, list=expIniActionList, scopes=expIniActionScopes ....

<?php /* #?ini charset="utf-8"?
# settings/override/ini.ini.append.php
[IniCommandSettings]
# an empty "Actions[]" first replaces the shipped list; without it the items are added
Actions[]
Actions[get]=expIniActionGet
Actions[set]=expIniActionSet
Actions[add]=expIniActionAdd
Actions[rem]=expIniActionRem
Actions[clear]=expIniActionClear
Actions[toggle]=expIniActionToggle
Actions[copy]=expIniActionCopy
Actions[move]=expIniActionMove
Actions[move-all]=expIniActionMoveAll
Actions[where]=expIniActionWhere
Actions[list]=expIniActionList
Actions[scopes]=expIniActionScopes
Actions[actions]=expIniActionActions
*/ ?>

ActionAliases #

Other names of actions: ActionAliases[<alias>]=<action name>.

Default: a hash of 1: remove=rem.

<?php /* #?ini charset="utf-8"?
# settings/override/ini.ini.append.php
[IniCommandSettings]
# an empty "ActionAliases[]" first replaces the shipped list; without it the items are added
ActionAliases[]
ActionAliases[remove]=rem
*/ ?>

ScopeProviders #

The scope providers: classes implementing expIniScopeProvider
(kernel/classes/ini/expiniscopeprovider.php), whose scopes( $root ) returns
expIniScope objects. The two built-ins give global, default, every siteaccess,
every extension and every extension siteaccess directory. An extension adds a
scope (a cluster-wide directory, one per environment, ...) by an INI append:

[IniCommandSettings]
ScopeProviders[]=myExtIniScopeProvider

The first scope of a name wins, so a provider cannot take over a built-in one.

Default: a list of 2: expIniCoreScopeProvider, expIniExtensionScopeProvider.

<?php /* #?ini charset="utf-8"?
# settings/override/ini.ini.append.php
[IniCommandSettings]
# an empty "ScopeProviders[]" first replaces the shipped list; without it the items are added
ScopeProviders[]
ScopeProviders[]=expIniCoreScopeProvider
ScopeProviders[]=expIniExtensionScopeProvider
*/ ?>

Related #

• All blocks of ini.ini
• All INI files
• The settings page

Generated by ./console exp:help:examples from settings/ini.ini. Do not edit this page: change the source and generate again (how). Free documentation: GFDL 1.3 or later.