You are here

Home » API reference » Message 7

message.admin.inc in Message 7

Message type editing UI.

File

includes/message.admin.inc
View source 
<?php

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

/**
 * UI controller.
 */
class MessageTypeUIController extends EntityDefaultUIController {

  /**
   * Overridden to customize the field location.
   */
  public function entityFormSubmitBuildEntity($form, &$form_state) {

    // We cannot use entity_form_submit_build_entity() any more.
    $entity = $form_state['message_type'];

    // Extract form values.
    form_state_values_clean($form_state);
    foreach ($form_state['values'] as $key => $value) {
      if ($key != 'message_type_fields') {
        $entity->{$key} = $value;
      }
    }

    // Invoke all specified builders for copying form values to entity
    // properties.
    // @see entity_form_submit_build_entity()
    if (isset($form['#entity_builders'])) {
      foreach ($form['#entity_builders'] as $function) {
        $function('message_type', $entity, $form, $form_state);
      }
    }
    field_attach_submit('message_type', $entity, $form['message_type_fields'], $form_state);
    return $entity;
  }

}

/**
 * Menu callback; Admin settings form.
 */
function message_user_admin_settings($form_state) {
  $form = array();
  $form['purge'] = array(
    '#type' => 'fieldset',
    '#title' => t('Purge settings'),
  );
  $form['purge']['message_purge_enable'] = array(
    '#type' => 'checkbox',
    '#title' => t('Purge messages'),
    '#description' => t('When enabled, old messages will be deleted.'),
    '#default_value' => variable_get('message_purge_enable', FALSE),
  );
  $states = array(
    'visible' => array(
      ':input[name="message_purge_enable"]' => array(
        'checked' => TRUE,
      ),
    ),
  );
  $form['purge']['message_purge_quota'] = array(
    '#type' => 'textfield',
    '#title' => t('Messages quota'),
    '#description' => t('Maximal (approximate) amount of messages.'),
    '#default_value' => variable_get('message_purge_quota', NULL),
    '#element_validate' => array(
      'element_validate_integer_positive',
    ),
    '#states' => $states,
  );
  $form['purge']['message_purge_days'] = array(
    '#type' => 'textfield',
    '#title' => t('Purge messages older than'),
    '#description' => t('Maximal message age in days.'),
    '#default_value' => variable_get('message_purge_days', NULL),
    '#element_validate' => array(
      'element_validate_integer_positive',
    ),
    '#states' => $states,
  );
  $options = array();
  foreach (entity_get_info() as $entity_id => $entity) {
    $options[$entity_id] = $entity['label'];
  }
  $form['message_delete_on_entity_delete'] = array(
    '#title' => t('Auto delete messages referencing the following entities'),
    '#type' => 'select',
    '#multiple' => TRUE,
    '#options' => $options,
    '#default_value' => variable_get('message_delete_on_entity_delete', array(
      'node',
      'user',
      'taxonomy_term',
      'comment',
    )),
    '#description' => t('Messages that reference entities of these types will be deleted when the referenced entity gets deleted.'),
  );

  // Display link to the copy form if the locale module is enabled.
  if (module_exists('locale')) {
    $form['links'] = array(
      '#type' => 'fieldset',
      '#title' => t('Other settings'),
    );
    $form['links']['text_copy'] = array(
      '#markup' => l(t('Copy messages text fields from one language to others'), 'admin/config/system/message/text-copy'),
    );
  }
  $form['message_use_queue'] = array(
    '#type' => 'checkbox',
    '#title' => t('Use queue'),
    '#description' => t('Delete messages without existing reference via queue.'),
    '#default_value' => variable_get('message_use_queue', FALSE),
  );
  return system_settings_form($form);
}

/**
 * Menu callback; Texts copying settings form.
 */
function message_admin_text_copy($form, $form_state) {

  // Only display the form if the locale module is enabled.
  if (!module_exists('locale')) {
    $form['_notice'] = array(
      '#markup' => t('Copying messages text fields is dependent on the locale module.'),
    );
    return $form;
  }
  $languages = language_list();
  $language_options = array(
    LANGUAGE_NONE => t('"Language none"'),
  );
  foreach ($languages as $langcode => $language) {
    $language_options[$langcode] = $language->name;
  }
  $form['origin'] = array(
    '#type' => 'select',
    '#title' => t('Select a language to copy from'),
    '#options' => $language_options,
    '#required' => TRUE,
  );
  $form['destinations'] = array(
    '#type' => 'select',
    '#title' => t('Select languages to copy to'),
    '#multiple' => TRUE,
    '#options' => $language_options,
    '#required' => TRUE,
  );
  $form['override'] = array(
    '#type' => 'checkbox',
    '#title' => t('Override existing text'),
    '#description' => t('When checked, existing text in the destination languages will be overriden by the origin language.'),
  );
  $form['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Copy'),
  );
  return $form;
}

/**
 * Submit callback for the copy texts form.
 */
function message_admin_text_copy_submit($form, $form_state) {
  $batch = array(
    'title' => t('Copying messages texts betweem languages'),
    'operations' => array(
      array(
        'message_admin_text_copy_batch',
        array(
          $form_state['values']['origin'],
          $form_state['values']['destinations'],
          $form_state['values']['override'],
        ),
      ),
    ),
    'init_message' => t('Starting message texts copying.'),
    'progress_message' => t('Processed @current out of @total.'),
    'error_message' => t('Message texts copying has encountered an error.'),
  );
  batch_set($batch);
}

/**
 * Validate callback for the copy texts form.
 */
function message_admin_text_copy_validate($form, $form_state) {
  if (in_array($form_state['values']['origin'], $form_state['values']['destinations'])) {
    form_set_error('destinations', t('Cannot copy language values into itself.'));
  }
}

/**
 * Generates the message type editing form.
 */
function message_type_form($form, &$form_state, $message_type, $op = 'edit') {
  if ($op == 'clone') {
    $message_type->description .= ' (cloned)';

    // Save the original message type into form state so that the submit
    // handler can clone its field instances.
    $form_state['original_message_type'] = menu_get_object('entity_object', 4);
  }
  $form['description'] = array(
    '#title' => t('Description'),
    '#type' => 'textfield',
    '#default_value' => $message_type->description,
    '#description' => t('The human-readable description of this message type.'),
    '#required' => TRUE,
    '#weight' => -5,
  );

  // Machine-readable type name.
  $form['name'] = array(
    '#type' => 'machine_name',
    '#default_value' => isset($message_type->name) ? $message_type->name : '',
    '#disabled' => $message_type
      ->hasStatus(ENTITY_IN_CODE),
    '#machine_name' => array(
      'exists' => 'message_type_load',
      'source' => array(
        'description',
      ),
    ),
    '#description' => t('A unique machine-readable name for this message type. It must only contain lowercase letters, numbers, and underscores.'),
    '#weight' => -5,
  );

  // We might have gotten the message type category via ajax, so set it in the
  // message type entity.
  if (!empty($form_state['values']['message_type_category'])) {
    $message_type->category = $form_state['values']['message_type_category'];
  }
  if ($op == 'add') {

    // Get all the message type category, and allow user to choose one using ajax.
    $options = array();
    $options['message_type'] = t('Default message type category');
    foreach (message_type_category_load() as $message_category) {
      $options[$message_category->category] = !empty($message_category->description) ? $message_category->description : $message_type->category;
    }
    $form['message_type_category'] = array(
      '#title' => t('Message type category'),
      '#type' => count($options) > 1 ? 'select' : 'value',
      '#options' => $options,
      '#default_value' => $message_type->category,
      '#description' => t('Select the message type category.'),
      '#required' => TRUE,
      '#ajax' => array(
        'callback' => 'message_type_fields_ajax_callback',
        'wrapper' => 'message-type-wrapper',
      ),
    );
  }
  else {
    if ($message_category = message_type_category_load($message_type->category)) {
      $value = !empty($message_category->description) ? check_plain($message_category->description) : check_plain($message_type->category);
    }
    else {
      $value = t('Default message type category');
    }
    $form['message_type_category'] = array(
      '#title' => t('Message type category'),
      '#type' => count(message_type_category_load()) > 1 ? 'item' : 'value',
      '#markup' => $value,
    );
  }
  $form['language'] = array(
    '#title' => t('Field language'),
    '#description' => t('The language code that will be saved with the field values. This is used to allow translation of fields.'),
  );
  $field_language = NULL;
  if (module_exists('locale')) {
    $options = array();
    foreach (language_list() as $key => $value) {
      if (!empty($value->enabled)) {
        $options[$key] = $value->name;
      }
    }
    $field_language = !empty($form_state['values']['language']) ? $form_state['values']['language'] : language_default()->language;
    $form['language'] += array(
      '#type' => 'select',
      '#options' => $options,
      '#required' => TRUE,
      '#default_value' => $field_language,
      '#ajax' => array(
        'callback' => 'message_type_fields_ajax_callback',
        'wrapper' => 'message-type-wrapper',
      ),
    );
  }
  else {
    $form['language'] += array(
      '#type' => 'item',
      '#markup' => t('Undefined language'),
    );
  }
  $form['message_type_fields'] = array(
    '#prefix' => '<div id="message-type-wrapper">',
    '#suffix' => '</div>',
    '#tree' => TRUE,
    '#parents' => array(
      'message_type_fields',
    ),
  );
  field_attach_form('message_type', $message_type, $form['message_type_fields'], $form_state, $field_language);
  $token_types = module_exists('entity_token') ? array(
    'message',
  ) : array();
  if (!$token_types) {
    $form['entity_token'] = array(
      '#markup' => '<p>' . t('Optional: Enable "Entity token" module to use Message and Message-type related tokens.') . '</p>',
    );
  }
  if (module_exists('token')) {
    $form['token_tree'] = array(
      '#theme' => 'token_tree',
      '#token_types' => $token_types + array(
        'all',
      ),
    );
  }
  else {
    $form['token_tree'] = array(
      '#markup' => '<p>' . t("Optional: Install <a href='@token-url'>Token</a> module, to show a the list of available tokens.", array(
        '@token-url' => 'http://drupal.org/project/token',
      )) . '</p>',
    );
  }
  $params = array(
    '@url-rules' => 'http://drupal.org/project/rules',
    '!link' => 'http://api.drupal.org/api/drupal/includes--bootstrap.inc/function/t/7',
  );
  $form['argument_keys'] = array(
    '#title' => t('Replacement tokens'),
    '#type' => 'textfield',
    '#default_value' => implode(', ', (array) $message_type->argument_keys),
    '#description' => t('Optional: For <a href="@url-rules">Rules</a> module, in order to set argument using Rules actions, a comma-separated list of replacement tokens, e.g. %title or !url, of which the message text makes use of. Each replacement token has to start with one of the special characters "@", "%" or "!". This character controls the sanitization method used, analogously to the <a href="!link">t()</a> function.', $params),
  );
  $form['data'] = array(
    // Placeholder for other module to add their settings, that should be added
    // to the data column.
    '#tree' => TRUE,
  );
  $form['data']['token options']['clear'] = array(
    '#title' => t('Clear empty tokens'),
    '#type' => 'checkbox',
    '#description' => t('When this option is selected, empty tokens will be removed from display.'),
    '#default_value' => isset($message_type->data['token options']['clear']) ? $message_type->data['token options']['clear'] : FALSE,
  );
  $form['data']['purge'] = array(
    '#type' => 'fieldset',
    '#title' => t('Purge settings'),
  );
  $form['data']['purge']['override'] = array(
    '#title' => t('Override global settings'),
    '#type' => 'checkbox',
    '#description' => t('Override global purge settings for messages of this type.'),
    '#default_value' => !empty($message_type->data['purge']['override']),
  );
  $states = array(
    'visible' => array(
      ':input[name="data[purge][override]"]' => array(
        'checked' => TRUE,
      ),
    ),
  );
  $form['data']['purge']['enabled'] = array(
    '#type' => 'checkbox',
    '#title' => t('Purge messages'),
    '#description' => t('When enabled, old messages will be deleted.'),
    '#default_value' => !empty($message_type->data['purge']['enabled']),
    '#states' => $states,
  );
  $states = array(
    'visible' => array(
      ':input[name="data[purge][enabled]"]' => array(
        'checked' => TRUE,
      ),
    ),
  );
  $form['data']['purge']['quota'] = array(
    '#type' => 'textfield',
    '#title' => t('Messages quota'),
    '#description' => t('Maximal (approximate) amount of messages of this type.'),
    '#default_value' => !empty($message_type->data['purge']['quota']) ? $message_type->data['purge']['quota'] : '',
    '#element_validate' => array(
      'element_validate_integer_positive',
    ),
    '#states' => $states,
  );
  $form['data']['purge']['days'] = array(
    '#type' => 'textfield',
    '#title' => t('Purge messages older than'),
    '#description' => t('Maximal message age in days, for messages of this type.'),
    '#default_value' => !empty($message_type->data['purge']['days']) ? $message_type->data['purge']['days'] : '',
    '#element_validate' => array(
      'element_validate_integer_positive',
    ),
    '#states' => $states,
  );
  $form['actions'] = array(
    '#type' => 'actions',
  );
  $form['actions']['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Save message type'),
    '#weight' => 40,
  );
  if (!$message_type
    ->hasStatus(ENTITY_IN_CODE) && $op != 'add') {
    $form['actions']['delete'] = array(
      '#type' => 'submit',
      '#value' => t('Delete message type'),
      '#weight' => 45,
      '#limit_validation_errors' => array(),
      '#submit' => array(
        'message_type_form_submit_delete',
      ),
    );
  }
  return $form;
}

/**
 * AJAX callback to attach the message type fields to the form.
 *
 * Since the controlling logic for populating the form is in the form builder
 * function, all we do here is select the element and return it to be updated.
 */
function message_type_fields_ajax_callback(array $form, array &$form_state) {
  return $form['message_type_fields'];
}

/**
 * Form API validation callback for the type form.
 */
function message_type_form_validate($form, $form_state) {
  field_attach_form_validate('message_type', $form_state['message_type'], $form['message_type_fields'], $form_state);
}

/**
 * Form API submit callback for the type form.
 */
function message_type_form_submit(&$form, &$form_state) {
  $message_type = entity_ui_form_submit_build_entity($form, $form_state);
  $message_type->argument_keys = array_filter(array_map('trim', explode(',', $message_type->argument_keys)));
  $message_type
    ->save();

  // If this was a clone operation, clone the field instances as well.
  $op = $form_state['build_info']['args'][1];
  if ($op == 'clone') {
    $original_instances = field_info_instances('message', $form_state['original_message_type']->name);
    foreach ($original_instances as $instance) {
      $instance['bundle'] = $message_type->name;
      field_create_instance($instance);
    }
  }
  $form_state['redirect'] = 'admin/structure/messages';
}

/**
 * Form API submit callback for the delete button.
 */
function message_type_form_submit_delete(&$form, &$form_state) {
  $form_state['redirect'] = 'admin/structure/messages/manage/' . $form_state['message_type']->name . '/delete';
}

Functions

Namesort descending Description
message_admin_text_copy Menu callback; Texts copying settings form.
message_admin_text_copy_submit Submit callback for the copy texts form.
message_admin_text_copy_validate Validate callback for the copy texts form.
message_type_fields_ajax_callback AJAX callback to attach the message type fields to the form.
message_type_form Generates the message type editing form.
message_type_form_submit Form API submit callback for the type form.
message_type_form_submit_delete Form API submit callback for the delete button.
message_type_form_validate Form API validation callback for the type form.
message_user_admin_settings Menu callback; Admin settings form.

Classes

Namesort descending Description
MessageTypeUIController UI controller.