You are here

function log_type_form in Log entity 7

Generates the log type editing form.

Parameters

array $form: The form array.

array $form_state: The form state array.

string $log_type: The log type.

string $op: The operation being performed.

Return value

array Returns the form array.

File

./log.admin.inc, line 48
Log admin pages.

Code

function log_type_form(array $form, array &$form_state, $log_type, $op = 'edit') {
  if ($op == 'clone') {
    $log_type->label .= ' (cloned)';
    $log_type->type = '';
  }
  $form['label'] = array(
    '#title' => t('Label'),
    '#type' => 'textfield',
    '#default_value' => $log_type->label,
    '#description' => t('The human-readable name of this log type.'),
    '#required' => TRUE,
    '#size' => 30,
  );

  // Machine-readable type name.
  $form['type'] = array(
    '#type' => 'machine_name',
    '#default_value' => !empty($log_type->type) ? $log_type->type : '',
    '#maxlength' => 32,
    '#disabled' => $log_type
      ->isLocked() && $op != 'clone',
    '#machine_name' => array(
      'exists' => 'log_types',
      'source' => array(
        'label',
      ),
    ),
    '#description' => t('A unique machine-readable name for this log type. It must only contain lowercase letters, numbers, and underscores.'),
  );

  // Name pattern.
  $form['name_pattern'] = array(
    '#type' => 'textfield',
    '#title' => t('Naming pattern'),
    '#desription' => t('When a log name is auto-generated, this is the naming pattern that will be used. Available tokens are below.'),
    '#default_value' => !empty($log_type->name_pattern) ? $log_type->name_pattern : 'Log [log:id]',
    '#required' => TRUE,
    '#maxlength' => 256,
  );
  if (module_exists('token')) {
    $form['token_help'] = array(
      '#title' => t('Replacement patterns'),
      '#type' => 'fieldset',
      '#collapsible' => TRUE,
      '#collapsed' => TRUE,
      '#description' => t('Prefer raw-text replacements for text to avoid problems with HTML entities!'),
    );
    $form['token_help']['help'] = array(
      '#theme' => 'token_tree',
      '#token_types' => array(
        'log',
      ),
    );
  }

  // Allow name editing.
  $form['name_edit'] = array(
    '#type' => 'checkbox',
    '#title' => t('Allow name editing'),
    '#description' => t('Check this to allow users to edit log names. Otherwise, log names will always be auto-generated.'),
    '#default_value' => !empty($log_type->name_edit) ? $log_type->name_edit : FALSE,
  );

  // Automatically mark logs of this type as done.
  $form['done'] = array(
    '#type' => 'checkbox',
    '#title' => t('Automatically done'),
    '#description' => t('Automatically mark logs of this type as "done".'),
    '#default_value' => !empty($log_type->done) ? $log_type->done : FALSE,
  );
  $form['actions'] = array(
    '#type' => 'actions',
  );
  $form['actions']['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Save log type'),
    '#weight' => 40,
  );
  if (!$log_type
    ->isLocked() && $op != 'add' && $op != 'clone') {
    $form['actions']['delete'] = array(
      '#type' => 'submit',
      '#value' => t('Delete log type'),
      '#weight' => 45,
      '#limit_validation_errors' => array(),
      '#submit' => array(
        'log_type_form_submit_delete',
      ),
    );
  }
  return $form;
}