form.inc 32.1 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) {
Steven Wittens's avatar
Steven Wittens committed
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) {
Steven Wittens's avatar
Steven Wittens committed
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;
Steven Wittens's avatar
Steven Wittens committed
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());
    }

Dries's avatar
Dries committed
71
    $form['form_token'] = array('#type' => 'hidden', '#default_value' => md5(session_id() . $form['#token'] . variable_get('drupal_private_key', '')));
72
  }
Dries's avatar
Dries committed
73
  $form['form_id'] = array('#type' => 'hidden', '#value' => $form_id);
Steven Wittens's avatar
Steven Wittens committed
74

75
76
  $form = array_merge(_element_info('form'), $form);

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

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

97
98
  foreach (module_implements('form_alter') as $module) {
    $function = $module .'_form_alter';
99
    $function($form_id, $form);
100
101
  }

102
  $form = _form_builder($form_id, $form);
Steven Wittens's avatar
Steven Wittens committed
103

104
  if (!empty($_POST['edit']) && (($_POST['edit']['form_id'] == $form_id) || ($_POST['edit']['form_id'] == $callback))) {
105
    drupal_validate_form($form_id, $form, $callback);
Dries's avatar
Dries committed
106
    if ($form_submitted && !form_get_errors()) {
107
      drupal_submit_form($form_id, $form, $callback);
108
    }
109
110
  }

111
  if (theme_get_function($form_id)) {
112
    $form['#theme'] = $form_id;
113
  }
114
  elseif (theme_get_function($callback)) {
115
    $form['#theme'] = $callback;
116
117
118
119
120
121
122
  }
  return form_render($form);
}

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

123
  if (isset($form['#token'])) {
124
    if ($form_values['form_token'] != md5(session_id() . $form['#token'] . variable_get('drupal_private_key', ''))) {
125
126
127
128
129
      // 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.'));
    }
  }

130
  _form_validate($form, $form_id);
131
132
}

133
function drupal_submit_form($form_id, $form, $callback = NULL) {
134
135
  global $form_values;

136
  unset($GLOBALS['form_values']['submit'], $GLOBALS['form_values']['form_id']);
137
  if (isset($form['#submit'])) {
138
139
140
    foreach ($form['#submit'] as $function => $args) {
      if (function_exists($function)) {
        call_user_func_array($function, $args);
Dries's avatar
Dries committed
141
142
      }
    }
143
144
145
  }
}

146
function _form_validate($elements, $form_id = NULL) {
147
  /* Validate the current input */
148
  if (!$elements['#validated'] && ($elements['#input'] || isset($form_id))) {
149
150
151
    // 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.
152
    if ($elements['#required'] && empty($elements['#value']) && $elements['#value'] !== '0') {
153
      form_error($elements, t('%name field is required.', array('%name' => $elements['#title'])));
154
    }
155
156
157
158

    // Add legal choice check if element has #options.
    if (isset($elements['#options']) && isset($elements['#value'])) {
      $message = t('Illegal choice in %title.', array('%title' => theme('placeholder', $elements['#title'])));
159
160
161
162
163
164
      if ($elements['#type'] == 'select') {
        $options = form_options_flatten($elements['#options']);
      }
      else {
        $options = $elements['#options'];
      }
165
166
167
      if (is_array($elements['#value'])) {
        $value = $elements['#type'] == 'checkboxes' ? array_keys(array_filter($elements['#value'])) : $elements['#value'];
        foreach ($value as $v) {
168
          if (!isset($options[$v])) {
169
170
171
172
            form_error($elements, $message);
          }
        }
      }
173
      elseif (!isset($options[$elements['#value']])) {
174
175
176
177
178
        form_error($elements, $message);
      }
    }

    // User-applied checks.
Dries's avatar
Dries committed
179
    if (isset($elements['#validate'])) {
180
181
182
183
184
      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);
185
        }
186
187
        if (function_exists($function))  {
          call_user_func_array($function, $args);
188
189
190
        }
      }
    }
191
    $elements['#validated'] = TRUE;
192
  }
193
194
195
196
197
198
199

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

202
203
204
205
206
/**
 * 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.
 */
207
function form_set_error($name = NULL, $message = '') {
208
209
210
  static $form = array();
  if (isset($name) && !isset($form[$name])) {
    $form[$name] = $message;
211
212
213
    if ($message) {
      drupal_set_message($message, 'error');
    }
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
  }
  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];
  }
}

243
244
245
/**
 * Flag an element as having an error.
 */
246
function form_error(&$element, $message = '') {
247
  $element['#error'] = TRUE;
248
  form_set_error(implode('][', $element['#parents']), $message);
249
250
251
252
253
254
255
}

/**
 * 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.
 */
256
function _form_builder($form_id, $form) {
257
  global $form_values;
Dries's avatar
Dries committed
258
  global $form_submitted;
259
  /* Use element defaults */
260
  if ((!empty($form['#type'])) && ($info = _element_info($form['#type']))) {
261
    // overlay $info onto $form, retaining preexisting keys in $form
262
263
264
    $form += $info;
  }

265
  if (isset($form['#input']) && $form['#input']) {
266
267
268
269
270
271
    if (!isset($form['#name'])) {
      $form['#name'] = 'edit[' . implode('][', $form['#parents']) . ']';
    }
    if (!isset($form['#id'])) {
      $form['#id'] =  'edit-' . implode('-', $form['#parents']);
    }
272

273
    $posted = (isset($_POST['edit']) && ($_POST['edit']['form_id'] == $form_id));
274
275
    $edit = $posted ? $_POST['edit'] : array();
    $ref =& $form_values;
276
    foreach ($form['#parents'] as $parent) {
277
278
279
      $edit = isset($edit[$parent]) ? $edit[$parent] : NULL;
      $ref =& $ref[$parent];
    }
280
    $form['#ref'] = &$ref;
281
    if (!isset($form['#value'])) {
282
283
284
285
286
      if ($posted) {
        if (isset($edit)) {
          $form['#value'] = $edit; // normal element
        }
        elseif (isset($form['#return_value'])) {
287
          $form['#value'] = '0'; // checkbox unchecked
288
289
290
        }
      }
      if (!isset($form['#value'])) {
291
292
293
294
295
296
297
        $function = $form['#type'] . '_value';
        if (function_exists($function)) {
          $function($form);
        }
        else {
          $form['#value'] = $form['#default_value'];
        }
298
      }
299
    }
300
    if (isset($form['#form_submitted']) && isset($_POST[$form['#name']])) {
301
      if ($_POST[$form['#name']] == $form['#value']) {
Dries's avatar
Dries committed
302
        $form_submitted = $form_submitted || $form['#form_submitted'];
303
304
305
306
      }
    }
  }

307
  // Allow for elements to expand to multiple elements, e.g. radios, checkboxes and files.
308
  if (isset($form['#process']) && !$form['#processed']) {
309
310
    foreach ($form['#process'] as $process => $args) {
      if (function_exists($process)) {
311
312
        $args = array_merge(array($form), $args);
        $form = call_user_func_array($process, $args);
313
314
      }
    }
315
    $form['#processed'] = TRUE;
316
317
  }

318
319
320
  // 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.
321
  if (isset($form['#input']) && $form['#input']) {
322
323
324
    $ref = $form['#value'];
  }

325
326
327
  // Recurse through all child elements.
  $count  = 0;
  foreach (element_children($form) as $key) {
Steven Wittens's avatar
Steven Wittens committed
328
    // don't squash an existing tree value
329
330
331
    if (!isset($form[$key]['#tree'])) {
      $form[$key]['#tree'] = $form['#tree'];
    }
Steven Wittens's avatar
Steven Wittens committed
332

333
334
    // don't squash existing parents value
    if (!isset($form[$key]['#parents'])) {
335
336
      // 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);
Steven Wittens's avatar
Steven Wittens committed
337
338
    }

339
    # Assign a decimal placeholder weight to preserve original array order
340
341
342
    if (!isset($form[$key]['#weight'])) {
      $form[$key]['#weight'] = $count/1000;
    }
343
    $form[$key] = _form_builder($form_id, $form[$key]);
344
345
346
    $count++;
  }

347
  if (isset($form['#after_build']) && function_exists($form['#after_build']) && !isset($form['#after_build_done'])) {
348
    $function = $form['#after_build'];
349
    $form = $function($form, $form_values);
350
    $form['#after_build_done'] = TRUE;
Steven Wittens's avatar
Steven Wittens committed
351
  }
352
353
354
355
356

  return $form;
}

/**
357
358
 * Renders a HTML form given a form tree. Recursively iterates over each of
 * the form elements, generating HTML code. This function is usually
359
 * called from within a theme.  To render a form from within a module, use
360
 * drupal_get_form().
361
362
363
364
365
366
367
 *
 * @param $elements
 *   The form tree describing the form.
 * @return
 *   The rendered HTML form.
 */
function form_render(&$elements) {
368
369
  if (!isset($elements)) {
    return NULL;
370
  }
371
372
  $content = '';
  uasort($elements, "_form_sort");
373

374
  if (!isset($elements['#children'])) {
375
    /* render all the children using a theme function */
376
    if (isset($elements['#theme']) && !$elements['#theme_used']) {
377
378
379
380
381
      $elements['#theme_used'] = TRUE;
      $previous_type = $elements['#type'];
      $elements['#type'] = 'markup';
      $content = theme($elements['#theme'], $elements);
      $elements['#type'] = $previous_type;
382
383
384
385
386
387
388
389
390
    }
    /* 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) {
391
    $elements['#children'] = $content;
392
393
394
  }

  /* Call the form element renderer */
395
  if (!isset($elements['#printed'])) {
396
397
    $content = theme(($elements['#type']) ? $elements['#type']: 'markup', $elements);
    $elements['#printed'] = TRUE;
398
399
  }

400
  if ($content) {
401
402
403
    $prefix = isset($elements['#prefix']) ? $elements['#prefix'] : '';
    $suffix = isset($elements['#suffix']) ? $elements['#suffix'] : '';
    return $prefix . $content . $suffix;
404
  }
405
406
407
}

/**
408
 * Function used by uasort in form_render() to sort form by weight.
409
410
 */
function _form_sort($a, $b) {
411
412
413
  $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
414
415
    return 0;
  }
416
  return ($a_weight < $b_weight) ? -1 : 1;
417
418
419
420
421
422
423
}

/**
 * Retrieve the default properties for the defined element type.
 */
function _element_info($type, $refresh = null) {
  static $cache;
Steven Wittens's avatar
Steven Wittens committed
424

425
  $basic_defaults = array(
426
427
428
    '#description' => NULL,
    '#attributes' => array(),
    '#required' => FALSE,
Steven Wittens's avatar
Steven Wittens committed
429
    '#tree' => FALSE,
430
    '#parents' => array()
431
  );
432
  if (!isset($cache) || $refresh) {
433
434
435
    $cache = array();
    foreach (module_implements('elements') as $module) {
      $elements = module_invoke($module, 'elements');
436
      if (isset($elements) && is_array($elements)) {
437
        $cache = array_merge_recursive($cache, $elements);
438
439
440
441
      }
    }
    if (sizeof($cache)) {
      foreach ($cache as $element_type => $info) {
442
        $cache[$element_type] = array_merge_recursive($basic_defaults, $info);
443
444
445
446
447
448
449
      }
    }
  }

  return $cache[$type];
}

450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
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;
}

469
470
471
472
473
/**
 * Format a dropdown menu or scrolling selection box.
 *
 * @param $element
 *   An associative array containing the properties of the element.
474
 *   Properties used: title, value, options, description, extra, multiple, required
475
476
477
478
479
480
481
482
483
 * @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 = '';
484
  $size = $element['#size'] ? ' size="' . $element['#size'] . '"' : '';
485
486
487
488
489
490
491
  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'];
  }
492
  // array_key_exists() accomodates the rare event where $element['#value'] is NULL.
493
494
495
  // isset() fails in this situation.
  $value_valid = isset($element['#value']) || array_key_exists('#value', $element);
  $value_is_array = is_array($element['#value']);
496
497
  $options = '';
  foreach ($choices as $key => $choice) {
498
    if (is_array($choice)) {
499
500
501
      $options .= '<optgroup label="'. $key .'">';
      $options .= form_select_options($element, $choice);
      $options .= '</optgroup>';
502
503
    }
    else {
504
505
      $key = (string)$key;
      if ($value_valid && ($element['#value'] == $key || ($value_is_array && in_array($key, $element['#value'])))) {
506
507
508
509
510
        $selected = ' selected="selected"';
      }
      else {
        $selected = '';
      }
511
      $options .= '<option value="'. $key .'"'. $selected .'>'. check_plain($choice) .'</option>';
512
513
    }
  }
514
  return $options;
515
516
517
518
519
520
521
}

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

530
531
532
    $element['#attributes']['class'] .= ' collapsible';
    if ($element['#collapsed']) {
     $element['#attributes']['class'] .= ' collapsed';
533
534
535
    }
  }

536
  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";
537
538
539
540
541
542
543
544

}

/**
 * Format a radio button.
 *
 * @param $element
 *   An associative array containing the properties of the element.
545
 *   Properties used: required, return_value, value, attributes, title, description
546
547
548
549
550
 * @return
 *   A themed HTML string representing the form item group.
 */
function theme_radio($element) {
  $output = '<input type="radio" ';
551
  $output .= 'class="'. _form_get_class('form-radio', $element['#required'], form_get_error($element)) .'" ';
552
553
554
555
556
557
  $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>';
558
  }
559
  return theme('form_element', NULL, $output, $element['#description'], $element['#name'], $element['#required'], form_get_error($element));
560
561
562
563
564
565
566
}

/**
 * Format a set of radio buttons.
 *
 * @param $element
 *   An associative array containing the properties of the element.
567
 *   Properties used: title, value, options, description, required and attributes.
568
569
570
571
 * @return
 *   A themed HTML string representing the radio button set.
 */
function theme_radios($element) {
572
  if ($element['#title'] || $element['#description']) {
573
    return theme('form_element', $element['#title'], $element['#children'], $element['#description'], $element['#id'], $element['#required'], form_get_error($element));
574
575
  }
  else {
576
    return $element['#children'];
577
578
579
  }
}

580
581
582
583
584
585
586
587
588
589
590
591
592
593
/**
 * 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));
}

/**
594
 * Validate password_confirm element.
595
 */
596
597
598
599
600
601
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;
602
    if ($pass1 != $pass2) {
603
604
605
      form_error($form, t('The specified passwords do not match.'));
      form_error($form['pass1']);
      form_error($form['pass2']);
606
    }
607
608
609
610
    $form['#ref'] = $pass1;
  }
  elseif ($form['#required'] && !empty($_POST['edit'])) {
    form_set_error('pass1', t('Password field is required.'));
611
612
613
614
  }
  return $form;
}

615
/**
616
 * Format a date selection element.
617
618
619
 *
 * @param $element
 *   An associative array containing the properties of the element.
620
 *   Properties used: title, value, options, description, required and attributes.
621
 * @return
622
 *   A themed HTML string representing the date selection boxes.
623
624
 */
function theme_date($element) {
625
  $output = '<div class="container-inline">' . $element['#children'] . '</div>';
626
  return theme('form_element', $element['#title'], $output, $element['#description'], $element['#id'], $element['#required'], form_get_error($element));
627
628
629
}

/**
630
 * Roll out a single date element.
631
632
633
 */
function expand_date($element) {
  // Default to current date
634
635
  if (!isset($element['#value'])) {
    $element['#value'] = array('day' => format_date(time(), 'custom', 'j'),
636
637
638
639
                            'month' => format_date(time(), 'custom', 'n'),
                            'year' => format_date(time(), 'custom', 'Y'));
  }

640
641
  $element['#tree'] = TRUE;

642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
  // 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':
658
        $options = drupal_map_assoc(range(1, 12), 'map_month');
659
660
661
662
663
        break;
      case 'year':
        $options = drupal_map_assoc(range(1900, 2050));
        break;
    }
664
665
666
667
668
669
670
671
    $parents = $element['#parents'];
    $parents[] = $type;
    $element[$type] = array(
      '#type' => 'select',
      '#value' => $element['#value'][$type],
      '#attributes' => $element['#attributes'],
      '#options' => $options,
    );
672
673
674
675
676
  }

  return $element;
}

677
678
679
680
681
682
/**
 * 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);
}
683

684
685
686
687
688
689
690
691
692
693
694
/**
 * 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;
}

695
696
697
698
699
700
701
702
703
704
705
706
/**
 * 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;
  }
}

707
/**
708
709
 * Roll out a single radios element to a list of radios,
 * using the options array as index.
710
711
 */
function expand_radios($element) {
712
713
  if (count($element['#options']) > 0) {
    foreach ($element['#options'] as $key => $choice) {
714
      if (!$element[$key]) {
715
        $element[$key] = array('#type' => 'radio', '#title' => $choice, '#return_value' => $key, '#default_value' => $element['#default_value'], '#attributes' => $element['#attributes'], '#parents' => $element['#parents'], '#spawned' => TRUE);
716
717
718
719
720
721
722
723
724
725
726
      }
    }
  }
  return $element;
}

/**
 * Format a form item.
 *
 * @param $element
 *   An associative array containing the properties of the element.
727
 *   Properties used:  title, value, description, required, error
728
729
730
731
 * @return
 *   A themed HTML string representing the form item.
 */
function theme_item($element) {
732
  return theme('form_element', $element['#title'], $element['#value'] . $element['#children'], $element['#description'], $element['#id'], $element['#required'], $element['#error']);
733
734
735
736
737
738
739
}

/**
 * Format a checkbox.
 *
 * @param $element
 *   An associative array containing the properties of the element.
740
 *   Properties used:  title, value, return_value, description, required
741
742
743
744
745
746
 * @return
 *   A themed HTML string representing the checkbox.
 */
function theme_checkbox($element) {
  $checkbox = '<input ';
  $checkbox .= 'type="checkbox" ';
747
  $checkbox .= 'class="'. _form_get_class('form-checkbox', $element['#required'], form_get_error($element)) . '" ';
748
749
750
  $checkbox .= 'name="'. $element['#name'] .'" ';
  $checkbox .= 'id="'. $element['#id'].'" ' ;
  $checkbox .= 'value="'. $element['#return_value'] .'" ';
751
  $checkbox .= ($element['#return_value'] == $element['#value']) ? ' checked="checked" ' : ' ';
752
753
754
755
  $checkbox .= drupal_attributes($element['#attributes']) . ' />';

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

758
  return theme('form_element', NULL, $checkbox, $element['#description'], $element['#name'], $element['#required'], form_get_error($element));
759
760
761
762
763
764
765
766
767
768
769
}

/**
 * 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) {
770
  if ($element['#title'] || $element['#description']) {
771
    return theme('form_element', $element['#title'], $element['#children'], $element['#description'], 'edit-'. $element['#name'], $element['#required'], form_get_error($element));
772
773
  }
  else {
774
    return $element['#children'];
775
776
777
778
  }
}

function expand_checkboxes($element) {
779
  $value = is_array($element['#value']) ? $element['#value'] : array();
Steven Wittens's avatar
Steven Wittens committed
780
  $element['#tree'] = TRUE;
781
782
783
  if (count($element['#options']) > 0) {
    if (!isset($element['#default_value']) || $element['#default_value'] == 0) {
      $element['#default_value'] = array();
784
    }
785
    foreach ($element['#options'] as $key => $choice) {
786
      if (!isset($element[$key])) {
787
        $element[$key] = array('#type' => 'checkbox', '#processed' => TRUE, '#title' => $choice, '#return_value' => $key, '#default_value' => isset($value[$key]), '#attributes' => $element['#attributes']);
788
789
790
791
792
793
794
795
796
797
798
      }
    }
  }
  return $element;
}

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

function theme_button($element) {
799
  return '<input type="submit" class="form-'. $element['#button_type'] .'" name="'. $element['#name'] .'" value="'. check_plain($element['#value']) .'" '. drupal_attributes($element['#attributes']) ." />\n";
800
801
802
803
804
805
806
}

/**
 * Format a hidden form field.
 *
 * @param $element
 *   An associative array containing the properties of the element.
807
 *   Properties used:  value, edit
808
809
810
811
 * @return
 *   A themed HTML string representing the hidden form field.
 */
function theme_hidden($element) {
812
  return '<input type="hidden" name="'. $element['#name'] . '" value="'. check_plain($element['#value']) ."\" " . drupal_attributes($element['#attributes']) ." />\n";
813
814
815
816
817
818
819
}

/**
 * Format a textfield.
 *
 * @param $element
 *   An associative array containing the properties of the element.
820
 *   Properties used:  title, value, description, size, maxlength, required, attributes autocomplete_path
821
822
823
824
 * @return
 *   A themed HTML string representing the textfield.
 */
function theme_textfield($element) {
825
  $size = $element['#size'] ? ' size="' . $element['#size'] . '"' : '';
826
827
  $class = '';
  $extra = '';
828
  if ($element['#autocomplete_path']) {
829
830
    drupal_add_js('misc/autocomplete.js');
    $class = ' form-autocomplete';
831
    $extra =  '<input class="autocomplete" type="hidden" id="'. $element['#id'] .'-autocomplete" value="'. check_url(url($element['#autocomplete_path'], NULL, NULL, TRUE)) .'" disabled="disabled" />';
832
833
  }

834
835
  $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;
836
837
838
839
840
841
842
}

/**
 * Format a form.
 *
 * @param $element
 *   An associative array containing the properties of the element.
843
 *   Properties used: action, method, attributes, children
844
845
846
847
848
 * @return
 *   A themed HTML string representing the form.
 */
function theme_form($element) {
  // Anonymous div to satisfy XHTML compliancy.
849
850
  $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";
851
852
853
854
855
856
857
}

/**
 * Format a textarea.
 *
 * @param $element
 *   An associative array containing the properties of the element.
858
 *   Properties used: title, value, description, rows, cols, required, attributes
859
860
861
862
 * @return
 *   A themed HTML string representing the textarea.
 */
function theme_textarea($element) {
863
864
865
866
867
868
  $class = 'textarea';
  if ($element['#resizable'] !== false) {
    drupal_add_js('misc/textarea.js');
    $class .= ' resizable';
  }

869
  $cols = $element['#cols'] ? ' cols="'. $element['#cols'] .'"' : '';
870

871
  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));
872
873
874
875
876
877
878
879
880
}

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

function theme_markup($element) {
887
  return $element['#value'] . $element['#children'];
888
889
890
891
892
893
894
}

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

902
  $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']) .' />';
903

904
  return theme('form_element', $element['#title'], $output, $element['#description'], $element['#id'], $element['#required'], form_get_error($element));
905
906
907
908
909
910
911
}

/**
 * Format a weight selection menu.
 *
 * @param $element
 *   An associative array containing the properties of the element.
912
 *   Properties used:  title, delta, description
913
914
915
916
 * @return
 *   A themed HTML string representing the form.
 */
function theme_weight($element) {
917
  for ($n = (-1 * $element['#delta']); $n <= $element['#delta']; $n++) {
918
919
    $weights[$n] = $n;
  }
920
921
  $element['#options'] = $weights;
  $element['#type'] = 'select';
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945

  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) {
946
  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));
947
}
948

949
function _form_get_class($name, $required, $error) {
950
  return $name. ($required ? ' required' : '') . (isset($error) ? ' error' : '');
951
952
953
}

/**
954
 * Remove invalid characters from an HTML ID attribute string.
955
956
957
958
959
960
961
962
963
964
965
966
967
968
 *
 * @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".
 */