class MigrateDestination in Drupal 9

Defines a migration destination plugin annotation object.

Plugin Namespace: Plugin\migrate\destination

For a working example, see \Drupal\migrate\Plugin\migrate\destination\UrlAlias

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\migrate\Annotation\MigrateDestination

See also

\Drupal\migrate\Plugin\MigrateDestinationInterface

\Drupal\migrate\Plugin\migrate\destination\DestinationBase

\Drupal\migrate\Plugin\MigrateDestinationPluginManager

\Drupal\migrate\Annotation\MigrateSource

\Drupal\migrate\Annotation\MigrateProcessPlugin

Plugin API

Related topics

Annotations

Annotations for class discovery and metadata description.

Migrate API

Overview of the Migrate API, which migrates data into Drupal.

30 classes are annotated with MigrateDestination

BlockedIp in core/modules/ban/src/Plugin/migrate/destination/BlockedIp.php

Destination for blocked IP addresses.

Book in core/modules/book/src/Plugin/migrate/destination/Book.php

Plugin annotation @MigrateDestination( id = "book", provider = "book" )

Color in core/modules/color/src/Plugin/migrate/destination/Color.php

Persist color data to the config system.

Config in core/modules/migrate/src/Plugin/migrate/destination/Config.php

Provides Configuration Management destination plugin.

DefaultLangcode in core/modules/language/src/Plugin/migrate/destination/DefaultLangcode.php

Provides a destination plugin for the default langcode config.

... See full list

File

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

Namespace

Drupal\migrate\Annotation

class MigrateDestination extends Plugin {

  /**
   * A unique identifier for the process plugin.
   *
   * @var string
   */
  public $id;

  /**
   * Whether requirements are met.
   *
   * If TRUE and a 'provider' key is present in the annotation then the
   * default destination plugin manager will set this to FALSE if the
   * provider (module/theme) doesn't exist.
   *
   * @var bool
   */
  public $requirements_met = TRUE;

  /**
   * Identifies the system handling the data the destination plugin will write.
   *
   * The destination plugin itself determines how the value is used. For
   * example, Migrate Drupal's destination plugins expect destination_module to
   * be the name of a module that must be installed on the destination.
   *
   * @var string
   */
  public $destination_module;

}

Members

Name	Modifiers	Type	Description	Overrides
MigrateDestination::$destination_module	public	property	Identifies the system handling the data the destination plugin will write.
MigrateDestination::$id	public	property	A unique identifier for the process plugin.
MigrateDestination::$requirements_met	public	property	Whether requirements are met.
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