class TestSqlIdMap
Defines a SQL ID map for use in tests.
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\DependencyInjection\AutowiredInstanceTrait, \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait extends \Drupal\Component\Plugin\PluginBase
- class \Drupal\migrate\Plugin\migrate\id_map\Sql implements \Drupal\migrate\Plugin\MigrateIdMapInterface, \Drupal\Core\Plugin\ContainerFactoryPluginInterface, \Drupal\migrate\Audit\HighestIdInterface extends \Drupal\Core\Plugin\PluginBase
- class \Drupal\Tests\migrate\Unit\TestSqlIdMap implements \Drupal\Tests\migrate\Unit\Iterator extends \Drupal\migrate\Plugin\migrate\id_map\Sql
 
 
 - class \Drupal\migrate\Plugin\migrate\id_map\Sql implements \Drupal\migrate\Plugin\MigrateIdMapInterface, \Drupal\Core\Plugin\ContainerFactoryPluginInterface, \Drupal\migrate\Audit\HighestIdInterface extends \Drupal\Core\Plugin\PluginBase
 
 - class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\DependencyInjection\AutowiredInstanceTrait, \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait extends \Drupal\Component\Plugin\PluginBase
 
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 17  
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.
   * @param \Drupal\migrate\Plugin\MigrationPluginManagerInterface $migration_manager
   *   The migration manager.
   */
  public function __construct(Connection $database, array $configuration, $plugin_id, $plugin_definition, MigrationInterface $migration, EventDispatcherInterface $event_dispatcher, MigrationPluginManagerInterface $migration_manager) {
    $this->database = $database;
    parent::__construct($configuration, $plugin_id, $plugin_definition, $migration, $event_dispatcher, $migration_manager);
  }
  
  /**
   * {@inheritdoc}
   */
  public $message;
  
  /**
   * 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}
   */
  // phpcs:ignore Generic.CodeAnalysis.UselessOverridingMethod, Drupal.Commenting.FunctionComment.Missing
  public function ensureTables() {
    parent::ensureTables();
  }
}
Members
| Title Sort descending | Deprecated | Modifiers | Object type | Summary | Overriden Title | Overrides | 
|---|---|---|---|---|---|---|
| AutowiredInstanceTrait::createInstanceAutowired | public static | function | Instantiates a new instance of the implementing class using autowiring. | |||
| DependencySerializationTrait::$_entityStorages | protected | property | An array of entity type IDs keyed by the property name of their storages. | |||
| DependencySerializationTrait::$_serviceIds | protected | property | An array of service IDs keyed by property name used for serialization. | |||
| DependencySerializationTrait::__sleep | public | function | 2 | |||
| DependencySerializationTrait::__wakeup | public | function | 2 | |||
| MessengerTrait::$messenger | protected | property | The messenger. | 25 | ||
| MessengerTrait::messenger | public | function | Gets the messenger. | 25 | ||
| MessengerTrait::setMessenger | public | function | Sets the messenger. | |||
| MigrateIdMapInterface::ROLLBACK_DELETE | constant | Indicates that the data for the row is to be deleted. | ||||
| MigrateIdMapInterface::ROLLBACK_PRESERVE | constant | Indicates that the data for the row is to be preserved. | ||||
| MigrateIdMapInterface::STATUS_FAILED | constant | Indicates that the import of the row failed. | ||||
| MigrateIdMapInterface::STATUS_IGNORED | constant | Indicates that the import of the row was ignored. | ||||
| MigrateIdMapInterface::STATUS_IMPORTED | constant | Indicates that the import of the row was successful. | ||||
| MigrateIdMapInterface::STATUS_NEEDS_UPDATE | constant | Indicates that the row needs to be updated. | ||||
| PluginBase::$configuration | protected | property | Configuration information passed into the plugin. | 1 | ||
| PluginBase::$pluginDefinition | protected | property | The plugin implementation definition. | 1 | ||
| PluginBase::$pluginId | protected | property | The plugin ID. | |||
| PluginBase::DERIVATIVE_SEPARATOR | constant | A string which is used to separate base plugin IDs from the derivative ID. | ||||
| PluginBase::getBaseId | public | function | Gets the base_plugin_id of the plugin instance. | Overrides DerivativeInspectionInterface::getBaseId | ||
| PluginBase::getDerivativeId | public | function | Gets the derivative_id of the plugin instance. | Overrides DerivativeInspectionInterface::getDerivativeId | ||
| PluginBase::getPluginDefinition | public | function | Gets the definition of the plugin implementation. | Overrides PluginInspectionInterface::getPluginDefinition | 2 | |
| PluginBase::getPluginId | public | function | Gets the plugin ID of the plugin instance. | Overrides PluginInspectionInterface::getPluginId | ||
| PluginBase::isConfigurable | Deprecated | public | function | Determines if the plugin is configurable. | ||
| Sql::$currentKey | protected | property | The current key. | |||
| Sql::$currentRow | protected | property | The current row. | |||
| Sql::$database | protected | property | The database connection for the map/message tables on the destination. | |||
| Sql::$destinationIdFields | protected | property | The destination ID fields. | |||
| Sql::$destinationIds | protected | property | The destination identifiers. | |||
| Sql::$eventDispatcher | protected | property | An event dispatcher instance to use for map events. | |||
| Sql::$initialized | protected | property | Whether the plugin is already initialized. | |||
| Sql::$mapTableName | protected | property | The migration map table name. | |||
| Sql::$messageTableName | protected | property | The message table name. | |||
| Sql::$migration | protected | property | The migration being done. | |||
| Sql::$migrationPluginManager | protected | property | The migration plugin manager. | |||
| Sql::$query | protected | property | The select query. | |||
| Sql::$result | protected | property | The result. | |||
| Sql::$sourceIdFields | protected | property | The source ID fields. | |||
| Sql::$sourceIds | protected | property | The source identifiers. | |||
| Sql::clearMessages | public | function | Clears all messages from the map. | Overrides MigrateIdMapInterface::clearMessages | ||
| Sql::countHelper | protected | function | Counts records in a table. | |||
| Sql::create | public static | function | Instantiates a new instance of the implementing class using autowiring. | Overrides PluginBase::create | ||
| Sql::current | public | function | Implementation of \Iterator::current(). | |||
| Sql::currentDestination | public | function | Looks up the destination identifier currently being iterated. | Overrides MigrateIdMapInterface::currentDestination | ||
| Sql::currentSource | public | function | Looks up the source identifier(s) currently being iterated. | Overrides MigrateIdMapInterface::currentSource | ||
| Sql::delete | public | function | Deletes the map and message entries for a given source record. | Overrides MigrateIdMapInterface::delete | ||
| Sql::deleteDestination | public | function | Deletes the map and message table entries for a given destination row. | Overrides MigrateIdMapInterface::deleteDestination | ||
| Sql::destinationIdFields | protected | function | The destination ID fields. | |||
| Sql::destroy | public | function | Removes any persistent storage used by this map. | Overrides MigrateIdMapInterface::destroy | ||
| Sql::errorCount | public | function | Returns the number of items that failed to import. | Overrides MigrateIdMapInterface::errorCount | ||
| Sql::getDatabase | public | function | Gets the database connection. | |||
| Sql::getHighestId | public | function | Returns the highest ID tracked by the implementing plugin. | Overrides HighestIdInterface::getHighestId | ||
| Sql::getMessages | public | function | Retrieves a traversable object of messages related to source records. | Overrides MigrateIdMapInterface::getMessages | ||
| Sql::getQualifiedMapTableName | public | function | Get the fully qualified map table name. | Overrides MigrateIdMapInterface::getQualifiedMapTableName | ||
| Sql::getRowByDestination | public | function | Retrieves a row by the destination identifiers. | Overrides MigrateIdMapInterface::getRowByDestination | ||
| Sql::getRowBySource | public | function | Retrieves a row from the map table based on source identifier values. | Overrides MigrateIdMapInterface::getRowBySource | ||
| Sql::getRowsNeedingUpdate | public | function | Retrieves an array of map rows marked as needing update. | Overrides MigrateIdMapInterface::getRowsNeedingUpdate | ||
| Sql::getSourceIdsHash | public | function | Retrieves the hash of the source identifier values. | |||
| Sql::importedCount | public | function | Returns the number of imported items in the map. | Overrides MigrateIdMapInterface::importedCount | ||
| Sql::init | protected | function | Initialize the plugin. | |||
| Sql::key | public | function | Implementation of \Iterator::key(). | |||
| Sql::lookupDestinationIds | public | function | Looks up the destination identifiers corresponding to a source key. | Overrides MigrateIdMapInterface::lookupDestinationIds | ||
| Sql::lookupSourceId | public | function | Looks up the source identifier. | Overrides MigrateIdMapInterface::lookupSourceId | ||
| Sql::mapTableName | public | function | The name of the database map table. | |||
| Sql::messageCount | public | function | Returns the number of messages saved. | Overrides MigrateIdMapInterface::messageCount | ||
| Sql::messageTableName | public | function | The name of the database message table. | |||
| Sql::next | public | function | Implementation of \Iterator::next(). | |||
| Sql::prepareUpdate | public | function | Prepares to run a full update. | Overrides MigrateIdMapInterface::prepareUpdate | ||
| Sql::processedCount | public | function | Returns the number of processed items in the map. | Overrides MigrateIdMapInterface::processedCount | ||
| Sql::rewind | public | function | Implementation of \Iterator::rewind(). | |||
| Sql::saveIdMapping | public | function | Saves a mapping from the source identifiers to the destination identifiers. | Overrides MigrateIdMapInterface::saveIdMapping | ||
| Sql::saveMessage | public | function | Saves a message related to a source record in the migration message table. | Overrides MigrateIdMapInterface::saveMessage | ||
| Sql::setMessage | public | function | Sets the migrate message service. | Overrides MigrateIdMapInterface::setMessage | ||
| Sql::setUpdate | public | function | Sets a specified record to be updated, if it exists. | Overrides MigrateIdMapInterface::setUpdate | ||
| Sql::sourceIdFields | protected | function | The source ID fields. | |||
| Sql::SOURCE_IDS_HASH | constant | Column name of hashed source id values. | ||||
| Sql::updateCount | public | function | Returns a count of items which are marked as needing update. | Overrides MigrateIdMapInterface::updateCount | ||
| Sql::valid | public | function | Implementation of \Iterator::valid(). | |||
| StringTranslationTrait::$stringTranslation | protected | property | The string translation service. | 3 | ||
| StringTranslationTrait::formatPlural | protected | function | Formats a string containing a count of items. | |||
| StringTranslationTrait::getNumberOfPlurals | protected | function | Returns the number of plurals supported by a given language. | |||
| StringTranslationTrait::getStringTranslation | protected | function | Gets the string translation service. | |||
| StringTranslationTrait::setStringTranslation | public | function | Sets the string translation service to use. | 2 | ||
| StringTranslationTrait::t | protected | function | Translates a string to the current language or to a given language. | 1 | ||
| TestSqlIdMap::$message | public | property | The migrate message service. | Overrides Sql::$message | ||
| TestSqlIdMap::ensureTables | public | function | Create the map and message tables if they don't already exist. | Overrides Sql::ensureTables | ||
| TestSqlIdMap::getFieldSchema | protected | function | Gets the field schema. | Overrides Sql::getFieldSchema | 1 | |
| TestSqlIdMap::__construct | public | function | Constructs a TestSqlIdMap object. | Overrides Sql::__construct | 
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.