settings
Changes one INI file of settings/override or settings/siteaccess/<name> through the INI editor, with a backup.
A step of a YAML migration with type: settings. The class expMigrationStepSettings (kernel/classes/migration/steps/expmigrationstepsettings.php) is registered in settings/migration.ini [StepSettings] StepTypeList[settings].
Keys
| Key | Type | Default | What it is |
|---|---|---|---|
file | string | required | the INI file: site.ini, content.ini ... |
siteaccess | string | the siteaccess (settings/siteaccess/<name>); without: settings/override | |
set | map | block => variable => value (a list: the array; a map: hash keys) | |
add | map | block => variable => values added to the array | |
remove | map | block => list of Var, Var[key] or Var[]=value |
Besides these, every step takes the keys of the engine: type, mode, if, references, environments, engines and comment (the file format). A key of type identifier names a node, an object or another part of the installation by id, remote id, path or name (identifiers).
Values for references
references: { <name>: <value> } keeps a value of the step's result as ${ref.<name>} for the steps and migrations after it:
| Value | What it is |
|---|---|
file | the file written, relative to the installation |
changed | true when the file changed |
Undoing
A step of this type does not undo itself: a migration with it needs down: or a rollback to its caption.
Caches it touches (cleared after the run): tag:ini.
Example
- type: settings
file: site.ini
siteaccess: admin
set:
SiteSettings:
DefaultPage: content/dashboardRelated
Generated by ./console exp:help:examples from settings/migration.ini, kernel/classes/migration/steps/expmigrationstepsettings.php. Do not edit this page: change the source and generate again (how). Free documentation: GFDL 1.3 or later.