content_types.inc 14.1 KB
Newer Older
drumm's avatar
drumm committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
<?php
// $Id$

/**
 * @file
 * Content type editing UI.
 */

/**
 * Displays the content type admin overview page.
 */
function node_overview_types() {
  $types = node_get_types();
  $names = node_get_types('names');
  $header = array(t('Name'), t('Type'), t('Description'), array('data' => t('Operations'), 'colspan' => '2'));
  $rows = array();

  foreach ($names as $key => $name) {
    $type = $types[$key];
20
    if (node_hook($type, 'form')) {
drumm's avatar
drumm committed
21
      $type_url_str = str_replace('_', '-', $type->type);
22 23 24
      $row = array(
        l($name, 'admin/content/types/'. $type_url_str),
        check_plain($type->type),
25
        filter_xss_admin($type->description),
26
      );
drumm's avatar
drumm committed
27
      // Set the edit column.
28
      $row[] = array('data' => l(t('edit'), 'admin/content/types/'. $type_url_str));
drumm's avatar
drumm committed
29 30 31

      // Set the delete column.
      if ($type->custom) {
32
        $row[] = array('data' => l(t('delete'), 'admin/content/types/'. $type_url_str .'/delete'));
drumm's avatar
drumm committed
33 34
      }
      else {
35
        $row[] = array('data' => '');
drumm's avatar
drumm committed
36 37 38 39 40 41 42 43 44 45 46 47 48 49 50
      }
      $rows[] = $row;
    }
  }

  if (empty($rows)) {
    $rows[] = array(array('data' => t('No content types available.'), 'colspan' => '5', 'class' => 'message'));
  }

  return theme('table', $header, $rows);
}

/**
 * Generates the node type editing form.
 */
51
function node_type_form(&$form_state, $type = NULL) {
drumm's avatar
drumm committed
52 53 54 55 56 57 58 59 60 61 62 63 64
  if (!isset($type->type)) {
    $type = new stdClass();
    $type->type = $type->name = $type->module = $type->description = $type->help = '';
    $type->min_word_count = 0;
    $type->has_title = TRUE;
    $type->has_body = TRUE;
    $type->title_label = t('Title');
    $type->body_label = t('Body');
    $type->custom = TRUE;
    $type->modified = FALSE;
    $type->locked = FALSE;
  }

65
  $form['#node_type'] = $type; // Make the type object available to implementations of hook_form_alter.
66

drumm's avatar
drumm committed
67 68 69 70 71 72 73 74
  $form['identity'] = array(
    '#type' => 'fieldset',
    '#title' => t('Identification'),
  );
  $form['identity']['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>create content</em> page. This name must begin with a capital letter and contain only letters, numbers, and <strong>spaces</strong>. This name must be unique.'),
drumm's avatar
drumm committed
76 77 78 79 80 81 82 83 84 85
    '#required' => TRUE,
  );

  if (!$type->locked) {
    $form['identity']['type'] = array(
      '#title' => t('Type'),
      '#type' => 'textfield',
      '#default_value' => $type->type,
      '#maxlength' => 32,
      '#required' => TRUE,
86
      '#description' => t('The machine-readable name of this content type. This text will be used for constructing the URL of the <em>create content</em> page for this content type. This name must contain only lowercase letters, numbers, and underscores. Underscores will be converted into hyphens when constructing the URL of the <em>create content</em> page. This name must be unique.'),
drumm's avatar
drumm committed
87 88 89 90 91 92 93 94 95 96 97 98 99 100 101
    );
  }
  else {
    $form['identity']['type'] = array(
      '#type' => 'value',
      '#value' => $type->type,
    );
    $form['identity']['type_display'] = array(
      '#title' => t('Type'),
      '#type' => 'item',
      '#value' => theme('placeholder', $type->type),
      '#description' => t('The machine-readable name of this content type. This field cannot be modified for system-defined content types.'),
    );
  }

102 103 104 105 106 107 108
  $form['identity']['description'] = array(
    '#title' => t('Description'),
    '#type' => 'textarea',
    '#default_value' => $type->description,
    '#description' => t('A brief description of this content type. This text will be displayed as part of the list on the <em>create content</em> page.'),
    );

drumm's avatar
drumm committed
109 110
  $form['submission'] = array(
    '#type' => 'fieldset',
111
    '#title' => t('Submission form settings'),
drumm's avatar
drumm committed
112
    '#collapsible' => TRUE,
113
    '#collapsed' => TRUE,
drumm's avatar
drumm committed
114
  );
115 116 117 118 119 120 121 122 123 124 125 126
  $form['submission']['title_label'] = array(
    '#title' => t('Title field label'),
    '#type' => 'textfield',
    '#default_value' => $type->title_label,
    '#required' => TRUE,
  );
  if (!$type->has_title) {
    // Avoid overwriting a content type that intentionally does not have a
    // title field.
    $form['submission']['title_label']['#attributes'] = array('disabled' => 'disabled');
    $form['submission']['title_label']['#description'] = t('This content type does not have a title field.');
    $form['submission']['title_label']['#required'] = FALSE;
drumm's avatar
drumm committed
127
  }
128 129 130
  $form['submission']['body_label'] = array(
    '#title' => t('Body field label'),
    '#type' => 'textfield',
131
    '#default_value' => isset($type->body_label) ? $type->body_label : '',
132 133
    '#description' => t('To omit the body field for this content type, remove any text and leave this field blank.'),
  );
drumm's avatar
drumm committed
134 135 136 137 138 139 140
  $form['submission']['min_word_count'] = array(
    '#type' => 'select',
    '#title' => t('Minimum number of words'),
    '#default_value' => $type->min_word_count,
    '#options' => drupal_map_assoc(array(0, 10, 25, 50, 75, 100, 125, 150, 175, 200)),
    '#description' => t('The minimum number of words for the body field to be considered valid for this content type. This can be useful to rule out submissions that do not meet the site\'s standards, such as short test posts.')
  );
141 142 143
  $form['submission']['help']  = array(
    '#type' => 'textarea',
    '#title' => t('Explanation or submission guidelines'),
144
    '#default_value' => $type->help,
145 146
    '#description' => t('This text will be displayed at the top of the submission form for this content type. It is useful for helping or instructing your users.')
  );
drumm's avatar
drumm committed
147 148
  $form['workflow'] = array(
    '#type' => 'fieldset',
149
    '#title' => t('Workflow settings'),
drumm's avatar
drumm committed
150
    '#collapsible' => TRUE,
151
    '#collapsed' => TRUE,
drumm's avatar
drumm committed
152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170
  );
  $form['workflow']['node_options'] = array('#type' => 'checkboxes',
    '#title' => t('Default options'),
    '#default_value' => variable_get('node_options_'. $type->type, array('status', 'promote')),
    '#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 nodes</em> permission will be able to override these options.'),
  );

  $form['old_type'] = array(
    '#type' => 'value',
    '#value' => $type->type,
  );
  $form['orig_type'] = array(
    '#type' => 'value',
171
    '#value' => isset($type->orig_type) ? $type->orig_type : '',
drumm's avatar
drumm committed
172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192
  );
  $form['module'] = array(
    '#type' => 'value',
    '#value' => $type->module,
  );
  $form['custom'] = array(
    '#type' => 'value',
    '#value' => $type->custom,
  );
  $form['modified'] = array(
    '#type' => 'value',
    '#value' => $type->modified,
  );
  $form['locked'] = array(
    '#type' => 'value',
    '#value' => $type->locked,
  );

  $form['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Save content type'),
193
    '#weight' => 40,
drumm's avatar
drumm committed
194 195 196 197 198 199 200
  );

  if ($type->custom) {
    if (!empty($type->type)) {
      $form['delete'] = array(
        '#type' => 'submit',
        '#value' => t('Delete content type'),
201
        '#weight' => 45,
drumm's avatar
drumm committed
202 203 204 205 206 207 208
      );
    }
  }
  else {
    $form['reset'] = array(
      '#type' => 'submit',
      '#value' => t('Reset to defaults'),
209
      '#weight' => 50,
drumm's avatar
drumm committed
210 211 212
    );
  }

213
  return $form;
drumm's avatar
drumm committed
214 215 216 217 218
}

/**
 * Implementation of hook_form_validate().
 */
219
function node_type_form_validate($form, &$form_state) {
drumm's avatar
drumm committed
220
  $type = new stdClass();
221 222
  $type->type = trim($form_state['values']['type']);
  $type->name = trim($form_state['values']['name']);
drumm's avatar
drumm committed
223 224

  // Work out what the type was before the user submitted this form
225
  $old_type = trim($form_state['values']['old_type']);
drumm's avatar
drumm committed
226 227 228

  $types = node_get_types('names');

229
  if (!$form_state['values']['locked']) {
drumm's avatar
drumm committed
230
    if (isset($types[$type->type]) && $type->type != $old_type) {
231
      form_set_error('type', t('The machine-readable name %type is already taken.', array('%type' => $type->type)));
drumm's avatar
drumm committed
232
    }
233
    if (!preg_match('!^[a-z0-9_]+$!', $type->type)) {
234
      form_set_error('type', t('The machine-readable name must contain only lowercase letters, numbers, and underscores.'));
drumm's avatar
drumm committed
235
    }
236 237 238 239
    // The type cannot be just the character '0', since elsewhere we check it using empty().
    if ($type->type === '0') {
      form_set_error('type', t("Invalid type. Please enter a type name other than '0' (the character zero)."));
    }
drumm's avatar
drumm committed
240 241 242 243 244
  }

  $names = array_flip($types);

  if (isset($names[$type->name]) && $names[$type->name] != $old_type) {
245
    form_set_error('name', t('The human-readable name %name is already taken.', array('%name' => $type->name)));
drumm's avatar
drumm committed
246 247 248 249 250 251
  }
}

/**
 * Implementation of hook_form_submit().
 */
252 253
function node_type_form_submit($form, &$form_state) {
  $op = isset($form_state['values']['op']) ? $form_state['values']['op'] : '';
drumm's avatar
drumm committed
254 255 256

  $type = new stdClass();

257 258 259 260
  $type->type = trim($form_state['values']['type']);
  $type->name = trim($form_state['values']['name']);
  $type->orig_type = trim($form_state['values']['orig_type']);
  $type->old_type = isset($form_state['values']['old_type']) ? $form_state['values']['old_type'] : $type->type;
drumm's avatar
drumm committed
261

262 263 264 265 266
  $type->description = $form_state['values']['description'];
  $type->help = $form_state['values']['help'];
  $type->min_word_count = $form_state['values']['min_word_count'];
  $type->title_label = $form_state['values']['title_label'];
  $type->body_label = $form_state['values']['body_label'];
drumm's avatar
drumm committed
267

268 269 270 271 272
  // title_label is required in core; has_title will always be true, unless a
  // module alters the title field.
  $type->has_title = ($type->title_label != '');
  $type->has_body = ($type->body_label != '');

273 274
  $type->module = !empty($form_state['values']['module']) ? $form_state['values']['module'] : 'node';
  $type->custom = $form_state['values']['custom'];
drumm's avatar
drumm committed
275
  $type->modified = TRUE;
276
  $type->locked = $form_state['values']['locked'];
drumm's avatar
drumm committed
277 278 279 280 281

  if ($op == t('Reset to defaults')) {
    node_type_reset($type);
  }
  elseif ($op == t('Delete content type')) {
282 283
    $form_state['redirect'] = 'admin/content/types/'. str_replace('_', '-', $type->old_type) .'/delete';
    return;
drumm's avatar
drumm committed
284 285 286 287
  }

  $status = node_type_save($type);

288
  $variables = $form_state['values'];
289

drumm's avatar
drumm committed
290 291
  // Remove everything that's been saved already - whatever's left is assumed
  // to be a persistent variable.
292
  foreach ($variables as $key => $value) {
drumm's avatar
drumm committed
293
    if (isset($type->$key)) {
294
      unset($variables[$key]);
drumm's avatar
drumm committed
295 296 297
    }
  }

298
  unset($variables['form_token'], $variables['op'], $variables['submit'], $variables['delete'], $variables['reset'], $variables['form_id']);
drumm's avatar
drumm committed
299 300

  // Save or reset persistent variable values.
301
  foreach ($variables as $key => $value) {
302 303 304
    $variable_new = $key .'_'. $type->type;
    $variable_old = $key .'_'. $type->old_type;

drumm's avatar
drumm committed
305
    if ($op == t('Reset to defaults')) {
306
      variable_del($variable_old);
drumm's avatar
drumm committed
307 308 309 310 311
    }
    else {
      if (is_array($value)) {
        $value = array_keys(array_filter($value));
      }
312
      variable_set($variable_new, $value);
drumm's avatar
drumm committed
313

314 315
      if ($variable_new != $variable_old) {
        variable_del($variable_old);
drumm's avatar
drumm committed
316 317 318 319 320 321
      }
    }
  }

  node_types_rebuild();
  menu_rebuild();
322
  $t_args = array('%name' => $type->name);
drumm's avatar
drumm committed
323 324 325 326 327 328 329 330 331 332 333

  if ($op == t('Reset to defaults')) {
    drupal_set_message(t('The content type %name has been reset to its default values.', $t_args));
    return;
  }

  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));
334
    watchdog('node', 'Added content type %name.', $t_args, WATCHDOG_NOTICE, l(t('view'), 'admin/content/types'));
drumm's avatar
drumm committed
335 336
  }

337 338
  $form_state['redirect'] = 'admin/content/types';
  return;
drumm's avatar
drumm committed
339 340
}

341 342 343 344
/**
 * Implementation of hook_node_type().
 */
function node_node_type($op, $info) {
345
  if ($op != 'delete' && !empty($info->old_type) && $info->old_type != $info->type) {
346 347 348
    $update_count = node_type_update_nodes($info->old_type, $info->type);

    if ($update_count) {
349
      drupal_set_message(format_plural($update_count, 'Changed the content type of 1 post from %old-type to %type.', 'Changed the content type of @count posts from %old-type to %type.', array('%old-type' => $info->old_type, '%type' => $info->type)));
350 351 352 353
    }
  }
}

drumm's avatar
drumm committed
354 355 356 357 358 359 360 361 362 363
/**
 * Resets all of the relevant fields of a module-defined node type to their
 * default values.
 *
 * @param &$type
 *   The node type to reset. The node type is passed back by reference with its
 *   resetted values. If there is no module-defined info for this node type,
 *   then nothing happens.
 */
function node_type_reset(&$type) {
364
  $info_array = module_invoke_all('node_info');
drumm's avatar
drumm committed
365 366 367 368 369 370 371 372 373 374 375 376 377
  if (isset($info_array[$type->orig_type])) {
    $info = _node_type_set_defaults($info_array[$type->orig_type]);
    $info['type'] = $type->orig_type;

    foreach ($info as $field => $value) {
      $type->$field = $value;
    }
  }
}

/**
 * Menu callback; delete a single content type.
 */
378
function node_type_delete_confirm(&$form_state, $type) {
drumm's avatar
drumm committed
379 380 381
  $form['type'] = array('#type' => 'value', '#value' => $type->type);
  $form['name'] = array('#type' => 'value', '#value' => $type->name);

382
  $message = t('Are you sure you want to delete the content type %type?', array('%type' => $type->name));
drumm's avatar
drumm committed
383 384
  $caption = '';

385
  $num_nodes = db_result(db_query("SELECT COUNT(*) FROM {node} WHERE type = '%s'", $type->type));
drumm's avatar
drumm committed
386
  if ($num_nodes) {
387
    $caption .= '<p>'. format_plural($num_nodes, '<strong>Warning:</strong> there is currently 1 %type post on your site. It may not be able to be displayed or edited correctly, once you have removed this content type.', '<strong>Warning:</strong> there are currently @count %type posts on your site. They may not be able to be displayed or edited correctly, once you have removed this content type.', array('%type' => $type->name)) .'</p>';
drumm's avatar
drumm committed
388 389 390 391
  }

  $caption .= '<p>'. t('This action cannot be undone.') .'</p>';

392
  return confirm_form($form, $message, 'admin/content/types', $caption, t('Delete'));
drumm's avatar
drumm committed
393 394 395
}

/**
396
 * Process content type delete confirm submissions.
drumm's avatar
drumm committed
397
 */
398 399
function node_type_delete_confirm_submit($form, &$form_state) {
  node_type_delete($form_state['values']['type']);
drumm's avatar
drumm committed
400

401
  $t_args = array('%name' => $form_state['values']['name']);
drumm's avatar
drumm committed
402
  drupal_set_message(t('The content type %name has been deleted.', $t_args));
403
  watchdog('menu', 'Deleted content type %name.', $t_args, WATCHDOG_NOTICE);
drumm's avatar
drumm committed
404 405 406 407

  node_types_rebuild();
  menu_rebuild();

408 409
  $form_state['redirect'] = 'admin/content/types';
  return;
drumm's avatar
drumm committed
410
}