MigrateDestination.php

Same filename in this branch
  1. 11.x core/modules/migrate/src/Annotation/MigrateDestination.php
Same filename and directory in other branches
  1. 9 core/modules/migrate/src/Annotation/MigrateDestination.php
  2. 8.9.x core/modules/migrate/src/Annotation/MigrateDestination.php
  3. 10 core/modules/migrate/src/Annotation/MigrateDestination.php

Namespace

Drupal\migrate\Attribute

File

core/modules/migrate/src/Attribute/MigrateDestination.php

View source
<?php

declare (strict_types=1);
namespace Drupal\migrate\Attribute;

use Drupal\Component\Plugin\Attribute\Plugin;

/**
 * Defines a MigrateDestination attribute.
 *
 * Plugin Namespace: Plugin\migrate\destination
 *
 * For a working example, see
 * \Drupal\migrate\Plugin\migrate\destination\UrlAlias
 *
 * @see \Drupal\migrate\Plugin\MigrateDestinationPluginManager
 * @see \Drupal\migrate\Plugin\MigrateDestinationInterface
 * @see \Drupal\migrate\Plugin\migrate\destination\DestinationBase
 * @see \Drupal\migrate\Attribute\MigrateProcess
 * @see plugin_api
 *
 * @ingroup migration
 */
class MigrateDestination extends Plugin {
    
    /**
     * Constructs a migrate destination plugin attribute object.
     *
     * @param string $id
     *   A unique identifier for the destination plugin.
     * @param bool $requirements_met
     *   (optional) Whether requirements are met.
     * @param string|null $destination_module
     *   (optional) Identifies the system handling the data the destination plugin
     *   will write. The destination plugin itself determines how the value is
     *   used. For example, Migrate's destination plugins expect
     *   destination_module to be the name of a module that must be installed on
     *   the destination.
     * @param class-string|null $deriver
     *   (optional) The deriver class.
     */
    public function __construct(string $id, bool $requirements_met = TRUE, ?string $destination_module = NULL, ?string $deriver = NULL) {
    }

}

Classes

Title Deprecated Summary
MigrateDestination Defines a MigrateDestination attribute.

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