class MigrateDestination

Same name in this branch
  1. 11.x core/modules/migrate/src/Attribute/MigrateDestination.php \Drupal\migrate\Attribute\MigrateDestination
Same name in other branches
  1. 9 core/modules/migrate/src/Annotation/MigrateDestination.php \Drupal\migrate\Annotation\MigrateDestination
  2. 8.9.x core/modules/migrate/src/Annotation/MigrateDestination.php \Drupal\migrate\Annotation\MigrateDestination
  3. 10 core/modules/migrate/src/Annotation/MigrateDestination.php \Drupal\migrate\Annotation\MigrateDestination
  4. 10 core/modules/migrate/src/Attribute/MigrateDestination.php \Drupal\migrate\Attribute\MigrateDestination

Defines a migration destination plugin annotation object.

Plugin Namespace: Plugin\migrate\destination

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

Hierarchy

Expanded class hierarchy of 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

2 classes are annotated with MigrateDestination
Book in core/modules/book/src/Plugin/migrate/destination/Book.php
Plugin annotation @MigrateDestination( id = "book", provider = "book" )
NodeCounter in core/modules/statistics/src/Plugin/migrate/destination/NodeCounter.php
Destination for node counter.

File

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

Namespace

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

Title Sort descending Modifiers Object type Summary Overriden Title 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 6
Plugin::getClass public function Gets the class of the annotated class. Overrides AnnotationInterface::getClass 1
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 1
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. 3

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