class NodeType

Same name in this branch
  1. 11.x core/modules/node/src/Entity/NodeType.php \Drupal\node\Entity\NodeType
  2. 11.x core/modules/node/src/Plugin/migrate/source/d7/NodeType.php \Drupal\node\Plugin\migrate\source\d7\NodeType
Same name and namespace in other branches
  1. 9 core/modules/node/src/Entity/NodeType.php \Drupal\node\Entity\NodeType
  2. 9 core/modules/node/src/Plugin/migrate/source/d6/NodeType.php \Drupal\node\Plugin\migrate\source\d6\NodeType
  3. 9 core/modules/node/src/Plugin/migrate/source/d7/NodeType.php \Drupal\node\Plugin\migrate\source\d7\NodeType
  4. 9 core/modules/node/src/Plugin/Condition/NodeType.php \Drupal\node\Plugin\Condition\NodeType
  5. 8.9.x core/modules/node/src/Entity/NodeType.php \Drupal\node\Entity\NodeType
  6. 8.9.x core/modules/node/src/Plugin/migrate/source/d6/NodeType.php \Drupal\node\Plugin\migrate\source\d6\NodeType
  7. 8.9.x core/modules/node/src/Plugin/migrate/source/d7/NodeType.php \Drupal\node\Plugin\migrate\source\d7\NodeType
  8. 8.9.x core/modules/node/src/Plugin/Condition/NodeType.php \Drupal\node\Plugin\Condition\NodeType
  9. 10 core/modules/node/src/Entity/NodeType.php \Drupal\node\Entity\NodeType
  10. 10 core/modules/node/src/Plugin/migrate/source/d6/NodeType.php \Drupal\node\Plugin\migrate\source\d6\NodeType
  11. 10 core/modules/node/src/Plugin/migrate/source/d7/NodeType.php \Drupal\node\Plugin\migrate\source\d7\NodeType

Drupal 6 Node types source from database.

For available configuration keys, refer to the parent classes.

Plugin annotation


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

Hierarchy

Expanded class hierarchy of NodeType

See also

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

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

File

core/modules/node/src/Plugin/migrate/source/d6/NodeType.php, line 21

Namespace

Drupal\node\Plugin\migrate\source\d6
View source
class NodeType extends DrupalSqlBase {
    
    /**
     * The teaser length.
     *
     * @var int
     */
    protected $teaserLength;
    
    /**
     * Node preview optional / required.
     *
     * @var int
     */
    protected $nodePreview;
    
    /**
     * An array of theme settings.
     *
     * @var array
     */
    protected $themeSettings;
    
    /**
     * {@inheritdoc}
     */
    public function query() {
        return $this->select('node_type', 't')
            ->fields('t', [
            'type',
            'name',
            'module',
            'description',
            'help',
            'title_label',
            'has_body',
            'body_label',
            'min_word_count',
            'custom',
            'modified',
            'locked',
            'orig_type',
        ])
            ->orderBy('t.type');
    }
    
    /**
     * {@inheritdoc}
     */
    public function fields() {
        $fields = [
            'type' => $this->t('Machine name of the node type.'),
            'name' => $this->t('Human name of the node type.'),
            'module' => $this->t('The module providing the node type.'),
            'description' => $this->t('Description of the node type.'),
            'help' => $this->t('Help text for the node type.'),
            'title_label' => $this->t('Title label.'),
            'has_body' => $this->t('Flag indicating the node type has a body field.'),
            'body_label' => $this->t('Body label.'),
            'min_word_count' => $this->t('Minimum word count for the body field.'),
            'custom' => $this->t('Flag.'),
            'modified' => $this->t('Flag.'),
            'locked' => $this->t('Flag.'),
            'orig_type' => $this->t('The original type.'),
            'teaser_length' => $this->t('Teaser length'),
        ];
        if ($this->moduleExists('comment')) {
            $fields += $this->getCommentFields();
        }
        return $fields;
    }
    
    /**
     * Returns the fields containing comment settings for each node type.
     *
     * @return string[]
     *   An associative array of field descriptions, keyed by field.
     */
    protected function getCommentFields() {
        return [
            'comment' => $this->t('Default comment setting'),
            'comment_default_mode' => $this->t('Default display mode'),
            'comment_default_per_page' => $this->t('Default comments per page'),
            'comment_anonymous' => $this->t('Anonymous commenting'),
            'comment_subject_field' => $this->t('Comment subject field'),
            'comment_preview' => $this->t('Preview comment'),
            'comment_form_location' => $this->t('Location of comment submission form'),
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    protected function initializeIterator() {
        $this->teaserLength = $this->variableGet('teaser_length', 600);
        $this->nodePreview = $this->variableGet('node_preview', 0);
        $this->themeSettings = $this->variableGet('theme_settings', []);
        return parent::initializeIterator();
    }
    
    /**
     * {@inheritdoc}
     */
    public function prepareRow(Row $row) {
        $row->setSourceProperty('teaser_length', $this->teaserLength);
        $row->setSourceProperty('node_preview', $this->nodePreview);
        $type = $row->getSourceProperty('type');
        $source_options = $this->variableGet('node_options_' . $type, [
            'promote',
            'sticky',
        ]);
        $options = [];
        foreach ([
            'promote',
            'sticky',
            'status',
            'revision',
        ] as $item) {
            $options[$item] = in_array($item, $source_options);
        }
        $row->setSourceProperty('options', $options);
        $submitted = $this->themeSettings['toggle_node_info_' . $type] ?? FALSE;
        $row->setSourceProperty('display_submitted', $submitted);
        if ($default_node_menu = $this->variableGet('menu_default_node_menu', NULL)) {
            $row->setSourceProperty('available_menus', [
                $default_node_menu,
            ]);
            $row->setSourceProperty('parent', $default_node_menu . ':');
        }
        if ($this->moduleExists('comment')) {
            foreach (array_keys($this->getCommentFields()) as $field) {
                $row->setSourceProperty($field, $this->variableGet($field . '_' . $type, NULL));
            }
        }
        return parent::prepareRow($row);
    }
    
    /**
     * {@inheritdoc}
     */
    public function getIds() {
        $ids['type']['type'] = 'string';
        return $ids;
    }

}

Members

Title Sort descending 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.
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::create public static function Creates an instance of the plugin. Overrides SqlBase::create 2
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 5
MigrateSourceInterface::NOT_COUNTABLE constant Indicates that the source is not countable.
NodeType::$nodePreview protected property Node preview optional / required.
NodeType::$teaserLength protected property The teaser length.
NodeType::$themeSettings protected property An array of theme settings.
NodeType::fields public function Returns available fields on the source. Overrides MigrateSourceInterface::fields
NodeType::getCommentFields protected function Returns the fields containing comment settings for each node type.
NodeType::getIds public function Defines the source fields uniquely identifying a source row. Overrides MigrateSourceInterface::getIds
NodeType::initializeIterator protected function Initializes the iterator with the source data. Overrides SqlBase::initializeIterator
NodeType::prepareRow public function Adds additional data to the row. Overrides SourcePluginBase::prepareRow
NodeType::query public function Overrides SqlBase::query
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::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.