BlockCustomTranslation.php in Drupal 10

Namespace

Drupal\block_content\Plugin\migrate\source\d7

File

core/modules/block_content/src/Plugin/migrate/source/d7/BlockCustomTranslation.php

<?php

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

use Drupal\migrate\Row;
use Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase;
use Drupal\content_translation\Plugin\migrate\source\I18nQueryTrait;

/**
 * Drupal 7 i18n custom block translations source from database.
 *
 * For available configuration keys, refer to the parent classes.
 *
 * @see \Drupal\migrate\Plugin\migrate\source\SqlBase
 * @see \Drupal\migrate\Plugin\migrate\source\SourcePluginBase
 *
 * @MigrateSource(
 *   id = "d7_block_custom_translation",
 *   source_module = "i18n_block"
 * )
 */
class BlockCustomTranslation extends DrupalSqlBase {
  use I18nQueryTrait;

  /**
   * Drupal 7 table names.
   */
  const CUSTOM_BLOCK_TABLE = 'block_custom';
  const I18N_STRING_TABLE = 'i18n_string';

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

    // Build a query based on blockCustomTable table where each row has the
    // translation for only one property, either title or description. The
    // method prepareRow() is then used to obtain the translation for the
    // other property.
    $query = $this
      ->select(static::CUSTOM_BLOCK_TABLE, 'b')
      ->fields('b', [
      'bid',
      'format',
      'body',
    ])
      ->fields('i18n', [
      'property',
    ])
      ->fields('lt', [
      'lid',
      'translation',
      'language',
    ])
      ->orderBy('b.bid');

    // Use 'title' for the info field to match the property name in
    // i18nStringTable.
    $query
      ->addField('b', 'info', 'title');

    // Add in the property, which is either title or body. Cast the bid to text
    // so PostgreSQL can make the join.
    $query
      ->leftJoin(static::I18N_STRING_TABLE, 'i18n', '[i18n].[objectid] = CAST([b].[bid] AS CHAR(255))');
    $query
      ->condition('i18n.type', 'block');

    // Add in the translation for the property.
    $query
      ->innerJoin('locales_target', 'lt', '[lt].[lid] = [i18n].[lid]');
    return $query;
  }

  /**
   * {@inheritdoc}
   */
  public function prepareRow(Row $row) {
    if (!parent::prepareRow($row)) {
      return FALSE;
    }

    // Set the i18n string table for use in I18nQueryTrait.
    $this->i18nStringTable = static::I18N_STRING_TABLE;

    // Save the translation for this property.
    $property_in_row = $row
      ->getSourceProperty('property');

    // Get the translation for the property not already in the row and save it
    // in the row.
    $property_not_in_row = $property_in_row === 'title' ? 'body' : 'title';
    return $this
      ->getPropertyNotInRowTranslation($row, $property_not_in_row, 'bid', $this->idMap);
  }

  /**
   * {@inheritdoc}
   */
  public function fields() {
    return [
      'bid' => $this
        ->t('The block numeric identifier.'),
      'format' => $this
        ->t('Input format of the custom block/box content.'),
      'lid' => $this
        ->t('i18n_string table id'),
      'language' => $this
        ->t('Language for this field.'),
      'property' => $this
        ->t('Block property'),
      'translation' => $this
        ->t('The translation of the value of "property".'),
      'title' => $this
        ->t('Block title.'),
      'title_translated' => $this
        ->t('Block title translation.'),
      'body' => $this
        ->t('Block body.'),
      'body_translated' => $this
        ->t('Block body translation.'),
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function getIds() {
    $ids['bid']['type'] = 'integer';
    $ids['bid']['alias'] = 'b';
    $ids['language']['type'] = 'string';
    return $ids;
  }

}

Classes

Name	Description
BlockCustomTranslation	Drupal 7 i18n custom block translations source from database.