Mercurial > hg > cmmr2012-drupal-site
diff core/modules/migrate/src/Annotation/MigrateProcessPlugin.php @ 0:c75dbcec494b
Initial commit from drush-created site
author | Chris Cannam |
---|---|
date | Thu, 05 Jul 2018 14:24:15 +0000 |
parents | |
children |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/core/modules/migrate/src/Annotation/MigrateProcessPlugin.php Thu Jul 05 14:24:15 2018 +0000 @@ -0,0 +1,48 @@ +<?php + +namespace Drupal\migrate\Annotation; + +use Drupal\Component\Annotation\Plugin; + +/** + * Defines a migration process plugin annotation object. + * + * Plugin Namespace: Plugin\migrate\process + * + * For a working example, see + * \Drupal\migrate\Plugin\migrate\process\DefaultValue + * + * @see \Drupal\migrate\Plugin\MigratePluginManager + * @see \Drupal\migrate\Plugin\MigrateProcessInterface + * @see \Drupal\migrate\ProcessPluginBase + * @see \Drupal\migrate\Annotation\MigrateSource + * @see \Drupal\migrate\Annotation\MigrateDestination + * @see plugin_api + * + * @ingroup migration + * + * @Annotation + */ +class MigrateProcessPlugin extends Plugin { + + /** + * A unique identifier for the process plugin. + * + * @var string + */ + public $id; + + /** + * Whether the plugin handles multiples itself. + * + * Typically these plugins will expect an array as input and iterate over it + * themselves, changing the whole array. For example the 'sub_process' and the + * 'flatten' plugins. If the plugin only need to change a single value it + * can skip setting this attribute and let + * \Drupal\migrate\MigrateExecutable::processRow() handle the iteration. + * + * @var bool (optional) + */ + public $handle_multiples = FALSE; + +}