class CommentEntityTranslation

Same name in other branches
  1. 8.9.x core/modules/comment/src/Plugin/migrate/source/d7/CommentEntityTranslation.php \Drupal\comment\Plugin\migrate\source\d7\CommentEntityTranslation
  2. 10 core/modules/comment/src/Plugin/migrate/source/d7/CommentEntityTranslation.php \Drupal\comment\Plugin\migrate\source\d7\CommentEntityTranslation
  3. 11.x core/modules/comment/src/Plugin/migrate/source/d7/CommentEntityTranslation.php \Drupal\comment\Plugin\migrate\source\d7\CommentEntityTranslation

Drupal 7 comment entity translation source plugin.

For available configuration keys, refer to the parent classes.

Plugin annotation


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

Hierarchy

Expanded class hierarchy of CommentEntityTranslation

See also

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

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

File

core/modules/comment/src/Plugin/migrate/source/d7/CommentEntityTranslation.php, line 22

Namespace

Drupal\comment\Plugin\migrate\source\d7
View source
class CommentEntityTranslation extends FieldableEntity {
    
    /**
     * {@inheritdoc}
     */
    public function query() {
        $query = $this->select('entity_translation', 'et')
            ->fields('et')
            ->fields('c', [
            'subject',
        ])
            ->condition('et.entity_type', 'comment')
            ->condition('et.source', '', '<>');
        $query->innerJoin('comment', 'c', '[c].[cid] = [et].[entity_id]');
        $query->innerJoin('node', 'n', '[n].[nid] = [c].[nid]');
        $query->addField('n', 'type', 'node_type');
        $query->orderBy('et.created');
        return $query;
    }
    
    /**
     * {@inheritdoc}
     */
    public function prepareRow(Row $row) {
        $cid = $row->getSourceProperty('entity_id');
        $language = $row->getSourceProperty('language');
        $node_type = $row->getSourceProperty('node_type');
        $comment_type = 'comment_node_' . $node_type;
        // Get Field API field values.
        foreach ($this->getFields('comment', $comment_type) as $field_name => $field) {
            // Ensure we're using the right language if the entity is translatable.
            $field_language = $field['translatable'] ? $language : NULL;
            $row->setSourceProperty($field_name, $this->getFieldValues('comment', $field_name, $cid, NULL, $field_language));
        }
        // If the comment subject was replaced by a real field using the Drupal 7
        // Title module, use the field value instead of the comment subject.
        if ($this->moduleExists('title')) {
            $subject_field = $row->getSourceProperty('subject_field');
            if (isset($subject_field[0]['value'])) {
                $row->setSourceProperty('subject', $subject_field[0]['value']);
            }
        }
        return parent::prepareRow($row);
    }
    
    /**
     * {@inheritdoc}
     */
    public function fields() {
        return [
            'entity_type' => $this->t('The entity type this translation relates to'),
            'entity_id' => $this->t('The entity ID this translation relates to'),
            'revision_id' => $this->t('The entity revision ID this translation relates to'),
            'language' => $this->t('The target language for this translation.'),
            'source' => $this->t('The source language from which this translation was created.'),
            'uid' => $this->t('The author of this translation.'),
            'status' => $this->t('Boolean indicating whether the translation is published (visible to non-administrators).'),
            'translate' => $this->t('A boolean indicating whether this translation needs to be updated.'),
            'created' => $this->t('The Unix timestamp when the translation was created.'),
            'changed' => $this->t('The Unix timestamp when the translation was most recently saved.'),
            'subject' => $this->t('The comment title.'),
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    public function getIds() {
        return [
            'entity_id' => [
                'type' => 'integer',
                'alias' => 'et',
            ],
            'language' => [
                'type' => 'string',
                'alias' => 'et',
            ],
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    public function checkRequirements() {
        parent::checkRequirements();
        if (!$this->moduleExists('comment')) {
            // If we make it to here, the comment module isn't installed.
            throw new RequirementsException('The module comment is not enabled in the source site');
        }
        if (!$this->moduleExists('node')) {
            // Node module is also a requirement.
            throw new RequirementsException('The module node is not enabled in the source site');
        }
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
CommentEntityTranslation::checkRequirements public function Checks if requirements for this plugin are OK. Overrides DrupalSqlBase::checkRequirements
CommentEntityTranslation::fields public function Returns available fields on the source. Overrides MigrateSourceInterface::fields
CommentEntityTranslation::getIds public function Defines the source fields uniquely identifying a source row. Overrides MigrateSourceInterface::getIds
CommentEntityTranslation::prepareRow public function Adds additional data to the row. Overrides SourcePluginBase::prepareRow
CommentEntityTranslation::query public function Overrides SqlBase::query
DependencyTrait::$dependencies protected property The object&#039;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 1
DrupalSqlBase::create public static function Creates an instance of the plugin. Overrides SqlBase::create 3
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 Overrides SqlBase::__construct 6
FieldableEntity::getEntityTranslationSourceLanguage protected function Gets an entity source language from the &#039;entity_translation&#039; table.
FieldableEntity::getFields protected function Returns all non-deleted field instances attached to a specific entity type.
FieldableEntity::getFieldValues protected function Retrieves field values for a single field of a single entity.
FieldableEntity::isEntityTranslatable protected function Checks if an entity type uses Entity Translation.
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&#039;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::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. 83
SqlBase::$state protected property State service for retrieving database info.
SqlBase::doCount protected function Gets the source count using countQuery(). Overrides SourcePluginBase::doCount 6
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::initializeIterator protected function Initializes the iterator with the source data. Overrides SourcePluginBase::initializeIterator 18
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

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