1. 8.3.x core/modules/migrate/src/Annotation/MigrateProcessPlugin.php
  2. 8.0.x core/modules/migrate/src/Annotation/MigrateProcessPlugin.php
  3. 8.1.x core/modules/migrate/src/Annotation/MigrateProcessPlugin.php
  4. 8.2.x core/modules/migrate/src/Annotation/MigrateProcessPlugin.php
  5. 8.4.x core/modules/migrate/src/Annotation/MigrateProcessPlugin.php

Namespace

Drupal\migrate\Annotation

File

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

Classes

Namesort descending Description
MigrateProcessPlugin Defines a migration process plugin annotation object.