form.inc 33.9 KB
Newer Older
1
<?php
2 3
// $Id$

4 5 6 7 8 9 10
/**
 * @defgroup form Form generation
 * @{
 * Functions to enable output of HTML forms and form elements.
 *
 * Drupal uses these functions to achieve consistency in its form presentation,
 * while at the same time simplifying code and reducing the amount of HTML that
11 12 13 14
 * must be explicitly generated by modules. See the reference at
 * http://drupaldocs.org/api/head/file/contributions/docs/developer/topics/forms_api_reference.html
 * and the quickstart guide at
 * http://drupaldocs.org/api/head/file/contributions/docs/developer/topics/forms_api.html
15 16 17 18 19 20
 */

/**
 * Check if the key is a property.
 */
function element_property($key) {
21
  return $key[0] == '#';
22 23
}

24 25 26
/**
 * Get properties of a form tree element. Properties begin with '#'.
 */
27
function element_properties($element) {
28
  return array_filter(array_keys((array) $element), 'element_property');
29 30 31 32 33 34
}

/**
 * Check if the key is a child.
 */
function element_child($key) {
35
  return $key[0] != '#';
36 37
}

38 39 40
/**
 * Get keys of a form tree element that are not properties (i.e., do not begin with '#').
 */
41
function element_children($element) {
42
  return array_filter(array_keys((array) $element), 'element_child');
43 44 45
}

/**
46
 * Processes a form array and produces the HTML output of a form.
47
 * If there is input in the $_POST['edit'] variable, this function
48 49
 * will attempt to validate it, using drupal_validate_form(),
 * and then submit the form using drupal_submit_form().
50 51
 *
 * @param $form_id
52 53 54
 *   A unique string identifying the form. Allows each form to be
 *   themed.  Pass NULL to suppress the form_id parameter (produces
 *   a shorter URL with method=get)
55 56 57 58 59 60 61
 * @param $form
 *   An associative array containing the structure of the form.
 * @param $callback
 *   An optional callback that will be used in addition to the form_id.
 *
 */
function drupal_get_form($form_id, &$form, $callback = NULL) {
Dries's avatar
Dries committed
62
  global $form_values, $form_submitted;
63
  $form_values = array();
Dries's avatar
Dries committed
64
  $form_submitted = FALSE;
65

66 67
  $form['#type'] = 'form';
  if (isset($form['#token'])) {
68 69 70 71 72
    // Make sure that a private key is set:
    if (!variable_get('drupal_private_key', '')) {
      variable_set('drupal_private_key', mt_rand());
    }

73
    $form['form_token'] = array('#type' => 'hidden', '#default_value' => md5(session_id() . $form['#token'] . variable_get('drupal_private_key', '')));
74
  }
75 76 77
  if (isset($form_id)) {
    $form['form_id'] = array('#type' => 'hidden', '#value' => $form_id);
  }
78 79 80
  if (!isset($form['#id'])) {
    $form['#id'] = $form_id;
  }
81

82 83
  $form = array_merge(_element_info('form'), $form);

Dries's avatar
Dries committed
84 85
  if (!isset($form['#validate'])) {
    if (function_exists($form_id .'_validate')) {
86
      $form['#validate'] = array($form_id .'_validate' => array());
Dries's avatar
Dries committed
87 88
    }
    elseif (function_exists($callback .'_validate')) {
89
      $form['#validate'] = array($callback .'_validate' => array());
Dries's avatar
Dries committed
90 91 92
    }
  }

93 94
  if (!isset($form['#submit'])) {
    if (function_exists($form_id .'_submit')) {
95 96 97
      // we set submit here so that it can be altered but use reference for
      // $form_values because it will change later
      $form['#submit'] = array($form_id .'_submit' => array($form_id, &$form_values));
Dries's avatar
Dries committed
98
    }
99
    elseif (function_exists($callback .'_submit')) {
100
      $form['#submit'] = array($callback .'_submit' => array($form_id, &$form_values));
Dries's avatar
Dries committed
101 102 103
    }
  }

104 105
  foreach (module_implements('form_alter') as $module) {
    $function = $module .'_form_alter';
106
    $function($form_id, $form);
107 108
  }

109
  $form = form_builder($form_id, $form);
110
  if (!empty($_POST['edit']) && (($_POST['edit']['form_id'] == $form_id) || ($_POST['edit']['form_id'] == $callback))) {
111
    drupal_validate_form($form_id, $form, $callback);
Dries's avatar
Dries committed
112
    if ($form_submitted && !form_get_errors()) {
113
      $redirect = drupal_submit_form($form_id, $form, $callback);
114
      if (isset($redirect)) {
115 116
        $goto = $redirect;
      }
117
      elseif (isset($form['#redirect'])) {
118 119
        $goto = $form['#redirect'];
      }
120 121 122 123 124 125 126
      if ($goto !== FALSE) {
        if (is_array($goto)) {
          call_user_func_array('drupal_goto', $redirect);
        }
        else {
          drupal_goto($goto);
        }
127
      }
128
    }
129 130
  }

131
  if (theme_get_function($form_id)) {
132
    $form['#theme'] = $form_id;
133
  }
134
  elseif (theme_get_function($callback)) {
135
    $form['#theme'] = $callback;
136 137 138 139 140 141 142
  }
  return form_render($form);
}

function drupal_validate_form($form_id, &$form, $callback = NULL) {
  global $form_values;

143
  if (isset($form['#token'])) {
144
    if ($form_values['form_token'] != md5(session_id() . $form['#token'] . variable_get('drupal_private_key', ''))) {
145 146 147 148 149
      // setting this error will cause the form to fail validation
      form_set_error('form_token', t('Validation error, please try again.  If this error persists, please contact the site administrator.'));
    }
  }

150
  _form_validate($form, $form_id);
151 152
}

153
function drupal_submit_form($form_id, $form, $callback = NULL) {
154 155
  // Prevent system module forms (system/theme settings) from saving certain form fields to the variables table.
  unset($GLOBALS['form_values']['submit'], $GLOBALS['form_values']['reset'], $GLOBALS['form_values']['form_id']);
156

157
  if (isset($form['#submit'])) {
158 159
    foreach ($form['#submit'] as $function => $args) {
      if (function_exists($function)) {
160 161
        // Since we can only redirect to one page, only the last redirect will work
        $redirect = call_user_func_array($function, $args);
162 163 164
        if (isset($redirect)) {
          $goto = $redirect;
        }
Dries's avatar
Dries committed
165 166
      }
    }
167
  }
168
  return $goto;
169 170
}

171
function _form_validate($elements, $form_id = NULL) {
172
  /* Validate the current input */
173
  if (!$elements['#validated'] && ($elements['#input'] || isset($form_id))) {
174 175 176
    // An empty textfield returns '' so we use empty(). An empty checkbox
    // and a textfield could return '0' and empty('0') returns TRUE so we
    // need a special check for the '0' string.
177
    if ($elements['#required'] && empty($elements['#value']) && $elements['#value'] !== '0') {
178
      form_error($elements, t('%name field is required.', array('%name' => $elements['#title'])));
179
    }
180

181 182
    // Add legal choice check if element has #options. Can be skipped, but then you must validate your own element.
    if (isset($elements['#options']) && isset($elements['#value']) && !isset($elements['#DANGEROUS_SKIP_CHECK'])) {
183 184 185 186 187 188
      if ($elements['#type'] == 'select') {
        $options = form_options_flatten($elements['#options']);
      }
      else {
        $options = $elements['#options'];
      }
189 190 191
      if (is_array($elements['#value'])) {
        $value = $elements['#type'] == 'checkboxes' ? array_keys(array_filter($elements['#value'])) : $elements['#value'];
        foreach ($value as $v) {
192
          if (!isset($options[$v])) {
193 194
            form_error($elements, t('An illegal choice has been detected. Please contact the site administrator.'));
            watchdog('form', t('Illegal choice %choice in %name element.', array('%choice' => theme('placeholder', check_plain($v)), '%name' => theme_placeholder(empty($elements['#title']) ? $elements['#parents'][0] : $elements['#title'])), WATCHDOG_ERROR));
195 196 197
          }
        }
      }
198
      elseif (!isset($options[$elements['#value']])) {
199 200
        form_error($elements, t('An illegal choice has been detected. Please contact the site administrator.'));
        watchdog('form', t('Illegal choice %choice in %name element.', array('%choice' => theme_placeholder(check_plain($v)), '%name' => theme('placeholder', empty($elements['#title']) ? $elements['#parents'][0] : $elements['#title'])), WATCHDOG_ERROR));
201 202 203 204
      }
    }

    // User-applied checks.
Dries's avatar
Dries committed
205
    if (isset($elements['#validate'])) {
206 207 208 209 210
      foreach ($elements['#validate'] as $function => $args) {
        $args = array_merge(array($elements), $args);
        // for the full form we hand over a copy of $form_values
        if (isset($form_id)) {
          $args = array_merge(array($form_id, $GLOBALS['form_values']), $args);
211
        }
212 213
        if (function_exists($function))  {
          call_user_func_array($function, $args);
214 215 216
        }
      }
    }
217
    $elements['#validated'] = TRUE;
218
  }
219 220 221 222 223 224 225

  // Recurse through all children.
  foreach (element_children($elements) as $key) {
    if (isset($elements[$key]) && $elements[$key]) {
      _form_validate($elements[$key]);
    }
  }
226 227
}

228 229 230 231 232
/**
 * File an error against a form element. If the name of the element is
 * edit[foo][bar] then you may pass either foo or foo][bar as $name
 * foo will set an error for all its children.
 */
233
function form_set_error($name = NULL, $message = '') {
234 235 236
  static $form = array();
  if (isset($name) && !isset($form[$name])) {
    $form[$name] = $message;
237 238 239
    if ($message) {
      drupal_set_message($message, 'error');
    }
240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268
  }
  return $form;
}

/**
 * Return an associative array of all errors.
 */
function form_get_errors() {
  $form = form_set_error();
  if (!empty($form)) {
    return $form;
  }
}

/**
 * Return the error message filed against the form with the specified name.
 */
function form_get_error($element) {
  $form = form_set_error();
  $key = $element['#parents'][0];
  if (isset($form[$key])) {
    return $form[$key];
  }
  $key = implode('][', $element['#parents']);
  if (isset($form[$key])) {
    return $form[$key];
  }
}

269 270 271
/**
 * Flag an element as having an error.
 */
272
function form_error(&$element, $message = '') {
273
  $element['#error'] = TRUE;
274
  form_set_error(implode('][', $element['#parents']), $message);
275 276 277
}

/**
278 279 280 281 282 283 284 285 286
 * Adds some required properties to each form element, which are used
 * internally in the form api. This function also automatically assigns
 * the value property from the $edit array, provided the element doesn't
 * already have an assigned value.
 *
 * @param $form_id
 *   A unique string identifying the form. Allows each form to be themed.
 * @param $form
 *   An associative array containing the structure of the form.
287
 */
288
function form_builder($form_id, $form) {
289
  global $form_values;
Dries's avatar
Dries committed
290
  global $form_submitted;
291
  /* Use element defaults */
292
  if ((!empty($form['#type'])) && ($info = _element_info($form['#type']))) {
293
    // overlay $info onto $form, retaining preexisting keys in $form
294 295 296
    $form += $info;
  }

297
  if (isset($form['#input']) && $form['#input']) {
298 299 300 301 302 303
    if (!isset($form['#name'])) {
      $form['#name'] = 'edit[' . implode('][', $form['#parents']) . ']';
    }
    if (!isset($form['#id'])) {
      $form['#id'] =  'edit-' . implode('-', $form['#parents']);
    }
304

305
    $posted = (isset($_POST['edit']) && ($_POST['edit']['form_id'] == $form_id));
306 307
    $edit = $posted ? $_POST['edit'] : array();
    $ref =& $form_values;
308
    foreach ($form['#parents'] as $parent) {
309 310 311
      $edit = isset($edit[$parent]) ? $edit[$parent] : NULL;
      $ref =& $ref[$parent];
    }
312
    $form['#ref'] = &$ref;
313
    if (!isset($form['#value'])) {
314 315 316 317 318
      if ($posted) {
        if (isset($edit)) {
          $form['#value'] = $edit; // normal element
        }
        elseif (isset($form['#return_value'])) {
319
          $form['#value'] = '0'; // checkbox unchecked
320 321 322
        }
      }
      if (!isset($form['#value'])) {
323 324 325 326 327 328 329
        $function = $form['#type'] . '_value';
        if (function_exists($function)) {
          $function($form);
        }
        else {
          $form['#value'] = $form['#default_value'];
        }
330
      }
331
    }
332
    if (isset($form['#form_submitted']) && isset($_POST[$form['#name']])) {
333
      if ($_POST[$form['#name']] == $form['#value']) {
Dries's avatar
Dries committed
334
        $form_submitted = $form_submitted || $form['#form_submitted'];
335 336 337 338
      }
    }
  }

339
  // Allow for elements to expand to multiple elements, e.g. radios, checkboxes and files.
340
  if (isset($form['#process']) && !$form['#processed']) {
341 342
    foreach ($form['#process'] as $process => $args) {
      if (function_exists($process)) {
343 344
        $args = array_merge(array($form), $args);
        $form = call_user_func_array($process, $args);
345 346
      }
    }
347
    $form['#processed'] = TRUE;
348 349
  }

350 351 352
  // Set the $form_values key that gets passed to validate and submit.
  // We call this after #process gets called so that #process has a
  // chance to update #value if desired.
353
  if (isset($form['#input']) && $form['#input']) {
354 355 356
    $ref = $form['#value'];
  }

357 358 359
  // Recurse through all child elements.
  $count  = 0;
  foreach (element_children($form) as $key) {
360
    // don't squash an existing tree value
361 362 363
    if (!isset($form[$key]['#tree'])) {
      $form[$key]['#tree'] = $form['#tree'];
    }
364

365 366
    // don't squash existing parents value
    if (!isset($form[$key]['#parents'])) {
367 368
      // Check to see if a tree of child elements is present. If so, continue down the tree if required.
      $form[$key]['#parents'] = $form[$key]['#tree'] && $form['#tree'] ? array_merge($form['#parents'], array($key)) : array($key);
369 370
    }

371
    # Assign a decimal placeholder weight to preserve original array order
372 373 374
    if (!isset($form[$key]['#weight'])) {
      $form[$key]['#weight'] = $count/1000;
    }
375
    $form[$key] = form_builder($form_id, $form[$key]);
376 377 378
    $count++;
  }

379
  if (isset($form['#after_build']) && function_exists($form['#after_build']) && !isset($form['#after_build_done'])) {
380
    $function = $form['#after_build'];
381
    $form = $function($form, $form_values);
382
    $form['#after_build_done'] = TRUE;
383
  }
384 385 386 387 388

  return $form;
}

/**
389 390
 * Renders a HTML form given a form tree. Recursively iterates over each of
 * the form elements, generating HTML code. This function is usually
391
 * called from within a theme.  To render a form from within a module, use
392
 * drupal_get_form().
393 394 395 396 397 398 399
 *
 * @param $elements
 *   The form tree describing the form.
 * @return
 *   The rendered HTML form.
 */
function form_render(&$elements) {
400 401
  if (!isset($elements)) {
    return NULL;
402
  }
403 404
  $content = '';
  uasort($elements, "_form_sort");
405

406
  if (!isset($elements['#children'])) {
407
    /* render all the children using a theme function */
408
    if (isset($elements['#theme']) && !$elements['#theme_used']) {
409 410 411 412 413
      $elements['#theme_used'] = TRUE;
      $previous_type = $elements['#type'];
      $elements['#type'] = 'markup';
      $content = theme($elements['#theme'], $elements);
      $elements['#type'] = $previous_type;
414 415 416 417 418 419 420 421 422
    }
    /* render each of the children using form_render and concatenate them */
    if (!$content) {
      foreach (element_children($elements) as $key) {
        $content .= form_render($elements[$key]);
      }
    }
  }
  if ($content) {
423
    $elements['#children'] = $content;
424 425 426
  }

  /* Call the form element renderer */
427
  if (!isset($elements['#printed'])) {
428 429
    $content = theme(($elements['#type']) ? $elements['#type']: 'markup', $elements);
    $elements['#printed'] = TRUE;
430 431
  }

432
  if ($content) {
433 434 435
    $prefix = isset($elements['#prefix']) ? $elements['#prefix'] : '';
    $suffix = isset($elements['#suffix']) ? $elements['#suffix'] : '';
    return $prefix . $content . $suffix;
436
  }
437 438 439
}

/**
440
 * Function used by uasort in form_render() to sort form by weight.
441 442
 */
function _form_sort($a, $b) {
443 444 445
  $a_weight = (is_array($a) && isset($a['#weight'])) ? $a['#weight'] : 0;
  $b_weight = (is_array($b) && isset($b['#weight'])) ? $b['#weight'] : 0;
  if ($a_weight == $b_weight) {
Dries's avatar
Dries committed
446 447
    return 0;
  }
448
  return ($a_weight < $b_weight) ? -1 : 1;
449 450 451 452 453 454 455
}

/**
 * Retrieve the default properties for the defined element type.
 */
function _element_info($type, $refresh = null) {
  static $cache;
456

457
  $basic_defaults = array(
458 459 460
    '#description' => NULL,
    '#attributes' => array(),
    '#required' => FALSE,
461
    '#tree' => FALSE,
462
    '#parents' => array()
463
  );
464
  if (!isset($cache) || $refresh) {
465 466 467
    $cache = array();
    foreach (module_implements('elements') as $module) {
      $elements = module_invoke($module, 'elements');
468
      if (isset($elements) && is_array($elements)) {
469
        $cache = array_merge_recursive($cache, $elements);
470 471 472 473
      }
    }
    if (sizeof($cache)) {
      foreach ($cache as $element_type => $info) {
474
        $cache[$element_type] = array_merge_recursive($basic_defaults, $info);
475 476 477 478 479 480 481
      }
    }
  }

  return $cache[$type];
}

482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500
function form_options_flatten($array, $reset = TRUE) {
  static $return;

  if ($reset) {
    $return = array();
  }

  foreach ($array as $key => $value) {
    if (is_array($value)) {
      form_options_flatten($value, FALSE);
    }
    else {
      $return[$key] = 1;
    }
  }

  return $return;
}

501 502 503 504 505
/**
 * Format a dropdown menu or scrolling selection box.
 *
 * @param $element
 *   An associative array containing the properties of the element.
506
 *   Properties used: title, value, options, description, extra, multiple, required
507 508 509 510 511 512 513 514 515
 * @return
 *   A themed HTML string representing the form element.
 *
 * It is possible to group options together; to do this, change the format of
 * $options to an associative array in which the keys are group labels, and the
 * values are associative arrays in the normal $options format.
 */
function theme_select($element) {
  $select = '';
516
  $size = $element['#size'] ? ' size="' . $element['#size'] . '"' : '';
517
  return theme('form_element', $element['#title'], '<select class="' . _form_get_class('', $element['#required'], form_get_error($element)). '" name="'. $element['#name'] .''. ($element['#multiple'] ? '[]' : '') .'"'. ($element['#multiple'] ? ' multiple="multiple" ' : '') . drupal_attributes($element['#attributes']) .' id="' . $element['#id'] .'" '. $size .'>'. form_select_options($element) .'</select>', $element['#description'], $element['#id'], $element['#required'], form_get_error($element));
518 519 520 521 522 523
}

function form_select_options($element, $choices = NULL) {
  if (!isset($choices)) {
    $choices = $element['#options'];
  }
524
  // array_key_exists() accomodates the rare event where $element['#value'] is NULL.
525 526 527
  // isset() fails in this situation.
  $value_valid = isset($element['#value']) || array_key_exists('#value', $element);
  $value_is_array = is_array($element['#value']);
528 529
  $options = '';
  foreach ($choices as $key => $choice) {
530
    if (is_array($choice)) {
531 532 533
      $options .= '<optgroup label="'. $key .'">';
      $options .= form_select_options($element, $choice);
      $options .= '</optgroup>';
534 535
    }
    else {
536 537
      $key = (string)$key;
      if ($value_valid && ($element['#value'] == $key || ($value_is_array && in_array($key, $element['#value'])))) {
538 539 540 541 542
        $selected = ' selected="selected"';
      }
      else {
        $selected = '';
      }
543
      $options .= '<option value="'. $key .'"'. $selected .'>'. check_plain($choice) .'</option>';
544 545
    }
  }
546
  return $options;
547 548 549 550 551 552 553
}

/**
 * Format a group of form items.
 *
 * @param $element
 *   An associative array containing the properties of the element.
554
 *   Properties used: attributes, title, value, description, children, collapsible, collapsed
555 556 557 558
 * @return
 *   A themed HTML string representing the form item group.
 */
function theme_fieldset($element) {
559
  if ($element['#collapsible']) {
560 561
    drupal_add_js('misc/collapse.js');

562 563 564
    $element['#attributes']['class'] .= ' collapsible';
    if ($element['#collapsed']) {
     $element['#attributes']['class'] .= ' collapsed';
565 566 567
    }
  }

568
  return '<fieldset' . drupal_attributes($element['#attributes']) .'>' . ($element['#title'] ? '<legend>'. $element['#title'] .'</legend>' : '') . ($element['#description'] ? '<div class="description">'. $element['#description'] .'</div>' : '') . $element['#children'] . $element['#value'] . "</fieldset>\n";
569 570 571 572 573 574 575 576

}

/**
 * Format a radio button.
 *
 * @param $element
 *   An associative array containing the properties of the element.
577
 *   Properties used: required, return_value, value, attributes, title, description
578 579 580 581 582
 * @return
 *   A themed HTML string representing the form item group.
 */
function theme_radio($element) {
  $output = '<input type="radio" ';
583
  $output .= 'class="'. _form_get_class('form-radio', $element['#required'], form_get_error($element)) .'" ';
584 585 586 587 588 589
  $output .= 'name="' . $element['#name'] .'" ';
  $output .= 'value="'. $element['#return_value'] .'" ';
  $output .= ($element['#value'] == $element['#return_value']) ? ' checked="checked" ' : ' ';
  $output .= drupal_attributes($element['#attributes']) .' />';
  if (!is_null($element['#title'])) {
    $output = '<label class="option">'. $output .' '. $element['#title'] .'</label>';
590
  }
591
  return theme('form_element', NULL, $output, $element['#description'], $element['#id'], $element['#required'], form_get_error($element));
592 593 594 595 596 597 598
}

/**
 * Format a set of radio buttons.
 *
 * @param $element
 *   An associative array containing the properties of the element.
599
 *   Properties used: title, value, options, description, required and attributes.
600 601 602 603
 * @return
 *   A themed HTML string representing the radio button set.
 */
function theme_radios($element) {
604
  if ($element['#title'] || $element['#description']) {
605
    return theme('form_element', $element['#title'], $element['#children'], $element['#description'], $element['#id'], $element['#required'], form_get_error($element));
606 607
  }
  else {
608
    return $element['#children'];
609 610 611
  }
}

612 613 614 615 616 617 618 619 620 621 622 623 624 625
/**
 * Format a password_confirm item.
 *
 * @param $element
 *   An associative array containing the properties of the element.
 *   Properties used: title, value, id, required, error.
 * @return
 *   A themed HTML string representing the form item.
 */
function theme_password_confirm($element) {
  return theme('form_element', $element['#title'], '<div class="container-inline">'. $element['#children']. '</div>', $element['#description'],  $element['#id'], $element['#required'], form_get_error($element));
}

/**
626
 * Validate password_confirm element.
627
 */
628 629 630 631 632 633
function password_confirm_validate($form) {
  if (isset($form['pass1']['#value'])) {
    $pass1 = trim($form['pass1']['#value']);
    $pass2 = trim($form['pass2']['#value']);
    $form['pass1']['#ref'] = NULL;
    $form['pass2']['#ref'] = NULL;
634
    if ($pass1 != $pass2) {
635 636 637
      form_error($form, t('The specified passwords do not match.'));
      form_error($form['pass1']);
      form_error($form['pass2']);
638
    }
639 640 641 642
    $form['#ref'] = $pass1;
  }
  elseif ($form['#required'] && !empty($_POST['edit'])) {
    form_set_error('pass1', t('Password field is required.'));
643 644 645 646
  }
  return $form;
}

647
/**
648
 * Format a date selection element.
649 650 651
 *
 * @param $element
 *   An associative array containing the properties of the element.
652
 *   Properties used: title, value, options, description, required and attributes.
653
 * @return
654
 *   A themed HTML string representing the date selection boxes.
655 656
 */
function theme_date($element) {
657
  $output = '<div class="container-inline">' . $element['#children'] . '</div>';
658
  return theme('form_element', $element['#title'], $output, $element['#description'], $element['#id'], $element['#required'], form_get_error($element));
659 660 661
}

/**
662
 * Roll out a single date element.
663 664 665
 */
function expand_date($element) {
  // Default to current date
666 667
  if (!isset($element['#value'])) {
    $element['#value'] = array('day' => format_date(time(), 'custom', 'j'),
668 669 670 671
                            'month' => format_date(time(), 'custom', 'n'),
                            'year' => format_date(time(), 'custom', 'Y'));
  }

672 673
  $element['#tree'] = TRUE;

674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689
  // Determine the order of day, month, year in the site's chosen date format.
  $format = variable_get('date_format_short', 'm/d/Y');
  $sort = array();
  $sort['day'] = max(strpos($format, 'd'), strpos($format, 'j'));
  $sort['month'] = max(strpos($format, 'm'), strpos($format, 'M'));
  $sort['year'] = strpos($format, 'Y');
  asort($sort);
  $order = array_keys($sort);

  // Output multi-selector for date
  foreach ($order as $type) {
    switch ($type) {
      case 'day':
        $options = drupal_map_assoc(range(1, 31));
        break;
      case 'month':
690
        $options = drupal_map_assoc(range(1, 12), 'map_month');
691 692 693 694 695
        break;
      case 'year':
        $options = drupal_map_assoc(range(1900, 2050));
        break;
    }
696 697 698 699 700 701 702 703
    $parents = $element['#parents'];
    $parents[] = $type;
    $element[$type] = array(
      '#type' => 'select',
      '#value' => $element['#value'][$type],
      '#attributes' => $element['#attributes'],
      '#options' => $options,
    );
704 705 706 707 708
  }

  return $element;
}

709 710 711 712 713 714
/**
 * Helper function for usage with drupal_map_assoc to display month names.
 */
function map_month($month) {
  return format_date(gmmktime(0, 0, 0, $month, 2, 1970), 'custom', 'M', 0);
}
715

716 717 718 719 720 721 722 723 724 725 726
/**
 * Helper function to load value from default value for checkboxes
 */
function checkboxes_value(&$form) {
  $value = array();
  foreach ((array)$form['#default_value'] as $key) {
    $value[$key] = 1;
  }
  $form['#value'] = $value;
}

727 728 729 730 731 732 733 734 735 736 737 738
/**
 * If no default value is set for weight select boxes, use 0.
 */
function weight_value(&$form) {
  if (isset($form['#default_value'])) {
    $form['#value'] = $form['#default_value'];
  }
  else {
    $form['#value'] = 0;
  }
}

739
/**
740 741
 * Roll out a single radios element to a list of radios,
 * using the options array as index.
742 743
 */
function expand_radios($element) {
744 745
  if (count($element['#options']) > 0) {
    foreach ($element['#options'] as $key => $choice) {
746
      if (!$element[$key]) {
747
        $element[$key] = array('#type' => 'radio', '#title' => $choice, '#return_value' => $key, '#default_value' => $element['#default_value'], '#attributes' => $element['#attributes'], '#parents' => $element['#parents'], '#spawned' => TRUE);
748 749 750 751 752 753 754 755 756 757 758
      }
    }
  }
  return $element;
}

/**
 * Format a form item.
 *
 * @param $element
 *   An associative array containing the properties of the element.
759
 *   Properties used:  title, value, description, required, error
760 761 762 763
 * @return
 *   A themed HTML string representing the form item.
 */
function theme_item($element) {
764
  return theme('form_element', $element['#title'], $element['#value'] . $element['#children'], $element['#description'], $element['#id'], $element['#required'], $element['#error']);
765 766 767 768 769 770 771
}

/**
 * Format a checkbox.
 *
 * @param $element
 *   An associative array containing the properties of the element.
772
 *   Properties used:  title, value, return_value, description, required
773 774 775 776 777 778
 * @return
 *   A themed HTML string representing the checkbox.
 */
function theme_checkbox($element) {
  $checkbox = '<input ';
  $checkbox .= 'type="checkbox" ';
779
  $checkbox .= 'class="'. _form_get_class('form-checkbox', $element['#required'], form_get_error($element)) . '" ';
780 781 782
  $checkbox .= 'name="'. $element['#name'] .'" ';
  $checkbox .= 'id="'. $element['#id'].'" ' ;
  $checkbox .= 'value="'. $element['#return_value'] .'" ';
783
  $checkbox .= ($element['#return_value'] == $element['#value']) ? ' checked="checked" ' : ' ';
784 785 786 787
  $checkbox .= drupal_attributes($element['#attributes']) . ' />';

  if (!is_null($element['#title'])) {
    $checkbox = '<label class="option">'. $checkbox .' '. $element['#title'] .'</label>';
788 789
  }

790
  return theme('form_element', NULL, $checkbox, $element['#description'], $element['#id'], $element['#required'], form_get_error($element));
791 792 793 794 795 796 797 798 799 800 801
}

/**
 * Format a set of checkboxes.
 *
 * @param $element
 *   An associative array containing the properties of the element.
 * @return
 *   A themed HTML string representing the checkbox set.
 */
function theme_checkboxes($element) {
802
  if ($element['#title'] || $element['#description']) {
803
    return theme('form_element', $element['#title'], $element['#children'], $element['#description'], $element['#id'], $element['#required'], form_get_error($element));
804 805
  }
  else {
806
    return $element['#children'];
807 808 809 810
  }
}

function expand_checkboxes($element) {
811
  $value = is_array($element['#value']) ? $element['#value'] : array();
812
  $element['#tree'] = TRUE;
813 814 815
  if (count($element['#options']) > 0) {
    if (!isset($element['#default_value']) || $element['#default_value'] == 0) {
      $element['#default_value'] = array();
816
    }
817
    foreach ($element['#options'] as $key => $choice) {
818
      if (!isset($element[$key])) {
819
        $element[$key] = array('#type' => 'checkbox', '#processed' => TRUE, '#title' => $choice, '#return_value' => $key, '#default_value' => isset($value[$key]), '#attributes' => $element['#attributes']);
820 821 822 823 824 825 826 827 828 829 830
      }
    }
  }
  return $element;
}

function theme_submit($element) {
  return theme('button', $element);
}

function theme_button($element) {
831
  return '<input type="submit" class="form-'. $element['#button_type'] .'" '. (empty($element['#name']) ? '' : 'name="'. $element['#name'] .'" ') .'value="'. check_plain($element['#value']) .'" '. drupal_attributes($element['#attributes']) ." />\n";
832 833 834 835 836 837 838
}

/**
 * Format a hidden form field.
 *
 * @param $element
 *   An associative array containing the properties of the element.
839
 *   Properties used:  value, edit
840 841 842 843
 * @return
 *   A themed HTML string representing the hidden form field.
 */
function theme_hidden($element) {
844
  return '<input type="hidden" name="'. $element['#name'] . '" value="'. check_plain($element['#value']) ."\" " . drupal_attributes($element['#attributes']) ." />\n";
845 846 847 848 849 850 851
}

/**
 * Format a textfield.
 *
 * @param $element
 *   An associative array containing the properties of the element.
852
 *   Properties used:  title, value, description, size, maxlength, required, attributes autocomplete_path
853 854 855 856
 * @return
 *   A themed HTML string representing the textfield.
 */
function theme_textfield($element) {
857
  $size = $element['#size'] ? ' size="' . $element['#size'] . '"' : '';
858 859
  $class = '';
  $extra = '';
860
  if ($element['#autocomplete_path']) {
861 862
    drupal_add_js('misc/autocomplete.js');
    $class = ' form-autocomplete';
863
    $extra =  '<input class="autocomplete" type="hidden" id="'. $element['#id'] .'-autocomplete" value="'. check_url(url($element['#autocomplete_path'], NULL, NULL, TRUE)) .'" disabled="disabled" />';
864 865
  }

866 867
  $output = '<input type="text" maxlength="'. $element['#maxlength'] .'" class="'. _form_get_class("form-text$class", $element['#required'], form_get_error($element)) .'" name="'. $element['#name'] .'" id="'. $element['#id'] .'" '. $size .' value="'. check_plain($element['#value']) .'"'. drupal_attributes($element['#attributes']) .' />';
  return theme('form_element', $element['#title'], $output, $element['#description'], $element['#id'], $element['#required'], form_get_error($element)). $extra;
868 869 870 871 872 873 874
}

/**
 * Format a form.
 *
 * @param $element
 *   An associative array containing the properties of the element.
875
 *   Properties used: action, method, attributes, children
876 877 878 879 880
 * @return
 *   A themed HTML string representing the form.
 */
function theme_form($element) {
  // Anonymous div to satisfy XHTML compliancy.
881
  $action = $element['#action'] ? 'action="' . check_url($element['#action']) . '" ' : '';
882
  return '<form '. $action . ' method="'. $element['#method'] .'" '. 'id="'. $element['#id'] .'"'.  drupal_attributes($element['#attributes']) .">\n<div>". $element['#children'] ."\n</div></form>\n";
883 884 885 886 887 888 889
}

/**
 * Format a textarea.
 *
 * @param $element
 *   An associative array containing the properties of the element.
890
 *   Properties used: title, value, description, rows, cols, required, attributes
891 892 893 894
 * @return
 *   A themed HTML string representing the textarea.
 */
function theme_textarea($element) {
895 896 897 898 899 900
  $class = 'textarea';
  if ($element['#resizable'] !== false) {
    drupal_add_js('misc/textarea.js');
    $class .= ' resizable';
  }

901
  $cols = $element['#cols'] ? ' cols="'. $element['#cols'] .'"' : '';
902

903
  return theme('form_element', $element['#title'], '<textarea'. $cols .' rows="'. $element['#rows'] .'" name="'. $element['#name'] .'" id="' . $element['#id'] .'" class="'. _form_get_class($class, $element['#required'], form_get_error($element)) .'"'. drupal_attributes($element['#attributes']) .'>'. check_plain($element['#value']) .'</textarea>', $element['#description'], $element['#id'], $element['#required'], form_get_error($element));
904 905 906 907 908 909 910 911 912
}

/**
 * Format HTML markup for use in forms.
 *
 * This is used in more advanced forms, such as theme selection and filter format.
 *
 * @param $element
 *   An associative array containing the properties of the element.
913
 *   Properties used: prefix, value, children and suffix.
914 915 916 917 918
 * @return
 *   A themed HTML string representing the HTML markup.
 */

function theme_markup($element) {
919
  return $element['#value'] . $element['#children'];
920 921 922 923 924 925 926
}

/**
* Format a password field.
*
* @param $element
*   An associative array containing the properties of the element.
927
*   Properties used:  title, value, description, size, maxlength, required, attributes
928 929 930 931
* @return
*   A themed HTML string representing the form.
*/
function theme_password($element) {
932
  $size = $element['#size'] ? ' size="'. $element['#size'] .'" ' : '';
933

934
  $output = '<input type="password" maxlength="'. $element['#maxlength'] .'" class="'. _form_get_class('form-text', $element['#required'], form_get_error($element)) .'" name="'. $element['#name'] .'" id="'. $element['#id'] .'" '. $size . drupal_attributes($element['#attributes']) .' />';
935

936
  return theme('form_element', $element['#title'], $output, $element['#description'], $element['#id'], $element['#required'], form_get_error($element));
937 938 939 940 941 942 943
}

/**
 * Format a weight selection menu.
 *
 * @param $element
 *   An associative array containing the properties of the element.
944
 *   Properties used:  title, delta, description
945 946 947 948
 * @return
 *   A themed HTML string representing the form.
 */
function theme_weight($element) {
949
  for ($n = (-1 * $element['#delta']); $n <= $element['#delta']; $n++) {
950 951
    $weights[$n] = $n;
  }
952 953
  $element['#options'] = $weights;
  $element['#type'] = 'select';
954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977

  return form_render($element);
}

/**
 * Format a file upload field.
 *
 * @param $title
 *   The label for the file upload field.
 * @param $name
 *   The internal name used to refer to the field.
 * @param $size
 *   A measure of the visible size of the field (passed directly to HTML).
 * @param $description
 *   Explanatory text to display after the form item.
 * @param $required
 *   Whether the user must upload a file to the field.
 * @return
 *   A themed HTML string representing the field.
 *
 * For assistance with handling the uploaded file correctly, see the API
 * provided by file.inc.
 */
function theme_file($element) {
978
  return theme('form_element', $element['#title'], '<input type="file" class="'. _form_get_class('form-file', $element['#required'], form_get_error($element)) .'" name="'. $element['#name'] .'"'. ($element['#attributes'] ? ' '. drupal_attributes($element['#attributes']) : '') .' id="'. form_clean_id($element['#id']) .'" size="'. $element['#size'] ."\" />\n", $element['#description'], $element['#id'], $element['#required'], form_get_error($element));
979
}
980

981
function _form_get_class($name, $required, $error) {
982
  return $name. ($required ? ' required' : '') . (isset($error) ? ' error' : '');
983 984 985
}

/**
986
 * Remove invalid characters from an HTML ID attribute string.
987 988 989 990 991 992 993 994 995 996 997 998 999 1000
 *
 * @param $id
 *   The ID to clean
 * @return
 *   The cleaned ID
 */
function form_clean_id($id = NULL) {
  $id = str_replace('][', '-', $id);
  return $id;
}

/**
 * @} End of "defgroup form".
 */