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/d6/NodeType.php
Same filename 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\d7

File

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

View source
<?php

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

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

/**
 * Drupal 7 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 = "d7_node_type",
 *   source_module = "node"
 * )
 */
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;
    }

}

Classes

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

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