You are here

NodeEntityTranslation.php in Drupal 10

File

core/modules/node/src/Plugin/migrate/source/d7/NodeEntityTranslation.php
View source
<?php

namespace Drupal\node\Plugin\migrate\source\d7;

use Drupal\migrate\Row;
use Drupal\migrate_drupal\Plugin\migrate\source\d7\FieldableEntity;

/**
 * Drupal 7 node entity translations source from database.
 *
 * Available configuration keys:
 * - node_type: The node_types to get from the source - can be a string or
 *   an array. If not declared then nodes of all types will be retrieved.
 *
 * Examples:
 *
 * @code
 * source:
 *   plugin: d7_node_entity_translation
 *   node_type: page
 * @endcode
 *
 * In this example nodes of type page are retrieved from the source database.
 *
 * @code
 * source:
 *   plugin: d7_node_entity_translation
 *   node_type: [page, test]
 * @endcode
 *
 * In this example nodes of type page and test are retrieved from the source
 * database.
 *
 * For additional configuration keys, refer to the parent classes.
 *
 * @see \Drupal\migrate\Plugin\migrate\source\SqlBase
 * @see \Drupal\migrate\Plugin\migrate\source\SourcePluginBase
 *
 * @MigrateSource(
 *   id = "d7_node_entity_translation",
 *   source_module = "entity_translation"
 * )
 */
class NodeEntityTranslation extends FieldableEntity {

  /**
   * {@inheritdoc}
   */
  public function query() {
    $query = $this
      ->select('entity_translation', 'et')
      ->fields('et')
      ->fields('n', [
      'title',
      'type',
      'promote',
      'sticky',
    ])
      ->fields('nr', [
      'log',
      'timestamp',
    ])
      ->condition('et.entity_type', 'node')
      ->condition('et.source', '', '<>');
    $query
      ->addField('nr', 'uid', 'revision_uid');
    $query
      ->innerJoin('node', 'n', '[n].[nid] = [et].[entity_id]');
    $query
      ->innerJoin('node_revision', 'nr', '[nr].[vid] = [et].[revision_id]');
    if (isset($this->configuration['node_type'])) {
      $query
        ->condition('n.type', (array) $this->configuration['node_type'], 'IN');
    }
    return $query;
  }

  /**
   * {@inheritdoc}
   */
  public function prepareRow(Row $row) {
    $nid = $row
      ->getSourceProperty('entity_id');
    $vid = $row
      ->getSourceProperty('revision_id');
    $type = $row
      ->getSourceProperty('type');
    $language = $row
      ->getSourceProperty('language');

    // Get Field API field values.
    foreach ($this
      ->getFields('node', $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('node', $field_name, $nid, $vid, $field_language));
    }

    // If the node title was replaced by a real field using the Drupal 7 Title
    // module, use the field value instead of the node title.
    if ($this
      ->moduleExists('title')) {
      $title_field = $row
        ->getSourceProperty('title_field');
      if (isset($title_field[0]['value'])) {
        $row
          ->setSourceProperty('title', $title_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.'),
      'title' => $this
        ->t('Node title'),
      'type' => $this
        ->t('Node type'),
      'promote' => $this
        ->t('Promoted to front page'),
      'sticky' => $this
        ->t('Sticky at top of lists'),
      'log' => $this
        ->t('Revision log'),
      'timestamp' => $this
        ->t('The timestamp the latest revision of this node was created.'),
      'revision_uid' => $this
        ->t('Revision authored by (uid)'),
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function getIds() {
    return [
      'entity_id' => [
        'type' => 'integer',
        'alias' => 'et',
      ],
      'language' => [
        'type' => 'string',
        'alias' => 'et',
      ],
    ];
  }

}

Classes

Namesort descending Description
NodeEntityTranslation Drupal 7 node entity translations source from database.