NodeType.php

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

Namespace

Drupal\node\Plugin\migrate\source\d6

File

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

View source
<?php

namespace Drupal\node\Plugin\migrate\source\d6;

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

/**
 * Drupal 6 Node types source from database.
 *
 * For available configuration keys, refer to the parent classes.
 *
 * @see \Drupal\migrate\Plugin\migrate\source\SqlBase
 * @see \Drupal\migrate\Plugin\migrate\source\SourcePluginBase
 *
 * @MigrateSource(
 *   id = "d6_node_type",
 *   source_module = "node"
 * )
 */
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;
  }

}

Classes

Title Deprecated Summary
NodeType Drupal 6 Node types source from database.

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