form.inc 35.5 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
 *
 * @param $form_id
52
53
54
 *   A unique string identifying the form. Allows each form to be
 *   themed.  Pass NULL to suppress the form_id parameter (produces
 *   a shorter URL with method=get)
55
56
57
58
59
60
61
 * @param $form
 *   An associative array containing the structure of the form.
 * @param $callback
 *   An optional callback that will be used in addition to the form_id.
 *
 */
function drupal_get_form($form_id, &$form, $callback = NULL) {
62
  global $form_values, $form_submitted, $user;
63
  $form_values = array();
Dries's avatar
Dries committed
64
  $form_submitted = FALSE;
Steven Wittens's avatar
Steven Wittens committed
65

66
67
  $form['#type'] = 'form';
  if (isset($form['#token'])) {
68
69
    if (variable_get('cache', 0) && !$user->uid && $_SERVER['REQUEST_METHOD'] == 'GET') {
      unset($form['#token']);
70
    }
71
72
73
74
75
    else {
      // Make sure that a private key is set:
      if (!variable_get('drupal_private_key', '')) {
        variable_set('drupal_private_key', mt_rand());
      }
76

77
78
      $form['form_token'] = array('#type' => 'hidden', '#default_value' => md5(session_id() . $form['#token'] . variable_get('drupal_private_key', '')));
    }
79
  }
80
81
82
  if (isset($form_id)) {
    $form['form_id'] = array('#type' => 'hidden', '#value' => $form_id);
  }
83
84
85
  if (!isset($form['#id'])) {
    $form['#id'] = $form_id;
  }
Steven Wittens's avatar
Steven Wittens committed
86

87
  $form += _element_info('form');
88

Dries's avatar
Dries committed
89
90
  if (!isset($form['#validate'])) {
    if (function_exists($form_id .'_validate')) {
91
      $form['#validate'] = array($form_id .'_validate' => array());
Dries's avatar
Dries committed
92
93
    }
    elseif (function_exists($callback .'_validate')) {
94
      $form['#validate'] = array($callback .'_validate' => array());
Dries's avatar
Dries committed
95
96
97
    }
  }

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

109
110
  foreach (module_implements('form_alter') as $module) {
    $function = $module .'_form_alter';
111
    $function($form_id, $form);
112
113
  }

114
  $form = form_builder($form_id, $form);
115
  if (!empty($_POST['edit']) && (($_POST['edit']['form_id'] == $form_id) || ($_POST['edit']['form_id'] == $callback))) {
116
    drupal_validate_form($form_id, $form, $callback);
Dries's avatar
Dries committed
117
    if ($form_submitted && !form_get_errors()) {
118
      $redirect = drupal_submit_form($form_id, $form, $callback);
119
      if (isset($redirect)) {
120
121
        $goto = $redirect;
      }
122
      if (isset($form['#redirect'])) {
123
124
        $goto = $form['#redirect'];
      }
125
126
      if ($goto !== FALSE) {
        if (is_array($goto)) {
127
          call_user_func_array('drupal_goto', $goto);
128
        }
129
130
131
        elseif (!isset($goto)) {
          drupal_goto($_GET['q']);
        }
132
133
134
        else {
          drupal_goto($goto);
        }
135
      }
136
    }
137
138
  }

139
  if (theme_get_function($form_id)) {
140
    $form['#theme'] = $form_id;
141
  }
142
  elseif (theme_get_function($callback)) {
143
    $form['#theme'] = $callback;
144
  }
145
146
147
148
149
150
151
152
153

  if (isset($form['#pre_render'])) {
    foreach ($form['#pre_render'] as $function) {
      if (function_exists($function)) {
        $function($form_id, $form);
      }
    }
  }

154
155
156
157
158
159
  return form_render($form);
}

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

160
  if (isset($form['#token'])) {
161
    if ($form_values['form_token'] != md5(session_id() . $form['#token'] . variable_get('drupal_private_key', ''))) {
162
163
164
165
166
      // 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.'));
    }
  }

167
  _form_validate($form, $form_id);
168
169
}

170
function drupal_submit_form($form_id, $form, $callback = NULL) {
171
172
  global $form_values;
  $default_args = array($form_id, &$form_values);
173
174
  // Prevent system module forms (system/theme settings) from saving certain form fields to the variables table.
  unset($GLOBALS['form_values']['submit'], $GLOBALS['form_values']['reset'], $GLOBALS['form_values']['form_id']);
175

176
  if (isset($form['#submit'])) {
177
178
    foreach ($form['#submit'] as $function => $args) {
      if (function_exists($function)) {
179
        $args = array_merge($default_args, (array) $args);
180
181
        // Since we can only redirect to one page, only the last redirect will work
        $redirect = call_user_func_array($function, $args);
182
183
184
        if (isset($redirect)) {
          $goto = $redirect;
        }
Dries's avatar
Dries committed
185
186
      }
    }
187
  }
188
  return $goto;
189
190
}

191
function _form_validate($elements, $form_id = NULL) {
192
  /* Validate the current input */
193
  if (!$elements['#validated']) {
194
    if (isset($elements['#needs_validation'])) {
195
196
197
198
199
      // 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.
      if ($elements['#required'] && empty($elements['#value']) && $elements['#value'] !== '0') {
        form_error($elements, t('%name field is required.', array('%name' => $elements['#title'])));
200
      }
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216

      // 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'])) {
        if ($elements['#type'] == 'select') {
          $options = form_options_flatten($elements['#options']);
        }
        else {
          $options = $elements['#options'];
        }
        if (is_array($elements['#value'])) {
          $value = $elements['#type'] == 'checkboxes' ? array_keys(array_filter($elements['#value'])) : $elements['#value'];
          foreach ($value as $v) {
            if (!isset($options[$v])) {
              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));
            }
217
218
          }
        }
219
220
221
222
        elseif (!isset($options[$elements['#value']])) {
          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));
        }
223
224
225
226
      }
    }

    // User-applied checks.
Dries's avatar
Dries committed
227
    if (isset($elements['#validate'])) {
228
229
230
231
232
      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);
233
        }
234
235
        if (function_exists($function))  {
          call_user_func_array($function, $args);
236
237
238
        }
      }
    }
239
    $elements['#validated'] = TRUE;
240
  }
241
242
243
244
245
246
247

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

250
251
252
253
254
/**
 * 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.
 */
255
function form_set_error($name = NULL, $message = '') {
256
257
258
  static $form = array();
  if (isset($name) && !isset($form[$name])) {
    $form[$name] = $message;
259
260
261
    if ($message) {
      drupal_set_message($message, 'error');
    }
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
  }
  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];
  }
}

291
292
293
/**
 * Flag an element as having an error.
 */
294
function form_error(&$element, $message = '') {
295
  $element['#error'] = TRUE;
296
  form_set_error(implode('][', $element['#parents']), $message);
297
298
299
}

/**
300
301
302
303
304
305
306
307
308
 * 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.
309
 */
310
function form_builder($form_id, $form) {
311
  global $form_values;
Dries's avatar
Dries committed
312
  global $form_submitted;
313

314
  /* Use element defaults */
315
  if ((!empty($form['#type'])) && ($info = _element_info($form['#type']))) {
316
    // overlay $info onto $form, retaining preexisting keys in $form
317
318
319
    $form += $info;
  }

320
  if (isset($form['#input']) && $form['#input']) {
321
322
323
324
325
326
    if (!isset($form['#name'])) {
      $form['#name'] = 'edit[' . implode('][', $form['#parents']) . ']';
    }
    if (!isset($form['#id'])) {
      $form['#id'] =  'edit-' . implode('-', $form['#parents']);
    }
327

328
    $posted = (isset($_POST['edit']) && ($_POST['edit']['form_id'] == $form_id));
329
330
    $edit = $posted ? $_POST['edit'] : array();
    $ref =& $form_values;
331
    foreach ($form['#parents'] as $parent) {
332
333
334
      $edit = isset($edit[$parent]) ? $edit[$parent] : NULL;
      $ref =& $ref[$parent];
    }
335
    $form['#ref'] = &$ref;
336
    if (!isset($form['#value']) && !array_key_exists('#value', $form)) {
337
      if ($posted) {
338
339
        switch ($form['#type']) {
          case 'checkbox':
340
            $form['#value'] = !empty($edit) ? $form['#return_value'] : 0;
341
342
            break;
          case 'select':
343
344
345
346
347
348
            if (isset($edit)) {
              $form['#value'] = $edit;
            }
            elseif (isset($form['#multiple']) && $form['#multiple']) {
              $form['#value'] = array();
            }
349
350
351
            break;
          case 'textfield':
            if (isset($edit)) {
352
353
354
              // Equate $edit to the form value to ensure it's marked for validation
              $edit = str_replace(array("\r", "\n"), '', $edit);
              $form['#value'] = $edit;
355
356
357
358
359
360
            }
            break;
          default:
            if (isset($edit)) {
              $form['#value'] = $edit;
            }
361
        }
362
363
        // Mark all posted values for validation
        if (isset($form['#value']) && $form['#value'] === $edit) {
364
          $form['#needs_validation'] = TRUE;
365
366
367
        }
      }
      if (!isset($form['#value'])) {
368
369
370
371
372
373
374
        $function = $form['#type'] . '_value';
        if (function_exists($function)) {
          $function($form);
        }
        else {
          $form['#value'] = $form['#default_value'];
        }
375
      }
376
    }
377
    if (isset($form['#form_submitted']) && isset($_POST[$form['#name']])) {
378
      if ($_POST[$form['#name']] == $form['#value']) {
Dries's avatar
Dries committed
379
        $form_submitted = $form_submitted || $form['#form_submitted'];
380
381
382
383
      }
    }
  }

384
  // Allow for elements to expand to multiple elements, e.g. radios, checkboxes and files.
385
  if (isset($form['#process']) && !$form['#processed']) {
386
387
    foreach ($form['#process'] as $process => $args) {
      if (function_exists($process)) {
388
389
        $args = array_merge(array($form), $args);
        $form = call_user_func_array($process, $args);
390
391
      }
    }
392
    $form['#processed'] = TRUE;
393
394
  }

395
396
397
  // 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.
398
  if (isset($form['#input']) && $form['#input']) {
399
400
401
    $ref = $form['#value'];
  }

402
403
404
  // Recurse through all child elements.
  $count  = 0;
  foreach (element_children($form) as $key) {
Steven Wittens's avatar
Steven Wittens committed
405
    // don't squash an existing tree value
406
407
408
    if (!isset($form[$key]['#tree'])) {
      $form[$key]['#tree'] = $form['#tree'];
    }
Steven Wittens's avatar
Steven Wittens committed
409

410
411
    // don't squash existing parents value
    if (!isset($form[$key]['#parents'])) {
412
413
      // 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
414
415
    }

416
    # Assign a decimal placeholder weight to preserve original array order
417
418
419
    if (!isset($form[$key]['#weight'])) {
      $form[$key]['#weight'] = $count/1000;
    }
420
    $form[$key] = form_builder($form_id, $form[$key]);
421
422
423
    $count++;
  }

424
  if (isset($form['#after_build']) && function_exists($form['#after_build']) && !isset($form['#after_build_done'])) {
425
    $function = $form['#after_build'];
426
    $form = $function($form, $form_values);
427
    $form['#after_build_done'] = TRUE;
Steven Wittens's avatar
Steven Wittens committed
428
  }
429
430

  return $form;
431
432
433
}

/**
434
435
 * Renders a HTML form given a form tree. Recursively iterates over each of
 * the form elements, generating HTML code. This function is usually
436
 * called from within a theme.  To render a form from within a module, use
437
 * drupal_get_form().
438
439
440
441
442
443
444
 *
 * @param $elements
 *   The form tree describing the form.
 * @return
 *   The rendered HTML form.
 */
function form_render(&$elements) {
445
446
  if (!isset($elements)) {
    return NULL;
447
  }
448
449
  $content = '';
  uasort($elements, "_form_sort");
450

451
  if (!isset($elements['#children'])) {
452
    /* render all the children using a theme function */
453
    if (isset($elements['#theme']) && !$elements['#theme_used']) {
454
455
456
457
458
      $elements['#theme_used'] = TRUE;
      $previous_type = $elements['#type'];
      $elements['#type'] = 'markup';
      $content = theme($elements['#theme'], $elements);
      $elements['#type'] = $previous_type;
459
460
461
462
463
464
465
466
467
    }
    /* 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) {
468
    $elements['#children'] = $content;
469
470
471
  }

  /* Call the form element renderer */
472
  if (!isset($elements['#printed'])) {
473
474
    $content = theme(($elements['#type']) ? $elements['#type']: 'markup', $elements);
    $elements['#printed'] = TRUE;
475
476
  }

477
  if ($content) {
478
479
480
    $prefix = isset($elements['#prefix']) ? $elements['#prefix'] : '';
    $suffix = isset($elements['#suffix']) ? $elements['#suffix'] : '';
    return $prefix . $content . $suffix;
481
  }
482
483
484
}

/**
485
 * Function used by uasort in form_render() to sort form by weight.
486
487
 */
function _form_sort($a, $b) {
488
489
490
  $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
491
492
    return 0;
  }
493
  return ($a_weight < $b_weight) ? -1 : 1;
494
495
496
497
498
499
500
}

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

502
  $basic_defaults = array(
503
504
505
    '#description' => NULL,
    '#attributes' => array(),
    '#required' => FALSE,
Steven Wittens's avatar
Steven Wittens committed
506
    '#tree' => FALSE,
507
    '#parents' => array()
508
  );
509
  if (!isset($cache) || $refresh) {
510
511
512
    $cache = array();
    foreach (module_implements('elements') as $module) {
      $elements = module_invoke($module, 'elements');
513
      if (isset($elements) && is_array($elements)) {
514
        $cache = array_merge_recursive($cache, $elements);
515
516
517
518
      }
    }
    if (sizeof($cache)) {
      foreach ($cache as $element_type => $info) {
519
        $cache[$element_type] = array_merge_recursive($basic_defaults, $info);
520
521
522
523
524
525
526
      }
    }
  }

  return $cache[$type];
}

527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
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;
}

546
547
548
549
550
/**
 * Format a dropdown menu or scrolling selection box.
 *
 * @param $element
 *   An associative array containing the properties of the element.
551
 *   Properties used: title, value, options, description, extra, multiple, required
552
553
554
555
556
557
558
559
560
 * @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 = '';
561
  $size = $element['#size'] ? ' size="' . $element['#size'] . '"' : '';
562
563
  _form_set_class($element);
  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));
564
565
566
567
568
569
}

function form_select_options($element, $choices = NULL) {
  if (!isset($choices)) {
    $choices = $element['#options'];
  }
570
  // array_key_exists() accomodates the rare event where $element['#value'] is NULL.
571
572
573
  // isset() fails in this situation.
  $value_valid = isset($element['#value']) || array_key_exists('#value', $element);
  $value_is_array = is_array($element['#value']);
574
575
  $options = '';
  foreach ($choices as $key => $choice) {
576
    if (is_array($choice)) {
577
578
579
      $options .= '<optgroup label="'. $key .'">';
      $options .= form_select_options($element, $choice);
      $options .= '</optgroup>';
580
581
    }
    else {
582
583
      $key = (string)$key;
      if ($value_valid && ($element['#value'] == $key || ($value_is_array && in_array($key, $element['#value'])))) {
584
585
586
587
588
        $selected = ' selected="selected"';
      }
      else {
        $selected = '';
      }
589
      $options .= '<option value="'. $key .'"'. $selected .'>'. check_plain($choice) .'</option>';
590
591
    }
  }
592
  return $options;
593
594
595
596
597
598
599
}

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

608
609
610
    $element['#attributes']['class'] .= ' collapsible';
    if ($element['#collapsed']) {
     $element['#attributes']['class'] .= ' collapsed';
611
612
613
    }
  }

614
  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";
615
616
617
618
619
620
621
622

}

/**
 * Format a radio button.
 *
 * @param $element
 *   An associative array containing the properties of the element.
623
 *   Properties used: required, return_value, value, attributes, title, description
624
625
626
627
 * @return
 *   A themed HTML string representing the form item group.
 */
function theme_radio($element) {
628
  _form_set_class($element, array('form-radio'));
629
  $output = '<input type="radio" ';
630
631
632
633
634
635
  $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>';
636
  }
637
  return theme('form_element', NULL, $output, $element['#description'], $element['#id'], $element['#required'], form_get_error($element));
638
639
640
641
642
643
644
}

/**
 * Format a set of radio buttons.
 *
 * @param $element
 *   An associative array containing the properties of the element.
645
 *   Properties used: title, value, options, description, required and attributes.
646
647
648
649
 * @return
 *   A themed HTML string representing the radio button set.
 */
function theme_radios($element) {
650
  if ($element['#title'] || $element['#description']) {
651
    return theme('form_element', $element['#title'], $element['#children'], $element['#description'], $element['#id'], $element['#required'], form_get_error($element));
652
653
  }
  else {
654
    return $element['#children'];
655
656
657
  }
}

658
659
660
661
662
663
664
665
666
667
668
669
670
671
/**
 * 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));
}

/**
672
 * Validate password_confirm element.
673
 */
674
675
676
677
678
679
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;
680
    if ($pass1 != $pass2) {
681
682
683
      form_error($form, t('The specified passwords do not match.'));
      form_error($form['pass1']);
      form_error($form['pass2']);
684
    }
685
686
687
688
    $form['#ref'] = $pass1;
  }
  elseif ($form['#required'] && !empty($_POST['edit'])) {
    form_set_error('pass1', t('Password field is required.'));
689
690
691
692
  }
  return $form;
}

693
/**
694
 * Format a date selection element.
695
696
697
 *
 * @param $element
 *   An associative array containing the properties of the element.
698
 *   Properties used: title, value, options, description, required and attributes.
699
 * @return
700
 *   A themed HTML string representing the date selection boxes.
701
702
 */
function theme_date($element) {
703
  $output = '<div class="container-inline">' . $element['#children'] . '</div>';
704
  return theme('form_element', $element['#title'], $output, $element['#description'], $element['#id'], $element['#required'], form_get_error($element));
705
706
707
}

/**
708
 * Roll out a single date element.
709
710
711
 */
function expand_date($element) {
  // Default to current date
712
713
  if (!isset($element['#value'])) {
    $element['#value'] = array('day' => format_date(time(), 'custom', 'j'),
714
715
716
717
                            'month' => format_date(time(), 'custom', 'n'),
                            'year' => format_date(time(), 'custom', 'Y'));
  }

718
719
  $element['#tree'] = TRUE;

720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
  // 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':
736
        $options = drupal_map_assoc(range(1, 12), 'map_month');
737
738
739
740
741
        break;
      case 'year':
        $options = drupal_map_assoc(range(1900, 2050));
        break;
    }
742
743
744
745
746
747
748
749
    $parents = $element['#parents'];
    $parents[] = $type;
    $element[$type] = array(
      '#type' => 'select',
      '#value' => $element['#value'][$type],
      '#attributes' => $element['#attributes'],
      '#options' => $options,
    );
750
751
752
753
754
  }

  return $element;
}

755
756
757
758
759
760
/**
 * 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);
}
761

762
763
764
765
766
767
768
769
770
771
772
/**
 * 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;
}

773
774
775
776
777
778
779
780
781
782
783
784
/**
 * 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;
  }
}

785
/**
786
787
 * Roll out a single radios element to a list of radios,
 * using the options array as index.
788
789
 */
function expand_radios($element) {
790
791
  if (count($element['#options']) > 0) {
    foreach ($element['#options'] as $key => $choice) {
792
      if (!$element[$key]) {
793
        $element[$key] = array('#type' => 'radio', '#title' => $choice, '#return_value' => $key, '#default_value' => $element['#default_value'], '#attributes' => $element['#attributes'], '#parents' => $element['#parents'], '#spawned' => TRUE);
794
795
796
797
798
799
800
801
802
803
804
      }
    }
  }
  return $element;
}

/**
 * Format a form item.
 *
 * @param $element
 *   An associative array containing the properties of the element.
805
 *   Properties used:  title, value, description, required, error
806
807
808
809
 * @return
 *   A themed HTML string representing the form item.
 */
function theme_item($element) {
810
  return theme('form_element', $element['#title'], $element['#value'] . $element['#children'], $element['#description'], $element['#id'], $element['#required'], $element['#error']);
811
812
813
814
815
816
817
}

/**
 * Format a checkbox.
 *
 * @param $element
 *   An associative array containing the properties of the element.
818
 *   Properties used:  title, value, return_value, description, required
819
820
821
822
 * @return
 *   A themed HTML string representing the checkbox.
 */
function theme_checkbox($element) {
823
  _form_set_class($element, array('form-checkbox'));
824
825
  $checkbox = '<input ';
  $checkbox .= 'type="checkbox" ';
826
827
828
  $checkbox .= 'name="'. $element['#name'] .'" ';
  $checkbox .= 'id="'. $element['#id'].'" ' ;
  $checkbox .= 'value="'. $element['#return_value'] .'" ';
829
  $checkbox .= ($element['#return_value'] == $element['#value']) ? ' checked="checked" ' : ' ';
830
831
832
833
  $checkbox .= drupal_attributes($element['#attributes']) . ' />';

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

836
  return theme('form_element', NULL, $checkbox, $element['#description'], $element['#id'], $element['#required'], form_get_error($element));
837
838
839
840
841
842
843
844
845
846
847
}

/**
 * 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) {
848
  if ($element['#title'] || $element['#description']) {
849
    return theme('form_element', $element['#title'], $element['#children'], $element['#description'], $element['#id'], $element['#required'], form_get_error($element));
850
851
  }
  else {
852
    return $element['#children'];
853
854
855
856
  }
}

function expand_checkboxes($element) {
857
  $value = is_array($element['#value']) ? $element['#value'] : array();
Steven Wittens's avatar
Steven Wittens committed
858
  $element['#tree'] = TRUE;
859
860
861
  if (count($element['#options']) > 0) {
    if (!isset($element['#default_value']) || $element['#default_value'] == 0) {
      $element['#default_value'] = array();
862
    }
863
    foreach ($element['#options'] as $key => $choice) {
864
      if (!isset($element[$key])) {
865
        $element[$key] = array('#type' => 'checkbox', '#processed' => TRUE, '#title' => $choice, '#return_value' => $key, '#default_value' => isset($value[$key]), '#attributes' => $element['#attributes']);
866
867
868
869
870
871
872
873
874
875
876
      }
    }
  }
  return $element;
}

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

function theme_button($element) {
877
878
879
880
881
882
883
  //Make sure not to overwrite classes
  if (isset($element['#attributes']['class'])) {
    $element['#attributes']['class'] = 'form-'. $element['#button_type'] .' '. $element['#attributes']['class'];
  }
  else {
    $element['#attributes']['class'] = 'form-'. $element['#button_type'];
  }
884

885
  return '<input type="submit" '. (empty($element['#name']) ? '' : 'name="'. $element['#name'] .'" ') .'value="'. check_plain($element['#value']) .'" '. drupal_attributes($element['#attributes']) ." />\n";
886
887
888
889
890
891
892
}

/**
 * Format a hidden form field.
 *
 * @param $element
 *   An associative array containing the properties of the element.
893
 *   Properties used:  value, edit
894
895
896
897
 * @return
 *   A themed HTML string representing the hidden form field.
 */
function theme_hidden($element) {
898
  return '<input type="hidden" name="'. $element['#name'] . '" value="'. check_plain($element['#value']) ."\" " . drupal_attributes($element['#attributes']) ." />\n";
899
900
901
902
903
904
905
}

/**
 * Format a textfield.
 *
 * @param $element
 *   An associative array containing the properties of the element.
906
 *   Properties used:  title, value, description, size, maxlength, required, attributes autocomplete_path
907
908
909
910
 * @return
 *   A themed HTML string representing the textfield.
 */
function theme_textfield($element) {
911
  $size = $element['#size'] ? ' size="' . $element['#size'] . '"' : '';
912
  $class = array('form-text');
913
  $extra = '';
914
  if ($element['#autocomplete_path']) {
915
    drupal_add_js('misc/autocomplete.js');
916
    $class[] = 'form-autocomplete';
917
    $extra =  '<input class="autocomplete" type="hidden" id="'. $element['#id'] .'-autocomplete" value="'. check_url(url($element['#autocomplete_path'], NULL, NULL, TRUE)) .'" disabled="disabled" />';
918
  }
919
920
  _form_set_class($element, $class);
  $output = '<input type="text" maxlength="'. $element['#maxlength'] .'" name="'. $element['#name'] .'" id="'. $element['#id'] .'" '. $size .' value="'. check_plain($element['#value']) .'"'. drupal_attributes($element['#attributes']) .' />';
921
  return theme('form_element', $element['#title'], $output, $element['#description'], $element['#id'], $element['#required'], form_get_error($element)). $extra;
922
923
924
925
926
927
928
}

/**
 * Format a form.
 *
 * @param $element
 *   An associative array containing the properties of the element.
929
 *   Properties used: action, method, attributes, children
930
931
932
933
934
 * @return
 *   A themed HTML string representing the form.
 */
function theme_form($element) {
  // Anonymous div to satisfy XHTML compliancy.
935
  $action = $element['#action'] ? 'action="' . check_url($element['#action']) . '" ' : '';
936
  return '<form '. $action . ' method="'. $element['#method'] .'" '. 'id="'. $element['#id'] .'"'.  drupal_attributes($element['#attributes']) .">\n<div>". $element['#children'] ."\n</div></form>\n";
937
938
939
940
941
942
943
}

/**
 * Format a textarea.
 *
 * @param $element
 *   An associative array containing the properties of the element.
944
 *   Properties used: title, value, description, rows, cols, required, attributes
945
946
947
948
 * @return
 *   A themed HTML string representing the textarea.
 */
function theme_textarea($element) {
949
  $class = array('textarea');
950
951
  if ($element['#resizable'] !== false) {
    drupal_add_js('misc/textarea.js');
952
    $class[] = 'resizable';
953
954
  }

955
  $cols = $element['#cols'] ? ' cols="'. $element['#cols'] .'"' : '';
956
957
  _form_set_class($element, $class);
  return theme('form_element', $element['#title'], '<textarea'. $cols .' rows="'. $element['#rows'] .'" name="'. $element['#name'] .'" id="' . $element['#id'] .'" '. drupal_attributes($element['#attributes']) .'>'. check_plain($element['#value']) .'</textarea>', $element['#description'], $element['#id'], $element['#required'], form_get_error($element));
958
959
960
961
962
963
964
965
966
}

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

function theme_markup($element) {
973
  return $element['#value'] . $element['#children'];
974
975
976
977
978
979
980
}

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

988
989
  _form_set_class($element, array('form-text'));
  $output = '<input type="password" maxlength="'. $element['#maxlength'] .'" name="'. $element['#name'] .'" id="'. $element['#id'] .'" '. $size . drupal_attributes($element['#attributes']) .' />';
990

991
  return theme('form_element', $element['#title'], $output, $element['#description'], $element['#id'], $element['#required'], form_get_error($element));
992
993
994
995
996
997
998
}

/**
 * Format a weight selection menu.
 *
 * @param $element
 *   An associative array containing the properties of the element.
999
 *   Properties used:  title, delta, description
1000
1001
1002
1003
 * @return
 *   A themed HTML string representing the form.
 */
function theme_weight($element) {
1004
  for ($n = (-1 * $element['#delta']); $n <= $element['#delta']; $n++) {
1005
1006
    $weights[$n] = $n;
  }
1007
1008
  $element['#options'] = $weights;
  $element['#type'] = 'select';
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032

  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) {
1033
1034
  _form_set_class($element, array('form-file'));
  return theme('form_element', $element['#title'], '<input type="file" 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));
1035
}
1036

1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
/**
 * Sets a form element's class attribute.
 *
 * Adds 'required' and 'error' classes as needed.
 *
 * @param &$element
 *   The form element
 * @param $name
 *   Array of new class names to be added
 */
function _form_set_class(&$element, $class = array()) {
  if ($element['#required']) {
    $class[] = 'required';
  }
  if (form_get_error($element)){
    $class[] = 'error';
  }
  if (isset($element['#attributes']['class'])) {
    $class[] = $element['#attributes']['class'];
  }
  $element['#attributes']['class'] = implode(' ', $class);
1058
1059
1060
}

/**
1061
 * Remove invalid characters from an HTML ID attribute string.
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
 *
 * @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".
 */