class VariableTranslation

Same name in this branch
  1. 11.x core/modules/migrate_drupal/src/Plugin/migrate/source/d7/VariableTranslation.php \Drupal\migrate_drupal\Plugin\migrate\source\d7\VariableTranslation
Same name and namespace in other branches
  1. 9 core/modules/migrate_drupal/src/Plugin/migrate/source/d6/VariableTranslation.php \Drupal\migrate_drupal\Plugin\migrate\source\d6\VariableTranslation
  2. 9 core/modules/migrate_drupal/src/Plugin/migrate/source/d7/VariableTranslation.php \Drupal\migrate_drupal\Plugin\migrate\source\d7\VariableTranslation
  3. 8.9.x core/modules/migrate_drupal/src/Plugin/migrate/source/d6/VariableTranslation.php \Drupal\migrate_drupal\Plugin\migrate\source\d6\VariableTranslation
  4. 8.9.x core/modules/migrate_drupal/src/Plugin/migrate/source/d7/VariableTranslation.php \Drupal\migrate_drupal\Plugin\migrate\source\d7\VariableTranslation
  5. 10 core/modules/migrate_drupal/src/Plugin/migrate/source/d6/VariableTranslation.php \Drupal\migrate_drupal\Plugin\migrate\source\d6\VariableTranslation
  6. 10 core/modules/migrate_drupal/src/Plugin/migrate/source/d7/VariableTranslation.php \Drupal\migrate_drupal\Plugin\migrate\source\d7\VariableTranslation

Drupal 6 i18n_variable source from database.

Available configuration keys:

  • variables: (required) The list of variable translations to retrieve from the source database. All translations are retrieved in a single row.

Examples:


plugin: d6_variable_translation
variables:
  - site_offline_message

In this example the translations for site_offline_message variable are retrieved from the source database.

For additional configuration keys, refer to the parent classes.

Plugin annotation


@MigrateSource(
  id = "d6_variable_translation",
  source_module = "i18n",
)

Hierarchy

Expanded class hierarchy of VariableTranslation

See also

\Drupal\migrate\Plugin\migrate\source\SqlBase

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

File

core/modules/migrate_drupal/src/Plugin/migrate/source/d6/VariableTranslation.php, line 38

Namespace

Drupal\migrate_drupal\Plugin\migrate\source\d6
View source
class VariableTranslation extends DrupalSqlBase {
    
    /**
     * The variable names to fetch.
     *
     * @var array
     */
    protected $variables;
    
    /**
     * {@inheritdoc}
     */
    public function __construct(array $configuration, $plugin_id, $plugin_definition, MigrationInterface $migration, StateInterface $state, EntityTypeManagerInterface $entity_type_manager) {
        parent::__construct($configuration, $plugin_id, $plugin_definition, $migration, $state, $entity_type_manager);
        $this->variables = $this->configuration['variables'];
    }
    
    /**
     * {@inheritdoc}
     */
    protected function initializeIterator() {
        return new \ArrayIterator($this->values());
    }
    
    /**
     * Return the values of the variables specified in the plugin configuration.
     *
     * @return array
     *   An associative array where the keys are the variables specified in the
     *   plugin configuration and the values are the values found in the source.
     *   A key/value pair is added for the language code. Only those values are
     *   returned that are actually in the database.
     */
    protected function values() {
        $values = [];
        $result = $this->prepareQuery()
            ->execute()
            ->FetchAllAssoc('language');
        foreach ($result as $i18n_variable) {
            $values[]['language'] = $i18n_variable->language;
        }
        $result = $this->prepareQuery()
            ->execute()
            ->FetchAll();
        foreach ($result as $i18n_variable) {
            foreach ($values as $key => $value) {
                if ($values[$key]['language'] === $i18n_variable->language) {
                    $values[$key][$i18n_variable->name] = unserialize($i18n_variable->value);
                    break;
                }
            }
        }
        return $values;
    }
    
    /**
     * {@inheritdoc}
     */
    protected function doCount() {
        return $this->initializeIterator()
            ->count();
    }
    
    /**
     * {@inheritdoc}
     */
    public function fields() {
        return array_combine($this->variables, $this->variables);
    }
    
    /**
     * {@inheritdoc}
     */
    public function query() {
        return $this->getDatabase()
            ->select('i18n_variable', 'v')
            ->fields('v')
            ->condition('name', (array) $this->configuration['variables'], 'IN');
    }
    
    /**
     * {@inheritdoc}
     */
    public function getIds() {
        $ids['language']['type'] = 'string';
        return $ids;
    }
    
    /**
     * {@inheritdoc}
     */
    public function checkRequirements() {
        if (!$this->getDatabase()
            ->schema()
            ->tableExists('i18n_variable')) {
            throw new RequirementsException("Source database table 'i18n_variable' does not exist");
        }
        parent::checkRequirements();
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
DependencyTrait::$dependencies protected property The object's dependencies.
DependencyTrait::addDependencies protected function Adds multiple dependencies.
DependencyTrait::addDependency protected function Adds a dependency.
DrupalSqlBase::$entityTypeManager protected property The entity type manager.
DrupalSqlBase::$requirements protected property If the source provider is missing.
DrupalSqlBase::$systemData protected property The contents of the system table.
DrupalSqlBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
DrupalSqlBase::create public static function Creates an instance of the plugin. Overrides SqlBase::create 2
DrupalSqlBase::getModuleSchemaVersion protected function Retrieves a module schema_version from the source Drupal database.
DrupalSqlBase::getSystemData public function Retrieves all system data information from the source Drupal database.
DrupalSqlBase::moduleExists protected function Checks if a given module is enabled in the source Drupal database.
DrupalSqlBase::variableGet protected function Reads a variable from a source Drupal database.
MigrateSourceInterface::NOT_COUNTABLE constant Indicates that the source is not countable.
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2
SourcePluginBase::$cache protected property The backend cache.
SourcePluginBase::$cacheCounts protected property Whether this instance should cache the source count. 1
SourcePluginBase::$cacheKey protected property Key to use for caching counts.
SourcePluginBase::$currentRow protected property The current row from the query.
SourcePluginBase::$currentSourceIds protected property The primary key of the current row.
SourcePluginBase::$highWaterProperty protected property Information on the property used as the high-water mark.
SourcePluginBase::$highWaterStorage protected property The key-value storage for the high-water value.
SourcePluginBase::$idMap protected property The migration ID map.
SourcePluginBase::$iterator protected property The iterator to iterate over the source rows.
SourcePluginBase::$mapRowAdded protected property Flags whether source plugin will read the map row and add to data row.
SourcePluginBase::$migration protected property The entity migration object.
SourcePluginBase::$moduleHandler protected property The module handler service. 2
SourcePluginBase::$originalHighWater protected property The high water mark at the beginning of the import operation.
SourcePluginBase::$skipCount protected property Whether this instance should not attempt to count the source. 1
SourcePluginBase::$trackChanges protected property Flags whether to track changes to incoming data. 1
SourcePluginBase::aboveHighWater protected function Check if the incoming data is newer than what we've previously imported.
SourcePluginBase::count public function Gets the source count. 2
SourcePluginBase::current public function
SourcePluginBase::getCache protected function Gets the cache object.
SourcePluginBase::getCurrentIds public function Gets the currentSourceIds data member.
SourcePluginBase::getHighWater protected function The current value of the high water mark.
SourcePluginBase::getHighWaterField protected function Get the name of the field used as the high watermark.
SourcePluginBase::getHighWaterProperty protected function Get information on the property used as the high watermark.
SourcePluginBase::getHighWaterStorage protected function Get the high water storage object.
SourcePluginBase::getIterator protected function Returns the iterator that will yield the row arrays to be processed.
SourcePluginBase::getModuleHandler protected function Gets the module handler.
SourcePluginBase::getSourceModule public function Gets the source module providing the source data. Overrides MigrateSourceInterface::getSourceModule
SourcePluginBase::key public function Gets the iterator key.
SourcePluginBase::next public function
SourcePluginBase::postRollback public function Performs post-rollback tasks. Overrides RollbackAwareInterface::postRollback
SourcePluginBase::prepareRow public function Adds additional data to the row. Overrides MigrateSourceInterface::prepareRow 49
SourcePluginBase::preRollback public function Performs pre-rollback tasks. Overrides RollbackAwareInterface::preRollback
SourcePluginBase::rowChanged protected function Checks if the incoming row has changed since our last import.
SourcePluginBase::saveHighWater protected function Save the new high water mark.
SourcePluginBase::valid public function Checks whether the iterator is currently valid.
SqlBase::$batch protected property The count of the number of batches run.
SqlBase::$batchSize protected property Number of records to fetch from the database during each batch.
SqlBase::$database protected property The database object. 1
SqlBase::$query protected property The query string. 81
SqlBase::$state protected property State service for retrieving database info.
SqlBase::fetchNextBatch protected function Prepares query for the next set of data from the source database.
SqlBase::fetchNextRow protected function Position the iterator to the following row. Overrides SourcePluginBase::fetchNextRow
SqlBase::getDatabase public function Gets the database connection object. 2
SqlBase::mapJoinable protected function Checks if we can join against the map table. 1
SqlBase::prepareQuery protected function Adds tags and metadata to the query.
SqlBase::rewind public function Rewinds the iterator. Overrides SourcePluginBase::rewind
SqlBase::select protected function Wrapper for database select.
SqlBase::setUpDatabase protected function Gets a connection to the referenced database.
SqlBase::__sleep public function
SqlBase::__toString public function Prints the query string when the object is used as a string. Overrides MigrateSourceInterface::__toString
VariableTranslation::$variables protected property The variable names to fetch.
VariableTranslation::checkRequirements public function Checks if requirements for this plugin are OK. Overrides DrupalSqlBase::checkRequirements
VariableTranslation::doCount protected function Gets the source count using countQuery(). Overrides SqlBase::doCount
VariableTranslation::fields public function Returns available fields on the source. Overrides MigrateSourceInterface::fields
VariableTranslation::getIds public function Defines the source fields uniquely identifying a source row. Overrides MigrateSourceInterface::getIds
VariableTranslation::initializeIterator protected function Initializes the iterator with the source data. Overrides SqlBase::initializeIterator
VariableTranslation::query public function Overrides SqlBase::query
VariableTranslation::values protected function Return the values of the variables specified in the plugin configuration.
VariableTranslation::__construct public function Overrides DrupalSqlBase::__construct

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.