user_group
Creates, updates, ensures or deletes a user group, with its name and description in one or more languages.
A step of a YAML migration with type: user_group. The class expMigrationStepUserGroup (kernel/classes/migration/steps/expmigrationstepusergroup.php) is registered in settings/migration.ini [StepSettings] StepTypeList[user_group].
Modes
mode: is one of create, update, ensure, delete; every step names one.
Keys
| Key | Type | Modes | Default | What it is |
|---|---|---|---|---|
parent | identifier (node) | create, ensure | the node of the group the new group is in (create, ensure) | |
group | identifier (object) | update, delete | the group to update or delete: an object identifier (remote:<remote id>, id, path:) | |
remote_id | string | create, ensure | the remote id of a new group; ensure finds the group by it | |
class | identifier (class) | create, ensure | "user_group" | the class of a new group (default: user_group) |
language | string | create, update, ensure | the language of name: and description: (default: the default language of content) | |
name | string | create, update, ensure | the name of the group | |
description | string | create, update, ensure | the description of the group | |
names | map | create, update, ensure | language => the name of the group in it: its translations | |
fields | map | create, update, ensure | further attributes of the class: attribute identifier => value | |
missing | string: fail, skip | update, delete | "fail" | what happens when the group is not there: fail (the default) or skip |
workflows | bool | create, update, ensure | false | true: the workflows of the operation's triggers run, as in the administration (default: they do not) |
notify | bool | create, update, ensure | false | true: the publish makes a notification event (default: published without notification) |
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 |
|---|---|
object_id | the id of the group's object |
node_id | the id of its main node (the parent: of users and groups in it) |
remote_id | its remote id |
name | its name |
created | true when the step created the group |
changed | true when the step changed it (created, updated or deleted) |
Undoing
Some steps of this type undo themselves when their migration is rolled back without down: (the class says which); a migration with any other step of it needs down: or a rollback to its caption.
Caches it touches (cleared after the run): content.
Example
- type: user_group
mode: ensure
parent: 5
remote_id: news-editors
name: News editors
names: { ger-DE: Nachrichtenredaktion }
references: { editors: node_id, editors_object: object_id }Related
Generated by ./console exp:help:examples from settings/migration.ini, kernel/classes/migration/steps/expmigrationstepusergroup.php. Do not edit this page: change the source and generate again (how). Free documentation: GFDL 1.3 or later.