content_version
Restores an earlier version of a content object or removes its old versions.
A step of a YAML migration with type: content_version. The class expMigrationStepContentVersion (kernel/classes/migration/steps/expmigrationstepcontentversion.php) is registered in settings/migration.ini [StepSettings] StepTypeList[content_version].
Modes
mode: is one of restore, cleanup; every step names one.
Keys
| Key | Type | Modes | Default | What it is |
|---|---|---|---|---|
object | identifier (object) | all | the object (or node:) | |
node | identifier (node) | all | a node of the object (or object:) | |
version | int | restore | the number of the version to restore (restore) | |
language | string | restore | restore only this language of the version (default: every language it has) | |
keep | int | cleanup | 0 | how many archived versions are kept, the newest (cleanup) |
drafts | bool | cleanup | false | true: the drafts of the object are removed too (cleanup) |
workflows | bool | restore | false | true: the workflows of the operation's triggers run, as in the administration (default: they do not) |
notify | bool | restore | 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 object |
version | its current version after the step |
removed | how many versions cleanup removed |
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): content.
Example
- type: content_version
mode: cleanup
object: remote:news-welcome
keep: 5Related
Generated by ./console exp:help:examples from settings/migration.ini, kernel/classes/migration/steps/expmigrationstepcontentversion.php. Do not edit this page: change the source and generate again (how). Free documentation: GFDL 1.3 or later.