class MigrateSource
Same name in this branch
- 11.x core/modules/migrate/src/Annotation/MigrateSource.php \Drupal\migrate\Annotation\MigrateSource
Same name in other branches
- 9 core/modules/migrate/src/Annotation/MigrateSource.php \Drupal\migrate\Annotation\MigrateSource
- 8.9.x core/modules/migrate/src/Annotation/MigrateSource.php \Drupal\migrate\Annotation\MigrateSource
- 10 core/modules/migrate/src/Annotation/MigrateSource.php \Drupal\migrate\Annotation\MigrateSource
Defines a MigrateSource attribute.
Plugin Namespace: Plugin\migrate\source
For a working example, see \Drupal\migrate\Plugin\migrate\source\EmptySource \Drupal\migrate_drupal\Plugin\migrate\source\UrlAlias
Hierarchy
- class \Drupal\Component\Plugin\Attribute\AttributeBase implements \Drupal\Component\Plugin\Attribute\AttributeInterface
- class \Drupal\Component\Plugin\Attribute\Plugin extends \Drupal\Component\Plugin\Attribute\AttributeBase
- class \Drupal\migrate\Attribute\MigrateSource extends \Drupal\Component\Plugin\Attribute\Plugin implements \Drupal\migrate\Attribute\MultipleProviderAttributeInterface
- class \Drupal\Component\Plugin\Attribute\Plugin extends \Drupal\Component\Plugin\Attribute\AttributeBase
Expanded class hierarchy of MigrateSource
See also
\Drupal\migrate\Plugin\MigratePluginManager
\Drupal\migrate\Plugin\MigrateSourceInterface
\Drupal\migrate\Plugin\migrate\source\SourcePluginBase
\Drupal\migrate\Attribute\MigrateDestination
\Drupal\migrate\Attribute\MigrateProcess
Related topics
116 files declare their use of MigrateSource
- Action.php in core/
modules/ system/ src/ Plugin/ migrate/ source/ Action.php - Block.php in core/
modules/ block/ src/ Plugin/ migrate/ source/ Block.php - BlockCustom.php in core/
modules/ block_content/ src/ Plugin/ migrate/ source/ d7/ BlockCustom.php - BlockCustomTranslation.php in core/
modules/ block_content/ src/ Plugin/ migrate/ source/ d7/ BlockCustomTranslation.php - BlockedIps.php in core/
modules/ ban/ src/ Plugin/ migrate/ source/ d7/ BlockedIps.php
File
-
core/
modules/ migrate/ src/ Attribute/ MigrateSource.php, line 27
Namespace
Drupal\migrate\AttributeView source
class MigrateSource extends Plugin implements MultipleProviderAttributeInterface {
/**
* The providers of the source plugin.
*/
protected array $providers = [];
/**
* Constructs a migrate source plugin attribute object.
*
* @param string $id
* A unique identifier for the source plugin.
* @param string|null $source_module
* (optional) Identifies the system providing the data the source plugin
* will read. The source plugin itself determines how the value is used. For
* example, Migrate Drupal's source plugins expect source_module to be the
* name of a module that must be installed and enabled in the source
* database.
* @param bool $requirements_met
* (optional) Whether requirements are met. Defaults to true. The source
* plugin itself determines how the value is used. For example, Migrate
* Drupal's source plugins expect source_module to be the name of a module
* that must be installed and enabled in the source database.
* @param mixed $minimum_version
* (optional) 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_module.
* @param class-string|null $deriver
* (optional) The deriver class.
*
* @see \Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase::checkRequirements
*/
public function __construct(string $id, ?string $source_module = NULL, bool $requirements_met = TRUE, mixed $minimum_version = NULL, ?string $deriver = NULL) {
}
/**
* {@inheritdoc}
*/
public function setProvider(string $provider) : void {
$this->setProviders([
$provider,
]);
}
/**
* {@inheritdoc}
*/
public function getProviders() : array {
return $this->providers;
}
/**
* {@inheritdoc}
*/
public function setProviders(array $providers) : void {
if ($providers) {
parent::setProvider(reset($providers));
}
else {
$this->provider = NULL;
}
$this->providers = $providers;
}
}
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.