You are here

Term.php in Zircon Profile 8

File

core/modules/taxonomy/src/Plugin/migrate/source/Term.php
View source
<?php

/**
 * @file
 * Contains \Drupal\taxonomy\Plugin\migrate\source\Term.
 */
namespace Drupal\taxonomy\Plugin\migrate\source;

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

/**
 * Taxonomy term source from database.
 *
 * @todo Support term_relation, term_synonym table if possible.
 *
 * @MigrateSource(
 *   id = "taxonomy_term",
 *   source_provider = "taxonomy"
 * )
 */
class Term extends DrupalSqlBase {

  /**
   * Name of the term data table.
   *
   * @var string
   */
  protected $termDataTable;

  /**
   * Name of the term hierarchy table.
   *
   * @var string
   */
  protected $termHierarchyTable;

  /**
   * {@inheritdoc}
   */
  public function query() {
    if ($this
      ->getModuleSchemaVersion('taxonomy') >= 7000) {
      $this->termDataTable = 'taxonomy_term_data';
      $this->termHierarchyTable = 'taxonomy_term_hierarchy';
    }
    else {
      $this->termDataTable = 'term_data';
      $this->termHierarchyTable = 'term_hierarchy';
    }
    $query = $this
      ->select($this->termDataTable, 'td')
      ->fields('td')
      ->distinct()
      ->orderBy('tid');
    if (isset($this->configuration['vocabulary'])) {
      $query
        ->condition('vid', $this->configuration['vocabulary'], 'IN');
    }
    return $query;
  }

  /**
   * {@inheritdoc}
   */
  public function fields() {
    $fields = array(
      'tid' => $this
        ->t('The term ID.'),
      'vid' => $this
        ->t('Existing term VID'),
      'name' => $this
        ->t('The name of the term.'),
      'description' => $this
        ->t('The term description.'),
      'weight' => $this
        ->t('Weight'),
      'parent' => $this
        ->t("The Drupal term IDs of the term's parents."),
    );
    if ($this
      ->getModuleSchemaVersion('taxonomy') >= 7000) {
      $fields['format'] = $this
        ->t('Format of the term description.');
    }
    return $fields;
  }

  /**
   * {@inheritdoc}
   */
  public function prepareRow(Row $row) {

    // Find parents for this row.
    $parents = $this
      ->select($this->termHierarchyTable, 'th')
      ->fields('th', array(
      'parent',
      'tid',
    ))
      ->condition('tid', $row
      ->getSourceProperty('tid'))
      ->execute()
      ->fetchCol();
    $row
      ->setSourceProperty('parent', $parents);
    return parent::prepareRow($row);
  }

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

}

Classes

Namesort descending Description
Term Taxonomy term source from database.