NodeTypeForm.php 9.11 KB
Newer Older
1 2 3 4
<?php

/**
 * @file
5
 * Contains \Drupal\node\NodeTypeForm.
6 7 8 9
 */

namespace Drupal\node;

10
use Drupal\Core\Entity\EntityForm;
11
use Drupal\Core\Entity\EntityManagerInterface;
12
use Drupal\Component\Utility\String;
13
use Drupal\Core\Entity\EntityTypeInterface;
14
use Drupal\Core\Form\FormStateInterface;
15
use Symfony\Component\DependencyInjection\ContainerInterface;
16 17 18 19

/**
 * Form controller for node type forms.
 */
20
class NodeTypeForm extends EntityForm {
21

22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47
  /**
   * The entity manager.
   *
   * @var \Drupal\Core\Entity\EntityManagerInterface
   */
  protected $entityManager;

  /**
   * Constructs the NodeTypeForm object.
   *
   * @param \Drupal\Core\Entity\EntityManagerInterface $entity_manager
   *   The entity manager
   */
  public function __construct(EntityManagerInterface $entity_manager) {
    $this->entityManager = $entity_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static(
      $container->get('entity.manager')
    );
  }

48 49 50
  /**
   * {@inheritdoc}
   */
51
  public function form(array $form, FormStateInterface $form_state) {
52 53 54 55
    $form = parent::form($form, $form_state);

    $type = $this->entity;
    if ($this->operation == 'add') {
56
      $form['#title'] = String::checkPlain($this->t('Add content type'));
57 58 59 60 61 62
      $fields = $this->entityManager->getBaseFieldDefinitions('node');
      // Create a node with a fake bundle using the type's UUID so that we can
      // get the default values for workflow settings.
      // @todo Make it possible to get default values without an entity.
      //   https://www.drupal.org/node/2318187
      $node = $this->entityManager->getStorage('node')->create(array('type' => $type->uuid()));
63
    }
64
    else {
65
      $form['#title'] = $this->t('Edit %label content type', array('%label' => $type->label()));
66 67 68
      $fields = $this->entityManager->getFieldDefinitions('node', $type->id());
      // Create a node to get the current values for workflow settings fields.
      $node = $this->entityManager->getStorage('node')->create(array('type' => $type->id()));
69 70 71 72 73 74
    }

    $form['name'] = array(
      '#title' => t('Name'),
      '#type' => 'textfield',
      '#default_value' => $type->name,
75
      '#description' => t('The human-readable name of this content type. This text will be displayed as part of the list on the <em>Add content</em> page. It is recommended that this name begin with a capital letter and contain only letters, numbers, and spaces. This name must be unique.'),
76 77 78 79 80 81 82
      '#required' => TRUE,
      '#size' => 30,
    );

    $form['type'] = array(
      '#type' => 'machine_name',
      '#default_value' => $type->id(),
83
      '#maxlength' => EntityTypeInterface::BUNDLE_MAX_LENGTH,
84 85 86 87 88 89
      '#disabled' => $type->isLocked(),
      '#machine_name' => array(
        'exists' => 'node_type_load',
        'source' => array('name'),
      ),
      '#description' => t('A unique machine-readable name for this content type. It must only contain lowercase letters, numbers, and underscores. This name will be used for constructing the URL of the %node-add page, in which underscores will be converted into hyphens.', array(
90
        '%node-add' => t('Add content'),
91 92 93 94 95 96 97
      )),
    );

    $form['description'] = array(
      '#title' => t('Description'),
      '#type' => 'textarea',
      '#default_value' => $type->description,
98
      '#description' => t('Describe this content type. The text will be displayed on the <em>Add content</em> page.'),
99 100 101 102 103
    );

    $form['additional_settings'] = array(
      '#type' => 'vertical_tabs',
      '#attached' => array(
104
        'library' => array('node/drupal.content_types'),
105 106 107 108 109 110 111
      ),
    );

    $form['submission'] = array(
      '#type' => 'details',
      '#title' => t('Submission form settings'),
      '#group' => 'additional_settings',
112
      '#open' => TRUE,
113 114 115 116
    );
    $form['submission']['title_label'] = array(
      '#title' => t('Title field label'),
      '#type' => 'textfield',
117
      '#default_value' => $fields['title']->getLabel(),
118 119
      '#required' => TRUE,
    );
120
    $form['submission']['preview_mode'] = array(
121 122
      '#type' => 'radios',
      '#title' => t('Preview before submitting'),
123
      '#default_value' => $type->getPreviewMode(),
124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140
      '#options' => array(
        DRUPAL_DISABLED => t('Disabled'),
        DRUPAL_OPTIONAL => t('Optional'),
        DRUPAL_REQUIRED => t('Required'),
      ),
    );
    $form['submission']['help']  = array(
      '#type' => 'textarea',
      '#title' => t('Explanation or submission guidelines'),
      '#default_value' => $type->help,
      '#description' => t('This text will be displayed at the top of the page when creating or editing content of this type.'),
    );
    $form['workflow'] = array(
      '#type' => 'details',
      '#title' => t('Publishing options'),
      '#group' => 'additional_settings',
    );
141 142 143 144
    $workflow_options = array(
      'status' => $node->status->value,
      'promote' => $node->promote->value,
      'sticky' => $node->sticky->value,
145
      'revision' => $type->isNewRevision(),
146 147 148 149
    );
    // Prepare workflow options to be used for 'checkboxes' form element.
    $keys = array_keys(array_filter($workflow_options));
    $workflow_options = array_combine($keys, $keys);
150 151
    $form['workflow']['options'] = array('#type' => 'checkboxes',
      '#title' => t('Default options'),
152
      '#default_value' => $workflow_options,
153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182
      '#options' => array(
        'status' => t('Published'),
        'promote' => t('Promoted to front page'),
        'sticky' => t('Sticky at top of lists'),
        'revision' => t('Create new revision'),
      ),
      '#description' => t('Users with the <em>Administer content</em> permission will be able to override these options.'),
    );
    if ($this->moduleHandler->moduleExists('language')) {
      $form['language'] = array(
        '#type' => 'details',
        '#title' => t('Language settings'),
        '#group' => 'additional_settings',
      );

      $language_configuration = language_get_default_configuration('node', $type->id());
      $form['language']['language_configuration'] = array(
        '#type' => 'language_configuration',
        '#entity_information' => array(
          'entity_type' => 'node',
          'bundle' => $type->id(),
        ),
        '#default_value' => $language_configuration,
      );
    }
    $form['display'] = array(
      '#type' => 'details',
      '#title' => t('Display settings'),
      '#group' => 'additional_settings',
    );
183
    $form['display']['display_submitted'] = array(
184
      '#type' => 'checkbox',
185
      '#title' => t('Display author and date information'),
186
      '#default_value' => $type->displaySubmitted(),
187 188 189 190 191 192 193 194
      '#description' => t('Author username and publish date will be displayed.'),
    );
    return $form;
  }

  /**
   * {@inheritdoc}
   */
195
  protected function actions(array $form, FormStateInterface $form_state) {
196 197 198 199 200 201 202 203 204
    $actions = parent::actions($form, $form_state);
    $actions['submit']['#value'] = t('Save content type');
    $actions['delete']['#value'] = t('Delete content type');
    return $actions;
  }

  /**
   * {@inheritdoc}
   */
205
  public function validate(array $form, FormStateInterface $form_state) {
206 207
    parent::validate($form, $form_state);

208
    $id = trim($form_state->getValue('type'));
209 210
    // '0' is invalid, since elsewhere we check it using empty().
    if ($id == '0') {
211
      $form_state->setErrorByName('type', $this->t("Invalid machine-readable name. Enter a name other than %invalid.", array('%invalid' => $id)));
212 213 214 215 216 217
    }
  }

  /**
   * {@inheritdoc}
   */
218
  public function save(array $form, FormStateInterface $form_state) {
219
    $type = $this->entity;
220
    $type->setNewRevision($form_state->getValue(array('options', 'revision')));
221 222 223 224 225 226 227 228 229 230 231 232
    $type->type = trim($type->id());
    $type->name = trim($type->name);

    $status = $type->save();

    $t_args = array('%name' => $type->label());

    if ($status == SAVED_UPDATED) {
      drupal_set_message(t('The content type %name has been updated.', $t_args));
    }
    elseif ($status == SAVED_NEW) {
      drupal_set_message(t('The content type %name has been added.', $t_args));
233 234
      $context = array_merge($t_args, array('link' => l(t('View'), 'admin/structure/types')));
      $this->logger('node')->notice('Added content type %name.', $context);
235 236
    }

237 238 239
    $fields = $this->entityManager->getFieldDefinitions('node', $type->id());
    // Update title field definition.
    $title_field = $fields['title'];
240 241 242
    $title_label = $form_state->getValue('title_label');
    if ($title_field->getLabel() != $title_label) {
      $title_field->getConfig($type->id())->setLabel($title_label)->save();
243 244 245 246 247 248
    }
    // Update workflow options.
    // @todo Make it possible to get default values without an entity.
    //   https://www.drupal.org/node/2318187
    $node = $this->entityManager->getStorage('node')->create(array('type' => $type->id()));
    foreach (array('status', 'promote', 'sticky')  as $field_name) {
249
      $value = (bool) $form_state->getValue(['options', $field_name]);
250 251 252 253 254 255
      if ($node->$field_name->value != $value) {
        $fields[$field_name]->getConfig($type->id())->setDefaultValue($value)->save();
      }
    }

    $this->entityManager->clearCachedFieldDefinitions();
256
    $form_state->setRedirect('node.overview_types');
257 258 259
  }

}