class Node

Same name in this branch
  1. 10 core/modules/node/src/Entity/Node.php \Drupal\node\Entity\Node
  2. 10 core/modules/node/src/Plugin/views/field/Node.php \Drupal\node\Plugin\views\field\Node
  3. 10 core/modules/node/src/Plugin/views/wizard/Node.php \Drupal\node\Plugin\views\wizard\Node
  4. 10 core/modules/node/src/Plugin/views/argument_default/Node.php \Drupal\node\Plugin\views\argument_default\Node
  5. 10 core/modules/node/src/Plugin/migrate/source/d7/Node.php \Drupal\node\Plugin\migrate\source\d7\Node
Same name in other branches
  1. 9 core/modules/node/src/Entity/Node.php \Drupal\node\Entity\Node
  2. 9 core/modules/node/src/Plugin/views/field/Node.php \Drupal\node\Plugin\views\field\Node
  3. 9 core/modules/node/src/Plugin/views/wizard/Node.php \Drupal\node\Plugin\views\wizard\Node
  4. 9 core/modules/node/src/Plugin/views/argument_default/Node.php \Drupal\node\Plugin\views\argument_default\Node
  5. 9 core/modules/node/src/Plugin/migrate/source/d6/Node.php \Drupal\node\Plugin\migrate\source\d6\Node
  6. 9 core/modules/node/src/Plugin/migrate/source/d7/Node.php \Drupal\node\Plugin\migrate\source\d7\Node
  7. 8.9.x core/modules/node/src/Entity/Node.php \Drupal\node\Entity\Node
  8. 8.9.x core/modules/node/src/Plugin/views/field/Node.php \Drupal\node\Plugin\views\field\Node
  9. 8.9.x core/modules/node/src/Plugin/views/wizard/Node.php \Drupal\node\Plugin\views\wizard\Node
  10. 8.9.x core/modules/node/src/Plugin/views/argument_default/Node.php \Drupal\node\Plugin\views\argument_default\Node
  11. 8.9.x core/modules/node/src/Plugin/migrate/source/d6/Node.php \Drupal\node\Plugin\migrate\source\d6\Node
  12. 8.9.x core/modules/node/src/Plugin/migrate/source/d7/Node.php \Drupal\node\Plugin\migrate\source\d7\Node
  13. 11.x core/modules/node/src/Entity/Node.php \Drupal\node\Entity\Node
  14. 11.x core/modules/node/src/Plugin/views/field/Node.php \Drupal\node\Plugin\views\field\Node
  15. 11.x core/modules/node/src/Plugin/views/wizard/Node.php \Drupal\node\Plugin\views\wizard\Node
  16. 11.x core/modules/node/src/Plugin/views/argument_default/Node.php \Drupal\node\Plugin\views\argument_default\Node
  17. 11.x core/modules/node/src/Plugin/migrate/source/d6/Node.php \Drupal\node\Plugin\migrate\source\d6\Node
  18. 11.x core/modules/node/src/Plugin/migrate/source/d7/Node.php \Drupal\node\Plugin\migrate\source\d7\Node

Drupal 6 node 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:


source:
  plugin: d6_node
  node_type: page

In this example nodes of type page are retrieved from the source database.


source:
  plugin: d6_node
  node_type: [page, test]

In this example nodes of type page and test are retrieved from the source database.

For additional configuration keys, refer to the parent classes.

Plugin annotation


@MigrateSource(
  id = "d6_node",
  source_module = "node"
)

Hierarchy

Expanded class hierarchy of Node

See also

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

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

1470 string references to 'Node'
2d3581c3-92c7-4600-8991-a0d4b3741198.yml in core/tests/fixtures/default_content/node/2d3581c3-92c7-4600-8991-a0d4b3741198.yml
core/tests/fixtures/default_content/node/2d3581c3-92c7-4600-8991-a0d4b3741198.yml
3434bd5a-d2cd-4f26-bf79-a7f6b951a21b.yml in core/tests/fixtures/default_content/menu_link_content/3434bd5a-d2cd-4f26-bf79-a7f6b951a21b.yml
core/tests/fixtures/default_content/menu_link_content/3434bd5a-d2cd-4f26-bf79-a7f6b951a21b.yml
7f1dd75a-0be2-4d3b-be5d-9d1a868b9267.yml in core/tests/fixtures/default_content/node/7f1dd75a-0be2-4d3b-be5d-9d1a868b9267.yml
core/tests/fixtures/default_content/node/7f1dd75a-0be2-4d3b-be5d-9d1a868b9267.yml
AccessPermissionTest::setUp in core/modules/user/tests/src/Kernel/Views/AccessPermissionTest.php
AddFeedTest::testFeedIconEscaping in core/modules/system/tests/src/Kernel/Common/AddFeedTest.php
Checks that special characters are correctly escaped.

... See full list

File

core/modules/node/src/Plugin/migrate/source/d6/Node.php, line 52

Namespace

Drupal\node\Plugin\migrate\source\d6
View source
class Node extends DrupalSqlBase {
    
    /**
     * The join options between the node and the node_revisions table.
     */
    const JOIN = '[n].[vid] = [nr].[vid]';
    
    /**
     * The default filter format.
     *
     * @var string
     */
    protected $filterDefaultFormat;
    
    /**
     * Cached field and field instance definitions.
     *
     * @var array
     */
    protected $fieldInfo;
    
    /**
     * The module handler.
     *
     * @var \Drupal\Core\Extension\ModuleHandler
     */
    protected $moduleHandler;
    
    /**
     * {@inheritdoc}
     */
    public function __construct(array $configuration, $plugin_id, $plugin_definition, MigrationInterface $migration, StateInterface $state, EntityTypeManagerInterface $entity_type_manager, ModuleHandler $module_handler) {
        parent::__construct($configuration, $plugin_id, $plugin_definition, $migration, $state, $entity_type_manager);
        $this->moduleHandler = $module_handler;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition, ?MigrationInterface $migration = NULL) {
        return new static($configuration, $plugin_id, $plugin_definition, $migration, $container->get('state'), $container->get('entity_type.manager'), $container->get('module_handler'));
    }
    
    /**
     * {@inheritdoc}
     */
    public function query() {
        $query = $this->select('node_revisions', 'nr');
        $query->innerJoin('node', 'n', static::JOIN);
        $this->handleTranslations($query);
        $query->fields('n', [
            'nid',
            'type',
            'language',
            'status',
            'created',
            'changed',
            'comment',
            'promote',
            'moderate',
            'sticky',
            'tnid',
            'translate',
        ])
            ->fields('nr', [
            'title',
            'body',
            'teaser',
            'log',
            'timestamp',
            'format',
            'vid',
        ]);
        $query->addField('n', 'uid', 'node_uid');
        $query->addField('nr', 'uid', 'revision_uid');
        // If the content_translation module is enabled, get the source langcode
        // to fill the content_translation_source field.
        if ($this->moduleHandler
            ->moduleExists('content_translation')) {
            $query->leftJoin('node', 'nt', '[n].[tnid] = [nt].[nid]');
            $query->addField('nt', 'language', 'source_langcode');
        }
        if (isset($this->configuration['node_type'])) {
            $query->condition('n.type', (array) $this->configuration['node_type'], 'IN');
        }
        return $query;
    }
    
    /**
     * {@inheritdoc}
     */
    protected function initializeIterator() {
        $this->filterDefaultFormat = $this->variableGet('filter_default_format', '1');
        return parent::initializeIterator();
    }
    
    /**
     * {@inheritdoc}
     */
    public function fields() {
        $fields = [
            'nid' => $this->t('Node ID'),
            'type' => $this->t('Type'),
            'title' => $this->t('Title'),
            'body' => $this->t('Body'),
            'format' => $this->t('Format'),
            'teaser' => $this->t('Teaser'),
            'node_uid' => $this->t('Node authored by (uid)'),
            'revision_uid' => $this->t('Revision authored by (uid)'),
            'created' => $this->t('Created timestamp'),
            'changed' => $this->t('Modified timestamp'),
            'status' => $this->t('Published'),
            'promote' => $this->t('Promoted to front page'),
            'sticky' => $this->t('Sticky at top of lists'),
            'revision' => $this->t('Create new revision'),
            'language' => $this->t('Language (fr, en, ...)'),
            'tnid' => $this->t('The translation set id for this node'),
            'timestamp' => $this->t('The timestamp the latest revision of this node was created.'),
        ];
        return $fields;
    }
    
    /**
     * {@inheritdoc}
     */
    public function prepareRow(Row $row) {
        // Format = 0 can happen when the body field is hidden. Set the format to 1
        // to avoid migration map issues (since the body field isn't used anyway).
        if ($row->getSourceProperty('format') === '0') {
            $row->setSourceProperty('format', $this->filterDefaultFormat);
        }
        if ($this->moduleExists('content') && $this->getModuleSchemaVersion('content') >= 6001) {
            foreach ($this->getFieldValues($row) as $field => $values) {
                $row->setSourceProperty($field, $values);
            }
        }
        // Make sure we always have a translation set.
        if ($row->getSourceProperty('tnid') == 0) {
            $row->setSourceProperty('tnid', $row->getSourceProperty('nid'));
        }
        return parent::prepareRow($row);
    }
    
    /**
     * Gets field values for a node.
     *
     * @param \Drupal\migrate\Row $node
     *   The node.
     *
     * @return array
     *   Field values, keyed by field name.
     */
    protected function getFieldValues(Row $node) {
        $values = [];
        foreach ($this->getFieldInfo($node->getSourceProperty('type')) as $field => $info) {
            $values[$field] = $this->getFieldData($info, $node);
        }
        return $values;
    }
    
    /**
     * Gets field and instance definitions from the database.
     *
     * @param string $node_type
     *   The node type for which to get field info.
     *
     * @return array
     *   Field and instance information for the node type, keyed by field name.
     */
    protected function getFieldInfo($node_type) {
        if (!isset($this->fieldInfo)) {
            $this->fieldInfo = [];
            // Query the database directly for all field info.
            $query = $this->select('content_node_field_instance', 'cnfi');
            $query->join('content_node_field', 'cnf', '[cnf].[field_name] = [cnfi].[field_name]');
            $query->fields('cnfi');
            $query->fields('cnf');
            foreach ($query->execute() as $field) {
                $this->fieldInfo[$field['type_name']][$field['field_name']] = $field;
            }
            foreach ($this->fieldInfo as $type => $fields) {
                foreach ($fields as $field => $info) {
                    foreach ($info as $property => $value) {
                        if ($property == 'db_columns' || str_ends_with($property, '_settings')) {
                            $this->fieldInfo[$type][$field][$property] = unserialize($value);
                        }
                    }
                }
            }
        }
        return $this->fieldInfo[$node_type] ?? [];
    }
    
    /**
     * Retrieves raw field data for a node.
     *
     * @param array $field
     *   A field and instance definition from getFieldInfo().
     * @param \Drupal\migrate\Row $node
     *   The node.
     *
     * @return array
     *   The field values, keyed and sorted by delta.
     */
    protected function getFieldData(array $field, Row $node) {
        $field_table = 'content_' . $field['field_name'];
        $node_table = 'content_type_' . $node->getSourceProperty('type');
        
        /** @var \Drupal\Core\Database\Schema $db */
        $db = $this->getDatabase()
            ->schema();
        if ($db->tableExists($field_table)) {
            $query = $this->select($field_table, 't');
            // If the delta column does not exist, add it as an expression to
            // normalize the query results.
            if ($db->fieldExists($field_table, 'delta')) {
                $query->addField('t', 'delta');
            }
            else {
                $query->addExpression(0, 'delta');
            }
        }
        elseif ($db->tableExists($node_table)) {
            $query = $this->select($node_table, 't');
            // Every row should have a delta of 0.
            $query->addExpression(0, 'delta');
        }
        if (isset($query)) {
            $columns = array_keys($field['db_columns']);
            // If there are no columns then there are no values to return.
            if (empty($columns)) {
                return [];
            }
            // Add every column in the field's schema.
            foreach ($columns as $column) {
                $query->addField('t', $field['field_name'] . '_' . $column, $column);
            }
            return $query->isNotNull($field['field_name'] . '_' . $columns[0])
                ->condition('nid', $node->getSourceProperty('nid'))
                ->condition('vid', $node->getSourceProperty('vid'))
                ->orderBy('delta')
                ->execute()
                ->fetchAllAssoc('delta');
        }
        else {
            return [];
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function getIds() {
        $ids['nid']['type'] = 'integer';
        $ids['nid']['alias'] = 'n';
        return $ids;
    }
    
    /**
     * Adapt our query for translations.
     *
     * @param \Drupal\Core\Database\Query\SelectInterface $query
     *   The generated query.
     */
    protected function handleTranslations(SelectInterface $query) {
        // Check whether or not we want translations.
        if (empty($this->configuration['translations'])) {
            // No translations: Yield untranslated nodes, or default translations.
            $query->where('[n].[tnid] = 0 OR [n].[tnid] = [n].[nid]');
        }
        else {
            // Translations: Yield only non-default translations.
            $query->where('[n].[tnid] <> 0 AND [n].[tnid] <> [n].[nid]');
        }
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
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
DrupalSqlBase::checkRequirements public function Checks if requirements for this plugin are OK. Overrides SqlBase::checkRequirements 4
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.
MigrateSourceInterface::NOT_COUNTABLE constant Indicates that the source is not countable.
Node::$fieldInfo protected property Cached field and field instance definitions.
Node::$filterDefaultFormat protected property The default filter format.
Node::$moduleHandler protected property The module handler. Overrides SourcePluginBase::$moduleHandler
Node::create public static function Creates an instance of the plugin. Overrides DrupalSqlBase::create
Node::fields public function Returns available fields on the source. Overrides MigrateSourceInterface::fields 1
Node::getFieldData protected function Retrieves raw field data for a node.
Node::getFieldInfo protected function Gets field and instance definitions from the database.
Node::getFieldValues protected function Gets field values for a node.
Node::getIds public function Defines the source fields uniquely identifying a source row. Overrides MigrateSourceInterface::getIds 1
Node::handleTranslations protected function Adapt our query for translations. 1
Node::initializeIterator protected function Initializes the iterator with the source data. Overrides SqlBase::initializeIterator
Node::JOIN constant The join options between the node and the node_revisions table. 1
Node::prepareRow public function Adds additional data to the row. Overrides SourcePluginBase::prepareRow
Node::query public function Overrides SqlBase::query 1
Node::__construct public function Overrides DrupalSqlBase::__construct
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::$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. 81
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::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.