class TestSqlIdMap in Drupal 9
Same name and namespace in other branches
- 8 core/modules/migrate/tests/src/Unit/TestSqlIdMap.php \Drupal\Tests\migrate\Unit\TestSqlIdMap
Defines a SQL ID map for use in tests.
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\migrate\Plugin\migrate\id_map\Sql implements ContainerFactoryPluginInterface, HighestIdInterface, MigrateIdMapInterface
- class \Drupal\Tests\migrate\Unit\TestSqlIdMap implements \Drupal\Tests\migrate\Unit\Iterator
- class \Drupal\migrate\Plugin\migrate\id_map\Sql implements ContainerFactoryPluginInterface, HighestIdInterface, MigrateIdMapInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of TestSqlIdMap
1 file declares its use of TestSqlIdMap
- SqlTest.php in core/
modules/ migrate/ tests/ src/ Kernel/ Plugin/ id_map/ SqlTest.php
File
- core/
modules/ migrate/ tests/ src/ Unit/ TestSqlIdMap.php, line 14
Namespace
Drupal\Tests\migrate\UnitView source
class TestSqlIdMap extends Sql implements \Iterator {
/**
* Constructs a TestSqlIdMap object.
*
* @param \Drupal\Core\Database\Connection $database
* The database.
* @param array $configuration
* The configuration.
* @param string $plugin_id
* The plugin ID for the migration process to do.
* @param mixed $plugin_definition
* The configuration for the plugin.
* @param \Drupal\migrate\Plugin\MigrationInterface $migration
* The migration to do.
* @param \Symfony\Contracts\EventDispatcher\EventDispatcherInterface $event_dispatcher
* The event dispatcher service.
*/
public function __construct(Connection $database, array $configuration, $plugin_id, $plugin_definition, MigrationInterface $migration, EventDispatcherInterface $event_dispatcher) {
$this->database = $database;
parent::__construct($configuration, $plugin_id, $plugin_definition, $migration, $event_dispatcher);
}
/**
* {@inheritdoc}
*/
public $message;
/**
* {@inheritdoc}
*/
public function getDatabase() {
return parent::getDatabase();
}
/**
* Gets the field schema.
*
* @param array $id_definition
* An array defining the field, with a key 'type'.
*
* @return array
* A field schema depending on value of key 'type'. An empty array is
* returned if 'type' is not defined.
*
* @throws \Drupal\migrate\MigrateException
*/
protected function getFieldSchema(array $id_definition) {
if (!isset($id_definition['type'])) {
return [];
}
switch ($id_definition['type']) {
case 'integer':
return [
'type' => 'int',
'not null' => TRUE,
];
case 'string':
return [
'type' => 'varchar',
'length' => 255,
'not null' => FALSE,
];
default:
throw new MigrateException($id_definition['type'] . ' not supported');
}
}
/**
* {@inheritdoc}
*/
public function ensureTables() {
parent::ensureTables();
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
public | function | 2 | |
DependencySerializationTrait:: |
public | function | 2 | |
MessengerTrait:: |
protected | property | The messenger. | 27 |
MessengerTrait:: |
public | function | Gets the messenger. | 27 |
MessengerTrait:: |
public | function | Sets the messenger. | |
MigrateIdMapInterface:: |
constant | Indicates that the data for the row is to be deleted. | ||
MigrateIdMapInterface:: |
constant | Indicates that the data for the row is to be preserved. | ||
MigrateIdMapInterface:: |
constant | Indicates that the import of the row failed. | ||
MigrateIdMapInterface:: |
constant | Indicates that the import of the row was ignored. | ||
MigrateIdMapInterface:: |
constant | Indicates that the import of the row was successful. | ||
MigrateIdMapInterface:: |
constant | Indicates that the row needs to be updated. | ||
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
2 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
Sql:: |
protected | property | The current key. | |
Sql:: |
protected | property | The current row. | |
Sql:: |
protected | property | The database connection for the map/message tables on the destination. | |
Sql:: |
protected | property | The destination ID fields. | |
Sql:: |
protected | property | The destination identifiers. | |
Sql:: |
protected | property | An event dispatcher instance to use for map events. | |
Sql:: |
protected | property | Whether the plugin is already initialized. | |
Sql:: |
protected | property | The migration map table name. | |
Sql:: |
protected | property | The message table name. | |
Sql:: |
protected | property | The migration being done. | |
Sql:: |
protected | property | The select query. | |
Sql:: |
protected | property | The result. | |
Sql:: |
protected | property | The source ID fields. | |
Sql:: |
protected | property | The source identifiers. | |
Sql:: |
public | function |
Clears all messages from the map. Overrides MigrateIdMapInterface:: |
|
Sql:: |
protected | function | Counts records in a table. | |
Sql:: |
public static | function |
Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface:: |
|
Sql:: |
public | function | Implementation of \Iterator::current(). | |
Sql:: |
public | function |
Looks up the destination identifier currently being iterated. Overrides MigrateIdMapInterface:: |
|
Sql:: |
public | function |
Looks up the source identifier(s) currently being iterated. Overrides MigrateIdMapInterface:: |
|
Sql:: |
public | function |
Deletes the map and message entries for a given source record. Overrides MigrateIdMapInterface:: |
|
Sql:: |
public | function |
Deletes the map and message table entries for a given destination row. Overrides MigrateIdMapInterface:: |
|
Sql:: |
protected | function | The destination ID fields. | |
Sql:: |
public | function |
Removes any persistent storage used by this map. Overrides MigrateIdMapInterface:: |
|
Sql:: |
public | function |
Returns the number of items that failed to import. Overrides MigrateIdMapInterface:: |
|
Sql:: |
public | function |
Returns the highest ID tracked by the implementing plugin. Overrides HighestIdInterface:: |
|
Sql:: |
public | function |
Retrieves a traversable object of messages related to source records. Overrides MigrateIdMapInterface:: |
|
Sql:: |
protected | function | Returns the migration plugin manager. | |
Sql:: |
public | function |
Get the fully qualified map table name. Overrides MigrateIdMapInterface:: |
|
Sql:: |
public | function |
Retrieves a row by the destination identifiers. Overrides MigrateIdMapInterface:: |
|
Sql:: |
public | function |
Retrieves a row from the map table based on source identifier values. Overrides MigrateIdMapInterface:: |
|
Sql:: |
public | function |
Retrieves an array of map rows marked as needing update. Overrides MigrateIdMapInterface:: |
|
Sql:: |
public | function | Retrieves the hash of the source identifier values. | |
Sql:: |
public | function |
Returns the number of imported items in the map. Overrides MigrateIdMapInterface:: |
|
Sql:: |
protected | function | Initialize the plugin. | |
Sql:: |
public | function | Implementation of \Iterator::key(). | |
Sql:: |
public | function |
Looks up the destination identifiers corresponding to a source key. Overrides MigrateIdMapInterface:: |
|
Sql:: |
public | function |
Looks up the source identifier. Overrides MigrateIdMapInterface:: |
|
Sql:: |
public | function | The name of the database map table. | |
Sql:: |
public | function |
Returns the number of messages saved. Overrides MigrateIdMapInterface:: |
|
Sql:: |
public | function | The name of the database message table. | |
Sql:: |
public | function | Implementation of \Iterator::next(). | |
Sql:: |
public | function |
Prepares to run a full update. Overrides MigrateIdMapInterface:: |
|
Sql:: |
public | function |
Returns the number of processed items in the map. Overrides MigrateIdMapInterface:: |
|
Sql:: |
public | function | Implementation of \Iterator::rewind(). | |
Sql:: |
public | function |
Saves a mapping from the source identifiers to the destination identifiers. Overrides MigrateIdMapInterface:: |
|
Sql:: |
public | function |
Saves a message related to a source record in the migration message table. Overrides MigrateIdMapInterface:: |
|
Sql:: |
public | function |
Sets the migrate message service. Overrides MigrateIdMapInterface:: |
|
Sql:: |
public | function |
Sets a specified record to be updated, if it exists. Overrides MigrateIdMapInterface:: |
|
Sql:: |
protected | function | The source ID fields. | |
Sql:: |
constant | Column name of hashed source id values. | ||
Sql:: |
public | function |
Returns a count of items which are marked as needing update. Overrides MigrateIdMapInterface:: |
|
Sql:: |
public | function | Implementation of \Iterator::valid(). | |
StringTranslationTrait:: |
protected | property | The string translation service. | 4 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. | |
TestSqlIdMap:: |
public | property |
The migrate message service. Overrides Sql:: |
|
TestSqlIdMap:: |
public | function |
Create the map and message tables if they don't already exist. Overrides Sql:: |
|
TestSqlIdMap:: |
public | function |
Gets the database connection. Overrides Sql:: |
|
TestSqlIdMap:: |
protected | function |
Gets the field schema. Overrides Sql:: |
1 |
TestSqlIdMap:: |
public | function |
Constructs a TestSqlIdMap object. Overrides Sql:: |