class MigrateProcess

Same name and namespace in other branches
  1. 11.x core/modules/migrate/src/Attribute/MigrateProcess.php \Drupal\migrate\Attribute\MigrateProcess

Defines a MigrateProcess attribute.

Plugin Namespace: Plugin\migrate\process

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

Attributes

#[\Attribute(\Attribute::TARGET_CLASS)]

Hierarchy

  • class \Drupal\migrate\Attribute\MigrateProcess extends \Drupal\Component\Plugin\Attribute\Plugin

Expanded class hierarchy of MigrateProcess

See also

\Drupal\migrate\Plugin\MigratePluginManager

\Drupal\migrate\Plugin\MigrateProcessInterface

\Drupal\migrate\ProcessPluginBase

\Drupal\migrate\Attribute\MigrateDestination

Plugin API

Related topics

79 files declare their use of MigrateProcess
ArrayBuild.php in core/modules/migrate/src/Plugin/migrate/process/ArrayBuild.php
BlockPluginId.php in core/modules/block/src/Plugin/migrate/process/BlockPluginId.php
BlockRegion.php in core/modules/block/src/Plugin/migrate/process/BlockRegion.php
BlockSettings.php in core/modules/block/src/Plugin/migrate/process/BlockSettings.php
BlockTheme.php in core/modules/block/src/Plugin/migrate/process/BlockTheme.php

... See full list

1 string reference to 'MigrateProcess'
migrate.services.yml in core/modules/migrate/migrate.services.yml
core/modules/migrate/migrate.services.yml

File

core/modules/migrate/src/Attribute/MigrateProcess.php, line 25

Namespace

Drupal\migrate\Attribute
View source
class MigrateProcess extends Plugin {
    
    /**
     * Constructs a migrate process plugin attribute object.
     *
     * @param string $id
     *   A unique identifier for the process plugin.
     * @param bool $handle_multiples
     *   (optional) 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 needs to change a single value, then it can
     *   skip setting this attribute and let
     *   \Drupal\migrate\MigrateExecutable::processRow() handle the iteration.
     * @param class-string|null $deriver
     *   (optional) The deriver class.
     */
    public function __construct(string $id, bool $handle_multiples = FALSE, ?string $deriver = NULL) {
    }

}

Members

Title Sort descending Modifiers Object type Summary
MigrateProcess::__construct public function Constructs a migrate process plugin attribute object.

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