class TermNode

Same name in other branches
  1. 9 core/modules/taxonomy/src/Plugin/migrate/source/d6/TermNode.php \Drupal\taxonomy\Plugin\migrate\source\d6\TermNode
  2. 10 core/modules/taxonomy/src/Plugin/migrate/source/d6/TermNode.php \Drupal\taxonomy\Plugin\migrate\source\d6\TermNode
  3. 11.x core/modules/taxonomy/src/Plugin/migrate/source/d6/TermNode.php \Drupal\taxonomy\Plugin\migrate\source\d6\TermNode

Source returning tids from the term_node table for the current revision.

Plugin annotation


@MigrateSource(
  id = "d6_term_node",
  source_module = "taxonomy"
)

Hierarchy

Expanded class hierarchy of TermNode

File

core/modules/taxonomy/src/Plugin/migrate/source/d6/TermNode.php, line 16

Namespace

Drupal\taxonomy\Plugin\migrate\source\d6
View source 
class TermNode extends DrupalSqlBase {
    
    /**
     * The join options between the node and the term node table.
     */
    const JOIN = 'tn.vid = n.vid';
    
    /**
     * {@inheritdoc}
     */
    public function query() {
        $query = $this->select('term_node', 'tn')
            ->distinct()
            ->fields('tn', [
            'nid',
            'vid',
        ])
            ->fields('n', [
            'type',
        ]);
        // Because this is an inner join it enforces the current revision.
        $query->innerJoin('term_data', 'td', 'td.tid = tn.tid AND td.vid = :vid', [
            ':vid' => $this->configuration['vid'],
        ]);
        $query->innerJoin('node', 'n', static::JOIN);
        return $query;
    }
    
    /**
     * {@inheritdoc}
     */
    public function fields() {
        return [
            'nid' => $this->t('The node revision ID.'),
            'vid' => $this->t('The node revision ID.'),
            'tid' => $this->t('The term ID.'),
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    public function prepareRow(Row $row) {
        // Select the terms belonging to the revision selected.
        $query = $this->select('term_node', 'tn')
            ->fields('tn', [
            'tid',
        ])
            ->condition('n.nid', $row->getSourceProperty('nid'));
        $query->join('node', 'n', static::JOIN);
        $query->innerJoin('term_data', 'td', 'td.tid = tn.tid AND td.vid = :vid', [
            ':vid' => $this->configuration['vid'],
        ]);
        $row->setSourceProperty('tid', $query->execute()
            ->fetchCol());
        return parent::prepareRow($row);
    }
    
    /**
     * {@inheritdoc}
     */
    public function getIds() {
        $ids['vid']['type'] = 'integer';
        $ids['vid']['alias'] = 'tn';
        return $ids;
    }

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
DependencyTrait::$dependencies protected property The object's dependencies.
DependencyTrait::addDependencies protected function Adds multiple dependencies.
DependencyTrait::addDependency protected function Adds a dependency.
DeprecatedServicePropertyTrait::__get public function Allows to access deprecated/removed properties.
DrupalSqlBase::$deprecatedProperties protected property 1
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::checkRequirements public function Checks if requirements for this plugin are OK. Overrides SqlBase::checkRequirements 2
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
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've previously imported.
SourcePluginBase::current public function
SourcePluginBase::doCount protected function Gets the source count checking if the source is countable or using the
iterator_count function. 		1
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. 1
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 The migration iterates over rows returned by the source plugin. This
method determines the next row which will be processed and imported into
the system.
SourcePluginBase::postRollback public function Performs post-rollback tasks. Overrides RollbackAwareInterface::postRollback
SourcePluginBase::preRollback public function Performs pre-rollback tasks. Overrides RollbackAwareInterface::preRollback
SourcePluginBase::rewind public function Rewinds the iterator.
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. 82
SqlBase::$state protected property State service for retrieving database info.
SqlBase::count public function Gets the source count. Overrides SourcePluginBase::count 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 20
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::__toString public function Prints the query string when the object is used as a string. Overrides MigrateSourceInterface::__toString
TermNode::fields public function Returns available fields on the source. Overrides MigrateSourceInterface::fields
TermNode::getIds public function Defines the source fields uniquely identifying a source row. Overrides MigrateSourceInterface::getIds
TermNode::JOIN constant The join options between the node and the term node table. 1
TermNode::prepareRow public function Adds additional data to the row. Overrides SourcePluginBase::prepareRow
TermNode::query public function Overrides SqlBase::query

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