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

4 5 6
/**
 * @defgroup form Form generation
 * @{
7
 * Functions to enable the processing and display of HTML forms.
8
 *
9 10 11 12 13 14 15
 * Drupal uses these functions to achieve consistency in its form processing and
 * presentation, while simplifying code and reducing the amount of HTML that
 * must be explicitly generated by modules.
 *
 * The drupal_get_form() function handles retrieving, processing, and
 * displaying a rendered HTML form for modules automatically. For example:
 *
16
 * @code
17
 * // Display the user registration form.
18
 * $output = drupal_get_form('user_register');
19
 * @endcode
20 21
 *
 * Forms can also be built and submitted programmatically without any user input
22
 * using the drupal_execute() function.
23 24
 *
 * For information on the format of the structured arrays used to define forms,
25
 * and more detailed explanations of the Form API workflow, see the
26 27
 * @link http://api.drupal.org/api/file/developer/topics/forms_api_reference.html reference @endlink
 * and the @link http://api.drupal.org/api/file/developer/topics/forms_api.html quickstart guide. @endlink
28 29 30
 */

/**
31 32 33
 * Retrieves a form from a constructor function, or from the cache if
 * the form was built in a previous page-load. The form is then passesed
 * on for processing, after and rendered for display if necessary.
34 35
 *
 * @param $form_id
36 37 38 39
 *   The unique string identifying the desired form. If a function
 *   with that name exists, it is called to build the form array.
 *   Modules that need to generate the same form (or very similar forms)
 *   using different $form_ids can implement hook_forms(), which maps
40
 *   different $form_id values to the proper form constructor function. Examples
41 42
 *   may be found in node_forms(), search_forms(), and user_forms().
 * @param ...
43 44 45 46
 *   Any additional arguments are passed on to the functions called by
 *   drupal_get_form(), including the unique form constructor function.
 *   For example, the node_edit form requires that a node object be passed
 *   in here when it is called.
47 48 49 50
 * @return
 *   The rendered form.
 */
function drupal_get_form($form_id) {
51 52 53
  $form_state = array('storage' => NULL, 'submitted' => FALSE);

  $args = func_get_args();
54
  $cacheable = FALSE;
55 56 57 58 59 60 61

  if (isset($_SESSION['batch_form_state'])) {
    // We've been redirected here after a batch processing : the form has
    // already been processed, so we grab the post-process $form_state value
    // and move on to form display. See _batch_finished() function.
    $form_state = $_SESSION['batch_form_state'];
    unset($_SESSION['batch_form_state']);
62 63
  }
  else {
64 65 66 67 68 69
    // If the incoming $_POST contains a form_build_id, we'll check the
    // cache for a copy of the form in question. If it's there, we don't
    // have to rebuild the form to proceed. In addition, if there is stored
    // form_state data from a previous step, we'll retrieve it so it can
    // be passed on to the form processing code.
    if (isset($_POST['form_id']) && $_POST['form_id'] == $form_id && !empty($_POST['form_build_id'])) {
70
      $form = form_get_cache($_POST['form_build_id'], $form_state);
71 72
    }

73 74 75 76
    // If the previous bit of code didn't result in a populated $form
    // object, we're hitting the form for the first time and we need
    // to build it from scratch.
    if (!isset($form)) {
77
      $form_state['post'] = $_POST;
78 79
      // Use a copy of the function's arguments for manipulation
      $args_temp = $args;
80
      $args_temp[0] = &$form_state;
81
      array_unshift($args_temp, $form_id);
82

83
      $form = call_user_func_array('drupal_retrieve_form', $args_temp);
84
      $form_build_id = 'form-'. md5(mt_rand());
85
      $form['#build_id'] = $form_build_id;
86
      drupal_prepare_form($form_id, $form, $form_state);
87 88 89 90
      // Store a copy of the unprocessed form for caching and indicate that it
      // is cacheable if #cache will be set.
      $original_form = $form;
      $cacheable = TRUE;
91
      unset($form_state['post']);
92
    }
93
    $form['#post'] = $_POST;
94

95 96 97 98 99 100
    // Now that we know we have a form, we'll process it (validating,
    // submitting, and handling the results returned by its submission
    // handlers. Submit handlers accumulate data in the form_state by
    // altering the $form_state variable, which is passed into them by
    // reference.
    drupal_process_form($form_id, $form, $form_state);
101 102 103 104 105 106
    if ($cacheable && !empty($form['#cache'])) {
      // Caching is done past drupal_process_form so #process callbacks can
      // set #cache. By not sending the form state, we avoid storing
      // $form_state['storage'].
      form_set_cache($form_build_id, $original_form, NULL);
    }
107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123
  }

  // Most simple, single-step forms will be finished by this point --
  // drupal_process_form() usually redirects to another page (or to
  // a 'fresh' copy of the form) once processing is complete. If one
  // of the form's handlers has set $form_state['redirect'] to FALSE,
  // the form will simply be re-rendered with the values still in its
  // fields.
  //
  // If $form_state['storage'] or $form_state['rebuild'] have been
  // set by any submit or validate handlers, however, we know that
  // we're in a complex multi-part process of some sort and the form's
  // workflow is NOT complete. We need to construct a fresh copy of
  // the form, passing in the latest $form_state in addition to any
  // other variables passed into drupal_get_form().

  if (!empty($form_state['rebuild']) || !empty($form_state['storage'])) {
124
    $form = drupal_rebuild_form($form_id, $form_state, $args);
125 126
  }

127 128 129 130
  // If we haven't redirected to a new location by now, we want to
  // render whatever form array is currently in hand.
  return drupal_render_form($form_id, $form);
}
131

132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171
/**
 * Retrieves a form, caches it and processes it with an empty $_POST.
 *
 * This function clears $_POST and passes the empty $_POST to the form_builder.
 * To preserve some parts from $_POST, pass them in $form_state.
 *
 * If your AHAH callback simulates the pressing of a button, then your AHAH
 * callback will need to do the same as what drupal_get_form would do when the
 * button is pressed: get the form from the cache, run drupal_process_form over
 * it and then if it needs rebuild, run drupal_rebuild_form over it. Then send
 * back a part of the returned form.
 * $form_state['clicked_button']['#array_parents'] will help you to find which
 * part.
 *
 * @param $form_id
 *   The unique string identifying the desired form. If a function
 *   with that name exists, it is called to build the form array.
 *   Modules that need to generate the same form (or very similar forms)
 *   using different $form_ids can implement hook_forms(), which maps
 *   different $form_id values to the proper form constructor function. Examples
 *   may be found in node_forms(), search_forms(), and user_forms().
 * @param $form_state
 *   A keyed array containing the current state of the form. Most
 *   important is the $form_state['storage'] collection.
 * @param $args
 *   Any additional arguments are passed on to the functions called by
 *   drupal_get_form(), plus the original form_state in the beginning. If you
 *   are getting a form from the cache, use $form['#parameters'] to shift off
 *   the $form_id from its beginning then the resulting array can be used as
 *   $arg here.
 * @param $form_build_id
 *   If the AHAH callback calling this function only alters part of the form,
 *   then pass in the existing form_build_id so we can re-cache with the same
 *   csid.
 * @return
 *   The newly built form.
 */
function drupal_rebuild_form($form_id, &$form_state, $args, $form_build_id = NULL) {
  // Remove the first argument. This is $form_id.when called from
  // drupal_get_form and the original $form_state when called from some AHAH
172 173
  // callback. Neither is needed. After that, put in the current state.
  $args[0] = &$form_state;
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
  // And the form_id.
  array_unshift($args, $form_id);
  $form = call_user_func_array('drupal_retrieve_form', $args);

  if (!isset($form_build_id)) {
    // We need a new build_id for the new version of the form.
    $form_build_id = 'form-'. md5(mt_rand());
  }
  $form['#build_id'] = $form_build_id;
  drupal_prepare_form($form_id, $form, $form_state);

  // Now, we cache the form structure so it can be retrieved later for
  // validation. If $form_state['storage'] is populated, we'll also cache
  // it so that it can be used to resume complex multi-step processes.
  form_set_cache($form_build_id, $form, $form_state);

  // Clear out all post data, as we don't want the previous step's
  // data to pollute this one and trigger validate/submit handling,
  // then process the form for rendering.
  $_POST = array();
  $form['#post'] = array();
  drupal_process_form($form_id, $form, $form_state);
  return $form;
}

199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223
/**
 * Fetch a form from cache.
 */
function form_get_cache($form_build_id, &$form_state) {
  if ($cached = cache_get('form_'. $form_build_id, 'cache_form')) {
    $form = $cached->data;
    if ($cached = cache_get('storage_'. $form_build_id, 'cache_form')) {
      $form_state['storage'] = $cached->data;
    }
    return $form;
  }
}

/**
 * Store a form in the cache
 */
function form_set_cache($form_build_id, $form, $form_state) {
  $expire = max(ini_get('session.cookie_lifetime'), 86400);

  cache_set('form_'. $form_build_id, $form, 'cache_form', $expire);
  if (!empty($form_state['storage'])) {
    cache_set('storage_'. $form_build_id, $form_state['storage'], 'cache_form', $expire);
  }
}

224
/**
225
 * Retrieves a form using a form_id, populates it with $form_state['values'],
226 227 228 229 230 231 232 233
 * processes it, and returns any validation errors encountered. This
 * function is the programmatic counterpart to drupal_get_form().
 *
 * @param $form_id
 *   The unique string identifying the desired form. If a function
 *   with that name exists, it is called to build the form array.
 *   Modules that need to generate the same form (or very similar forms)
 *   using different $form_ids can implement hook_forms(), which maps
234
 *   different $form_id values to the proper form constructor function. Examples
235
 *   may be found in node_forms(), search_forms(), and user_forms().
236 237 238 239 240
 * @param $form_state
 *   A keyed array containing the current state of the form. Most
 *   important is the $form_state['values'] collection, a tree of data
 *   used to simulate the incoming $_POST information from a user's
 *   form submission.
241
 * @param ...
242 243 244 245
 *   Any additional arguments are passed on to the functions called by
 *   drupal_execute(), including the unique form constructor function.
 *   For example, the node_edit form requires that a node object be passed
 *   in here when it is called.
246 247 248
 * For example:
 *
 * // register a new user
249 250 251 252
 * $form_state = array();
 * $form_state['values']['name'] = 'robo-user';
 * $form_state['values']['mail'] = 'robouser@example.com';
 * $form_state['values']['pass'] = 'password';
253
 * $form_state['values']['op'] = t('Create new account');
254
 * drupal_execute('user_register', $form_state);
255 256
 *
 * // Create a new node
257
 * $form_state = array();
258
 * $node = array('type' => 'story');
259 260 261
 * $form_state['values']['title'] = 'My node';
 * $form_state['values']['body'] = 'This is the body text!';
 * $form_state['values']['name'] = 'robo-user';
262
 * $form_state['values']['op'] = t('Save');
263
 * drupal_execute('story_node_form', $form_state, $node);
264
 */
265
function drupal_execute($form_id, &$form_state) {
266
  $args = func_get_args();
267 268 269 270
  $form = call_user_func_array('drupal_retrieve_form', $args);
  $form['#post'] = $form_state['values'];
  drupal_prepare_form($form_id, $form, $form_state);
  drupal_process_form($form_id, $form, $form_state);
271 272
}

273 274 275 276 277 278 279 280
/**
 * Retrieves the structured array that defines a given form.
 *
 * @param $form_id
 *   The unique string identifying the desired form. If a function
 *   with that name exists, it is called to build the form array.
 *   Modules that need to generate the same form (or very similar forms)
 *   using different $form_ids can implement hook_forms(), which maps
281
 *   different $form_id values to the proper form constructor function.
282 283
 * @param $form_state
 *   A keyed array containing the current state of the form.
284
 * @param ...
285 286 287 288 289 290
 *   Any additional arguments needed by the unique form constructor
 *   function. Generally, these are any arguments passed into the
 *   drupal_get_form() or drupal_execute() functions after the first
 *   argument. If a module implements hook_forms(), it can examine
 *   these additional arguments and conditionally return different
 *   builder functions as well.
291
 */
292
function drupal_retrieve_form($form_id, &$form_state) {
293 294
  static $forms;

295
  // We save two copies of the incoming arguments: one for modules to use
296 297 298
  // when mapping form ids to constructor functions, and another to pass to
  // the constructor function itself. We shift out the first argument -- the
  // $form_id itself -- from the list to pass into the constructor function,
299
  // since it's already known.
300
  $args = func_get_args();
301
  $saved_args = $args;
302
  array_shift($args);
303 304 305
  if (isset($form_state)) {
    array_shift($args);
  }
306 307 308

  // We first check to see if there's a function named after the $form_id.
  // If there is, we simply pass the arguments on to it to get the form.
309
  if (!function_exists($form_id)) {
310
    // In cases where many form_ids need to share a central constructor function,
311
    // such as the node editing form, modules can implement hook_forms(). It
312
    // maps one or more form_ids to the correct constructor functions.
313 314 315 316 317 318 319 320 321
    //
    // We cache the results of that hook to save time, but that only works
    // for modules that know all their form_ids in advance. (A module that
    // adds a small 'rate this comment' form to each comment in a list
    // would need a unique form_id for each one, for example.)
    //
    // So, we call the hook if $forms isn't yet populated, OR if it doesn't
    // yet have an entry for the requested form_id.
    if (!isset($forms) || !isset($forms[$form_id])) {
322
      $forms = module_invoke_all('forms', $form_id, $args);
323 324 325 326 327 328 329 330 331
    }
    $form_definition = $forms[$form_id];
    if (isset($form_definition['callback arguments'])) {
      $args = array_merge($form_definition['callback arguments'], $args);
    }
    if (isset($form_definition['callback'])) {
      $callback = $form_definition['callback'];
    }
  }
332

333 334
  array_unshift($args, NULL);
  $args[0] = &$form_state;
335

336 337
  // If $callback was returned by a hook_forms() implementation, call it.
  // Otherwise, call the function named after the form id.
338 339 340 341 342 343
  $form = call_user_func_array(isset($callback) ? $callback : $form_id, $args);

  // We store the original function arguments, rather than the final $arg
  // value, so that form_alter functions can see what was originally
  // passed to drupal_retrieve_form(). This allows the contents of #parameters
  // to be saved and passed in at a later date to recreate the form.
344
  $form['#parameters'] = $saved_args;
345
  return $form;
346 347 348 349 350 351 352 353
}

/**
 * This function is the heart of form API. The form gets built, validated and in
 * appropriate cases, submitted.
 *
 * @param $form_id
 *   The unique string identifying the current form.
354 355
 * @param $form
 *   An associative array containing the structure of the form.
356 357
 * @param $form_state
 *   A keyed array containing the current state of the form. This
Dries's avatar
Dries committed
358
 *   includes the current persistent storage data for the form, and
359 360 361
 *   any data passed along by earlier steps when displaying a
 *   multi-step form. Additional information, like the sanitized $_POST
 *   data, is also accumulated here.
362
 */
363 364 365 366
function drupal_process_form($form_id, &$form, &$form_state) {
  $form_state['values'] = array();

  $form = form_builder($form_id, $form, $form_state);
367 368 369
  // Only process the form if it is programmed or the form_id coming
  // from the POST data is set and matches the current form_id.
  if ((!empty($form['#programmed'])) || (!empty($form['#post']) && (isset($form['#post']['form_id']) && ($form['#post']['form_id'] == $form_id)))) {
370 371
    drupal_validate_form($form_id, $form, $form_state);

372 373 374 375 376 377 378
    // form_clean_id() maintains a cache of element IDs it has seen,
    // so it can prevent duplicates. We want to be sure we reset that
    // cache when a form is processed, so scenerios that result in
    // the form being built behind the scenes and again for the
    // browser don't increment all the element IDs needlessly.
    form_clean_id(NULL, TRUE);

379 380 381 382 383 384 385
    if ((!empty($form_state['submitted'])) && !form_get_errors() && empty($form_state['rebuild'])) {
      $form_state['redirect'] = NULL;
      form_execute_handlers('submit', $form, $form_state);

      // We'll clear out the cached copies of the form and its stored data
      // here, as we've finished with them. The in-memory copies are still
      // here, though.
386
      if (variable_get('cache', CACHE_DISABLED) == CACHE_DISABLED && !empty($form_state['values']['form_build_id'])) {
387 388 389 390 391
        cache_clear_all('form_'. $form_state['values']['form_build_id'], 'cache_form');
        cache_clear_all('storage_'. $form_state['values']['form_build_id'], 'cache_form');
      }

      // If batches were set in the submit handlers, we process them now,
392 393 394 395
      // possibly ending execution. We make sure we do not react to the batch
      // that is already being processed (if a batch operation performs a
      // drupal_execute).
      if ($batch =& batch_get() && !isset($batch['current_set'])) {
396 397 398 399
        // The batch uses its own copies of $form and $form_state for
        // late execution of submit handers and post-batch redirection.
        $batch['form'] = $form;
        $batch['form_state'] = $form_state;
400 401
        $batch['progressive'] = !$form['#programmed'];
        batch_process();
402 403 404 405
        // Execution continues only for programmatic forms.
        // For 'regular' forms, we get redirected to the batch processing
        // page. Form redirection will be handled in _batch_finished(),
        // after the batch is processed.
406
      }
407 408 409 410 411 412 413 414 415

      // If no submit handlers have populated the $form_state['storage']
      // bundle, and the $form_state['rebuild'] flag has not been set,
      // we're finished and should redirect to a new destination page
      // if one has been set (and a fresh, unpopulated copy of the form
      // if one hasn't). If the form was called by drupal_execute(),
      // however, we'll skip this and let the calling function examine
      // the resulting $form_state bundle itself.
      if (!$form['#programmed'] && empty($form_state['rebuild']) && empty($form_state['storage'])) {
416
        drupal_redirect_form($form, $form_state['redirect']);
417
      }
418 419 420 421 422 423 424 425 426 427 428 429 430 431
    }
  }
}

/**
 * Prepares a structured form array by adding required elements,
 * executing any hook_form_alter functions, and optionally inserting
 * a validation token to prevent tampering.
 *
 * @param $form_id
 *   A unique string identifying the form for validation, submission,
 *   theming, and hook_form_alter functions.
 * @param $form
 *   An associative array containing the structure of the form.
432 433 434
 * @param $form_state
 *   A keyed array containing the current state of the form. Passed
 *   in here so that hook_form_alter() calls can use it, as well.
435
 */
436
function drupal_prepare_form($form_id, &$form, &$form_state) {
437 438
  global $user;

439
  $form['#type'] = 'form';
440
  $form['#programmed'] = isset($form['#post']);
441

442 443 444 445 446 447 448 449 450
  if (isset($form['#build_id'])) {
    $form['form_build_id'] = array(
      '#type' => 'hidden',
      '#value' => $form['#build_id'],
      '#id' => $form['#build_id'],
      '#name' => 'form_build_id',
    );
  }

451 452 453 454
  // Add a token, based on either #token or form_id, to any form displayed to
  // authenticated users. This ensures that any submitted form was actually
  // requested previously by the user and protects against cross site request
  // forgeries.
455
  if (isset($form['#token'])) {
456
    if ($form['#token'] === FALSE || $user->uid == 0 || $form['#programmed']) {
457
      unset($form['#token']);
458
    }
459
    else {
460
      $form['form_token'] = array('#type' => 'token', '#default_value' => drupal_get_token($form['#token']));
461
    }
462
  }
463
  else if (isset($user->uid) && $user->uid && !$form['#programmed']) {
464 465
    $form['#token'] = $form_id;
    $form['form_token'] = array(
466
      '#id' => form_clean_id('edit-'. $form_id .'-form-token'),
467 468 469 470 471
      '#type' => 'token',
      '#default_value' => drupal_get_token($form['#token']),
    );
  }

472
  if (isset($form_id)) {
473 474 475 476 477
    $form['form_id'] = array(
      '#type' => 'hidden',
      '#value' => $form_id,
      '#id' => form_clean_id("edit-$form_id"),
    );
478
  }
479
  if (!isset($form['#id'])) {
480
    $form['#id'] = form_clean_id($form_id);
481
  }
482

483
  $form += _element_info('form');
484

Dries's avatar
Dries committed
485 486
  if (!isset($form['#validate'])) {
    if (function_exists($form_id .'_validate')) {
487
      $form['#validate'] = array($form_id .'_validate');
Dries's avatar
Dries committed
488 489 490
    }
  }

491 492
  if (!isset($form['#submit'])) {
    if (function_exists($form_id .'_submit')) {
493
      // We set submit here so that it can be altered.
494
      $form['#submit'] = array($form_id .'_submit');
Dries's avatar
Dries committed
495 496 497
    }
  }

498 499 500 501 502 503 504 505 506 507 508 509 510 511
  // Normally, we would call drupal_alter($form_id, $form, $form_state).
  // However, drupal_alter() normally supports just one byref parameter. Using
  // the __drupal_alter_by_ref key, we can store any additional parameters
  // that need to be altered, and they'll be split out into additional params
  // for the hook_form_alter() implementations.
  // @todo: Remove this in Drupal 7.
  $data = &$form;
  $data['__drupal_alter_by_ref'] = array(&$form_state);
  drupal_alter('form_'. $form_id, $data);

  // __drupal_alter_by_ref is unset in the drupal_alter() function, we need
  // to repopulate it to ensure both calls get the data.
  $data['__drupal_alter_by_ref'] = array(&$form_state);
  drupal_alter('form', $data, $form_id);
512 513
}

514 515

/**
516
 * Validates user-submitted form data from the $form_state using
517 518 519 520 521 522 523
 * the validate functions defined in a structured form array.
 *
 * @param $form_id
 *   A unique string identifying the form for validation, submission,
 *   theming, and hook_form_alter functions.
 * @param $form
 *   An associative array containing the structure of the form.
524 525 526 527 528 529 530 531 532 533
 * @param $form_state
 *   A keyed array containing the current state of the form. The current
 *   user-submitted data is stored in $form_state['values'], though
 *   form validation functions are passed an explicit copy of the
 *   values for the sake of simplicity. Validation handlers can also
 *   $form_state to pass information on to submit handlers. For example:
 *     $form_state['data_for_submision'] = $data;
 *   This technique is useful when validation requires file parsing,
 *   web service requests, or other expensive requests that should
 *   not be repeated in the submission step.
534
 */
535
function drupal_validate_form($form_id, $form, &$form_state) {
536 537 538 539 540
  static $validated_forms = array();

  if (isset($validated_forms[$form_id])) {
    return;
  }
541

542
  // If the session token was set by drupal_prepare_form(), ensure that it
543
  // matches the current user's session.
544
  if (isset($form['#token'])) {
545
    if (!drupal_valid_token($form_state['values']['form_token'], $form['#token'])) {
546
      // Setting this error will cause the form to fail validation.
547
      form_set_error('form_token', t('Validation error, please try again. If this error persists, please contact the site administrator.'));
548 549 550
    }
  }

551
  _form_validate($form, $form_state, $form_id);
552
  $validated_forms[$form_id] = TRUE;
553 554
}

555 556 557 558 559 560 561 562 563 564 565 566
/**
 * Renders a structured form array into themed HTML.
 *
 * @param $form_id
 *   A unique string identifying the form for validation, submission,
 *   theming, and hook_form_alter functions.
 * @param $form
 *   An associative array containing the structure of the form.
 * @return
 *   A string containing the path of the page to display when processing
 *   is complete.
 */
567
function drupal_render_form($form_id, &$form) {
568 569
  // Don't override #theme if someone already set it.
  if (!isset($form['#theme'])) {
570 571 572
    init_theme();
    $registry = theme_get_registry();
    if (isset($registry[$form_id])) {
573 574 575 576
      $form['#theme'] = $form_id;
    }
  }

577
  $output = drupal_render($form);
578 579 580 581 582 583 584 585 586
  return $output;
}

/**
 * Redirect the user to a URL after a form has been processed.
 *
 * @param $form
 *   An associative array containing the structure of the form.
 * @param $redirect
587
 *   An optional value containing the destination path to redirect
588 589 590
 *   to if none is specified by the form.
 */
function drupal_redirect_form($form, $redirect = NULL) {
591
  $goto = NULL;
592 593 594
  if (isset($redirect)) {
    $goto = $redirect;
  }
595
  if ($goto !== FALSE && isset($form['#redirect'])) {
596 597
    $goto = $form['#redirect'];
  }
598 599 600 601 602 603 604 605 606 607 608
  if (!isset($goto) || ($goto !== FALSE)) {
    if (isset($goto)) {
      if (is_array($goto)) {
        call_user_func_array('drupal_goto', $goto);
      }
      else {
        drupal_goto($goto);
      }
    }
    drupal_goto($_GET['q']);
  }
609 610
}

611 612 613 614 615 616 617
/**
 * Performs validation on form elements. First ensures required fields are
 * completed, #maxlength is not exceeded, and selected options were in the
 * list of options given to the user. Then calls user-defined validators.
 *
 * @param $elements
 *   An associative array containing the structure of the form.
618 619 620 621 622 623 624 625 626 627
 * @param $form_state
 *   A keyed array containing the current state of the form. The current
 *   user-submitted data is stored in $form_state['values'], though
 *   form validation functions are passed an explicit copy of the
 *   values for the sake of simplicity. Validation handlers can also
 *   $form_state to pass information on to submit handlers. For example:
 *     $form_state['data_for_submision'] = $data;
 *   This technique is useful when validation requires file parsing,
 *   web service requests, or other expensive requests that should
 *   not be repeated in the submission step.
628 629 630 631
 * @param $form_id
 *   A unique string identifying the form for validation, submission,
 *   theming, and hook_form_alter functions.
 */
632
function _form_validate($elements, &$form_state, $form_id = NULL) {
633 634
  // Also used in the installer, pre-database setup.
  $t = get_t();
635

636 637 638
  // Recurse through all children.
  foreach (element_children($elements) as $key) {
    if (isset($elements[$key]) && $elements[$key]) {
639
      _form_validate($elements[$key], $form_state);
640 641
    }
  }
642
  /* Validate the current input */
643
  if (!isset($elements['#validated']) || !$elements['#validated']) {
644
    if (isset($elements['#needs_validation'])) {
645 646 647 648
      // 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') {
649
        form_error($elements, $t('!name field is required.', array('!name' => $elements['#title'])));
650
      }
651

652 653
      // Verify that the value is not longer than #maxlength.
      if (isset($elements['#maxlength']) && drupal_strlen($elements['#value']) > $elements['#maxlength']) {
654
        form_error($elements, $t('!name cannot be longer than %max characters but is currently %length characters long.', array('!name' => empty($elements['#title']) ? $elements['#parents'][0] : $elements['#title'], '%max' => $elements['#maxlength'], '%length' => drupal_strlen($elements['#value']))));
655 656
      }

657
      if (isset($elements['#options']) && isset($elements['#value'])) {
658 659 660 661 662 663 664 665 666 667
        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])) {
668
              form_error($elements, $t('An illegal choice has been detected. Please contact the site administrator.'));
669
              watchdog('form', 'Illegal choice %choice in !name element.', array('%choice' => $v, '!name' => empty($elements['#title']) ? $elements['#parents'][0] : $elements['#title']), WATCHDOG_ERROR);
670
            }
671 672
          }
        }
673
        elseif (!isset($options[$elements['#value']])) {
674
          form_error($elements, $t('An illegal choice has been detected. Please contact the site administrator.'));
675
          watchdog('form', 'Illegal choice %choice in %name element.', array('%choice' => $elements['#value'], '%name' => empty($elements['#title']) ? $elements['#parents'][0] : $elements['#title']), WATCHDOG_ERROR);
676
        }
677 678 679
      }
    }

680 681 682 683 684 685 686 687
    // Call user-defined form level validators.
    if (isset($form_id)) {
      form_execute_handlers('validate', $elements, $form_state);
    }
    // Call any element-specific validators. These must act on the element
    // #value data.
    elseif (isset($elements['#element_validate'])) {
      foreach ($elements['#element_validate'] as $function) {
688
        if (function_exists($function))  {
689
          $function($elements, $form_state);
690 691 692
        }
      }
    }
693
    $elements['#validated'] = TRUE;
694 695 696
  }
}

697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729
/**
 * A helper function used to execute custom validation and submission
 * handlers for a given form. Button-specific handlers are checked
 * first. If none exist, the function falls back to form-level handlers.
 *
 * @param $type
 *   The type of handler to execute. 'validate' or 'submit' are the
 *   defaults used by Form API.
 * @param $form
 *   An associative array containing the structure of the form.
 * @param $form_state
 *   A keyed array containing the current state of the form. If the user
 *   submitted the form by clicking a button with custom handler functions
 *   defined, those handlers will be stored here.
 */
function form_execute_handlers($type, &$form, &$form_state) {
  $return = FALSE;
  if (isset($form_state[$type .'_handlers'])) {
    $handlers = $form_state[$type .'_handlers'];
  }
  elseif (isset($form['#'. $type])) {
    $handlers = $form['#'. $type];
  }
  else {
    $handlers = array();
  }

  foreach ($handlers as $function) {
    if (function_exists($function))  {
      if ($type == 'submit' && ($batch =& batch_get())) {
        // Some previous _submit handler has set a batch. We store the call
        // in a special 'control' batch set, for execution at the correct
        // time during the batch processing workflow.
730
        $batch['sets'][] = array('form_submit' => $function);
731 732
      }
      else {
733
        $function($form, $form_state);
734 735 736 737 738 739 740
      }
      $return = TRUE;
    }
  }
  return $return;
}

741
/**
742 743 744 745 746 747 748 749 750 751 752 753
 * File an error against a form element.
 *
 * @param $name
 *   The name of the form element. If the #parents property of your form
 *   element is array('foo', 'bar', 'baz') then you may set an error on 'foo'
 *   or 'foo][bar][baz'. Setting an error on 'foo' sets an error for every
 *   element where the #parents array starts with 'foo'.
 * @param $message
 *   The error message to present to the user.
 * @return
 *   Never use the return value of this function, use form_get_errors and
 *   form_get_error instead.
754
 */
755
function form_set_error($name = NULL, $message = '') {
756 757 758
  static $form = array();
  if (isset($name) && !isset($form[$name])) {
    $form[$name] = $message;
759 760 761
    if ($message) {
      drupal_set_message($message, 'error');
    }
762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790
  }
  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];
  }
}

791 792 793
/**
 * Flag an element as having an error.
 */
794
function form_error(&$element, $message = '') {
795
  form_set_error(implode('][', $element['#parents']), $message);
796 797 798
}

/**
799 800 801
 * Walk through the structured form array, adding any required
 * properties to each element and mapping the incoming $_POST
 * data to the proper elements.
802 803
 *
 * @param $form_id
804 805
 *   A unique string identifying the form for validation, submission,
 *   theming, and hook_form_alter functions.
806 807
 * @param $form
 *   An associative array containing the structure of the form.
808 809 810 811 812
 * @param $form_state
 *   A keyed array containing the current state of the form. In this
 *   context, it is used to accumulate information about which button
 *   was clicked when the form was submitted, as well as the sanitized
 *   $_POST data.
813
 */
814
function form_builder($form_id, $form, &$form_state) {
815
  static $complete_form, $cache;
816

817 818 819
  // Initialize as unprocessed.
  $form['#processed'] = FALSE;

820
  /* Use element defaults */
821
  if ((!empty($form['#type'])) && ($info = _element_info($form['#type']))) {
822
    // Overlay $info onto $form, retaining preexisting keys in $form.
823 824 825
    $form += $info;
  }

826 827 828 829 830
  if (isset($form['#type']) && $form['#type'] == 'form') {
    $complete_form = $form;
    if (!empty($form['#programmed'])) {
      $form_state['submitted'] = TRUE;
    }
831 832
  }

833
  if (isset($form['#input']) && $form['#input']) {
834
    _form_builder_handle_input_element($form_id, $form, $form_state, $complete_form);
835
  }
836
  $form['#defaults_loaded'] = TRUE;
837

838 839 840
  // We start off assuming all form elements are in the correct order.
  $form['#sorted'] = TRUE;

841
  // Recurse through all child elements.
842
  $count = 0;
843
  foreach (element_children($form) as $key) {
844 845
    $form[$key]['#post'] = $form['#post'];
    $form[$key]['#programmed'] = $form['#programmed'];
846
    // Don't squash an existing tree value.
847 848 849
    if (!isset($form[$key]['#tree'])) {
      $form[$key]['#tree'] = $form['#tree'];
    }
850

851
    // Deny access to child elements if parent is denied.
852 853 854 855
    if (isset($form['#access']) && !$form['#access']) {
      $form[$key]['#access'] = FALSE;
    }

856
    // Don't squash existing parents value.
857
    if (!isset($form[$key]['#parents'])) {
858 859
      // Check to see if a tree of child elements is present. If so,
      // continue down the tree if required.
860
      $form[$key]['#parents'] = $form[$key]['#tree'] && $form['#tree'] ? array_merge($form['#parents'], array($key)) : array($key);
861 862 863
      $array_parents = isset($form['#array_parents']) ? $form['#array_parents'] : array();
      $array_parents[] = $key;
      $form[$key]['#array_parents'] = $array_parents;
864 865
    }

866
    // Assign a decimal placeholder weight to preserve original array order.
867 868 869
    if (!isset($form[$key]['#weight'])) {
      $form[$key]['#weight'] = $count/1000;
    }
870
    else {
871 872
      // If one of the child elements has a weight then we will need to sort
      // later.
873 874
      unset($form['#sorted']);
    }
875
    $form[$key] = form_builder($form_id, $form[$key], $form_state);
876 877 878
    $count++;
  }

879 880
  // The #after_build flag allows any piece of a form to be altered
  // after normal input parsing has been completed.
881 882
  if (isset($form['#after_build']) && !isset($form['#after_build_done'])) {
    foreach ($form['#after_build'] as $function) {
883
      $form = $function($form, $form_state);
884 885 886 887 888
      $form['#after_build_done'] = TRUE;
    }
  }

  // Now that we've processed everything, we can go back to handle the funky
Dries's avatar
Dries committed
889
  // Internet Explorer button-click scenario.
890 891
  _form_builder_ie_cleanup($form, $form_state);

892 893 894
  // After handling the special IE case, we no longer need the buttons collection.
  unset($form_state['buttons']);

895 896 897 898 899 900 901 902 903
  // If some callback set #cache, we need to flip a static flag so later it
  // can be found.
  if (isset($form['#cache'])) {
    $cache = $form['#cache'];
  }
  // We are on the top form, we can copy back #cache if it's set.
  if (isset($form['#type']) && $form['#type'] == 'form' && isset($cache)) {
    $form['#cache'] = TRUE;
  }
904 905 906 907 908 909 910 911
  return $form;
}

/**
 * Populate the #value and #name properties of input elements so they
 * can be processed and rendered. Also, execute any #process handlers
 * attached to a specific element.
 */
912
function _form_builder_handle_input_element($form_id, &$form, &$form_state, $complete_form) {
913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930
  if (!isset($form['#name'])) {
    $name = array_shift($form['#parents']);
    $form['#name'] = $name;
    if ($form['#type'] == 'file') {
      // To make it easier to handle $_FILES in file.inc, we place all
      // file fields in the 'files' array. Also, we do not support
      // nested file names.
      $form['#name'] = 'files['. $form['#name'] .']';
    }
    elseif (count($form['#parents'])) {
      $form['#name'] .= '['. implode('][', $form['#parents']) .']';
    }
    array_unshift($form['#parents'], $name);
  }
  if (!isset($form['#id'])) {
    $form['#id'] = form_clean_id('edit-'. implode('-', $form['#parents']));
  }

931
  unset($edit);
932 933 934 935 936
  if (!empty($form['#disabled'])) {
    $form['#attributes']['disabled'] = 'disabled';
  }

  if (!isset($form['#value']) && !array_key_exists('#value', $form)) {
937
    $function = !empty($form['#value_callback']) ? $form['#value_callback'] : 'form_type_'. $form['#type'] .'_value';
938 939 940 941 942 943
    if (($form['#programmed']) || ((!isset($form['#access']) || $form['#access']) && isset($form['#post']) && (isset($form['#post']['form_id']) && $form['#post']['form_id'] == $form_id))) {
      $edit = $form['#post'];
      foreach ($form['#parents'] as $parent) {
        $edit = isset($edit[$parent]) ? $edit[$parent] : NULL;
      }
      if (!$form['#programmed'] || isset($edit)) {
944 945 946
        // Call #type_value to set the form value;
        if (function_exists($function)) {
          $form['#value'] = $function($form, $edit);
947
        }
948 949
        if (!isset($form['#value']) && isset($edit)) {
          $form['#value'] = $edit;
950 951
        }
      }
952 953 954 955
      // Mark all posted values for validation.
      if (isset($form['#value']) || (isset($form['#required']) && $form['#required'])) {
        $form['#needs_validation'] = TRUE;
      }
956
    }
957
    // Load defaults.
958
    if (!isset($form['#value'])) {
959
      // Call #type_value without a second argument to request default_value handling.
960
      if (function_exists($function)) {
961
        $form['#value'] = $function($form);
962
      }
963
      // Final catch. If we haven't set a value yet, use the explicit default value.
964
      if (!isset($form['#value'])) {
965
        $form['#value'] = isset($form['#default_value']) ? $form['#default_value'] : '';
966 967
      }
    }
968
  }
969

970 971 972 973 974 975 976 977 978 979
  // Determine which button (if any) was clicked to submit the form.
  // We compare the incoming values with the buttons defined in the form,
  // and flag the one that matches. We have to do some funky tricks to
  // deal with Internet Explorer's handling of single-button forms, though.
  if (!empty($form['#post']) && isset($form['#executes_submit_callback'])) {
    // First, accumulate a collection of buttons, divided into two bins:
    // those that execute full submit callbacks and those that only validate.
    $button_type = $form['#executes_submit_callback'] ? 'submit' : 'button';
    $form_state['buttons'][$button_type][] = $form;

980
    if (_form_button_was_clicked($form)) {
981 982 983 984 985 986
      $form_state['submitted'] = $form_state['submitted'] || $form['#executes_submit_callback'];

      // In most cases, we want to use form_set_value() to manipulate
      // the global variables. In this special case, we want to make sure that
      // the value of this element is listed in $form_variables under 'op'.
      $form_state['values'][$form['#name']] = $form['#value'];
987
      $form_state['clicked_button'] = $form;
988 989 990 991 992 993 994 995 996 997 998 999 1000 1001

      if (isset($form['#validate'])) {
        $form_state['validate_handlers'] = $form['#validate'];
      }
      if (isset($form['#submit'])) {
        $form_state['submit_handlers'] = $form['#submit'];
      }
    }
  }
  // Allow for elements to expand to multiple elements, e.g., radios,
  // checkboxes and files.
  if (isset($form['#process']) && !$form['#processed']) {
    foreach ($form['#process'] as $process) {
      if (function_exists($process)) {
1002
        $form = $process($form, isset($edit) ? $edit : NULL, $form_state, $complete_form);
1003 1004 1005 1006 1007 1008 1009
      }
    }
    $form['#processed'] = TRUE;
  }
  form_set_value($form, $form['#value'], $form_state);
}

1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067
/**
 * Helper function to handle the sometimes-convoluted logic of button
 * click detection.
 *
 * In Internet Explorer, if ONLY one submit button is present, AND the
 * enter key is used to submit the form, no form value is sent for it
 * and we'll never detect a match. That special case is handled by
 * _form_builder_ie_cleanup().
 */
function _form_button_was_clicked($form) {
  // First detect normal 'vanilla' button clicks. Traditionally, all
  // standard buttons on a form share the same name (usually 'op'),
  // and the specific return value is used to determine which was
  // clicked. This ONLY works as long as $form['#name'] puts the
  // value at the top level of the tree of $_POST data.
  if (isset($form['#post'][$form['#name']]) && $form['#post'][$form['#name']] == $form['#value']) {
    return TRUE;
  }
  // When image buttons are clicked, browsers do NOT pass the form element
  // value in $_POST. Instead they pass an integer representing the
  // coordinates of the click on the button image. This means that image
  // buttons MUST have unique $form['#name'] values, but the details of
  // their $_POST data should be ignored.
  elseif (!empty($form['#has_garbage_value']) && isset($form['#value']) && $form['#value'] !== '') {
    return TRUE;
  }
  return FALSE;
}

/**
 * In IE, if only one submit button is present, AND the enter key is
 * used to submit the form, no form value is sent for it and our normal
 * button detection code will never detect a match. We call this
 * function after all other button-detection is complete to check
 * for the proper conditions, and treat the single button on the form
 * as 'clicked' if they are met.
 */
function _form_builder_ie_cleanup($form, &$form_state) {
  // Quick check to make sure we're always looking at the full form
  // and not a sub-element.
  if (!empty($form['#type']) && $form['#type'] == 'form') {
    // If we haven't recognized a submission yet, and there's a single
    // submit button, we know that we've hit the right conditions. Grab
    // the first one and treat it as the clicked button.
    if (empty($form_state['submitted']) && !empty($form_state['buttons']['submit']) && empty($form_state['buttons']['button'])) {
      $button = $form_state['buttons']['submit'][0];

      // Set up all the $form_state information that would have been
      // populated had the button been recognized earlier.
      $form_state['submitted'] = TRUE;
      $form_state['submit_handlers'] = empty($button['#submit']) ? NULL : $button['#submit'];
      $form_state['validate_handlers'] = empty($button['#validate']) ? NULL : $button['#validate'];
      $form_state['values'][$button['#name']] = $button['#value'];
      $form_state['clicked_button'] = $button;
    }
  }
}

1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112
/**
 * Helper function to determine the value for an image button form element.
 *
 * @param $form
 *   The form element whose value is being populated.
 * @param $edit
 *   The incoming POST data to populate the form element. If this is FALSE,
 *   the element's default value should be returned.
 * @return
 *   The data that will appear in the $form_state['values'] collection
 *   for this element. Return nothing to use the default.
 */
function form_type_image_button_value($form, $edit = FALSE) {
  if ($edit !== FALSE) {
    if (!empty($edit)) {
      // If we're dealing with Mozilla or Opera, we're lucky. It will
      // return a proper value, and we can get on with things.
      return $form['#return_value'];
    }
    else {
      // Unfortunately, in IE we never get back a proper value for THIS
      // form element. Instead, we get back two split values: one for the
      // X and one for the Y coordinates on which the user clicked the
      // button. We'll find this element in the #post data, and search
      // in the same spot for its name, with '_x'.
      $post = $form['#post'];
      foreach (split('\[', $form['#name']) as $element_name) {
        // chop off the ] that may exist.
        if (substr($element_name, -1) == ']') {
          $element_name = substr($element_name, 0, -1);
        }

        if (!isset($post[$element_name])) {
          if (isset($post[$element_name .'_x'])) {
            return $form['#return_value'];
          }
          return NULL;
        }
        $post = $array[$element_name];
      }
      return $form['#return_value'];
    }
  }
}

1113 1114 1115 1116
/**
 * Helper function to determine the value for a checkbox form element.
 *
 * @param $form
1117
 *   The form element whose value is being populated.
1118
 * @param $edit
1119 1120
 *   The incoming POST data to populate the form element. If this is FALSE,
 *   the element's default value should be returned.
1121
 * @return
1122 1123
 *   The data that will appear in the $form_state['values'] collection
 *   for this element. Return nothing to use the default.
1124
 */
1125 1126
function form_type_checkbox_value($form, $edit = FALSE) {
  if ($edit !== FALSE) {
1127 1128 1129 1130 1131 1132 1133 1134
    return !empty($edit) ? $form['#return_value'] : 0;
  }
}

/**
 * Helper function to determine the value for a checkboxes form element.
 *
 * @param $form
1135
 *   The form element whose value is being populated.
1136
 * @param $edit
1137 1138
 *   The incoming POST data to populate the form element. If this is FALSE,
 *   the element's default value should be returned.
1139
 * @return
1140 1141
 *   The data that will appear in the $form_state['values'] collection
 *   for this element. Return nothing to use the default.
1142
 */
1143
function form_type_checkboxes_value($form, $edit = FALSE) {
1144
  if ($edit === FALSE) {
1145 1146 1147 1148 1149 1150 1151
    $value = array();
    $form += array('#default_value' => array());
    foreach ($form['#default_value'] as $key) {
      $value[$key] = 1;
    }
    return $value;
  }
1152 1153 1154
  elseif (!isset($edit)) {
    return array();
  }
1155 1156 1157 1158 1159 1160 1161
}

/**
 * Helper function to determine the value for a password_confirm form
 * element.
 *
 * @param $form
1162
 *   The form element whose value is being populated.
1163
 * @param $edit
1164 1165
 *   The incoming POST data to populate the form element. If this is FALSE,
 *   the element's default value should be returned.
1166
 * @return
1167 1168
 *   The data that will appear in the $form_state['values'] collection
 *   for this element. Return nothing to use the default.
1169
 */
1170 1171
function form_type_password_confirm_value($form, $edit = FALSE) {
  if ($edit === FALSE) {
1172 1173 1174 1175 1176 1177 1178 1179 1180
    $form += array('#default_value' => array());
    return $form['#default_value'] + array('pass1' => '', 'pass2' => '');
  }
}

/**
 * Helper function to determine the value for a select form element.
 *
 * @param $form
1181
 *   The form element whose value is being populated.
1182
 * @param $edit
1183 1184
 *   The incoming POST data to populate the form element. If this is FALSE,
 *   the element's default value should be returned.
1185
 * @return
1186 1187
 *   The data that will appear in the $form_state['values'] collection
 *   for this element. Return nothing to use the default.
1188
 */
1189 1190
function form_type_select_value($form, $edit = FALSE) {
  if ($edit !== FALSE) {
1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203
    if (isset($form['#multiple']) && $form['#multiple']) {
      return (is_array($edit)) ? drupal_map_assoc($edit) : array();
    }
    else {
      return $edit;
    }
  }
}

/**
 * Helper function to determine the value for a textfield form element.
 *
 * @param $form
1204
 *   The form element whose value is being populated.
1205
 * @param $edit
1206 1207
 *   The incoming POST data to populate the form element. If this is FALSE,
 *   the element's default value should be returned.
1208
 * @return
1209 1210
 *   The data that will appear in the $form_state['values'] collection
 *   for this element. Return nothing to use the default.
1211
 */
1212 1213
function form_type_textfield_value($form, $edit = FALSE) {
  if ($edit !== FALSE) {
1214 1215 1216 1217 1218 1219 1220 1221 1222 1223
    // Equate $edit to the form value to ensure it's marked for
    // validation.
    return str_replace(array("\r", "\n"), '', $edit);
  }
}

/**
 * Helper function to determine the value for form's token value.
 *
 * @param $form
1224
 *   The form element whose value is being populated.
1225
 * @param $edit
1226 1227
 *   The incoming POST data to populate the form element. If this is FALSE,
 *   the element's default value should be returned.
1228
 * @return
1229 1230
 *   The data that will appear in the $form_state['values'] collection
 *   for this element. Return nothing to use the default.
1231
 */
1232 1233
function form_type_token_value($form, $edit = FALSE) {
  if ($edit !== FALSE) {
1234 1235 1236 1237
    return (string)$edit;
  }
}

1238
/**
Dries's avatar
Dries committed
1239
 * Use this function to make changes to form values in the form validate
1240
 * phase, so they will be available in the submit phase in $form_state.
1241 1242 1243
 *
 * Specifically, if $form['#parents'] is array('foo', 'bar')
 * and $value is 'baz' then this function will make
1244
 * $form_state['values']['foo']['bar'] to be 'baz'.
1245 1246 1247 1248 1249 1250
 *
 * @param $form
 *   The form item. Keys used: #parents, #value
 * @param $value
 *   The value for the form item.
 */
1251 1252
function form_set_value($form, $value, &$form_state) {
  _form_set_value($form_state['values'], $form, $form['#parents'], $value);
1253 1254 1255 1256 1257
}

/**
 * Helper function for form_set_value().
 *
1258
 * We iterate over $parents and create nested arrays for them
1259
 * in $form_state['values'] if needed. Then we insert the value into
1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274
 * the right array.
 */
function _form_set_value(&$form_values, $form, $parents, $value) {
  $parent = array_shift($parents);
  if (empty($parents)) {
    $form_values[$parent] = $value;
  }
  else {
    if (!isset($form_values[$parent])) {
      $form_values[$parent] = array();
    }
    _form_set_value($form_values[$parent], $form, $parents, $value);
  }
}

1275 1276 1277
/**
 * Retrieve the default properties for the defined element type.
 */
1278
function _element_info($type, $refresh = NULL) {
1279
  static $cache;
1280

1281
  $basic_defaults = array(
1282 1283 1284
    '#description' => NULL,
    '#attributes' => array(),
    '#required' => FALSE,
1285
    '#tree' => FALSE,
1286
    '#parents' => array()
1287
  );
1288
  if (!isset($cache) || $refresh) {
1289 1290 1291
    $cache = array();
    foreach (module_implements('elements') as $module) {
      $elements =