class MigrateSource in Zircon Profile 8

Defines a migration source plugin annotation object.

Plugin Namespace: Plugin\migrate\source

For a working example, check \Drupal\migrate\Plugin\migrate\source\EmptySource \Drupal\migrate_drupal\Plugin\migrate\source\UrlAlias

Hierarchy

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

See also

\Drupal\migrate\Plugin\MigratePluginManager

\Drupal\migrate\Plugin\MigrateSourceInterface

\Drupal\migrate\Plugin\migrate\source\SourcePluginBase

\Drupal\migrate\Annotation\MigrateProcessPlugin

\Drupal\migrate\Annotation\MigrateDestination

Plugin API

Related topics

Annotations

Annotations for class discovery and metadata description.

Migration API

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

1 string reference to 'MigrateSource'

migrate.services.yml in core/modules/migrate/migrate.services.yml

core/modules/migrate/migrate.services.yml

69 classes are annotated with MigrateSource

Action in core/modules/action/src/Plugin/migrate/source/d6/Action.php

Drupal 6 action source from database.

AggregatorFeed in core/modules/aggregator/src/Plugin/migrate/source/AggregatorFeed.php

Drupal feed source from database.

AggregatorItem in core/modules/aggregator/src/Plugin/migrate/source/AggregatorItem.php

Drupal aggregator item source from database.

Block in core/modules/block/src/Plugin/migrate/source/Block.php

Drupal block source from database.

BlockCustom in core/modules/block_content/src/Plugin/migrate/source/d7/BlockCustom.php

Drupal 7 custom block source from database.

... See full list

File

core/modules/migrate/src/Annotation/MigrateSource.php, line 32

Contains \Drupal\migrate\Annotation\MigrateSource.

Namespace

Drupal\migrate\Annotation

class MigrateSource extends Plugin {

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

  /**
   * Whether requirements are met.
   *
   * @var bool
   */
  public $requirements_met = TRUE;

  /**
   * Identifies the system providing the data the source plugin will read.
   *
   * This can be any type, and the source plugin itself determines how the value
   * is used. For example, Migrate Drupal's source plugins expect
   * source_provider to be the name of a module that must be installed and
   * enabled in the source database.
   *
   * @see \Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase::checkRequirements
   *
   * @var mixed
   */
  public $source_provider;

  /**
   * Specifies the minimum version of the source provider.
   *
   * This can be any type, and the source plugin itself determines how it is
   * used. For example, Migrate Drupal's source plugins expect this to be an
   * integer representing the minimum installed database schema version of the
   * module specified by source_provider.
   *
   * @var mixed
   */
  public $minimum_version;

}

Members

Name	Modifiers	Type	Description	Overrides
MigrateSource::$id	public	property	A unique identifier for the process plugin.
MigrateSource::$minimum_version	public	property	Specifies the minimum version of the source provider.
MigrateSource::$requirements_met	public	property	Whether requirements are met.
MigrateSource::$source_provider	public	property	Identifies the system providing the data the source plugin will read.
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	2
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
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.	1