form.inc 27.8 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 15
 * must be explicitly generated by modules. See the
 * <a href="http://drupaldocs.org/api/head/file/contributions/docs/developer/topics/forms_api_reference.html">reference</a>
 * and the
 * <a href="http://drupaldocs.org/api/file/contributions/docs/developer/topics/forms_api.html">quickstart</a>
 * guide for more.
16 17 18 19 20 21
 */

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

function element_properties($element) {
26
  return array_filter(array_keys((array) $element), 'element_property');
27 28 29 30 31 32
}

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

function element_children($element) {
37
  return array_filter(array_keys((array) $element), 'element_child');
38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57
}

/**
 * Processes a form array, and produces the HTML output of a form.
 * If there is input in the $_POST['edit'] variable, this function
 * will attempt to validate it, using <code>drupal_validate_form</code>,
 * and then execute the form using <code>drupal_execute_form</code>.
 *
 * @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) {
  global $form_values, $form_execute;
  $form_values = array();
  $form_execute = FALSE;
58

59 60
  $form['#type'] = 'form';
  if (isset($form['#token'])) {
61 62 63 64 65
    // Make sure that a private key is set:
    if (!variable_get('drupal_private_key', '')) {
      variable_set('drupal_private_key', mt_rand());
    }

66 67
    $form['form_token'] = array('#type' => 'hidden', '#value' => md5($_SERVER['REMOTE_ADDR'] . $form['#token'] . variable_get('drupal_private_key',
'')));
68
  }
69 70
  $form['form_id'] = array('#type' => 'hidden', '#default_value' => $form_id);

71 72 73 74
  $form = array_merge(_element_info('form'), $form);

  foreach (module_implements('form_alter') as $module) {
    $function = $module .'_form_alter';
75
    $function($form_id, $form);
76 77
  }

78
  $form = _form_builder($form_id, $form);
79

80
  if (!empty($_POST['edit']) && (($_POST['edit']['form_id'] == $form_id) || ($_POST['edit']['form_id'] == $callback))) {
81 82 83 84
    drupal_validate_form($form_id, $form, $callback);
    if ($form_execute && !form_get_errors()) {
      drupal_execute_form($form_id, $form, $callback);
    }
85 86 87
  }

  if (function_exists('theme_' . $form_id)) {
88
    $form['#theme'] = $form_id;
89 90
  }
  elseif (function_exists('theme_' . $callback)) {
91
    $form['#theme'] = $callback;
92 93 94 95 96 97 98
  }
  return form_render($form);
}

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

99 100
  if (isset($form['#token'])) {
    if ($form_values['form_token'] != md5($_SERVER['REMOTE_ADDR'] . $form['#token'] . variable_get('drupal_private_key', ''))) {
101 102 103 104 105 106 107 108 109 110 111 112 113 114 115
      // 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.'));
    }
  }

  foreach (module_implements('form_validate_alter') as $module) {
    $function = $module .'_form_validate_alter';
    $function($form_id, $form_values);
  }

  _form_validate($form);

  if (function_exists($form_id . '_validate')) {
    call_user_func($form_id . '_validate', $form_id, $form_values);
  }
116
  elseif (function_exists($callback . '_validate')) {
117 118 119 120 121 122
    call_user_func($callback . '_validate', $form_id, $form_values);
  }
}

function drupal_execute_form($form_id, $form, $callback = NULL) {
  global $form_values;
123 124 125 126
  foreach (module_implements('form_execute_alter') as $module) {
    $function = $module .'_form_execute_alter';
    $function($form_id, $form_values);
  }
127

128 129 130 131 132
  if (function_exists($form_id . '_execute')) {
    call_user_func($form_id . '_execute', $form_id, $form_values);
  }
  elseif (function_exists($callback . '_execute')) {
    call_user_func($callback . '_execute', $form_id, $form_values);
133 134 135
  }
}

136
function _form_validate($elements) {
137 138 139

  // Recurse through all children.
  foreach (element_children($elements) as $key) {
140 141 142
    if (isset($elements[$key]) && $elements[$key]) {
      _form_validate($elements[$key]);
    }
143 144 145
  }

  /* Validate the current input */
146
  if (!$elements['#validated'] && $elements['#input']) {
147 148 149 150
    // An empty checkbox returns 0, an empty textfield returns '' so we use empty().
    // Unfortunately, empty('0') returns TRUE so we need a special check for the '0' string.
    if ($elements['#required'] && empty($elements['#value']) && $elements['#value'] !== '0') {
      form_error($elements, t('%name field is required', array('%name' => $elements['#title'])));
151 152 153 154 155 156 157
    }
    if ($elements['#valid']) {
      if (is_array($elements['#valid'])) {
        foreach ($elements['#valid'] as $key => $valid) {
          $args = is_array($elements['#validation_arguments'][$key]) ? $elements['#validation_arguments'][$key] : array();
          if (function_exists($valid . '_valid'))  {
            call_user_func_array($valid . '_valid', array_merge(array($elements), $args));
158 159
          }
        }
160 161 162 163 164
      }
      else {
        $args = is_array($elements['#validation_arguments']) ? $elements['#validation_arguments'] : array();
        if (function_exists($elements['#valid'] . '_valid'))  {
          call_user_func_array($elements['#valid'] . '_valid', array_merge(array($elements), $args));
165 166 167
        }
      }
    }
168
    $elements['#validated'] = TRUE;
169 170 171
  }
}

172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210
/**
 * 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.
 */
function form_set_error($name = NULL, $message = NULL) {
  static $form = array();
  if (isset($name) && !isset($form[$name])) {
    $form[$name] = $message;
    drupal_set_message($message, 'error');
  }
  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];
  }
}

211 212 213 214
/**
 * Flag an element as having an error.
 */
function form_error(&$element, $message) {
215
  $element['#error'] = TRUE;
216
  form_set_error(implode('][', $element['#parents']), $message);
217 218 219 220 221 222 223
}

/**
 * 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.
 */
224
function _form_builder($form_id, $form) {
225 226 227
  global $form_values;
  global $form_execute;
  /* Use element defaults */
228
  if ((!empty($form['#type'])) && ($info = _element_info($form['#type']))) {
229 230 231
    $form += $info;
  }

232
  if ($form['#input']) {
233 234 235 236 237 238
    if (!isset($form['#name'])) {
      $form['#name'] = 'edit[' . implode('][', $form['#parents']) . ']';
    }
    if (!isset($form['#id'])) {
      $form['#id'] =  'edit-' . implode('-', $form['#parents']);
    }
239

240
    $posted = (isset($_POST['edit']) && ($_POST['edit']['form_id'] == $form_id));
241 242
    $edit = $posted ? $_POST['edit'] : array();
    $ref =& $form_values;
243
    foreach ($form['#parents'] as $parent) {
244 245 246
      $edit = isset($edit[$parent]) ? $edit[$parent] : NULL;
      $ref =& $ref[$parent];
    }
247
    if (!isset($form['#value'])) {
248 249 250 251 252 253 254 255 256 257 258
      if ($posted) {
        if (isset($edit)) {
          $form['#value'] = $edit; // normal element
        }
        elseif (isset($form['#return_value'])) {
          $form['#value'] = 0; // checkbox unchecked
        }
      }
      if (!isset($form['#value'])) {
        $form['#value'] = $form['#default_value'];
      }
259 260 261 262
    }
    if (isset($form['#execute'])) {
      if ($_POST[$form['#name']] == $form['#value']) {
        $form_execute = $form_execute || $form['#execute'];
263 264 265
      }
    }

266
    $ref = $form['#value'];
267 268 269
  }

  // Allow for elements to expand to multiple elements. Radios, checkboxes and files for instance.
270 271 272
  if (function_exists($form['#process']) && !$form['#processed']) {
    $form = call_user_func($form['#process'], $form);
    $form['#processed'] = TRUE;
273 274 275 276 277
  }

  // Recurse through all child elements.
  $count  = 0;
  foreach (element_children($form) as $key) {
278
    // don't squash an existing tree value
279 280 281
    if (!isset($form[$key]['#tree'])) {
      $form[$key]['#tree'] = $form['#tree'];
    }
282

283 284 285 286 287 288 289 290 291 292 293
    // don't squash existing parents value
    if (!isset($form[$key]['#parents'])) {
      if ($form[$key]['#tree']) {
        if (!$form['#tree']) {
          // begin tree
          $form[$key]['#parents'] = array($key);
        }
        else {
          //continue tree
          $form[$key]['#parents'] = array_merge($form['#parents'], array($key));
        }
294 295
      }
      else {
296 297
        // no tree
        $form[$key]['#parents'] = array($key);
298
      }
299 300
    }

301
    # Assign a decimal placeholder weight, to preserve original array order
302 303 304
    if (!isset($form[$key]['#weight'])) {
      $form[$key]['#weight'] = $count/1000;
    }
305
    $form[$key] = _form_builder($form_id, $form[$key]);
306 307 308
    $count++;
  }

309 310 311
  if (function_exists($form['#after_build']) && !isset($form['#after_build_done'])) {
    $form = call_user_func($form['#after_build'], $form, $form_values);
    $form['#after_build_done'] = TRUE;
312
  }
313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333

  return $form;
}

/**
 * Renders a HTML form given an form tree.  Recursively iterates over each of
 * each of the form elements generating HTML code.  This function is usually
 * called from within a theme.  To render a form from within a module, use
 * <code>drupal_get_form()</code>.
 *
 * @param $elements
 *   The form tree describing the form.
 * @return
 *   The rendered HTML form.
 */
function form_render(&$elements) {
  $content = '';
  if (is_array($elements)) {
    uasort($elements, "_form_sort");
  }

334
  if (!$elements['#children']) {
335
    /* render all the children using a theme function */
336 337 338 339 340 341
    if ($elements['#theme'] && !$elements['#theme_used']) {
      $elements['#theme_used'] = TRUE;
      $previous_type = $elements['#type'];
      $elements['#type'] = 'markup';
      $content = theme($elements['#theme'], $elements);
      $elements['#type'] = $previous_type;
342 343 344 345 346 347 348 349 350
    }
    /* 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) {
351
    $elements['#children'] = $content;
352 353 354
  }

  /* Call the form element renderer */
355 356 357
  if (!$elements['#printed']) {
    $content = theme(($elements['#type']) ? $elements['#type']: 'markup', $elements);
    $elements['#printed'] = TRUE;
358 359
  }

360 361 362
  if ($content) {
    return $elements['#prefix'] . $content . $elements['#suffix'];
  }
363 364 365 366 367 368
}

/**
 * Function used by uasort in form render to sort form via weight.
 */
function _form_sort($a, $b) {
369
  if ($a['#weight'] == $b['#weight']) {
370 371
    return 0;
  }
372
  return ($a['#weight'] < $b['#weight']) ? -1 : 1;
373 374 375 376 377 378 379
}

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

  $parents = array();
382
  $basic_defaults = array(
383 384 385
    '#description' => NULL,
    '#attributes' => array(),
    '#required' => FALSE,
386 387
    '#tree' => FALSE,
    '#parents' => $parents
388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421
  );
  if ($refresh || !is_array($cache)) {
    $cache = array();
    foreach (module_implements('elements') as $module) {
      $elements = module_invoke($module, 'elements');
      if (is_array($elements)) {
        $cache = array_merge($cache, $elements);
      }
    }
    if (sizeof($cache)) {
      foreach ($cache as $element_type => $info) {
        $cache[$element_type] = array_merge($basic_defaults, $info);
      }
    }
  }

  return $cache[$type];
}

/**
 * Format a dropdown menu or scrolling selection box.
 *
 * @param $element
 *   An associative array containing the properties of the element.
 *   Properties used : title, value, options, description, extra, multiple, required
 * @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 = '';
422
  foreach ($element['#options'] as $key => $choice) {
423 424 425
    if (is_array($choice)) {
      $select .= '<optgroup label="'. $key .'">';
      foreach ($choice as $key => $choice) {
426
        $select .= '<option value="'. $key .'"'. (is_array($element['#value']) ? (in_array($key, $element['#value']) ? ' selected="selected"' : '') : ($element['#value'] == $key ? ' selected="selected"' : '')) .'>'. check_plain($choice) .'</option>';
427 428 429 430
      }
      $select .= '</optgroup>';
    }
    else {
431
      $select .= '<option value="'. $key .'"'. (is_array($element['#value']) ? (in_array($key, $element['#value']) ? ' selected="selected"' : '') : ($element['#value'] == $key ? ' selected="selected"' : '')) .'>'. check_plain($choice) .'</option>';
432 433
    }
  }
434
  return theme('form_element', $element['#title'], '<select name="'. $element['#name'] .''. ($element['#multiple'] ? '[]' : '') .'"'. ($element['#multiple'] ? ' multiple="multiple" ' : '') . drupal_attributes($element['#attributes']) .' id="' . $element['#id'] .'">'. $select .'</select>', $element['#description'], $element['#id'], $element['#required'], form_get_error($element));
435 436 437 438 439 440 441 442 443 444 445 446
}

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

450 451 452
    $element['#attributes']['class'] .= ' collapsible';
    if ($element['#collapsed']) {
     $element['#attributes']['class'] .= ' collapsed';
453 454 455
    }
  }

456
  return '<fieldset' . drupal_attributes($element['#attributes']) .'>' . ($element['#title'] ? '<legend>'. $element['#title'] .'</legend>' : '') . $element['#children'] . $element['#value'] . ($element['#description'] ? '<div class="description">'. $element['#description'] .'</div>' : '') . "</fieldset>\n";
457 458 459 460 461 462 463 464 465 466 467 468 469 470 471

}


/**
 * Format a radio button.
 *
 * @param $element
 *   An associative array containing the properties of the element.
 *   Properties used : required, return_value, value, attributes, title, description
 * @return
 *   A themed HTML string representing the form item group.
 */
function theme_radio($element) {
  $output = '<input type="radio" ';
472
  $output .= 'class="'. _form_get_class('form-radio', $element['#required'], form_get_error($element)) .'" ';
473 474 475 476 477 478
  $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>';
479
  }
480
  return theme('form_element', NULL, $output, $element['#description'], $element['#name'], $element['#required'], form_get_error($element));
481 482 483 484 485 486 487 488 489 490 491 492
}

/**
 * Format a set of radio buttons.
 *
 * @param $element
 *   An associative array containing the properties of the element.
 *   Properties used : title, value, options, description, required and attributes.
 * @return
 *   A themed HTML string representing the radio button set.
 */
function theme_radios($element) {
493
  if ($element['#title'] || $element['#description']) {
494
    return theme('form_element', $element['#title'], $element['#children'], $element['#description'], $element['#id'], $element['#required'], form_get_error($element));
495 496
  }
  else {
497
    return $element['#children'];
498 499 500 501
  }
}

/**
502
 * Format a date selection element.
503 504 505 506 507
 *
 * @param $element
 *   An associative array containing the properties of the element.
 *   Properties used : title, value, options, description, required and attributes.
 * @return
508
 *   A themed HTML string representing the date selection boxes.
509 510
 */
function theme_date($element) {
511
  $output = '<div class="container-inline">' . $element['#children'] . '</div>';
512
  return theme('form_element', $element['#title'], $output, $element['#description'], $element['#id'], $element['#required'], form_get_error($element));
513 514 515
}

/**
516
 * Roll out a single date element.
517 518 519
 */
function expand_date($element) {
  // Default to current date
520 521
  if (!isset($element['#value'])) {
    $element['#value'] = array('day' => format_date(time(), 'custom', 'j'),
522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541
                            'month' => format_date(time(), 'custom', 'n'),
                            'year' => format_date(time(), 'custom', 'Y'));
  }

  // 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':
542
        $options = drupal_map_assoc(range(1, 12), 'map_month');
543 544 545 546 547
        break;
      case 'year':
        $options = drupal_map_assoc(range(1900, 2050));
        break;
    }
548
    $element[$type] = array('#type' => 'select', '#value' => $element['#value'][$type], '#attributes' => $element['#attributes'], '#parents' => $element['#parents'], '#options' => $options,  '#tree' => TRUE);
549 550 551 552 553
  }

  return $element;
}

554 555 556 557 558 559
/**
 * 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);
}
560 561

/**
562
 * Roll out a single radios element
563
 * to a list of radios, using the options array as index.
564 565
 */
function expand_radios($element) {
566 567
  if (count($element['#options']) > 0) {
    foreach ($element['#options'] as $key => $choice) {
568
      if (!$element[$key]) {
569
        $element[$key] = array('#type' => 'radio', '#title' => $choice, '#return_value' => $key, '#default_value' => $element['#default_value'], '#attributes' => $element['#attributes'], '#parents' => $element['#parents'], '#spawned' => TRUE);
570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586
      }
    }
  }
  return $element;
}


/**
 * Format a form item.
 *
 * @param $element
 *   An associative array containing the properties of the element.
 *   Properties used :  title, value, description, required, error
 * @return
 *   A themed HTML string representing the form item.
 */
function theme_item($element) {
587
  return theme('form_element', $element['#title'], $element['#value'] . $element['#children'], $element['#description'], $element['#id'], $element['#required'], $element['#error']);
588 589 590 591 592 593 594 595 596 597 598 599 600 601 602
}


/**
 * Format a checkbox.
 *
 * @param $element
 *   An associative array containing the properties of the element.
 *   Properties used :  title, value, return_value, description, required
 * @return
 *   A themed HTML string representing the checkbox.
 */
function theme_checkbox($element) {
  $checkbox = '<input ';
  $checkbox .= 'type="checkbox" ';
603
  $checkbox .= 'class="'. _form_get_class('form-checkbox', $element['#required'], form_get_error($element)) . '" ';
604 605 606 607 608 609 610 611
  $checkbox .= 'name="'. $element['#name'] .'" ';
  $checkbox .= 'id="'. $element['#id'].'" ' ;
  $checkbox .= 'value="'. $element['#return_value'] .'" ';
  $checkbox .= ($element['#value'] == $element['#return_value']) ? ' checked="checked" ' : ' ';
  $checkbox .= drupal_attributes($element['#attributes']) . ' />';

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

614
  return theme('form_element', NULL, $checkbox, $element['#description'], $element['#name'], $element['#required'], form_get_error($element));
615 616 617 618 619 620 621 622 623 624 625
}

/**
 * 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) {
626
  if ($element['#title'] || $element['#description']) {
627
    return theme('form_element', $element['#title'], $element['#children'], $element['#description'], 'edit-'. $element['#name'], $element['#required'], form_get_error($element));
628 629
  }
  else {
630
    return $element['#children'];
631 632 633 634
  }
}

function expand_checkboxes($element) {
635
  $value = is_array($element['#value']) ? $element['#value'] : array();
636
  $element['#tree'] = TRUE;
637 638 639
  if (count($element['#options']) > 0) {
    if (!isset($element['#default_value']) || $element['#default_value'] == 0) {
      $element['#default_value'] = array();
640
    }
641
    foreach ($element['#options'] as $key => $choice) {
642
      if (!isset($element[$key])) {
643
        $element[$key] = array('#type' => 'checkbox', '#processed' => TRUE, '#title' => $choice, '#default_value' => in_array($key, $value), '#attributes' => $element['#attributes']);
644 645 646 647 648 649 650 651 652 653 654 655
      }
    }
  }
  return $element;
}


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

function theme_button($element) {
656
  return '<input type="submit" class="form-'. $element['#button_type'] .'" name="'. $element['#name'] .'" value="'. check_plain($element['#value']) .'" '. drupal_attributes($element['#attributes']) ." />\n";
657 658 659 660 661 662 663 664 665 666 667 668
}

/**
 * Format a hidden form field.
 *
 * @param $element
 *   An associative array containing the properties of the element.
 *   Properties used :  value, edit
 * @return
 *   A themed HTML string representing the hidden form field.
 */
function theme_hidden($element) {
669
  return '<input type="hidden" name="'. $element['#name'] . '" id="' . $element['#id'] . '" value="'. check_plain($element['#value']) ."\" " . drupal_attributes($element['#attributes']) ." />\n";
670 671 672 673 674 675 676 677 678 679 680 681
}

/**
 * Format a textfield.
 *
 * @param $element
 *   An associative array containing the properties of the element.
 *   Properties used :  title, value, description, size, maxlength, required, attributes autocomplete_path
 * @return
 *   A themed HTML string representing the textfield.
 */
function theme_textfield($element) {
682 683
  $size = $element['#size'] ? ' size="' . $element['#size'] . '"' : '';
  if ($element['#autocomplete_path']) {
684 685
    drupal_add_js('misc/autocomplete.js');
    $class = ' form-autocomplete';
686
    $extra =  '<input class="autocomplete" type="hidden" id="'. $element['#id'] .'-autocomplete" value="'. check_url(url($element['#autocomplete_path'], NULL, NULL, TRUE)) .'" disabled="disabled" />';
687 688
  }

689 690
  $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;
691 692 693 694 695 696 697 698 699 700 701 702 703
}

/**
 * Format a form.
 *
 * @param $element
 *   An associative array containing the properties of the element.
 *   Properties used : action, method, attributes, children
 * @return
 *   A themed HTML string representing the form.
 */
function theme_form($element) {
  // Anonymous div to satisfy XHTML compliancy.
704 705
  $action = $element['#action'] ? 'action="' . check_url($element['#action']) . '" ' : '';
  return '<form '. $action . ' method="'. $element['#method'] .'" '. drupal_attributes($element['#attributes']) .">\n<div>". $element['#children'] ."\n</div></form>\n";
706 707 708 709 710 711 712 713 714 715 716 717 718
}


/**
 * Format a textarea.
 *
 * @param $element
 *   An associative array containing the properties of the element.
 *   Properties used : title, value, description, rows, cols, required, attributes
 * @return
 *   A themed HTML string representing the textarea.
 */
function theme_textarea($element) {
719
  $cols = $element['#cols'] ? ' cols="'. $element['#cols'] .'"' : '';
720

721
  return theme('form_element', $element['#title'], '<textarea'. $cols .' rows="'. $element['#rows'] .'" name="'. $element['#name'] .'" id="' . $element['#id'] .'" class="'. _form_get_class('textarea', $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));
722 723 724 725 726 727 728 729 730 731 732 733 734 735 736
}

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

function theme_markup($element) {
737
  return $element['#value'] . $element['#children'];
738 739 740 741 742 743 744 745 746 747 748 749 750 751
}



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

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

756
  return theme('form_element', $element['#title'], $output, $element['#description'], $element['#id'], $element['#required'], form_get_error($element));
757 758 759 760 761 762 763 764 765 766 767 768
}

/**
 * Format a weight selection menu.
 *
 * @param $element
 *   An associative array containing the properties of the element.
 *   Properties used :  title, delta, description
 * @return
 *   A themed HTML string representing the form.
 */
function theme_weight($element) {
769
  for ($n = (-1 * $element['#delta']); $n <= $element['#delta']; $n++) {
770 771
    $weights[$n] = $n;
  }
772 773
  $element['#options'] = $weights;
  $element['#type'] = 'select';
774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797

  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) {
798
  return theme('form_element', $element['#title'], '<input type="file" class="'. _form_get_class('form-file', $element['#required'], form_get_error($element)) .'" name="'. $element['#name'] .'" id="'. form_clean_id($element['#id']) .'" size="'. $element['#size'] ."\" />\n", $element['#description'], $element['#id'], $element['#required'], form_get_error($element));
799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819
}
function _form_get_class($name, $required, $error) {
  return $name. ($required ? ' required' : '') . ($error ? ' error' : '');
}

/**
 * Remove invalid characters from an HTML ID attribute string
 *
 * @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".
 */