Same name in this branch
  1. 10 core/modules/node/src/Entity/NodeType.php \Drupal\node\Entity\NodeType
  2. 10 core/modules/node/src/Plugin/migrate/source/d6/NodeType.php \Drupal\node\Plugin\migrate\source\d6\NodeType
  3. 10 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. 8.9.x core/modules/node/src/Plugin/migrate/source/d7/NodeType.php \Drupal\node\Plugin\migrate\source\d7\NodeType
  2. 9 core/modules/node/src/Plugin/migrate/source/d7/NodeType.php \Drupal\node\Plugin\migrate\source\d7\NodeType

Drupal 7 Node types source from database.

For available configuration keys, refer to the parent classes.

Plugin annotation


@MigrateSource(
  id = "d7_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/d7/NodeType.php, line 21

Namespace

Drupal\node\Plugin\migrate\source\d7
View source
class NodeType extends DrupalSqlBase {

  /**
   * The teaser length.
   *
   * @var int
   */
  protected $teaserLength;

  /**
   * Node preview optional / required.
   *
   * @var int
   */
  protected $nodePreview;

  /**
   * {@inheritdoc}
   */
  public function query() {
    return $this
      ->select('node_type', 't')
      ->fields('t');
  }

  /**
   * {@inheritdoc}
   */
  public function fields() {
    $fields = [
      'type' => $this
        ->t('Machine name of the node type.'),
      'name' => $this
        ->t('Human name of 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.'),
      'disabled' => $this
        ->t('Flag indicating the node type is enable'),
      'base' => $this
        ->t('base node.'),
      '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);
    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);

    // Don't create a body field until we prove that this node type has one.
    $row
      ->setSourceProperty('create_body', FALSE);
    if ($this
      ->moduleExists('field')) {

      // Find body field for this node type.
      $body = $this
        ->select('field_config_instance', 'fci')
        ->fields('fci', [
        'data',
      ])
        ->condition('entity_type', 'node')
        ->condition('bundle', $row
        ->getSourceProperty('type'))
        ->condition('field_name', 'body')
        ->execute()
        ->fetchAssoc();
      if ($body) {
        $row
          ->setSourceProperty('create_body', TRUE);
        $body['data'] = unserialize($body['data']);
        $row
          ->setSourceProperty('body_label', $body['data']['label']);
      }
    }
    $row
      ->setSourceProperty('display_submitted', $this
      ->variableGet('node_submitted_' . $type, TRUE));
    if ($menu_options = $this
      ->variableGet('menu_options_' . $type, NULL)) {
      $row
        ->setSourceProperty('available_menus', $menu_options);
    }
    if ($parent = $this
      ->variableGet('menu_parent_' . $type, NULL)) {
      $row
        ->setSourceProperty('parent', $parent . ':');
    }
    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

Name Modifierssort descending Type Description Overrides
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
MigrateSourceInterface::NOT_COUNTABLE constant Indicates that the source is not countable.
NodeType::getCommentFields protected function Returns the fields containing comment settings for each node type.
NodeType::initializeIterator protected function Initializes the iterator with the source data. Overrides SqlBase::initializeIterator
DrupalSqlBase::getModuleSchemaVersion protected function Retrieves a module schema_version 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.
DependencyTrait::addDependency protected function Adds a dependency.
DependencyTrait::addDependencies protected function Adds multiple dependencies.
SqlBase::setUpDatabase protected function Gets a connection to the referenced database.
SqlBase::select protected function Wrapper for database select.
SqlBase::prepareQuery protected function Adds tags and metadata to the query.
SqlBase::fetchNextRow protected function Position the iterator to the following row. Overrides SourcePluginBase::fetchNextRow
SqlBase::fetchNextBatch protected function Prepares query for the next set of data from the source database.
SqlBase::doCount protected function Gets the source count using countQuery(). Overrides SourcePluginBase::doCount 6
SqlBase::mapJoinable protected function Checks if we can join against the map table. 1
SourcePluginBase::getModuleHandler protected function Gets the module handler.
SourcePluginBase::getIterator protected function Returns the iterator that will yield the row arrays to be processed.
SourcePluginBase::aboveHighWater protected function Check if the incoming data is newer than what we've previously imported.
SourcePluginBase::rowChanged protected function Checks if the incoming row has changed since our last import.
SourcePluginBase::getCache protected function Gets the cache object.
SourcePluginBase::getHighWaterStorage protected function Get the high water storage object.
SourcePluginBase::getHighWater protected function The current value of the high water mark.
SourcePluginBase::saveHighWater protected function Save the new high water mark.
SourcePluginBase::getHighWaterProperty protected function Get information on the property used as the high watermark.
SourcePluginBase::getHighWaterField protected function Get the name of the field used as the high watermark.
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
NodeType::$teaserLength protected property The teaser length.
NodeType::$nodePreview protected property Node preview optional / required.
DrupalSqlBase::$systemData protected property The contents of the system table.
DrupalSqlBase::$requirements protected property If the source provider is missing.
DrupalSqlBase::$entityTypeManager protected property The entity type manager.
DependencyTrait::$dependencies protected property The object's dependencies.
SqlBase::$query protected property The query string. 81
SqlBase::$database protected property The database object. 1
SqlBase::$state protected property State service for retrieving database info.
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.
SourcePluginBase::$moduleHandler protected property The module handler service. 2
SourcePluginBase::$migration protected property The entity migration object.
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::$originalHighWater protected property The high water mark at the beginning of the import operation.
SourcePluginBase::$cacheCounts protected property Whether this instance should cache the source count. 1
SourcePluginBase::$cacheKey protected property Key to use for caching counts.
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::$mapRowAdded protected property Flags whether source plugin will read the map row and add to data row.
SourcePluginBase::$cache protected property The backend cache.
SourcePluginBase::$idMap protected property The migration ID map.
SourcePluginBase::$iterator protected property The iterator to iterate over the source rows.
StringTranslationTrait::$stringTranslation protected property The string translation service. 3
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::$_entityStorages protected property
MessengerTrait::$messenger protected property The messenger. 10
PluginBase::$pluginId protected property The plugin_id.
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
NodeType::query public function Overrides SqlBase::query
NodeType::fields public function Returns available fields on the source. Overrides MigrateSourceInterface::fields
NodeType::prepareRow public function Adds additional data to the row. Overrides SourcePluginBase::prepareRow
NodeType::getIds public function Defines the source fields uniquely identifying a source row. Overrides MigrateSourceInterface::getIds
DrupalSqlBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides SqlBase::__construct 5
DrupalSqlBase::getSystemData public function Retrieves all system data information from the source Drupal database.
DrupalSqlBase::checkRequirements public function Checks if requirements for this plugin are OK. Overrides SqlBase::checkRequirements 4
DrupalSqlBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
SqlBase::__toString public function Prints the query string when the object is used as a string. Overrides MigrateSourceInterface::__toString
SqlBase::getDatabase public function Gets the database connection object. 2
SqlBase::__sleep public function Overrides DependencySerializationTrait::__sleep
SqlBase::rewind public function Overrides SourcePluginBase::rewind
SourcePluginBase::current public function
SourcePluginBase::key public function
SourcePluginBase::valid public function
SourcePluginBase::next public function
SourcePluginBase::getCurrentIds public function Gets the currentSourceIds data member.
SourcePluginBase::count public function 2
SourcePluginBase::preRollback public function Performs pre-rollback tasks. Overrides RollbackAwareInterface::preRollback
SourcePluginBase::postRollback public function Performs post-rollback tasks. Overrides RollbackAwareInterface::postRollback
SourcePluginBase::getSourceModule public function Gets the source module providing the source data. Overrides MigrateSourceInterface::getSourceModule
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 1
DependencySerializationTrait::__wakeup public function 2
MessengerTrait::setMessenger public function Sets the messenger.
MessengerTrait::messenger public function Gets the messenger. 10
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 2
PluginBase::isConfigurable public function Determines if the plugin is configurable.
DrupalSqlBase::create public static function Creates an instance of the plugin. Overrides SqlBase::create 2