aleph1.co.uk Git - yaffs-website/blob - web/core/modules/migrate/src/Annotation/MigrateProcessPlugin.php

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