Mercurial > hg > isophonics-drupal-site
annotate core/modules/migrate/src/Annotation/MigrateProcessPlugin.php @ 19:fa3358dc1485 tip
Add ndrum files
author | Chris Cannam |
---|---|
date | Wed, 28 Aug 2019 13:14:47 +0100 |
parents | 7a779792577d |
children |
rev | line source |
---|---|
Chris@0 | 1 <?php |
Chris@0 | 2 |
Chris@0 | 3 namespace Drupal\migrate\Annotation; |
Chris@0 | 4 |
Chris@0 | 5 use Drupal\Component\Annotation\Plugin; |
Chris@0 | 6 |
Chris@0 | 7 /** |
Chris@0 | 8 * Defines a migration process plugin annotation object. |
Chris@0 | 9 * |
Chris@0 | 10 * Plugin Namespace: Plugin\migrate\process |
Chris@0 | 11 * |
Chris@0 | 12 * For a working example, see |
Chris@0 | 13 * \Drupal\migrate\Plugin\migrate\process\DefaultValue |
Chris@0 | 14 * |
Chris@0 | 15 * @see \Drupal\migrate\Plugin\MigratePluginManager |
Chris@0 | 16 * @see \Drupal\migrate\Plugin\MigrateProcessInterface |
Chris@0 | 17 * @see \Drupal\migrate\ProcessPluginBase |
Chris@0 | 18 * @see \Drupal\migrate\Annotation\MigrateSource |
Chris@0 | 19 * @see \Drupal\migrate\Annotation\MigrateDestination |
Chris@0 | 20 * @see plugin_api |
Chris@0 | 21 * |
Chris@0 | 22 * @ingroup migration |
Chris@0 | 23 * |
Chris@0 | 24 * @Annotation |
Chris@0 | 25 */ |
Chris@0 | 26 class MigrateProcessPlugin extends Plugin { |
Chris@0 | 27 |
Chris@0 | 28 /** |
Chris@0 | 29 * A unique identifier for the process plugin. |
Chris@0 | 30 * |
Chris@0 | 31 * @var string |
Chris@0 | 32 */ |
Chris@0 | 33 public $id; |
Chris@0 | 34 |
Chris@0 | 35 /** |
Chris@0 | 36 * Whether the plugin handles multiples itself. |
Chris@0 | 37 * |
Chris@0 | 38 * Typically these plugins will expect an array as input and iterate over it |
Chris@12 | 39 * themselves, changing the whole array. For example the 'sub_process' and the |
Chris@0 | 40 * 'flatten' plugins. If the plugin only need to change a single value it |
Chris@0 | 41 * can skip setting this attribute and let |
Chris@0 | 42 * \Drupal\migrate\MigrateExecutable::processRow() handle the iteration. |
Chris@0 | 43 * |
Chris@0 | 44 * @var bool (optional) |
Chris@0 | 45 */ |
Chris@0 | 46 public $handle_multiples = FALSE; |
Chris@0 | 47 |
Chris@0 | 48 } |