MigrateProcessPlugin.php

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

Namespace

Drupal\migrate\Annotation

File

core/modules/migrate/src/Annotation/MigrateProcessPlugin.php

View source
<?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;

}

Classes

Title Deprecated Summary
MigrateProcessPlugin Defines a migration process plugin annotation object.

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