form.inc 33.6 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 52 53 54 55 56 57 58 59
 *
 * @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.
 * @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
60
  global $form_values, $form_submitted;
61
  $form_values = array();
Dries's avatar
Dries committed
62
  $form_submitted = FALSE;
63

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

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

78 79
  $form = array_merge(_element_info('form'), $form);

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

89 90
  if (!isset($form['#submit'])) {
    if (function_exists($form_id .'_submit')) {
91 92 93
      // 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
94
    }
95
    elseif (function_exists($callback .'_submit')) {
96
      $form['#submit'] = array($callback .'_submit' => array($form_id, &$form_values));
Dries's avatar
Dries committed
97 98 99
    }
  }

100 101
  foreach (module_implements('form_alter') as $module) {
    $function = $module .'_form_alter';
102
    $function($form_id, $form);
103 104
  }

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

127
  if (theme_get_function($form_id)) {
128
    $form['#theme'] = $form_id;
129
  }
130
  elseif (theme_get_function($callback)) {
131
    $form['#theme'] = $callback;
132 133 134 135 136 137 138
  }
  return form_render($form);
}

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

139
  if (isset($form['#token'])) {
140
    if ($form_values['form_token'] != md5(session_id() . $form['#token'] . variable_get('drupal_private_key', ''))) {
141 142 143 144 145
      // 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.'));
    }
  }

146
  _form_validate($form, $form_id);
147 148
}

149
function drupal_submit_form($form_id, $form, $callback = NULL) {
150 151
  global $form_values;

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

167
function _form_validate($elements, $form_id = NULL) {
168
  /* Validate the current input */
169
  if (!$elements['#validated'] && ($elements['#input'] || isset($form_id))) {
170 171 172
    // 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.
173
    if ($elements['#required'] && empty($elements['#value']) && $elements['#value'] !== '0') {
174
      form_error($elements, t('%name field is required.', array('%name' => $elements['#title'])));
175
    }
176

177 178
    // 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'])) {
179 180 181 182 183 184
      if ($elements['#type'] == 'select') {
        $options = form_options_flatten($elements['#options']);
      }
      else {
        $options = $elements['#options'];
      }
185 186 187
      if (is_array($elements['#value'])) {
        $value = $elements['#type'] == 'checkboxes' ? array_keys(array_filter($elements['#value'])) : $elements['#value'];
        foreach ($value as $v) {
188
          if (!isset($options[$v])) {
189 190
            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));
191 192 193
          }
        }
      }
194
      elseif (!isset($options[$elements['#value']])) {
195 196
        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));
197 198 199 200
      }
    }

    // User-applied checks.
Dries's avatar
Dries committed
201
    if (isset($elements['#validate'])) {
202 203 204 205 206
      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);
207
        }
208 209
        if (function_exists($function))  {
          call_user_func_array($function, $args);
210 211 212
        }
      }
    }
213
    $elements['#validated'] = TRUE;
214
  }
215 216 217 218 219 220 221

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

224 225 226 227 228
/**
 * 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.
 */
229
function form_set_error($name = NULL, $message = '') {
230 231 232
  static $form = array();
  if (isset($name) && !isset($form[$name])) {
    $form[$name] = $message;
233 234 235
    if ($message) {
      drupal_set_message($message, 'error');
    }
236 237 238 239 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
  }
  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];
  }
}

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

/**
274 275 276 277 278 279 280 281 282
 * 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.
283
 */
284
function form_builder($form_id, $form) {
285
  global $form_values;
Dries's avatar
Dries committed
286
  global $form_submitted;
287
  /* Use element defaults */
288
  if ((!empty($form['#type'])) && ($info = _element_info($form['#type']))) {
289
    // overlay $info onto $form, retaining preexisting keys in $form
290 291 292
    $form += $info;
  }

293
  if (isset($form['#input']) && $form['#input']) {
294 295 296 297 298 299
    if (!isset($form['#name'])) {
      $form['#name'] = 'edit[' . implode('][', $form['#parents']) . ']';
    }
    if (!isset($form['#id'])) {
      $form['#id'] =  'edit-' . implode('-', $form['#parents']);
    }
300

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

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

346 347 348
  // 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.
349
  if (isset($form['#input']) && $form['#input']) {
350 351 352
    $ref = $form['#value'];
  }

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

361 362
    // don't squash existing parents value
    if (!isset($form[$key]['#parents'])) {
363 364
      // 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);
365 366
    }

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

375
  if (isset($form['#after_build']) && function_exists($form['#after_build']) && !isset($form['#after_build_done'])) {
376
    $function = $form['#after_build'];
377
    $form = $function($form, $form_values);
378
    $form['#after_build_done'] = TRUE;
379
  }
380 381 382 383 384

  return $form;
}

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

402
  if (!isset($elements['#children'])) {
403
    /* render all the children using a theme function */
404
    if (isset($elements['#theme']) && !$elements['#theme_used']) {
405 406 407 408 409
      $elements['#theme_used'] = TRUE;
      $previous_type = $elements['#type'];
      $elements['#type'] = 'markup';
      $content = theme($elements['#theme'], $elements);
      $elements['#type'] = $previous_type;
410 411 412 413 414 415 416 417 418
    }
    /* 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) {
419
    $elements['#children'] = $content;
420 421 422
  }

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

428
  if ($content) {
429 430 431
    $prefix = isset($elements['#prefix']) ? $elements['#prefix'] : '';
    $suffix = isset($elements['#suffix']) ? $elements['#suffix'] : '';
    return $prefix . $content . $suffix;
432
  }
433 434 435
}

/**
436
 * Function used by uasort in form_render() to sort form by weight.
437 438
 */
function _form_sort($a, $b) {
439 440 441
  $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
442 443
    return 0;
  }
444
  return ($a_weight < $b_weight) ? -1 : 1;
445 446 447 448 449 450 451
}

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

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

  return $cache[$type];
}

478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496
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;
}

497 498 499 500 501
/**
 * Format a dropdown menu or scrolling selection box.
 *
 * @param $element
 *   An associative array containing the properties of the element.
502
 *   Properties used: title, value, options, description, extra, multiple, required
503 504 505 506 507 508 509 510 511
 * @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 = '';
512
  $size = $element['#size'] ? ' size="' . $element['#size'] . '"' : '';
513 514 515 516 517 518 519
  return theme('form_element', $element['#title'], '<select 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));
}

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

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

558 559 560
    $element['#attributes']['class'] .= ' collapsible';
    if ($element['#collapsed']) {
     $element['#attributes']['class'] .= ' collapsed';
561 562 563
    }
  }

564
  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";
565 566 567 568 569 570 571 572

}

/**
 * Format a radio button.
 *
 * @param $element
 *   An associative array containing the properties of the element.
573
 *   Properties used: required, return_value, value, attributes, title, description
574 575 576 577 578
 * @return
 *   A themed HTML string representing the form item group.
 */
function theme_radio($element) {
  $output = '<input type="radio" ';
579
  $output .= 'class="'. _form_get_class('form-radio', $element['#required'], form_get_error($element)) .'" ';
580 581 582 583 584 585
  $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>';
586
  }
587
  return theme('form_element', NULL, $output, $element['#description'], $element['#id'], $element['#required'], form_get_error($element));
588 589 590 591 592 593 594
}

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

608 609 610 611 612 613 614 615 616 617 618 619 620 621
/**
 * 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));
}

/**
622
 * Validate password_confirm element.
623
 */
624 625 626 627 628 629
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;
630
    if ($pass1 != $pass2) {
631 632 633
      form_error($form, t('The specified passwords do not match.'));
      form_error($form['pass1']);
      form_error($form['pass2']);
634
    }
635 636 637 638
    $form['#ref'] = $pass1;
  }
  elseif ($form['#required'] && !empty($_POST['edit'])) {
    form_set_error('pass1', t('Password field is required.'));
639 640 641 642
  }
  return $form;
}

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

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

668 669
  $element['#tree'] = TRUE;

670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685
  // 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':
686
        $options = drupal_map_assoc(range(1, 12), 'map_month');
687 688 689 690 691
        break;
      case 'year':
        $options = drupal_map_assoc(range(1900, 2050));
        break;
    }
692 693 694 695 696 697 698 699
    $parents = $element['#parents'];
    $parents[] = $type;
    $element[$type] = array(
      '#type' => 'select',
      '#value' => $element['#value'][$type],
      '#attributes' => $element['#attributes'],
      '#options' => $options,
    );
700 701 702 703 704
  }

  return $element;
}

705 706 707 708 709 710
/**
 * 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);
}
711

712 713 714 715 716 717 718 719 720 721 722
/**
 * 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;
}

723 724 725 726 727 728 729 730 731 732 733 734
/**
 * 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;
  }
}

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

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

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

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

786
  return theme('form_element', NULL, $checkbox, $element['#description'], $element['#id'], $element['#required'], form_get_error($element));
787 788 789 790 791 792 793 794 795 796 797
}

/**
 * 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) {
798
  if ($element['#title'] || $element['#description']) {
799
    return theme('form_element', $element['#title'], $element['#children'], $element['#description'], $element['#id'], $element['#required'], form_get_error($element));
800 801
  }
  else {
802
    return $element['#children'];
803 804 805 806
  }
}

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

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

function theme_button($element) {
827
  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";
828 829 830 831 832 833 834
}

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

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

862 863
  $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;
864 865 866 867 868 869 870
}

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

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

897
  $cols = $element['#cols'] ? ' cols="'. $element['#cols'] .'"' : '';
898

899
  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));
900 901 902 903 904 905 906 907 908
}

/**
 * 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.
909
 *   Properties used: prefix, value, children and suffix.
910 911 912 913 914
 * @return
 *   A themed HTML string representing the HTML markup.
 */

function theme_markup($element) {
915
  return $element['#value'] . $element['#children'];
916 917 918 919 920 921 922
}

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

930
  $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']) .' />';
931

932
  return theme('form_element', $element['#title'], $output, $element['#description'], $element['#id'], $element['#required'], form_get_error($element));
933 934 935 936 937 938 939
}

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

  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) {
974
  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));
975
}
976

977
function _form_get_class($name, $required, $error) {
978
  return $name. ($required ? ' required' : '') . (isset($error) ? ' error' : '');
979 980 981
}

/**
982
 * Remove invalid characters from an HTML ID attribute string.
983 984 985 986 987 988 989 990 991 992 993 994 995 996
 *
 * @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".
 */