class EntityTranslationSettings in Drupal 10

Same name and namespace in other branches

8 core/modules/content_translation/src/Plugin/migrate/source/d7/EntityTranslationSettings.php \Drupal\content_translation\Plugin\migrate\source\d7\EntityTranslationSettings
9 core/modules/content_translation/src/Plugin/migrate/source/d7/EntityTranslationSettings.php \Drupal\content_translation\Plugin\migrate\source\d7\EntityTranslationSettings

Drupal 7 Entity Translation settings (variables) from database.

For available configuration keys, refer to the parent classes.

Plugin annotation


@MigrateSource(
  id = "d7_entity_translation_settings",
  source_module = "entity_translation"
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\migrate\Plugin\migrate\source\SourcePluginBase implements RollbackAwareInterface, MigrateSourceInterface
    class \Drupal\migrate\Plugin\migrate\source\SqlBase implements ContainerFactoryPluginInterface, RequirementsInterface
    class \Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase implements DependentPluginInterface uses DependencyTrait
    class \Drupal\content_translation\Plugin\migrate\source\d7\EntityTranslationSettings

Expanded class hierarchy of EntityTranslationSettings

File

core/modules/content_translation/src/Plugin/migrate/source/d7/EntityTranslationSettings.php, line 20

Namespace

Drupal\content_translation\Plugin\migrate\source\d7

View source

class EntityTranslationSettings extends DrupalSqlBase {

  /**
   * {@inheritdoc}
   */
  public function query() {

    // Query all meaningful variables for entity translation.
    $query = $this
      ->select('variable', 'v')
      ->fields('v', [
      'name',
      'value',
    ]);
    $condition = $query
      ->orConditionGroup()
      ->condition('name', 'entity_translation_entity_types')
      ->condition('name', 'entity_translation_taxonomy')
      ->condition('name', 'entity_translation_settings_%', 'LIKE')
      ->condition('name', 'language_content_type_%', 'LIKE');
    $query
      ->condition($condition);
    return $query;
  }

  /**
   * {@inheritdoc}
   */
  protected function initializeIterator() {
    $results = array_map('unserialize', $this
      ->prepareQuery()
      ->execute()
      ->fetchAllKeyed());
    $rows = [];

    // Find out which entity type uses entity translation by looking at the
    // 'entity_translation_entity_types' variable.
    $entity_types = array_filter($results['entity_translation_entity_types']);

    // If no entity type uses entity translation, there's nothing to do.
    if (empty($entity_types)) {
      return new \ArrayIterator($rows);
    }

    // Find out which node type uses entity translation by looking at the
    // 'language_content_type_%' variables.
    $node_types = [];
    foreach ($results as $name => $value) {
      if (preg_match('/^language_content_type_(.+)$/', $name, $matches) && (int) $value === 4) {
        $node_types[] = $matches[1];
      }
    }

    // Find out which vocabulary uses entity translation by looking at the
    // 'entity_translation_taxonomy' variable.
    $vocabularies = [];
    if (isset($results['entity_translation_taxonomy']) && is_array($results['entity_translation_taxonomy'])) {
      $vocabularies = array_keys(array_filter($results['entity_translation_taxonomy']));
    }
    if (in_array('node', $entity_types, TRUE) && !empty($node_types)) {

      // For each node type that uses entity translation, check if a
      // settings variable exists for that node type, otherwise use default
      // values.
      foreach ($node_types as $node_type) {
        $settings = $results['entity_translation_settings_node__' . $node_type] ?? [];
        $rows[] = [
          'id' => 'node.' . $node_type,
          'target_entity_type_id' => 'node',
          'target_bundle' => $node_type,
          'default_langcode' => $settings['default_language'] ?? 'und',
          // The Drupal 7 'hide_language_selector' configuration has become
          // 'language_alterable' in Drupal 8 so we need to negate the value we
          // receive from the source. The Drupal 7 'hide_language_selector'
          // default value for the node entity type was FALSE so in Drupal 8 it
          // should be set to TRUE, unlike the other entity types for which
          // it's the opposite.
          'language_alterable' => isset($settings['hide_language_selector']) ? (bool) (!$settings['hide_language_selector']) : TRUE,
          'untranslatable_fields_hide' => isset($settings['shared_fields_original_only']) ? (bool) $settings['shared_fields_original_only'] : FALSE,
        ];
      }
    }
    if (in_array('comment', $entity_types, TRUE) && !empty($node_types)) {

      // A comment type uses entity translation if the associated node type
      // uses it. So, for each node type that uses entity translation, check
      // if a settings variable exists for that comment type, otherwise use
      // default values.
      foreach ($node_types as $node_type) {
        $settings = $results['entity_translation_settings_comment__comment_node_' . $node_type] ?? [];

        // Forum uses a hardcoded comment type name, so make sure we use it
        // when we're dealing with forum comment type.
        $bundle = $node_type == 'forum' ? 'comment_forum' : 'comment_node_' . $node_type;
        $rows[] = [
          'id' => 'comment.' . $bundle,
          'target_entity_type_id' => 'comment',
          'target_bundle' => $bundle,
          'default_langcode' => $settings['default_language'] ?? 'xx-et-current',
          // The Drupal 7 'hide_language_selector' configuration has become
          // 'language_alterable' in Drupal 8 so we need to negate the value we
          // receive from the source. The Drupal 7 'hide_language_selector'
          // default value for the comment entity type was TRUE so in Drupal 8
          // it should be set to FALSE.
          'language_alterable' => isset($settings['hide_language_selector']) ? (bool) (!$settings['hide_language_selector']) : FALSE,
          'untranslatable_fields_hide' => isset($settings['shared_fields_original_only']) ? (bool) $settings['shared_fields_original_only'] : FALSE,
        ];
      }
    }
    if (in_array('taxonomy_term', $entity_types, TRUE) && !empty($vocabularies)) {

      // For each vocabulary that uses entity translation, check if a
      // settings variable exists for that vocabulary, otherwise use default
      // values.
      foreach ($vocabularies as $vocabulary) {
        $settings = $results['entity_translation_settings_taxonomy_term__' . $vocabulary] ?? [];
        $rows[] = [
          'id' => 'taxonomy_term.' . $vocabulary,
          'target_entity_type_id' => 'taxonomy_term',
          'target_bundle' => $vocabulary,
          'default_langcode' => $settings['default_language'] ?? 'xx-et-default',
          // The Drupal 7 'hide_language_selector' configuration has become
          // 'language_alterable' in Drupal 8 so we need to negate the value we
          // receive from the source. The Drupal 7 'hide_language_selector'
          // default value for the taxonomy_term entity type was TRUE so in
          // Drupal 8 it should be set to FALSE.
          'language_alterable' => isset($settings['hide_language_selector']) ? (bool) (!$settings['hide_language_selector']) : FALSE,
          'untranslatable_fields_hide' => isset($settings['shared_fields_original_only']) ? (bool) $settings['shared_fields_original_only'] : FALSE,
        ];
      }
    }
    if (in_array('user', $entity_types, TRUE)) {

      // User entity type is not bundleable. Check if a settings variable
      // exists, otherwise use default values.
      $settings = $results['entity_translation_settings_user__user'] ?? [];
      $rows[] = [
        'id' => 'user.user',
        'target_entity_type_id' => 'user',
        'target_bundle' => 'user',
        'default_langcode' => $settings['default_language'] ?? 'xx-et-default',
        // The Drupal 7 'hide_language_selector' configuration has become
        // 'language_alterable' in Drupal 8 so we need to negate the value we
        // receive from the source. The Drupal 7 'hide_language_selector'
        // default value for the user entity type was TRUE so in Drupal 8 it
        // should be set to FALSE.
        'language_alterable' => isset($settings['hide_language_selector']) ? (bool) (!$settings['hide_language_selector']) : FALSE,
        'untranslatable_fields_hide' => isset($settings['shared_fields_original_only']) ? (bool) $settings['shared_fields_original_only'] : FALSE,
      ];
    }
    return new \ArrayIterator($rows);
  }

  /**
   * {@inheritdoc}
   */
  public function fields() {
    return [
      'id' => $this
        ->t('The configuration ID'),
      'target_entity_type_id' => $this
        ->t('The target entity type ID'),
      'target_bundle' => $this
        ->t('The target bundle'),
      'default_langcode' => $this
        ->t('The default language'),
      'language_alterable' => $this
        ->t('Whether to show language selector on create and edit pages'),
      'untranslatable_fields_hide' => $this
        ->t('Whether to hide non translatable fields on translation forms'),
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function getIds() {
    $ids['id']['type'] = 'string';
    return $ids;
  }

  /**
   * {@inheritdoc}
   */
  protected function doCount() {

    // Since the number of variables we fetch with query() does not match the
    // actual number of rows generated by initializeIterator(), we need to
    // override count() to return the correct count.
    return (int) $this
      ->initializeIterator()
      ->count();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__wakeup	public	function		2
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::checkRequirements	public	function	Checks if requirements for this plugin are OK. Overrides SqlBase::checkRequirements	4
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.
DrupalSqlBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides SqlBase::__construct	5
EntityTranslationSettings::doCount	protected	function	Gets the source count using countQuery(). Overrides SqlBase::doCount
EntityTranslationSettings::fields	public	function	Returns available fields on the source. Overrides MigrateSourceInterface::fields
EntityTranslationSettings::getIds	public	function	Defines the source fields uniquely identifying a source row. Overrides MigrateSourceInterface::getIds
EntityTranslationSettings::initializeIterator	protected	function	Initializes the iterator with the source data. Overrides SqlBase::initializeIterator
EntityTranslationSettings::query	public	function	Overrides SqlBase::query
MessengerTrait::$messenger	protected	property	The messenger.	18
MessengerTrait::messenger	public	function	Gets the messenger.	18
MessengerTrait::setMessenger	public	function	Sets the messenger.
MigrateSourceInterface::NOT_COUNTABLE		constant	Indicates that the source is not countable.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
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
PluginBase::getDerivativeId	public	function
PluginBase::getPluginDefinition	public	function		2
PluginBase::getPluginId	public	function
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
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		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
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	50
SourcePluginBase::preRollback	public	function	Performs pre-rollback tasks. Overrides RollbackAwareInterface::preRollback
SourcePluginBase::rewind	public	function
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
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.	82
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::select	protected	function	Wrapper for database select.
SqlBase::setUpDatabase	protected	function	Gets a connection to the referenced database.
SqlBase::__sleep	public	function	Overrides DependencySerializationTrait::__sleep
SqlBase::__toString	public	function	Prints the query string when the object is used as a string. Overrides MigrateSourceInterface::__toString
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.	1
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.

You are here

class EntityTranslationSettings in Drupal 10

Plugin annotation

Hierarchy

See also

File

Namespace

Members

API Navigation