You are here

Home » API reference » Zircon Profile 8 » TestSqlIdMap.php

class TestSqlIdMap in Zircon Profile 8

Same name and namespace in other branches
  1. 8.0 core/modules/migrate/tests/src/Unit/TestSqlIdMap.php \Drupal\Tests\migrate\Unit\TestSqlIdMap

Defines a SQL ID map for use in tests.

Hierarchy

Expanded class hierarchy of TestSqlIdMap

File

core/modules/migrate/tests/src/Unit/TestSqlIdMap.php, line 19
Contains \Drupal\Tests\migrate\Unit\TestSqlIdMap.

Namespace

Drupal\Tests\migrate\Unit
View 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\Entity\MigrationInterface $migration
   *   The migration to do.
   */
  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 function getDatabase() {
    return parent::getDatabase();
  }
  protected function getFieldSchema(array $id_definition) {
    if (!isset($id_definition['type'])) {
      return array();
    }
    switch ($id_definition['type']) {
      case 'integer':
        return array(
          'type' => 'int',
          'not null' => TRUE,
        );
      case 'string':
        return array(
          'type' => 'varchar',
          'length' => 255,
          'not null' => FALSE,
        );
      default:
        throw new MigrateException($id_definition['type'] . ' not supported');
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
MigrateIdMapInterface::ROLLBACK_DELETE constant Codes reflecting how to handle the destination item on rollback.
MigrateIdMapInterface::ROLLBACK_PRESERVE constant
MigrateIdMapInterface::STATUS_FAILED constant
MigrateIdMapInterface::STATUS_IGNORED constant
MigrateIdMapInterface::STATUS_IMPORTED constant Codes reflecting the current status of a map row.
MigrateIdMapInterface::STATUS_NEEDS_UPDATE constant
PluginBase::$configuration protected property Configuration information passed into the plugin. 2
PluginBase::$pluginDefinition protected property The plugin implementation definition.
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
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
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::$message protected property The migrate message.
Sql::$messageTableName protected property The message table name.
Sql::$migration protected property The migration being done.
Sql::$query protected property
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 Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
Sql::current public function Implementation of Iterator::current().
Sql::currentDestination public function @inheritdoc Overrides MigrateIdMapInterface::currentDestination
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::ensureTables protected function Create the map and message tables if they don't already exist.
Sql::errorCount public function Returns the number of items that failed to import. Overrides MigrateIdMapInterface::errorCount
Sql::getMessageIterator public function Retrieves an iterator over messages relate to source records. Overrides MigrateIdMapInterface::getMessageIterator
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::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::lookupDestinationId public function Looks up the destination identifier corresponding to a source key. Overrides MigrateIdMapInterface::lookupDestinationId
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. 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::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.
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.
TestSqlIdMap::getDatabase public function Gets the database connection. Overrides Sql::getDatabase
TestSqlIdMap::getFieldSchema protected function Creates schema from an ID definition. Overrides Sql::getFieldSchema
TestSqlIdMap::__construct public function Constructs a TestSqlIdMap object. Overrides Sql::__construct