cache
Clears caches of ezcache by id or tag and the view caches of single objects, at once or after the run.
A step of a YAML migration with type: cache. The class expMigrationStepCache (kernel/classes/migration/steps/expmigrationstepcache.php) is registered in settings/migration.ini [StepSettings] StepTypeList[cache].
Keys
| Key | Type | Default | What it is |
|---|---|---|---|
caches | list | ids of ezcache: content, template-block, exphttpcache, template-override ... | |
tags | list | tags of ezcache: ini, template, content, image ... (every cache with the tag) | |
objects | list | objects (id, remote:, path:) whose content view caches are cleared | |
when | string: end, now | "end" | end: cleared once after the run with the caches of the other steps; now: cleared at once |
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 |
|---|---|
caches | the ids and tags the step clears (or leaves for the end), comma-separated |
objects | how many objects had their view caches cleared |
Undoing
Every step of this type undoes itself when its migration is rolled back without down:.
It touches no cache.
Example
- type: cache
caches: [ template-block ]
tags: [ ini ]
objects: [ "remote:home" ]
when: nowRelated
Generated by ./console exp:help:examples from settings/migration.ini, kernel/classes/migration/steps/expmigrationstepcache.php. Do not edit this page: change the source and generate again (how). Free documentation: GFDL 1.3 or later.