You are here

node.inc in Quick Edit 7

Implements Quick Edit module hooks on behalf of node.module.

File

includes/node.inc
View source
<?php

/**
 * @file
 * Implements Quick Edit module hooks on behalf of node.module.
 */

/**
 * Implements hook_quickedit_extra_fields_info().
 *
 * @todo document this in quickedit.api.php, but first evolve this to ensure it
 *   is a sufficiently complete API.
 */
function node_quickedit_extra_fields_info() {
  $extra['node'] = array(
    'title' => array(
      'label' => t('Title'),
      'default editor' => 'form',
      'view mode dependent editor' => array(
        'full' => 'plain_text',
        'teaser' => 'plain_text',
      ),
      'quickedit subform id' => 'quickedit_field_node_title_edit_form',
      'form simplification element key' => 'title',
      'rerender callback' => 'quickedit_field_node_title_rerender',
    ),
    'author' => array(
      'label' => t('Author'),
      'default editor' => 'form',
      'quickedit subform id' => 'quickedit_field_node_author_edit_form',
      'form simplification element key' => 'name',
      'rerender callback' => 'quickedit_field_node_author_rerender',
    ),
    'created' => array(
      'label' => t('Created'),
      'default editor' => 'form',
      'quickedit subform id' => 'quickedit_field_node_created_edit_form',
      'form simplification element key' => 'date',
      'rerender callback' => 'quickedit_field_node_created_rerender',
    ),
  );
  return $extra;
}

/**
 * Form constructor; in-place editing form for node's 'author' "extra field".
 *
 * This isn't a true form. As such it modifies the $form by reference.
 *
 * @see quickedit_field_node_author_edit_form_validate()
 * @see quickedit_field_node_author_edit_form_submit()
 * @ingroup forms
 */
function quickedit_field_node_author_edit_form(&$form, &$form_state, $node, $field_name) {
  _quickedit_node_object_prepare($node);
  $form['name'] = array(
    '#type' => 'textfield',
    '#title' => t('Authored by'),
    '#maxlength' => 60,
    '#autocomplete_path' => 'user/autocomplete',
    '#default_value' => !empty($node->name) ? $node->name : '',
    '#weight' => -1,
    '#description' => t('Leave blank for %anonymous.', array(
      '%anonymous' => variable_get('anonymous', t('Anonymous')),
    )),
  );
  $form['#validate'][] = 'quickedit_field_node_author_edit_form_validate';
  $form['#submit'][] = 'quickedit_field_node_author_edit_form_submit';
}

/**
 * Form validation handler for quickedit_field_node_author_edit_form().
 *
 * @see node_validate()
 * @see quickedit_field_node_author_edit_form()
 * @see quickedit_field_node_author_edit_form_submit()
 */
function quickedit_field_node_author_edit_form_validate($form, &$form_state) {
  $name = $form_state['values']['name'];
  if (!empty($name) && !($account = user_load_by_name($name))) {

    // The use of empty() is mandatory in the context of usernames
    // as the empty string denotes the anonymous user. In case we
    // are dealing with an anonymous user we set the user ID to 0.
    form_set_error('name', t('The username %name does not exist.', array(
      '%name' => $name,
    )));
  }
}

/**
 * Form submission handler for quickedit_field_node_author_edit_form().
 *
 * @see node_submit()
 * @see quickedit_field_node_author_edit_form()
 * @see quickedit_field_node_author_edit_form_validate()
 */
function quickedit_field_node_author_edit_form_submit($form, &$form_state) {
  $entity = $form_state['entity'];
  if ($account = user_load_by_name($form_state['values']['name'])) {
    $entity->uid = $account->uid;
    $entity->name = $account->name;
  }
  else {
    $entity->uid = 0;
  }

  // We must load fape.inc to use _quickedit_entity_set_log().
  module_load_include('inc', 'quickedit', 'includes/fape');
  _quickedit_entity_set_log($entity, t('Author'));
  _quickedit_entity_save_to_tempstore($form_state['entity_type'], $form_state['entity_id'], $entity);
}
function quickedit_field_node_author_rerender($entity) {
  return array(
    'value' => theme('username', array(
      'account' => $entity,
      'name' => $entity->name,
    )),
    'inline' => TRUE,
  );
}

/**
 * Form constructor; in-place editing form for node's 'created' "extra field".
 *
 * This isn't a true form. As such it modifies the $form by reference.
 *
 * @see quickedit_field_node_created_edit_form_validate()
 * @see quickedit_field_node_created_edit_form_submit()
 * @ingroup forms
 */
function quickedit_field_node_created_edit_form(&$form, &$form_state, $node, $field_name) {
  _quickedit_node_object_prepare($node);
  $form['date'] = array(
    '#type' => 'textfield',
    '#title' => t('Authored on'),
    '#maxlength' => 25,
    '#description' => t('Format: %time. The date format is YYYY-MM-DD and %timezone is the time zone offset from UTC. Leave blank to use the time of form submission.', array(
      '%time' => !empty($node->date) ? date_format(date_create($node->date), 'Y-m-d H:i:s O') : format_date($node->created, 'custom', 'Y-m-d H:i:s O'),
      '%timezone' => !empty($node->date) ? date_format(date_create($node->date), 'O') : format_date($node->created, 'custom', 'O'),
    )),
    '#default_value' => !empty($node->date) ? $node->date : '',
  );
  $form['#validate'][] = 'quickedit_field_node_created_edit_form_validate';
  $form['#submit'][] = 'quickedit_field_node_created_edit_form_submit';
}

/**
 * Form validation handler for quickedit_field_node_created_edit_form().
 *
 * @see node_validate()
 * @see quickedit_field_node_created_edit_form()
 * @see quickedit_field_node_created_edit_form_submit()
 */
function quickedit_field_node_created_edit_form_validate($form, &$form_state) {
  $date = $form_state['values']['date'];
  if (!empty($date) && strtotime($date) === FALSE) {
    form_set_error('date', t('You have to specify a valid date.'));
  }
}

/**
 * Form submission handler for quickedit_field_node_created_edit_form().
 *
 * @see node_submit()
 * @see quickedit_field_node_created_edit_form()
 * @see quickedit_field_node_created_edit_form_validate()
 */
function quickedit_field_node_created_edit_form_submit($form, &$form_state) {
  $entity = $form_state['entity'];
  $date = $form_state['values']['date'];
  $entity->created = !empty($date) ? strtotime($date) : REQUEST_TIME;

  // We must load fape.inc to use _quickedit_entity_set_log().
  module_load_include('inc', 'quickedit', 'includes/fape');
  _quickedit_entity_set_log($entity, t('Date'));
  _quickedit_entity_save_to_tempstore($form_state['entity_type'], $form_state['entity_id'], $entity);
}
function quickedit_field_node_created_rerender($entity) {
  return array(
    'value' => format_date($entity->created),
    'inline' => TRUE,
  );
}

/**
 * Form constructor; in-place editing form for node's 'title' "extra field".
 *
 * This isn't a true form. As such it modifies the $form by reference.
 *
 * @see quickedit_field_node_title_edit_form_submit()
 * @ingroup forms
 */
function quickedit_field_node_title_edit_form(&$form, &$form_state, $node, $field_name) {
  _quickedit_node_object_prepare($node);
  $type = node_type_get_type($node);
  $form['title'] = array(
    '#type' => 'textfield',
    '#title' => check_plain($type->title_label),
    '#default_value' => !empty($node->title) ? $node->title : '',
    '#required' => TRUE,
    '#weight' => -5,
  );
  $form['#submit'][] = 'quickedit_field_node_title_edit_form_submit';
}

/**
 * Form submission handler for quickedit_field_node_title_edit_form().
 *
 * @see node_submit()
 * @see quickedit_field_node_title_edit_form()
 */
function quickedit_field_node_title_edit_form_submit($form, &$form_state) {
  $entity = $form_state['entity'];
  $entity->title = $form_state['values']['title'];

  // We must load fape.inc to use _quickedit_entity_set_log().
  module_load_include('inc', 'quickedit', 'includes/fape');
  _quickedit_entity_set_log($entity, t('Title'));
  _quickedit_entity_save_to_tempstore($form_state['entity_type'], $form_state['entity_id'], $entity);
}
function quickedit_field_node_title_rerender($entity) {
  return array(
    'value' => $entity->title,
    'inline' => FALSE,
  );
}

/**
 * Prepares a node object for editing.
 *
 * Drupal 7 modules that do things upon hook_node_prepare() inappropriately
 * assume that they're only ever going to be used on forms, which requires some
 * additional fiddling to keep everything working correctly.
 *
 * @see node_object_prepare()
 */
function _quickedit_node_object_prepare(&$node) {
  node_object_prepare($node);

  // menu_node_save() specifically checks the presence of the "enabled" flag,
  // but menu_node_prepare() doesn't add it; it's only present in the form.
  // Hence we add it manually to ensure that when the form item is not present
  // (as is the case for single field in-place editing forms), the menu link is
  // retained instead of removed.
  if (!empty($node->menu['mlid'])) {
    $node->menu['enabled'] = TRUE;
  }
}

Functions

Namesort descending Description
node_quickedit_extra_fields_info Implements hook_quickedit_extra_fields_info().
quickedit_field_node_author_edit_form Form constructor; in-place editing form for node's 'author' "extra field".
quickedit_field_node_author_edit_form_submit Form submission handler for quickedit_field_node_author_edit_form().
quickedit_field_node_author_edit_form_validate Form validation handler for quickedit_field_node_author_edit_form().
quickedit_field_node_author_rerender
quickedit_field_node_created_edit_form Form constructor; in-place editing form for node's 'created' "extra field".
quickedit_field_node_created_edit_form_submit Form submission handler for quickedit_field_node_created_edit_form().
quickedit_field_node_created_edit_form_validate Form validation handler for quickedit_field_node_created_edit_form().
quickedit_field_node_created_rerender
quickedit_field_node_title_edit_form Form constructor; in-place editing form for node's 'title' "extra field".
quickedit_field_node_title_edit_form_submit Form submission handler for quickedit_field_node_title_edit_form().
quickedit_field_node_title_rerender
_quickedit_node_object_prepare Prepares a node object for editing.