class MigrateProcessPlugin

Same name in other branches
  1. 9 core/modules/migrate/src/Annotation/MigrateProcessPlugin.php \Drupal\migrate\Annotation\MigrateProcessPlugin
  2. 10 core/modules/migrate/src/Annotation/MigrateProcessPlugin.php \Drupal\migrate\Annotation\MigrateProcessPlugin
  3. 11.x core/modules/migrate/src/Annotation/MigrateProcessPlugin.php \Drupal\migrate\Annotation\MigrateProcessPlugin

Defines a migration process plugin annotation object.

Plugin Namespace: Plugin\migrate\process

For a working example, see \Drupal\migrate\Plugin\migrate\process\DefaultValue

Hierarchy

Expanded class hierarchy of MigrateProcessPlugin

See also

\Drupal\migrate\Plugin\MigratePluginManager

\Drupal\migrate\Plugin\MigrateProcessInterface

\Drupal\migrate\ProcessPluginBase

\Drupal\migrate\Annotation\MigrateSource

\Drupal\migrate\Annotation\MigrateDestination

Plugin API

Related topics

Migrate API
Overview of the Migrate API, which migrates data into Drupal.
Annotations
Annotations for class discovery and metadata description.
1 string reference to 'MigrateProcessPlugin'
migrate.services.yml in core/modules/migrate/migrate.services.yml
core/modules/migrate/migrate.services.yml
83 classes are annotated with MigrateProcessPlugin
ArrayBuild in core/modules/migrate/src/Plugin/migrate/process/ArrayBuild.php
Builds an array based on the key and value configuration.
BlockPluginId in core/modules/block/src/Plugin/migrate/process/BlockPluginId.php
Plugin annotation @MigrateProcessPlugin( id = "block_plugin_id" )
BlockRegion in core/modules/block/src/Plugin/migrate/process/BlockRegion.php
Plugin annotation @MigrateProcessPlugin( id = "block_region" )
BlockSettings in core/modules/block/src/Plugin/migrate/process/BlockSettings.php
Plugin annotation @MigrateProcessPlugin( id = "block_settings" )
BlockTheme in core/modules/block/src/Plugin/migrate/process/BlockTheme.php
Plugin annotation @MigrateProcessPlugin( id = "block_theme" )

... See full list

File

core/modules/migrate/src/Annotation/MigrateProcessPlugin.php, line 26

Namespace

Drupal\migrate\Annotation
View source 
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;

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
MigrateProcessPlugin::$handle_multiples public property Whether the plugin handles multiples itself.
MigrateProcessPlugin::$id public property A unique identifier for the process plugin.
Plugin::$definition protected property The plugin definition read from the class annotation. 1
Plugin::get public function Gets the value of an annotation. Overrides AnnotationInterface::get 5
Plugin::getClass public function Gets the class of the annotated class. Overrides AnnotationInterface::getClass
Plugin::getId public function Gets the unique ID for this annotated class. Overrides AnnotationInterface::getId
Plugin::getProvider public function Gets the name of the provider of the annotated class. Overrides AnnotationInterface::getProvider 1
Plugin::parse protected function Parses an annotation into its definition.
Plugin::setClass public function Sets the class of the annotated class. Overrides AnnotationInterface::setClass
Plugin::setProvider public function Sets the name of the provider of the annotated class. Overrides AnnotationInterface::setProvider
Plugin::__construct public function Constructs a Plugin object. 2

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.