content_class_group
Creates, renames, ensures or deletes a group of content classes.
A step of a YAML migration with type: content_class_group. The class expMigrationStepContentClassGroup (kernel/classes/migration/steps/expmigrationstepcontentclassgroup.php) is registered in settings/migration.ini [StepSettings] StepTypeList[content_class_group].
Modes
mode: is one of create, update, ensure, delete; every step names one.
Keys
| Key | Type | Modes | Default | What it is |
|---|---|---|---|---|
group | identifier (class_group) | update, delete | the group to rename or delete: its name or id | |
name | string | create, update, ensure | the name of the group (update: its new name) | |
missing | string: fail, skip | update, delete | "fail" | what happens when the group is not there: fail (the default) or skip |
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 |
|---|---|
group_id | the id of the group |
name | its name |
created | true when the step created the group |
changed | true when the step changed it (created, renamed 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): classid.
Example
- type: content_class_group
mode: ensure
name: News
references: { news_group: group_id }Related
Generated by ./console exp:help:examples from settings/migration.ini, kernel/classes/migration/steps/expmigrationstepcontentclassgroup.php. Do not edit this page: change the source and generate again (how). Free documentation: GFDL 1.3 or later.