form.inc

Functions for form and batch generation and processing.

File

drupal/includes/form.inc
View source
  1. <?php
  2. /**
  3. * @file
  4. * Functions for form and batch generation and processing.
  5. */
  6. /**
  7. * @defgroup forms Form builder functions
  8. * @{
  9. * Functions that build an abstract representation of a HTML form.
  10. *
  11. * All modules should declare their form builder functions to be in this
  12. * group and each builder function should reference its validate and submit
  13. * functions using \@see. Conversely, validate and submit functions should
  14. * reference the form builder function using \@see. For examples, of this see
  15. * system_modules_uninstall() or user_pass(), the latter of which has the
  16. * following in its doxygen documentation:
  17. *
  18. * \@ingroup forms
  19. * \@see user_pass_validate().
  20. * \@see user_pass_submit().
  21. *
  22. * @}
  23. */
  24. /**
  25. * @defgroup form_api Form generation
  26. * @{
  27. * Functions to enable the processing and display of HTML forms.
  28. *
  29. * Drupal uses these functions to achieve consistency in its form processing and
  30. * presentation, while simplifying code and reducing the amount of HTML that
  31. * must be explicitly generated by modules.
  32. *
  33. * The primary function used with forms is drupal_get_form(), which is
  34. * used for forms presented interactively to a user. Forms can also be built and
  35. * submitted programmatically without any user input using the
  36. * drupal_form_submit() function.
  37. *
  38. * drupal_get_form() handles retrieving, processing, and displaying a rendered
  39. * HTML form for modules automatically.
  40. *
  41. * Here is an example of how to use drupal_get_form() and a form builder
  42. * function:
  43. * @code
  44. * $form = drupal_get_form('my_module_example_form');
  45. * ...
  46. * function my_module_example_form($form, &$form_state) {
  47. * $form['submit'] = array(
  48. * '#type' => 'submit',
  49. * '#value' => t('Submit'),
  50. * );
  51. * return $form;
  52. * }
  53. * function my_module_example_form_validate($form, &$form_state) {
  54. * // Validation logic.
  55. * }
  56. * function my_module_example_form_submit($form, &$form_state) {
  57. * // Submission logic.
  58. * }
  59. * @endcode
  60. *
  61. * Or with any number of additional arguments:
  62. * @code
  63. * $extra = "extra";
  64. * $form = drupal_get_form('my_module_example_form', $extra);
  65. * ...
  66. * function my_module_example_form($form, &$form_state, $extra) {
  67. * $form['submit'] = array(
  68. * '#type' => 'submit',
  69. * '#value' => $extra,
  70. * );
  71. * return $form;
  72. * }
  73. * @endcode
  74. *
  75. * The $form argument to form-related functions is a structured array containing
  76. * the elements and properties of the form. For information on the array
  77. * components and format, and more detailed explanations of the Form API
  78. * workflow, see the
  79. * @link forms_api_reference.html Form API reference @endlink
  80. * and the
  81. * @link http://drupal.org/node/37775 Form API documentation section. @endlink
  82. * In addition, there is a set of Form API tutorials in
  83. * @link form_example_tutorial.inc the Form Example Tutorial @endlink which
  84. * provide basics all the way up through multistep forms.
  85. *
  86. * In the form builder, validation, submission, and other form functions,
  87. * $form_state is the primary influence on the processing of the form and is
  88. * passed by reference to most functions, so they use it to communicate with
  89. * the form system and each other.
  90. *
  91. * See drupal_build_form() for documentation of $form_state keys.
  92. */
  93. /**
  94. * Returns a renderable form array for a given form ID.
  95. *
  96. * This function should be used instead of drupal_build_form() when $form_state
  97. * is not needed (i.e., when initially rendering the form) and is often
  98. * used as a menu callback.
  99. *
  100. * @param $form_id
  101. * The unique string identifying the desired form. If a function with that
  102. * name exists, it is called to build the form array. Modules that need to
  103. * generate the same form (or very similar forms) using different $form_ids
  104. * can implement hook_forms(), which maps different $form_id values to the
  105. * proper form constructor function. Examples may be found in node_forms(),
  106. * and search_forms().
  107. * @param ...
  108. * Any additional arguments are passed on to the functions called by
  109. * drupal_get_form(), including the unique form constructor function. For
  110. * example, the node_edit form requires that a node object is passed in here
  111. * when it is called. These are available to implementations of
  112. * hook_form_alter() and hook_form_FORM_ID_alter() as the array
  113. * $form_state['build_info']['args'].
  114. *
  115. * @return
  116. * The form array.
  117. *
  118. * @see drupal_build_form()
  119. */
  120. function drupal_get_form($form_id) {
  121. $form_state = array();
  122. $args = func_get_args();
  123. // Remove $form_id from the arguments.
  124. array_shift($args);
  125. $form_state['build_info']['args'] = $args;
  126. return drupal_build_form($form_id, $form_state);
  127. }
  128. /**
  129. * Builds and process a form based on a form id.
  130. *
  131. * The form may also be retrieved from the cache if the form was built in a
  132. * previous page-load. The form is then passed on for processing, validation
  133. * and submission if there is proper input.
  134. *
  135. * @param $form_id
  136. * The unique string identifying the desired form. If a function with that
  137. * name exists, it is called to build the form array. Modules that need to
  138. * generate the same form (or very similar forms) using different $form_ids
  139. * can implement hook_forms(), which maps different $form_id values to the
  140. * proper form constructor function. Examples may be found in node_forms(),
  141. * and search_forms().
  142. * @param $form_state
  143. * An array which stores information about the form. This is passed as a
  144. * reference so that the caller can use it to examine what in the form changed
  145. * when the form submission process is complete. Furthermore, it may be used
  146. * to store information related to the processed data in the form, which will
  147. * persist across page requests when the 'cache' or 'rebuild' flag is set.
  148. * The following parameters may be set in $form_state to affect how the form
  149. * is rendered:
  150. * - build_info: Internal. An associative array of information stored by Form
  151. * API that is necessary to build and rebuild the form from cache when the
  152. * original context may no longer be available:
  153. * - args: A list of arguments to pass to the form constructor.
  154. * - files: An optional array defining include files that need to be loaded
  155. * for building the form. Each array entry may be the path to a file or
  156. * another array containing values for the parameters 'type', 'module' and
  157. * 'name' as needed by module_load_include(). The files listed here are
  158. * automatically loaded by form_get_cache(). By default the current menu
  159. * router item's 'file' definition is added, if any. Use
  160. * form_load_include() to add include files from a form constructor.
  161. * - form_id: Identification of the primary form being constructed and
  162. * processed.
  163. * - base_form_id: Identification for a base form, as declared in a
  164. * hook_forms() implementation.
  165. * - rebuild_info: Internal. Similar to 'build_info', but pertaining to
  166. * drupal_rebuild_form().
  167. * - rebuild: Normally, after the entire form processing is completed and
  168. * submit handlers have run, a form is considered to be done and
  169. * drupal_redirect_form() will redirect the user to a new page using a GET
  170. * request (so a browser refresh does not re-submit the form). However, if
  171. * 'rebuild' has been set to TRUE, then a new copy of the form is
  172. * immediately built and sent to the browser, instead of a redirect. This is
  173. * used for multi-step forms, such as wizards and confirmation forms.
  174. * Normally, $form_state['rebuild'] is set by a submit handler, since it is
  175. * usually logic within a submit handler that determines whether a form is
  176. * done or requires another step. However, a validation handler may already
  177. * set $form_state['rebuild'] to cause the form processing to bypass submit
  178. * handlers and rebuild the form instead, even if there are no validation
  179. * errors.
  180. * - redirect: Used to redirect the form on submission. It may either be a
  181. * string containing the destination URL, or an array of arguments
  182. * compatible with drupal_goto(). See drupal_redirect_form() for complete
  183. * information.
  184. * - no_redirect: If set to TRUE the form will NOT perform a drupal_goto(),
  185. * even if 'redirect' is set.
  186. * - method: The HTTP form method to use for finding the input for this form.
  187. * May be 'post' or 'get'. Defaults to 'post'. Note that 'get' method
  188. * forms do not use form ids so are always considered to be submitted, which
  189. * can have unexpected effects. The 'get' method should only be used on
  190. * forms that do not change data, as that is exclusively the domain of
  191. * 'post.'
  192. * - cache: If set to TRUE the original, unprocessed form structure will be
  193. * cached, which allows the entire form to be rebuilt from cache. A typical
  194. * form workflow involves two page requests; first, a form is built and
  195. * rendered for the user to fill in. Then, the user fills the form in and
  196. * submits it, triggering a second page request in which the form must be
  197. * built and processed. By default, $form and $form_state are built from
  198. * scratch during each of these page requests. Often, it is necessary or
  199. * desired to persist the $form and $form_state variables from the initial
  200. * page request to the one that processes the submission. 'cache' can be set
  201. * to TRUE to do this. A prominent example is an Ajax-enabled form, in which
  202. * ajax_process_form() enables form caching for all forms that include an
  203. * element with the #ajax property. (The Ajax handler has no way to build
  204. * the form itself, so must rely on the cached version.) Note that the
  205. * persistence of $form and $form_state happens automatically for
  206. * (multi-step) forms having the 'rebuild' flag set, regardless of the value
  207. * for 'cache'.
  208. * - no_cache: If set to TRUE the form will NOT be cached, even if 'cache' is
  209. * set.
  210. * - values: An associative array of values submitted to the form. The
  211. * validation functions and submit functions use this array for nearly all
  212. * their decision making. (Note that #tree determines whether the values are
  213. * a flat array or an array whose structure parallels the $form array. See
  214. * @link forms_api_reference.html Form API reference @endlink for more
  215. * information.) These are raw and unvalidated, so should not be used
  216. * without a thorough understanding of security implications. In almost all
  217. * cases, code should use the data in the 'values' array exclusively. The
  218. * most common use of this key is for multi-step forms that need to clear
  219. * some of the user input when setting 'rebuild'. The values correspond to
  220. * $_POST or $_GET, depending on the 'method' chosen.
  221. * - always_process: If TRUE and the method is GET, a form_id is not
  222. * necessary. This should only be used on RESTful GET forms that do NOT
  223. * write data, as this could lead to security issues. It is useful so that
  224. * searches do not need to have a form_id in their query arguments to
  225. * trigger the search.
  226. * - must_validate: Ordinarily, a form is only validated once, but there are
  227. * times when a form is resubmitted internally and should be validated
  228. * again. Setting this to TRUE will force that to happen. This is most
  229. * likely to occur during Ajax operations.
  230. * - programmed: If TRUE, the form was submitted programmatically, usually
  231. * invoked via drupal_form_submit(). Defaults to FALSE.
  232. * - process_input: Boolean flag. TRUE signifies correct form submission.
  233. * This is always TRUE for programmed forms coming from drupal_form_submit()
  234. * (see 'programmed' key), or if the form_id coming from the $_POST data is
  235. * set and matches the current form_id.
  236. * - submitted: If TRUE, the form has been submitted. Defaults to FALSE.
  237. * - executed: If TRUE, the form was submitted and has been processed and
  238. * executed. Defaults to FALSE.
  239. * - triggering_element: (read-only) The form element that triggered
  240. * submission. This is the same as the deprecated
  241. * $form_state['clicked_button']. It is the element that caused submission,
  242. * which may or may not be a button (in the case of Ajax forms). This key is
  243. * often used to distinguish between various buttons in a submit handler,
  244. * and is also used in Ajax handlers.
  245. * - clicked_button: Deprecated. Use triggering_element instead.
  246. * - has_file_element: Internal. If TRUE, there is a file element and Form API
  247. * will set the appropriate 'enctype' HTML attribute on the form.
  248. * - groups: Internal. An array containing references to fieldsets to render
  249. * them within vertical tabs.
  250. * - storage: $form_state['storage'] is not a special key, and no specific
  251. * support is provided for it in the Form API. By tradition it was
  252. * the location where application-specific data was stored for communication
  253. * between the submit, validation, and form builder functions, especially
  254. * in a multi-step-style form. Form implementations may use any key(s)
  255. * within $form_state (other than the keys listed here and other reserved
  256. * ones used by Form API internals) for this kind of storage. The
  257. * recommended way to ensure that the chosen key doesn't conflict with ones
  258. * used by the Form API or other modules is to use the module name as the
  259. * key name or a prefix for the key name. For example, the Node module uses
  260. * $form_state['node'] in node editing forms to store information about the
  261. * node being edited, and this information stays available across successive
  262. * clicks of the "Preview" button as well as when the "Save" button is
  263. * finally clicked.
  264. * - buttons: A list containing copies of all submit and button elements in
  265. * the form.
  266. * - complete form: A reference to the $form variable containing the complete
  267. * form structure. #process, #after_build, #element_validate, and other
  268. * handlers being invoked on a form element may use this reference to access
  269. * other information in the form the element is contained in.
  270. * - temporary: An array holding temporary data accessible during the current
  271. * page request only. All $form_state properties that are not reserved keys
  272. * (see form_state_keys_no_cache()) persist throughout a multistep form
  273. * sequence. Form API provides this key for modules to communicate
  274. * information across form-related functions during a single page request.
  275. * It may be used to temporarily save data that does not need to or should
  276. * not be cached during the whole form workflow; e.g., data that needs to be
  277. * accessed during the current form build process only. There is no use-case
  278. * for this functionality in Drupal core.
  279. * - wrapper_callback: Modules that wish to pre-populate certain forms with
  280. * common elements, such as back/next/save buttons in multi-step form
  281. * wizards, may define a form builder function name that returns a form
  282. * structure, which is passed on to the actual form builder function.
  283. * Such implementations may either define the 'wrapper_callback' via
  284. * hook_forms() or have to invoke drupal_build_form() (instead of
  285. * drupal_get_form()) on their own in a custom menu callback to prepare
  286. * $form_state accordingly.
  287. * Information on how certain $form_state properties control redirection
  288. * behavior after form submission may be found in drupal_redirect_form().
  289. *
  290. * @return
  291. * The rendered form. This function may also perform a redirect and hence may
  292. * not return at all, depending upon the $form_state flags that were set.
  293. *
  294. * @see drupal_redirect_form()
  295. */
  296. function drupal_build_form($form_id, &$form_state) {
  297. // Ensure some defaults; if already set they will not be overridden.
  298. $form_state += form_state_defaults();
  299. if (!isset($form_state['input'])) {
  300. $form_state['input'] = $form_state['method'] == 'get' ? $_GET : $_POST;
  301. }
  302. if (isset($_SESSION['batch_form_state'])) {
  303. // We've been redirected here after a batch processing. The form has
  304. // already been processed, but needs to be rebuilt. See _batch_finished().
  305. $form_state = $_SESSION['batch_form_state'];
  306. unset($_SESSION['batch_form_state']);
  307. return drupal_rebuild_form($form_id, $form_state);
  308. }
  309. // If the incoming input contains a form_build_id, we'll check the cache for a
  310. // copy of the form in question. If it's there, we don't have to rebuild the
  311. // form to proceed. In addition, if there is stored form_state data from a
  312. // previous step, we'll retrieve it so it can be passed on to the form
  313. // processing code.
  314. $check_cache = isset($form_state['input']['form_id']) && $form_state['input']['form_id'] == $form_id && !empty($form_state['input']['form_build_id']);
  315. if ($check_cache) {
  316. $form = form_get_cache($form_state['input']['form_build_id'], $form_state);
  317. }
  318. // If the previous bit of code didn't result in a populated $form object, we
  319. // are hitting the form for the first time and we need to build it from
  320. // scratch.
  321. if (!isset($form)) {
  322. // If we attempted to serve the form from cache, uncacheable $form_state
  323. // keys need to be removed after retrieving and preparing the form, except
  324. // any that were already set prior to retrieving the form.
  325. if ($check_cache) {
  326. $form_state_before_retrieval = $form_state;
  327. }
  328. $form = drupal_retrieve_form($form_id, $form_state);
  329. drupal_prepare_form($form_id, $form, $form_state);
  330. // form_set_cache() removes uncacheable $form_state keys defined in
  331. // form_state_keys_no_cache() in order for multi-step forms to work
  332. // properly. This means that form processing logic for single-step forms
  333. // using $form_state['cache'] may depend on data stored in those keys
  334. // during drupal_retrieve_form()/drupal_prepare_form(), but form
  335. // processing should not depend on whether the form is cached or not, so
  336. // $form_state is adjusted to match what it would be after a
  337. // form_set_cache()/form_get_cache() sequence. These exceptions are
  338. // allowed to survive here:
  339. // - always_process: Does not make sense in conjunction with form caching
  340. // in the first place, since passing form_build_id as a GET parameter is
  341. // not desired.
  342. // - temporary: Any assigned data is expected to survives within the same
  343. // page request.
  344. if ($check_cache) {
  345. $uncacheable_keys = array_flip(array_diff(form_state_keys_no_cache(), array('always_process', 'temporary')));
  346. $form_state = array_diff_key($form_state, $uncacheable_keys);
  347. $form_state += $form_state_before_retrieval;
  348. }
  349. }
  350. // Now that we have a constructed form, process it. This is where:
  351. // - Element #process functions get called to further refine $form.
  352. // - User input, if any, gets incorporated in the #value property of the
  353. // corresponding elements and into $form_state['values'].
  354. // - Validation and submission handlers are called.
  355. // - If this submission is part of a multistep workflow, the form is rebuilt
  356. // to contain the information of the next step.
  357. // - If necessary, the form and form state are cached or re-cached, so that
  358. // appropriate information persists to the next page request.
  359. // All of the handlers in the pipeline receive $form_state by reference and
  360. // can use it to know or update information about the state of the form.
  361. drupal_process_form($form_id, $form, $form_state);
  362. // If this was a successful submission of a single-step form or the last step
  363. // of a multi-step form, then drupal_process_form() issued a redirect to
  364. // another page, or back to this page, but as a new request. Therefore, if
  365. // we're here, it means that this is either a form being viewed initially
  366. // before any user input, or there was a validation error requiring the form
  367. // to be re-displayed, or we're in a multi-step workflow and need to display
  368. // the form's next step. In any case, we have what we need in $form, and can
  369. // return it for rendering.
  370. return $form;
  371. }
  372. /**
  373. * Retrieves default values for the $form_state array.
  374. */
  375. function form_state_defaults() {
  376. return array(
  377. 'rebuild' => FALSE,
  378. 'rebuild_info' => array(),
  379. 'redirect' => NULL,
  380. // @todo 'args' is usually set, so no other default 'build_info' keys are
  381. // appended via += form_state_defaults().
  382. 'build_info' => array(
  383. 'args' => array(),
  384. 'files' => array(),
  385. ),
  386. 'temporary' => array(),
  387. 'submitted' => FALSE,
  388. 'executed' => FALSE,
  389. 'programmed' => FALSE,
  390. 'cache'=> FALSE,
  391. 'method' => 'post',
  392. 'groups' => array(),
  393. 'buttons' => array(),
  394. );
  395. }
  396. /**
  397. * Constructs a new $form from the information in $form_state.
  398. *
  399. * This is the key function for making multi-step forms advance from step to
  400. * step. It is called by drupal_process_form() when all user input processing,
  401. * including calling validation and submission handlers, for the request is
  402. * finished. If a validate or submit handler set $form_state['rebuild'] to TRUE,
  403. * and if other conditions don't preempt a rebuild from happening, then this
  404. * function is called to generate a new $form, the next step in the form
  405. * workflow, to be returned for rendering.
  406. *
  407. * Ajax form submissions are almost always multi-step workflows, so that is one
  408. * common use-case during which form rebuilding occurs. See ajax_form_callback()
  409. * for more information about creating Ajax-enabled forms.
  410. *
  411. * @param $form_id
  412. * The unique string identifying the desired form. If a function
  413. * with that name exists, it is called to build the form array.
  414. * Modules that need to generate the same form (or very similar forms)
  415. * using different $form_ids can implement hook_forms(), which maps
  416. * different $form_id values to the proper form constructor function. Examples
  417. * may be found in node_forms() and search_forms().
  418. * @param $form_state
  419. * A keyed array containing the current state of the form.
  420. * @param $old_form
  421. * (optional) A previously built $form. Used to retain the #build_id and
  422. * #action properties in Ajax callbacks and similar partial form rebuilds. The
  423. * only properties copied from $old_form are the ones which both exist in
  424. * $old_form and for which $form_state['rebuild_info']['copy'][PROPERTY] is
  425. * TRUE. If $old_form is not passed, the entire $form is rebuilt freshly.
  426. * 'rebuild_info' needs to be a separate top-level property next to
  427. * 'build_info', since the contained data must not be cached.
  428. *
  429. * @return
  430. * The newly built form.
  431. *
  432. * @see drupal_process_form()
  433. * @see ajax_form_callback()
  434. */
  435. function drupal_rebuild_form($form_id, &$form_state, $old_form = NULL) {
  436. $form = drupal_retrieve_form($form_id, $form_state);
  437. // If only parts of the form will be returned to the browser (e.g., Ajax or
  438. // RIA clients), re-use the old #build_id to not require client-side code to
  439. // manually update the hidden 'build_id' input element.
  440. // Otherwise, a new #build_id is generated, to not clobber the previous
  441. // build's data in the form cache; also allowing the user to go back to an
  442. // earlier build, make changes, and re-submit.
  443. // @see drupal_prepare_form()
  444. if (isset($old_form['#build_id']) && !empty($form_state['rebuild_info']['copy']['#build_id'])) {
  445. $form['#build_id'] = $old_form['#build_id'];
  446. }
  447. else {
  448. $form['#build_id'] = 'form-' . drupal_hash_base64(uniqid(mt_rand(), TRUE) . mt_rand());
  449. }
  450. // #action defaults to request_uri(), but in case of Ajax and other partial
  451. // rebuilds, the form is submitted to an alternate URL, and the original
  452. // #action needs to be retained.
  453. if (isset($old_form['#action']) && !empty($form_state['rebuild_info']['copy']['#action'])) {
  454. $form['#action'] = $old_form['#action'];
  455. }
  456. drupal_prepare_form($form_id, $form, $form_state);
  457. // Caching is normally done in drupal_process_form(), but what needs to be
  458. // cached is the $form structure before it passes through form_builder(),
  459. // so we need to do it here.
  460. // @todo For Drupal 8, find a way to avoid this code duplication.
  461. if (empty($form_state['no_cache'])) {
  462. form_set_cache($form['#build_id'], $form, $form_state);
  463. }
  464. // Clear out all group associations as these might be different when
  465. // re-rendering the form.
  466. $form_state['groups'] = array();
  467. // Return a fully built form that is ready for rendering.
  468. return form_builder($form_id, $form, $form_state);
  469. }
  470. /**
  471. * Fetches a form from cache.
  472. */
  473. function form_get_cache($form_build_id, &$form_state) {
  474. if ($cached = cache_get('form_' . $form_build_id, 'cache_form')) {
  475. $form = $cached->data;
  476. global $user;
  477. if ((isset($form['#cache_token']) && drupal_valid_token($form['#cache_token'])) || (!isset($form['#cache_token']) && !$user->uid)) {
  478. if ($cached = cache_get('form_state_' . $form_build_id, 'cache_form')) {
  479. // Re-populate $form_state for subsequent rebuilds.
  480. $form_state = $cached->data + $form_state;
  481. // If the original form is contained in include files, load the files.
  482. // @see form_load_include()
  483. $form_state['build_info'] += array('files' => array());
  484. foreach ($form_state['build_info']['files'] as $file) {
  485. if (is_array($file)) {
  486. $file += array('type' => 'inc', 'name' => $file['module']);
  487. module_load_include($file['type'], $file['module'], $file['name']);
  488. }
  489. elseif (file_exists($file)) {
  490. require_once DRUPAL_ROOT . '/' . $file;
  491. }
  492. }
  493. }
  494. return $form;
  495. }
  496. }
  497. }
  498. /**
  499. * Stores a form in the cache.
  500. */
  501. function form_set_cache($form_build_id, $form, $form_state) {
  502. // 6 hours cache life time for forms should be plenty.
  503. $expire = 21600;
  504. // Cache form structure.
  505. if (isset($form)) {
  506. if ($GLOBALS['user']->uid) {
  507. $form['#cache_token'] = drupal_get_token();
  508. }
  509. cache_set('form_' . $form_build_id, $form, 'cache_form', REQUEST_TIME + $expire);
  510. }
  511. // Cache form state.
  512. if ($data = array_diff_key($form_state, array_flip(form_state_keys_no_cache()))) {
  513. cache_set('form_state_' . $form_build_id, $data, 'cache_form', REQUEST_TIME + $expire);
  514. }
  515. }
  516. /**
  517. * Returns an array of $form_state keys that shouldn't be cached.
  518. */
  519. function form_state_keys_no_cache() {
  520. return array(
  521. // Public properties defined by form constructors and form handlers.
  522. 'always_process',
  523. 'must_validate',
  524. 'rebuild',
  525. 'rebuild_info',
  526. 'redirect',
  527. 'no_redirect',
  528. 'temporary',
  529. // Internal properties defined by form processing.
  530. 'buttons',
  531. 'triggering_element',
  532. 'clicked_button',
  533. 'complete form',
  534. 'groups',
  535. 'input',
  536. 'method',
  537. 'submit_handlers',
  538. 'submitted',
  539. 'executed',
  540. 'validate_handlers',
  541. 'values',
  542. );
  543. }
  544. /**
  545. * Ensures an include file is loaded whenever the form is processed.
  546. *
  547. * Example:
  548. * @code
  549. * // Load node.admin.inc from Node module.
  550. * form_load_include($form_state, 'inc', 'node', 'node.admin');
  551. * @endcode
  552. *
  553. * Use this function instead of module_load_include() from inside a form
  554. * constructor or any form processing logic as it ensures that the include file
  555. * is loaded whenever the form is processed. In contrast to using
  556. * module_load_include() directly, form_load_include() makes sure the include
  557. * file is correctly loaded also if the form is cached.
  558. *
  559. * @param $form_state
  560. * The current state of the form.
  561. * @param $type
  562. * The include file's type (file extension).
  563. * @param $module
  564. * The module to which the include file belongs.
  565. * @param $name
  566. * (optional) The base file name (without the $type extension). If omitted,
  567. * $module is used; i.e., resulting in "$module.$type" by default.
  568. *
  569. * @return
  570. * The filepath of the loaded include file, or FALSE if the include file was
  571. * not found or has been loaded already.
  572. *
  573. * @see module_load_include()
  574. */
  575. function form_load_include(&$form_state, $type, $module, $name = NULL) {
  576. if (!isset($name)) {
  577. $name = $module;
  578. }
  579. if (!isset($form_state['build_info']['files']["$module:$name.$type"])) {
  580. // Only add successfully included files to the form state.
  581. if ($result = module_load_include($type, $module, $name)) {
  582. $form_state['build_info']['files']["$module:$name.$type"] = array(
  583. 'type' => $type,
  584. 'module' => $module,
  585. 'name' => $name,
  586. );
  587. return $result;
  588. }
  589. }
  590. return FALSE;
  591. }
  592. /**
  593. * Retrieves, populates, and processes a form.
  594. *
  595. * This function allows you to supply values for form elements and submit a
  596. * form for processing. Compare to drupal_get_form(), which also builds and
  597. * processes a form, but does not allow you to supply values.
  598. *
  599. * There is no return value, but you can check to see if there are errors
  600. * by calling form_get_errors().
  601. *
  602. * @param $form_id
  603. * The unique string identifying the desired form. If a function
  604. * with that name exists, it is called to build the form array.
  605. * Modules that need to generate the same form (or very similar forms)
  606. * using different $form_ids can implement hook_forms(), which maps
  607. * different $form_id values to the proper form constructor function. Examples
  608. * may be found in node_forms() and search_forms().
  609. * @param $form_state
  610. * A keyed array containing the current state of the form. Most important is
  611. * the $form_state['values'] collection, a tree of data used to simulate the
  612. * incoming $_POST information from a user's form submission. If a key is not
  613. * filled in $form_state['values'], then the default value of the respective
  614. * element is used. To submit an unchecked checkbox or other control that
  615. * browsers submit by not having a $_POST entry, include the key, but set the
  616. * value to NULL.
  617. * @param ...
  618. * Any additional arguments are passed on to the functions called by
  619. * drupal_form_submit(), including the unique form constructor function.
  620. * For example, the node_edit form requires that a node object be passed
  621. * in here when it is called. Arguments that need to be passed by reference
  622. * should not be included here, but rather placed directly in the $form_state
  623. * build info array so that the reference can be preserved. For example, a
  624. * form builder function with the following signature:
  625. * @code
  626. * function mymodule_form($form, &$form_state, &$object) {
  627. * }
  628. * @endcode
  629. * would be called via drupal_form_submit() as follows:
  630. * @code
  631. * $form_state['values'] = $my_form_values;
  632. * $form_state['build_info']['args'] = array(&$object);
  633. * drupal_form_submit('mymodule_form', $form_state);
  634. * @endcode
  635. * For example:
  636. * @code
  637. * // register a new user
  638. * $form_state = array();
  639. * $form_state['values']['name'] = 'robo-user';
  640. * $form_state['values']['mail'] = 'robouser@example.com';
  641. * $form_state['values']['pass']['pass1'] = 'password';
  642. * $form_state['values']['pass']['pass2'] = 'password';
  643. * $form_state['values']['op'] = t('Create new account');
  644. * drupal_form_submit('user_register_form', $form_state);
  645. * @endcode
  646. */
  647. function drupal_form_submit($form_id, &$form_state) {
  648. if (!isset($form_state['build_info']['args'])) {
  649. $args = func_get_args();
  650. array_shift($args);
  651. array_shift($args);
  652. $form_state['build_info']['args'] = $args;
  653. }
  654. // Merge in default values.
  655. $form_state += form_state_defaults();
  656. // Populate $form_state['input'] with the submitted values before retrieving
  657. // the form, to be consistent with what drupal_build_form() does for
  658. // non-programmatic submissions (form builder functions may expect it to be
  659. // there).
  660. $form_state['input'] = $form_state['values'];
  661. $form_state['programmed'] = TRUE;
  662. $form = drupal_retrieve_form($form_id, $form_state);
  663. // Programmed forms are always submitted.
  664. $form_state['submitted'] = TRUE;
  665. // Reset form validation.
  666. $form_state['must_validate'] = TRUE;
  667. form_clear_error();
  668. drupal_prepare_form($form_id, $form, $form_state);
  669. drupal_process_form($form_id, $form, $form_state);
  670. }
  671. /**
  672. * Retrieves the structured array that defines a given form.
  673. *
  674. * @param $form_id
  675. * The unique string identifying the desired form. If a function
  676. * with that name exists, it is called to build the form array.
  677. * Modules that need to generate the same form (or very similar forms)
  678. * using different $form_ids can implement hook_forms(), which maps
  679. * different $form_id values to the proper form constructor function.
  680. * @param $form_state
  681. * A keyed array containing the current state of the form, including the
  682. * additional arguments to drupal_get_form() or drupal_form_submit() in the
  683. * 'args' component of the array.
  684. */
  685. function drupal_retrieve_form($form_id, &$form_state) {
  686. $forms = &drupal_static(__FUNCTION__);
  687. // Record the $form_id.
  688. $form_state['build_info']['form_id'] = $form_id;
  689. // Record the filepath of the include file containing the original form, so
  690. // the form builder callbacks can be loaded when the form is being rebuilt
  691. // from cache on a different path (such as 'system/ajax'). See
  692. // form_get_cache(). Don't do this in maintenance mode as Drupal may not be
  693. // fully bootstrapped (i.e. during installation) in which case
  694. // menu_get_item() is not available.
  695. if (!isset($form_state['build_info']['files']['menu']) && !defined('MAINTENANCE_MODE')) {
  696. $item = menu_get_item();
  697. if (!empty($item['include_file'])) {
  698. // Do not use form_load_include() here, as the file is already loaded.
  699. // Anyway, form_get_cache() is able to handle filepaths too.
  700. $form_state['build_info']['files']['menu'] = $item['include_file'];
  701. }
  702. }
  703. // We save two copies of the incoming arguments: one for modules to use
  704. // when mapping form ids to constructor functions, and another to pass to
  705. // the constructor function itself.
  706. $args = $form_state['build_info']['args'];
  707. // We first check to see if there's a function named after the $form_id.
  708. // If there is, we simply pass the arguments on to it to get the form.
  709. if (!function_exists($form_id)) {
  710. // In cases where many form_ids need to share a central constructor function,
  711. // such as the node editing form, modules can implement hook_forms(). It
  712. // maps one or more form_ids to the correct constructor functions.
  713. //
  714. // We cache the results of that hook to save time, but that only works
  715. // for modules that know all their form_ids in advance. (A module that
  716. // adds a small 'rate this comment' form to each comment in a list
  717. // would need a unique form_id for each one, for example.)
  718. //
  719. // So, we call the hook if $forms isn't yet populated, OR if it doesn't
  720. // yet have an entry for the requested form_id.
  721. if (!isset($forms) || !isset($forms[$form_id])) {
  722. $forms = module_invoke_all('forms', $form_id, $args);
  723. }
  724. $form_definition = $forms[$form_id];
  725. if (isset($form_definition['callback arguments'])) {
  726. $args = array_merge($form_definition['callback arguments'], $args);
  727. }
  728. if (isset($form_definition['callback'])) {
  729. $callback = $form_definition['callback'];
  730. $form_state['build_info']['base_form_id'] = $callback;
  731. }
  732. // In case $form_state['wrapper_callback'] is not defined already, we also
  733. // allow hook_forms() to define one.
  734. if (!isset($form_state['wrapper_callback']) && isset($form_definition['wrapper_callback'])) {
  735. $form_state['wrapper_callback'] = $form_definition['wrapper_callback'];
  736. }
  737. }
  738. $form = array();
  739. // We need to pass $form_state by reference in order for forms to modify it,
  740. // since call_user_func_array() requires that referenced variables are passed
  741. // explicitly.
  742. $args = array_merge(array($form, &$form_state), $args);
  743. // When the passed $form_state (not using drupal_get_form()) defines a
  744. // 'wrapper_callback', then it requests to invoke a separate (wrapping) form
  745. // builder function to pre-populate the $form array with form elements, which
  746. // the actual form builder function ($callback) expects. This allows for
  747. // pre-populating a form with common elements for certain forms, such as
  748. // back/next/save buttons in multi-step form wizards. See drupal_build_form().
  749. if (isset($form_state['wrapper_callback']) && function_exists($form_state['wrapper_callback'])) {
  750. $form = call_user_func_array($form_state['wrapper_callback'], $args);
  751. // Put the prepopulated $form into $args.
  752. $args[0] = $form;
  753. }
  754. // If $callback was returned by a hook_forms() implementation, call it.
  755. // Otherwise, call the function named after the form id.
  756. $form = call_user_func_array(isset($callback) ? $callback : $form_id, $args);
  757. $form['#form_id'] = $form_id;
  758. return $form;
  759. }
  760. /**
  761. * Processes a form submission.
  762. *
  763. * This function is the heart of form API. The form gets built, validated and in
  764. * appropriate cases, submitted and rebuilt.
  765. *
  766. * @param $form_id
  767. * The unique string identifying the current form.
  768. * @param $form
  769. * An associative array containing the structure of the form.
  770. * @param $form_state
  771. * A keyed array containing the current state of the form. This
  772. * includes the current persistent storage data for the form, and
  773. * any data passed along by earlier steps when displaying a
  774. * multi-step form. Additional information, like the sanitized $_POST
  775. * data, is also accumulated here.
  776. */
  777. function drupal_process_form($form_id, &$form, &$form_state) {
  778. $form_state['values'] = array();
  779. // With $_GET, these forms are always submitted if requested.
  780. if ($form_state['method'] == 'get' && !empty($form_state['always_process'])) {
  781. if (!isset($form_state['input']['form_build_id'])) {
  782. $form_state['input']['form_build_id'] = $form['#build_id'];
  783. }
  784. if (!isset($form_state['input']['form_id'])) {
  785. $form_state['input']['form_id'] = $form_id;
  786. }
  787. if (!isset($form_state['input']['form_token']) && isset($form['#token'])) {
  788. $form_state['input']['form_token'] = drupal_get_token($form['#token']);
  789. }
  790. }
  791. // form_builder() finishes building the form by calling element #process
  792. // functions and mapping user input, if any, to #value properties, and also
  793. // storing the values in $form_state['values']. We need to retain the
  794. // unprocessed $form in case it needs to be cached.
  795. $unprocessed_form = $form;
  796. $form = form_builder($form_id, $form, $form_state);
  797. // Only process the input if we have a correct form submission.
  798. if ($form_state['process_input']) {
  799. drupal_validate_form($form_id, $form, $form_state);
  800. // drupal_html_id() maintains a cache of element IDs it has seen,
  801. // so it can prevent duplicates. We want to be sure we reset that
  802. // cache when a form is processed, so scenarios that result in
  803. // the form being built behind the scenes and again for the
  804. // browser don't increment all the element IDs needlessly.
  805. if (!form_get_errors()) {
  806. // In case of errors, do not break HTML IDs of other forms.
  807. drupal_static_reset('drupal_html_id');
  808. }
  809. if ($form_state['submitted'] && !form_get_errors() && !$form_state['rebuild']) {
  810. // Execute form submit handlers.
  811. form_execute_handlers('submit', $form, $form_state);
  812. // We'll clear out the cached copies of the form and its stored data
  813. // here, as we've finished with them. The in-memory copies are still
  814. // here, though.
  815. if (!variable_get('cache', 0) && !empty($form_state['values']['form_build_id'])) {
  816. cache_clear_all('form_' . $form_state['values']['form_build_id'], 'cache_form');
  817. cache_clear_all('form_state_' . $form_state['values']['form_build_id'], 'cache_form');
  818. }
  819. // If batches were set in the submit handlers, we process them now,
  820. // possibly ending execution. We make sure we do not react to the batch
  821. // that is already being processed (if a batch operation performs a
  822. // drupal_form_submit).
  823. if ($batch =& batch_get() && !isset($batch['current_set'])) {
  824. // Store $form_state information in the batch definition.
  825. // We need the full $form_state when either:
  826. // - Some submit handlers were saved to be called during batch
  827. // processing. See form_execute_handlers().
  828. // - The form is multistep.
  829. // In other cases, we only need the information expected by
  830. // drupal_redirect_form().
  831. if ($batch['has_form_submits'] || !empty($form_state['rebuild'])) {
  832. $batch['form_state'] = $form_state;
  833. }
  834. else {
  835. $batch['form_state'] = array_intersect_key($form_state, array_flip(array('programmed', 'rebuild', 'storage', 'no_redirect', 'redirect')));
  836. }
  837. $batch['progressive'] = !$form_state['programmed'];
  838. batch_process();
  839. // Execution continues only for programmatic forms.
  840. // For 'regular' forms, we get redirected to the batch processing
  841. // page. Form redirection will be handled in _batch_finished(),
  842. // after the batch is processed.
  843. }
  844. // Set a flag to indicate the the form has been processed and executed.
  845. $form_state['executed'] = TRUE;
  846. // Redirect the form based on values in $form_state.
  847. drupal_redirect_form($form_state);
  848. }
  849. // Don't rebuild or cache form submissions invoked via drupal_form_submit().
  850. if (!empty($form_state['programmed'])) {
  851. return;
  852. }
  853. // If $form_state['rebuild'] has been set and input has been processed
  854. // without validation errors, we are in a multi-step workflow that is not
  855. // yet complete. A new $form needs to be constructed based on the changes
  856. // made to $form_state during this request. Normally, a submit handler sets
  857. // $form_state['rebuild'] if a fully executed form requires another step.
  858. // However, for forms that have not been fully executed (e.g., Ajax
  859. // submissions triggered by non-buttons), there is no submit handler to set
  860. // $form_state['rebuild']. It would not make sense to redisplay the
  861. // identical form without an error for the user to correct, so we also
  862. // rebuild error-free non-executed forms, regardless of
  863. // $form_state['rebuild'].
  864. // @todo D8: Simplify this logic; considering Ajax and non-HTML front-ends,
  865. // along with element-level #submit properties, it makes no sense to have
  866. // divergent form execution based on whether the triggering element has
  867. // #executes_submit_callback set to TRUE.
  868. if (($form_state['rebuild'] || !$form_state['executed']) && !form_get_errors()) {
  869. // Form building functions (e.g., _form_builder_handle_input_element())
  870. // may use $form_state['rebuild'] to determine if they are running in the
  871. // context of a rebuild, so ensure it is set.
  872. $form_state['rebuild'] = TRUE;
  873. $form = drupal_rebuild_form($form_id, $form_state, $form);
  874. }
  875. }
  876. // After processing the form, the form builder or a #process callback may
  877. // have set $form_state['cache'] to indicate that the form and form state
  878. // shall be cached. But the form may only be cached if the 'no_cache' property
  879. // is not set to TRUE. Only cache $form as it was prior to form_builder(),
  880. // because form_builder() must run for each request to accommodate new user
  881. // input. Rebuilt forms are not cached here, because drupal_rebuild_form()
  882. // already takes care of that.
  883. if (!$form_state['rebuild'] && $form_state['cache'] && empty($form_state['no_cache'])) {
  884. form_set_cache($form['#build_id'], $unprocessed_form, $form_state);
  885. }
  886. }
  887. /**
  888. * Prepares a structured form array.
  889. *
  890. * Adds required elements, executes any hook_form_alter functions, and
  891. * optionally inserts a validation token to prevent tampering.
  892. *
  893. * @param $form_id
  894. * A unique string identifying the form for validation, submission,
  895. * theming, and hook_form_alter functions.
  896. * @param $form
  897. * An associative array containing the structure of the form.
  898. * @param $form_state
  899. * A keyed array containing the current state of the form. Passed
  900. * in here so that hook_form_alter() calls can use it, as well.
  901. */
  902. function drupal_prepare_form($form_id, &$form, &$form_state) {
  903. global $user;
  904. $form['#type'] = 'form';
  905. $form_state['programmed'] = isset($form_state['programmed']) ? $form_state['programmed'] : FALSE;
  906. // Fix the form method, if it is 'get' in $form_state, but not in $form.
  907. if ($form_state['method'] == 'get' && !isset($form['#method'])) {
  908. $form['#method'] = 'get';
  909. }
  910. // Generate a new #build_id for this form, if none has been set already. The
  911. // form_build_id is used as key to cache a particular build of the form. For
  912. // multi-step forms, this allows the user to go back to an earlier build, make
  913. // changes, and re-submit.
  914. // @see drupal_build_form()
  915. // @see drupal_rebuild_form()
  916. if (!isset($form['#build_id'])) {
  917. $form['#build_id'] = 'form-' . drupal_hash_base64(uniqid(mt_rand(), TRUE) . mt_rand());
  918. }
  919. $form['form_build_id'] = array(
  920. '#type' => 'hidden',
  921. '#value' => $form['#build_id'],
  922. '#id' => $form['#build_id'],
  923. '#name' => 'form_build_id',
  924. // Form processing and validation requires this value, so ensure the
  925. // submitted form value appears literally, regardless of custom #tree
  926. // and #parents being set elsewhere.
  927. '#parents' => array('form_build_id'),
  928. );
  929. // Add a token, based on either #token or form_id, to any form displayed to
  930. // authenticated users. This ensures that any submitted form was actually
  931. // requested previously by the user and protects against cross site request
  932. // forgeries.
  933. // This does not apply to programmatically submitted forms. Furthermore, since
  934. // tokens are session-bound and forms displayed to anonymous users are very
  935. // likely cached, we cannot assign a token for them.
  936. // During installation, there is no $user yet.
  937. if (!empty($user->uid) && !$form_state['programmed']) {
  938. // Form constructors may explicitly set #token to FALSE when cross site
  939. // request forgery is irrelevant to the form, such as search forms.
  940. if (isset($form['#token']) && $form['#token'] === FALSE) {
  941. unset($form['#token']);
  942. }
  943. // Otherwise, generate a public token based on the form id.
  944. else {
  945. $form['#token'] = $form_id;
  946. $form['form_token'] = array(
  947. '#id' => drupal_html_id('edit-' . $form_id . '-form-token'),
  948. '#type' => 'token',
  949. '#default_value' => drupal_get_token($form['#token']),
  950. // Form processing and validation requires this value, so ensure the
  951. // submitted form value appears literally, regardless of custom #tree
  952. // and #parents being set elsewhere.
  953. '#parents' => array('form_token'),
  954. );
  955. }
  956. }
  957. if (isset($form_id)) {
  958. $form['form_id'] = array(
  959. '#type' => 'hidden',
  960. '#value' => $form_id,
  961. '#id' => drupal_html_id("edit-$form_id"),
  962. // Form processing and validation requires this value, so ensure the
  963. // submitted form value appears literally, regardless of custom #tree
  964. // and #parents being set elsewhere.
  965. '#parents' => array('form_id'),
  966. );
  967. }
  968. if (!isset($form['#id'])) {
  969. $form['#id'] = drupal_html_id($form_id);
  970. }
  971. $form += element_info('form');
  972. $form += array('#tree' => FALSE, '#parents' => array());
  973. if (!isset($form['#validate'])) {
  974. // Ensure that modules can rely on #validate being set.
  975. $form['#validate'] = array();
  976. // Check for a handler specific to $form_id.
  977. if (function_exists($form_id . '_validate')) {
  978. $form['#validate'][] = $form_id . '_validate';
  979. }
  980. // Otherwise check whether this is a shared form and whether there is a
  981. // handler for the shared $form_id.
  982. elseif (isset($form_state['build_info']['base_form_id']) && function_exists($form_state['build_info']['base_form_id'] . '_validate')) {
  983. $form['#validate'][] = $form_state['build_info']['base_form_id'] . '_validate';
  984. }
  985. }
  986. if (!isset($form['#submit'])) {
  987. // Ensure that modules can rely on #submit being set.
  988. $form['#submit'] = array();
  989. // Check for a handler specific to $form_id.
  990. if (function_exists($form_id . '_submit')) {
  991. $form['#submit'][] = $form_id . '_submit';
  992. }
  993. // Otherwise check whether this is a shared form and whether there is a
  994. // handler for the shared $form_id.
  995. elseif (isset($form_state['build_info']['base_form_id']) && function_exists($form_state['build_info']['base_form_id'] . '_submit')) {
  996. $form['#submit'][] = $form_state['build_info']['base_form_id'] . '_submit';
  997. }
  998. }
  999. // If no #theme has been set, automatically apply theme suggestions.
  1000. // theme_form() itself is in #theme_wrappers and not #theme. Therefore, the
  1001. // #theme function only has to care for rendering the inner form elements,
  1002. // not the form itself.
  1003. if (!isset($form['#theme'])) {
  1004. $form['#theme'] = array($form_id);
  1005. if (isset($form_state['build_info']['base_form_id'])) {
  1006. $form['#theme'][] = $form_state['build_info']['base_form_id'];
  1007. }
  1008. }
  1009. // Invoke hook_form_alter(), hook_form_BASE_FORM_ID_alter(), and
  1010. // hook_form_FORM_ID_alter() implementations.
  1011. $hooks = array('form');
  1012. if (isset($form_state['build_info']['base_form_id'])) {
  1013. $hooks[] = 'form_' . $form_state['build_info']['base_form_id'];
  1014. }
  1015. $hooks[] = 'form_' . $form_id;
  1016. drupal_alter($hooks, $form, $form_state, $form_id);
  1017. }
  1018. /**
  1019. * Validates user-submitted form data in the $form_state array.
  1020. *
  1021. * @param $form_id
  1022. * A unique string identifying the form for validation, submission,
  1023. * theming, and hook_form_alter functions.
  1024. * @param $form
  1025. * An associative array containing the structure of the form, which is passed
  1026. * by reference. Form validation handlers are able to alter the form structure
  1027. * (like #process and #after_build callbacks during form building) in case of
  1028. * a validation error. If a validation handler alters the form structure, it
  1029. * is responsible for validating the values of changed form elements in
  1030. * $form_state['values'] to prevent form submit handlers from receiving
  1031. * unvalidated values.
  1032. * @param $form_state
  1033. * A keyed array containing the current state of the form. The current
  1034. * user-submitted data is stored in $form_state['values'], though
  1035. * form validation functions are passed an explicit copy of the
  1036. * values for the sake of simplicity. Validation handlers can also use
  1037. * $form_state to pass information on to submit handlers. For example:
  1038. * $form_state['data_for_submission'] = $data;
  1039. * This technique is useful when validation requires file parsing,
  1040. * web service requests, or other expensive requests that should
  1041. * not be repeated in the submission step.
  1042. */
  1043. function drupal_validate_form($form_id, &$form, &$form_state) {
  1044. $validated_forms = &drupal_static(__FUNCTION__, array());
  1045. if (isset($validated_forms[$form_id]) && empty($form_state['must_validate'])) {
  1046. return;
  1047. }
  1048. // If the session token was set by drupal_prepare_form(), ensure that it
  1049. // matches the current user's session.
  1050. if (isset($form['#token'])) {
  1051. if (!drupal_valid_token($form_state['values']['form_token'], $form['#token'])) {
  1052. $path = current_path();
  1053. $query = drupal_get_query_parameters();
  1054. $url = url($path, array('query' => $query));
  1055. // Setting this error will cause the form to fail validation.
  1056. form_set_error('form_token', t('The form has become outdated. Copy any unsaved work in the form below and then <a href="@link">reload this page</a>.', array('@link' => $url)));
  1057. }
  1058. }
  1059. _form_validate($form, $form_state, $form_id);
  1060. $validated_forms[$form_id] = TRUE;
  1061. // If validation errors are limited then remove any non validated form values,
  1062. // so that only values that passed validation are left for submit callbacks.
  1063. if (isset($form_state['triggering_element']['#limit_validation_errors']) && $form_state['triggering_element']['#limit_validation_errors'] !== FALSE) {
  1064. $values = array();
  1065. foreach ($form_state['triggering_element']['#limit_validation_errors'] as $section) {
  1066. // If the section exists within $form_state['values'], even if the value
  1067. // is NULL, copy it to $values.
  1068. $section_exists = NULL;
  1069. $value = drupal_array_get_nested_value($form_state['values'], $section, $section_exists);
  1070. if ($section_exists) {
  1071. drupal_array_set_nested_value($values, $section, $value);
  1072. }
  1073. }
  1074. // A button's #value does not require validation, so for convenience we
  1075. // allow the value of the clicked button to be retained in its normal
  1076. // $form_state['values'] locations, even if these locations are not included
  1077. // in #limit_validation_errors.
  1078. if (isset($form_state['triggering_element']['#button_type'])) {
  1079. $button_value = $form_state['triggering_element']['#value'];
  1080. // Like all input controls, the button value may be in the location
  1081. // dictated by #parents. If it is, copy it to $values, but do not override
  1082. // what may already be in $values.
  1083. $parents = $form_state['triggering_element']['#parents'];
  1084. if (!drupal_array_nested_key_exists($values, $parents) && drupal_array_get_nested_value($form_state['values'], $parents) === $button_value) {
  1085. drupal_array_set_nested_value($values, $parents, $button_value);
  1086. }
  1087. // Additionally, form_builder() places the button value in
  1088. // $form_state['values'][BUTTON_NAME]. If it's still there, after
  1089. // validation handlers have run, copy it to $values, but do not override
  1090. // what may already be in $values.
  1091. $name = $form_state['triggering_element']['#name'];
  1092. if (!isset($values[$name]) && isset($form_state['values'][$name]) && $form_state['values'][$name] === $button_value) {
  1093. $values[$name] = $button_value;
  1094. }
  1095. }
  1096. $form_state['values'] = $values;
  1097. }
  1098. }
  1099. /**
  1100. * Redirects the user to a URL after a form has been processed.
  1101. *
  1102. * After a form is submitted and processed, normally the user should be
  1103. * redirected to a new destination page. This function figures out what that
  1104. * destination should be, based on the $form_state array and the 'destination'
  1105. * query string in the request URL, and redirects the user there.
  1106. *
  1107. * Usually (for exceptions, see below) $form_state['redirect'] determines where
  1108. * to redirect the user. This can be set either to a string (the path to
  1109. * redirect to), or an array of arguments for drupal_goto(). If
  1110. * $form_state['redirect'] is missing, the user is usually (again, see below for
  1111. * exceptions) redirected back to the page they came from, where they should see
  1112. * a fresh, unpopulated copy of the form.
  1113. *
  1114. * Here is an example of how to set up a form to redirect to the path 'node':
  1115. * @code
  1116. * $form_state['redirect'] = 'node';
  1117. * @endcode
  1118. * And here is an example of how to redirect to 'node/123?foo=bar#baz':
  1119. * @code
  1120. * $form_state['redirect'] = array(
  1121. * 'node/123',
  1122. * array(
  1123. * 'query' => array(
  1124. * 'foo' => 'bar',
  1125. * ),
  1126. * 'fragment' => 'baz',
  1127. * ),
  1128. * );
  1129. * @endcode
  1130. *
  1131. * There are several exceptions to the "usual" behavior described above:
  1132. * - If $form_state['programmed'] is TRUE, the form submission was usually
  1133. * invoked via drupal_form_submit(), so any redirection would break the script
  1134. * that invoked drupal_form_submit() and no redirection is done.
  1135. * - If $form_state['rebuild'] is TRUE, the form is being rebuilt, and no
  1136. * redirection is done.
  1137. * - If $form_state['no_redirect'] is TRUE, redirection is disabled. This is
  1138. * set, for instance, by ajax_get_form() to prevent redirection in Ajax
  1139. * callbacks. $form_state['no_redirect'] should never be set or altered by
  1140. * form builder functions or form validation/submit handlers.
  1141. * - If $form_state['redirect'] is set to FALSE, redirection is disabled.
  1142. * - If none of the above conditions has prevented redirection, then the
  1143. * redirect is accomplished by calling drupal_goto(), passing in the value of
  1144. * $form_state['redirect'] if it is set, or the current path if it is
  1145. * not. drupal_goto() preferentially uses the value of $_GET['destination']
  1146. * (the 'destination' URL query string) if it is present, so this will
  1147. * override any values set by $form_state['redirect']. Note that during
  1148. * installation, install_goto() is called in place of drupal_goto().
  1149. *
  1150. * @param $form_state
  1151. * An associative array containing the current state of the form.
  1152. *
  1153. * @see drupal_process_form()
  1154. * @see drupal_build_form()
  1155. */
  1156. function drupal_redirect_form($form_state) {
  1157. // Skip redirection for form submissions invoked via drupal_form_submit().
  1158. if (!empty($form_state['programmed'])) {
  1159. return;
  1160. }
  1161. // Skip redirection if rebuild is activated.
  1162. if (!empty($form_state['rebuild'])) {
  1163. return;
  1164. }
  1165. // Skip redirection if it was explicitly disallowed.
  1166. if (!empty($form_state['no_redirect'])) {
  1167. return;
  1168. }
  1169. // Only invoke drupal_goto() if redirect value was not set to FALSE.
  1170. if (!isset($form_state['redirect']) || $form_state['redirect'] !== FALSE) {
  1171. if (isset($form_state['redirect'])) {
  1172. if (is_array($form_state['redirect'])) {
  1173. call_user_func_array('drupal_goto', $form_state['redirect']);
  1174. }
  1175. else {
  1176. // This function can be called from the installer, which guarantees
  1177. // that $redirect will always be a string, so catch that case here
  1178. // and use the appropriate redirect function.
  1179. $function = drupal_installation_attempted() ? 'install_goto' : 'drupal_goto';
  1180. $function($form_state['redirect']);
  1181. }
  1182. }
  1183. drupal_goto(current_path(), array('query' => drupal_get_query_parameters()));
  1184. }
  1185. }
  1186. /**
  1187. * Performs validation on form elements.
  1188. *
  1189. * First ensures required fields are completed, #maxlength is not exceeded, and
  1190. * selected options were in the list of options given to the user. Then calls
  1191. * user-defined validators.
  1192. *
  1193. * @param $elements
  1194. * An associative array containing the structure of the form.
  1195. * @param $form_state
  1196. * A keyed array containing the current state of the form. The current
  1197. * user-submitted data is stored in $form_state['values'], though
  1198. * form validation functions are passed an explicit copy of the
  1199. * values for the sake of simplicity. Validation handlers can also
  1200. * $form_state to pass information on to submit handlers. For example:
  1201. * $form_state['data_for_submission'] = $data;
  1202. * This technique is useful when validation requires file parsing,
  1203. * web service requests, or other expensive requests that should
  1204. * not be repeated in the submission step.
  1205. * @param $form_id
  1206. * A unique string identifying the form for validation, submission,
  1207. * theming, and hook_form_alter functions.
  1208. */
  1209. function _form_validate(&$elements, &$form_state, $form_id = NULL) {
  1210. // Also used in the installer, pre-database setup.
  1211. $t = get_t();
  1212. // Recurse through all children.
  1213. foreach (element_children($elements) as $key) {
  1214. if (isset($elements[$key]) && $elements[$key]) {
  1215. _form_validate($elements[$key], $form_state);
  1216. }
  1217. }
  1218. // Validate the current input.
  1219. if (!isset($elements['#validated']) || !$elements['#validated']) {
  1220. // The following errors are always shown.
  1221. if (isset($elements['#needs_validation'])) {
  1222. // Verify that the value is not longer than #maxlength.
  1223. if (isset($elements['#maxlength']) && drupal_strlen($elements['#value']) > $elements['#maxlength']) {
  1224. 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']))));
  1225. }
  1226. if (isset($elements['#options']) && isset($elements['#value'])) {
  1227. if ($elements['#type'] == 'select') {
  1228. $options = form_options_flatten($elements['#options']);
  1229. }
  1230. else {
  1231. $options = $elements['#options'];
  1232. }
  1233. if (is_array($elements['#value'])) {
  1234. $value = in_array($elements['#type'], array('checkboxes', 'tableselect')) ? array_keys($elements['#value']) : $elements['#value'];
  1235. foreach ($value as $v) {
  1236. if (!isset($options[$v])) {
  1237. form_error($elements, $t('An illegal choice has been detected. Please contact the site administrator.'));
  1238. watchdog('form', 'Illegal choice %choice in !name element.', array('%choice' => $v, '!name' => empty($elements['#title']) ? $elements['#parents'][0] : $elements['#title']), WATCHDOG_ERROR);
  1239. }
  1240. }
  1241. }
  1242. // Non-multiple select fields always have a value in HTML. If the user
  1243. // does not change the form, it will be the value of the first option.
  1244. // Because of this, form validation for the field will almost always
  1245. // pass, even if the user did not select anything. To work around this
  1246. // browser behavior, required select fields without a #default_value get
  1247. // an additional, first empty option. In case the submitted value is
  1248. // identical to the empty option's value, we reset the element's value
  1249. // to NULL to trigger the regular #required handling below.
  1250. // @see form_process_select()
  1251. elseif ($elements['#type'] == 'select' && !$elements['#multiple'] && $elements['#required'] && !isset($elements['#default_value']) && $elements['#value'] === $elements['#empty_value']) {
  1252. $elements['#value'] = NULL;
  1253. form_set_value($elements, NULL, $form_state);
  1254. }
  1255. elseif (!isset($options[$elements['#value']])) {
  1256. form_error($elements, $t('An illegal choice has been detected. Please contact the site administrator.'));
  1257. watchdog('form', 'Illegal choice %choice in %name element.', array('%choice' => $elements['#value'], '%name' => empty($elements['#title']) ? $elements['#parents'][0] : $elements['#title']), WATCHDOG_ERROR);
  1258. }
  1259. }
  1260. }
  1261. // While this element is being validated, it may be desired that some calls
  1262. // to form_set_error() be suppressed and not result in a form error, so
  1263. // that a button that implements low-risk functionality (such as "Previous"
  1264. // or "Add more") that doesn't require all user input to be valid can still
  1265. // have its submit handlers triggered. The triggering element's
  1266. // #limit_validation_errors property contains the information for which
  1267. // errors are needed, and all other errors are to be suppressed. The
  1268. // #limit_validation_errors property is ignored if submit handlers will run,
  1269. // but the element doesn't have a #submit property, because it's too large a
  1270. // security risk to have any invalid user input when executing form-level
  1271. // submit handlers.
  1272. if (isset($form_state['triggering_element']['#limit_validation_errors']) && ($form_state['triggering_element']['#limit_validation_errors'] !== FALSE) && !($form_state['submitted'] && !isset($form_state['triggering_element']['#submit']))) {
  1273. form_set_error(NULL, '', $form_state['triggering_element']['#limit_validation_errors']);
  1274. }
  1275. // If submit handlers won't run (due to the submission having been triggered
  1276. // by an element whose #executes_submit_callback property isn't TRUE), then
  1277. // it's safe to suppress all validation errors, and we do so by default,
  1278. // which is particularly useful during an Ajax submission triggered by a
  1279. // non-button. An element can override this default by setting the
  1280. // #limit_validation_errors property. For button element types,
  1281. // #limit_validation_errors defaults to FALSE (via system_element_info()),
  1282. // so that full validation is their default behavior.
  1283. elseif (isset($form_state['triggering_element']) && !isset($form_state['triggering_element']['#limit_validation_errors']) && !$form_state['submitted']) {
  1284. form_set_error(NULL, '', array());
  1285. }
  1286. // As an extra security measure, explicitly turn off error suppression if
  1287. // one of the above conditions wasn't met. Since this is also done at the
  1288. // end of this function, doing it here is only to handle the rare edge case
  1289. // where a validate handler invokes form processing of another form.
  1290. else {
  1291. drupal_static_reset('form_set_error:limit_validation_errors');
  1292. }
  1293. // Make sure a value is passed when the field is required.
  1294. if (isset($elements['#needs_validation']) && $elements['#required']) {
  1295. // A simple call to empty() will not cut it here as some fields, like
  1296. // checkboxes, can return a valid value of '0'. Instead, check the
  1297. // length if it's a string, and the item count if it's an array.
  1298. // An unchecked checkbox has a #value of integer 0, different than string
  1299. // '0', which could be a valid value.
  1300. $is_empty_multiple = (!count($elements['#value']));
  1301. $is_empty_string = (is_string($elements['#value']) && drupal_strlen(trim($elements['#value'])) == 0);
  1302. $is_empty_value = ($elements['#value'] === 0);
  1303. if ($is_empty_multiple || $is_empty_string || $is_empty_value) {
  1304. // Although discouraged, a #title is not mandatory for form elements. In
  1305. // case there is no #title, we cannot set a form error message.
  1306. // Instead of setting no #title, form constructors are encouraged to set
  1307. // #title_display to 'invisible' to improve accessibility.
  1308. if (isset($elements['#title'])) {
  1309. form_error($elements, $t('!name field is required.', array('!name' => $elements['#title'])));
  1310. }
  1311. else {
  1312. form_error($elements);
  1313. }
  1314. }
  1315. }
  1316. // Call user-defined form level validators.
  1317. if (isset($form_id)) {
  1318. form_execute_handlers('validate', $elements, $form_state);
  1319. }
  1320. // Call any element-specific validators. These must act on the element
  1321. // #value data.
  1322. elseif (isset($elements['#element_validate'])) {
  1323. foreach ($elements['#element_validate'] as $function) {
  1324. $function($elements, $form_state, $form_state['complete form']);
  1325. }
  1326. }
  1327. $elements['#validated'] = TRUE;
  1328. }
  1329. // Done validating this element, so turn off error suppression.
  1330. // _form_validate() turns it on again when starting on the next element, if
  1331. // it's still appropriate to do so.
  1332. drupal_static_reset('form_set_error:limit_validation_errors');
  1333. }
  1334. /**
  1335. * Executes custom validation and submission handlers for a given form.
  1336. *
  1337. * Button-specific handlers are checked first. If none exist, the function
  1338. * falls back to form-level handlers.
  1339. *
  1340. * @param $type
  1341. * The type of handler to execute. 'validate' or 'submit' are the
  1342. * defaults used by Form API.
  1343. * @param $form
  1344. * An associative array containing the structure of the form.
  1345. * @param $form_state
  1346. * A keyed array containing the current state of the form. If the user
  1347. * submitted the form by clicking a button with custom handler functions
  1348. * defined, those handlers will be stored here.
  1349. */
  1350. function form_execute_handlers($type, &$form, &$form_state) {
  1351. $return = FALSE;
  1352. // If there was a button pressed, use its handlers.
  1353. if (isset($form_state[$type . '_handlers'])) {
  1354. $handlers = $form_state[$type . '_handlers'];
  1355. }
  1356. // Otherwise, check for a form-level handler.
  1357. elseif (isset($form['#' . $type])) {
  1358. $handlers = $form['#' . $type];
  1359. }
  1360. else {
  1361. $handlers = array();
  1362. }
  1363. foreach ($handlers as $function) {
  1364. // Check if a previous _submit handler has set a batch, but make sure we
  1365. // do not react to a batch that is already being processed (for instance
  1366. // if a batch operation performs a drupal_form_submit()).
  1367. if ($type == 'submit' && ($batch =& batch_get()) && !isset($batch['id'])) {
  1368. // Some previous submit handler has set a batch. To ensure correct
  1369. // execution order, store the call in a special 'control' batch set.
  1370. // See _batch_next_set().
  1371. $batch['sets'][] = array('form_submit' => $function);
  1372. $batch['has_form_submits'] = TRUE;
  1373. }
  1374. else {
  1375. $function($form, $form_state);
  1376. }
  1377. $return = TRUE;
  1378. }
  1379. return $return;
  1380. }
  1381. /**
  1382. * Files an error against a form element.
  1383. *
  1384. * When a validation error is detected, the validator calls form_set_error() to
  1385. * indicate which element needs to be changed and provide an error message. This
  1386. * causes the Form API to not execute the form submit handlers, and instead to
  1387. * re-display the form to the user with the corresponding elements rendered with
  1388. * an 'error' CSS class (shown as red by default).
  1389. *
  1390. * The standard form_set_error() behavior can be changed if a button provides
  1391. * the #limit_validation_errors property. Multistep forms not wanting to
  1392. * validate the whole form can set #limit_validation_errors on buttons to
  1393. * limit validation errors to only certain elements. For example, pressing the
  1394. * "Previous" button in a multistep form should not fire validation errors just
  1395. * because the current step has invalid values. If #limit_validation_errors is
  1396. * set on a clicked button, the button must also define a #submit property
  1397. * (may be set to an empty array). Any #submit handlers will be executed even if
  1398. * there is invalid input, so extreme care should be taken with respect to any
  1399. * actions taken by them. This is typically not a problem with buttons like
  1400. * "Previous" or "Add more" that do not invoke persistent storage of the
  1401. * submitted form values. Do not use the #limit_validation_errors property on
  1402. * buttons that trigger saving of form values to the database.
  1403. *
  1404. * The #limit_validation_errors property is a list of "sections" within
  1405. * $form_state['values'] that must contain valid values. Each "section" is an
  1406. * array with the ordered set of keys needed to reach that part of
  1407. * $form_state['values'] (i.e., the #parents property of the element).
  1408. *
  1409. * Example 1: Allow the "Previous" button to function, regardless of whether any
  1410. * user input is valid.
  1411. *
  1412. * @code
  1413. * $form['actions']['previous'] = array(
  1414. * '#type' => 'submit',
  1415. * '#value' => t('Previous'),
  1416. * '#limit_validation_errors' => array(), // No validation.
  1417. * '#submit' => array('some_submit_function'), // #submit required.
  1418. * );
  1419. * @endcode
  1420. *
  1421. * Example 2: Require some, but not all, user input to be valid to process the
  1422. * submission of a "Previous" button.
  1423. *
  1424. * @code
  1425. * $form['actions']['previous'] = array(
  1426. * '#type' => 'submit',
  1427. * '#value' => t('Previous'),
  1428. * '#limit_validation_errors' => array(
  1429. * array('step1'), // Validate $form_state['values']['step1'].
  1430. * array('foo', 'bar'), // Validate $form_state['values']['foo']['bar'].
  1431. * ),
  1432. * '#submit' => array('some_submit_function'), // #submit required.
  1433. * );
  1434. * @endcode
  1435. *
  1436. * This will require $form_state['values']['step1'] and everything within it
  1437. * (for example, $form_state['values']['step1']['choice']) to be valid, so
  1438. * calls to form_set_error('step1', $message) or
  1439. * form_set_error('step1][choice', $message) will prevent the submit handlers
  1440. * from running, and result in the error message being displayed to the user.
  1441. * However, calls to form_set_error('step2', $message) and
  1442. * form_set_error('step2][groupX][choiceY', $message) will be suppressed,
  1443. * resulting in the message not being displayed to the user, and the submit
  1444. * handlers will run despite $form_state['values']['step2'] and
  1445. * $form_state['values']['step2']['groupX']['choiceY'] containing invalid
  1446. * values. Errors for an invalid $form_state['values']['foo'] will be
  1447. * suppressed, but errors flagging invalid values for
  1448. * $form_state['values']['foo']['bar'] and everything within it will be
  1449. * flagged and submission prevented.
  1450. *
  1451. * Partial form validation is implemented by suppressing errors rather than by
  1452. * skipping the input processing and validation steps entirely, because some
  1453. * forms have button-level submit handlers that call Drupal API functions that
  1454. * assume that certain data exists within $form_state['values'], and while not
  1455. * doing anything with that data that requires it to be valid, PHP errors
  1456. * would be triggered if the input processing and validation steps were fully
  1457. * skipped.
  1458. *
  1459. * @param $name
  1460. * The name of the form element. If the #parents property of your form
  1461. * element is array('foo', 'bar', 'baz') then you may set an error on 'foo'
  1462. * or 'foo][bar][baz'. Setting an error on 'foo' sets an error for every
  1463. * element where the #parents array starts with 'foo'.
  1464. * @param $message
  1465. * The error message to present to the user.
  1466. * @param $limit_validation_errors
  1467. * Internal use only. The #limit_validation_errors property of the clicked
  1468. * button, if it exists.
  1469. *
  1470. * @return
  1471. * Return value is for internal use only. To get a list of errors, use
  1472. * form_get_errors() or form_get_error().
  1473. *
  1474. * @see http://drupal.org/node/370537
  1475. * @see http://drupal.org/node/763376
  1476. */
  1477. function form_set_error($name = NULL, $message = '', $limit_validation_errors = NULL) {
  1478. $form = &drupal_static(__FUNCTION__, array());
  1479. $sections = &drupal_static(__FUNCTION__ . ':limit_validation_errors');
  1480. if (isset($limit_validation_errors)) {
  1481. $sections = $limit_validation_errors;
  1482. }
  1483. if (isset($name) && !isset($form[$name])) {
  1484. $record = TRUE;
  1485. if (isset($sections)) {
  1486. // #limit_validation_errors is an array of "sections" within which user
  1487. // input must be valid. If the element is within one of these sections,
  1488. // the error must be recorded. Otherwise, it can be suppressed.
  1489. // #limit_validation_errors can be an empty array, in which case all
  1490. // errors are suppressed. For example, a "Previous" button might want its
  1491. // submit action to be triggered even if none of the submitted values are
  1492. // valid.
  1493. $record = FALSE;
  1494. foreach ($sections as $section) {
  1495. // Exploding by '][' reconstructs the element's #parents. If the
  1496. // reconstructed #parents begin with the same keys as the specified
  1497. // section, then the element's values are within the part of
  1498. // $form_state['values'] that the clicked button requires to be valid,
  1499. // so errors for this element must be recorded. As the exploded array
  1500. // will all be strings, we need to cast every value of the section
  1501. // array to string.
  1502. if (array_slice(explode('][', $name), 0, count($section)) === array_map('strval', $section)) {
  1503. $record = TRUE;
  1504. break;
  1505. }
  1506. }
  1507. }
  1508. if ($record) {
  1509. $form[$name] = $message;
  1510. if ($message) {
  1511. drupal_set_message($message, 'error');
  1512. }
  1513. }
  1514. }
  1515. return $form;
  1516. }
  1517. /**
  1518. * Clears all errors against all form elements made by form_set_error().
  1519. */
  1520. function form_clear_error() {
  1521. drupal_static_reset('form_set_error');
  1522. }
  1523. /**
  1524. * Returns an associative array of all errors.
  1525. */
  1526. function form_get_errors() {
  1527. $form = form_set_error();
  1528. if (!empty($form)) {
  1529. return $form;
  1530. }
  1531. }
  1532. /**
  1533. * Returns the error message filed against the given form element.
  1534. *
  1535. * Form errors higher up in the form structure override deeper errors as well as
  1536. * errors on the element itself.
  1537. */
  1538. function form_get_error($element) {
  1539. $form = form_set_error();
  1540. $parents = array();
  1541. foreach ($element['#parents'] as $parent) {
  1542. $parents[] = $parent;
  1543. $key = implode('][', $parents);
  1544. if (isset($form[$key])) {
  1545. return $form[$key];
  1546. }
  1547. }
  1548. }
  1549. /**
  1550. * Flags an element as having an error.
  1551. */
  1552. function form_error(&$element, $message = '') {
  1553. form_set_error(implode('][', $element['#parents']), $message);
  1554. }
  1555. /**
  1556. * Builds and processes all elements in the structured form array.
  1557. *
  1558. * Adds any required properties to each element, maps the incoming input data
  1559. * to the proper elements, and executes any #process handlers attached to a
  1560. * specific element.
  1561. *
  1562. * This is one of the three primary functions that recursively iterates a form
  1563. * array. This one does it for completing the form building process. The other
  1564. * two are _form_validate() (invoked via drupal_validate_form() and used to
  1565. * invoke validation logic for each element) and drupal_render() (for rendering
  1566. * each element). Each of these three pipelines provides ample opportunity for
  1567. * modules to customize what happens. For example, during this function's life
  1568. * cycle, the following functions get called for each element:
  1569. * - $element['#value_callback']: A function that implements how user input is
  1570. * mapped to an element's #value property. This defaults to a function named
  1571. * 'form_type_TYPE_value' where TYPE is $element['#type'].
  1572. * - $element['#process']: An array of functions called after user input has
  1573. * been mapped to the element's #value property. These functions can be used
  1574. * to dynamically add child elements: for example, for the 'date' element
  1575. * type, one of the functions in this array is form_process_date(), which adds
  1576. * the individual 'year', 'month', 'day', etc. child elements. These functions
  1577. * can also be used to set additional properties or implement special logic
  1578. * other than adding child elements: for example, for the 'fieldset' element
  1579. * type, one of the functions in this array is form_process_fieldset(), which
  1580. * adds the attributes and JavaScript needed to make the fieldset collapsible
  1581. * if the #collapsible property is set. The #process functions are called in
  1582. * preorder traversal, meaning they are called for the parent element first,
  1583. * then for the child elements.
  1584. * - $element['#after_build']: An array of functions called after form_builder()
  1585. * is done with its processing of the element. These are called in postorder
  1586. * traversal, meaning they are called for the child elements first, then for
  1587. * the parent element.
  1588. * There are similar properties containing callback functions invoked by
  1589. * _form_validate() and drupal_render(), appropriate for those operations.
  1590. *
  1591. * Developers are strongly encouraged to integrate the functionality needed by
  1592. * their form or module within one of these three pipelines, using the
  1593. * appropriate callback property, rather than implementing their own recursive
  1594. * traversal of a form array. This facilitates proper integration between
  1595. * multiple modules. For example, module developers are familiar with the
  1596. * relative order in which hook_form_alter() implementations and #process
  1597. * functions run. A custom traversal function that affects the building of a
  1598. * form is likely to not integrate with hook_form_alter() and #process in the
  1599. * expected way. Also, deep recursion within PHP is both slow and memory
  1600. * intensive, so it is best to minimize how often it's done.
  1601. *
  1602. * As stated above, each element's #process functions are executed after its
  1603. * #value has been set. This enables those functions to execute conditional
  1604. * logic based on the current value. However, all of form_builder() runs before
  1605. * drupal_validate_form() is called, so during #process function execution, the
  1606. * element's #value has not yet been validated, so any code that requires
  1607. * validated values must reside within a submit handler.
  1608. *
  1609. * As a security measure, user input is used for an element's #value only if the
  1610. * element exists within $form, is not disabled (as per the #disabled property),
  1611. * and can be accessed (as per the #access property, except that forms submitted
  1612. * using drupal_form_submit() bypass #access restrictions). When user input is
  1613. * ignored due to #disabled and #access restrictions, the element's default
  1614. * value is used.
  1615. *
  1616. * Because of the preorder traversal, where #process functions of an element run
  1617. * before user input for its child elements is processed, and because of the
  1618. * Form API security of user input processing with respect to #access and
  1619. * #disabled described above, this generally means that #process functions
  1620. * should not use an element's (unvalidated) #value to affect the #disabled or
  1621. * #access of child elements. Use-cases where a developer may be tempted to
  1622. * implement such conditional logic usually fall into one of two categories:
  1623. * - Where user input from the current submission must affect the structure of a
  1624. * form, including properties like #access and #disabled that affect how the
  1625. * next submission needs to be processed, a multi-step workflow is needed.
  1626. * This is most commonly implemented with a submit handler setting persistent
  1627. * data within $form_state based on *validated* values in
  1628. * $form_state['values'] and setting $form_state['rebuild']. The form building
  1629. * functions must then be implemented to use the $form_state data to rebuild
  1630. * the form with the structure appropriate for the new state.
  1631. * - Where user input must affect the rendering of the form without affecting
  1632. * its structure, the necessary conditional rendering logic should reside
  1633. * within functions that run during the rendering phase (#pre_render, #theme,
  1634. * #theme_wrappers, and #post_render).
  1635. *
  1636. * @param $form_id
  1637. * A unique string identifying the form for validation, submission,
  1638. * theming, and hook_form_alter functions.
  1639. * @param $element
  1640. * An associative array containing the structure of the current element.
  1641. * @param $form_state
  1642. * A keyed array containing the current state of the form. In this
  1643. * context, it is used to accumulate information about which button
  1644. * was clicked when the form was submitted, as well as the sanitized
  1645. * $_POST data.
  1646. */
  1647. function form_builder($form_id, &$element, &$form_state) {
  1648. // Initialize as unprocessed.
  1649. $element['#processed'] = FALSE;
  1650. // Use element defaults.
  1651. if (isset($element['#type']) && empty($element['#defaults_loaded']) && ($info = element_info($element['#type']))) {
  1652. // Overlay $info onto $element, retaining preexisting keys in $element.
  1653. $element += $info;
  1654. $element['#defaults_loaded'] = TRUE;
  1655. }
  1656. // Assign basic defaults common for all form elements.
  1657. $element += array(
  1658. '#required' => FALSE,
  1659. '#attributes' => array(),
  1660. '#title_display' => 'before',
  1661. );
  1662. // Special handling if we're on the top level form element.
  1663. if (isset($element['#type']) && $element['#type'] == 'form') {
  1664. if (!empty($element['#https']) && variable_get('https', FALSE) &&
  1665. !url_is_external($element['#action'])) {
  1666. global $base_root;
  1667. // Not an external URL so ensure that it is secure.
  1668. $element['#action'] = str_replace('http://', 'https://', $base_root) . $element['#action'];
  1669. }
  1670. // Store a reference to the complete form in $form_state prior to building
  1671. // the form. This allows advanced #process and #after_build callbacks to
  1672. // perform changes elsewhere in the form.
  1673. $form_state['complete form'] = &$element;
  1674. // Set a flag if we have a correct form submission. This is always TRUE for
  1675. // programmed forms coming from drupal_form_submit(), or if the form_id coming
  1676. // from the POST data is set and matches the current form_id.
  1677. if ($form_state['programmed'] || (!empty($form_state['input']) && (isset($form_state['input']['form_id']) && ($form_state['input']['form_id'] == $form_id)))) {
  1678. $form_state['process_input'] = TRUE;
  1679. }
  1680. else {
  1681. $form_state['process_input'] = FALSE;
  1682. }
  1683. // All form elements should have an #array_parents property.
  1684. $element['#array_parents'] = array();
  1685. }
  1686. if (!isset($element['#id'])) {
  1687. $element['#id'] = drupal_html_id('edit-' . implode('-', $element['#parents']));
  1688. }
  1689. // Handle input elements.
  1690. if (!empty($element['#input'])) {
  1691. _form_builder_handle_input_element($form_id, $element, $form_state);
  1692. }
  1693. // Allow for elements to expand to multiple elements, e.g., radios,
  1694. // checkboxes and files.
  1695. if (isset($element['#process']) && !$element['#processed']) {
  1696. foreach ($element['#process'] as $process) {
  1697. $element = $process($element, $form_state, $form_state['complete form']);
  1698. }
  1699. $element['#processed'] = TRUE;
  1700. }
  1701. // We start off assuming all form elements are in the correct order.
  1702. $element['#sorted'] = TRUE;
  1703. // Recurse through all child elements.
  1704. $count = 0;
  1705. foreach (element_children($element) as $key) {
  1706. // Prior to checking properties of child elements, their default properties
  1707. // need to be loaded.
  1708. if (isset($element[$key]['#type']) && empty($element[$key]['#defaults_loaded']) && ($info = element_info($element[$key]['#type']))) {
  1709. $element[$key] += $info;
  1710. $element[$key]['#defaults_loaded'] = TRUE;
  1711. }
  1712. // Don't squash an existing tree value.
  1713. if (!isset($element[$key]['#tree'])) {
  1714. $element[$key]['#tree'] = $element['#tree'];
  1715. }
  1716. // Deny access to child elements if parent is denied.
  1717. if (isset($element['#access']) && !$element['#access']) {
  1718. $element[$key]['#access'] = FALSE;
  1719. }
  1720. // Make child elements inherit their parent's #disabled and #allow_focus
  1721. // values unless they specify their own.
  1722. foreach (array('#disabled', '#allow_focus') as $property) {
  1723. if (isset($element[$property]) && !isset($element[$key][$property])) {
  1724. $element[$key][$property] = $element[$property];
  1725. }
  1726. }
  1727. // Don't squash existing parents value.
  1728. if (!isset($element[$key]['#parents'])) {
  1729. // Check to see if a tree of child elements is present. If so,
  1730. // continue down the tree if required.
  1731. $element[$key]['#parents'] = $element[$key]['#tree'] && $element['#tree'] ? array_merge($element['#parents'], array($key)) : array($key);
  1732. }
  1733. // Ensure #array_parents follows the actual form structure.
  1734. $array_parents = $element['#array_parents'];
  1735. $array_parents[] = $key;
  1736. $element[$key]['#array_parents'] = $array_parents;
  1737. // Assign a decimal placeholder weight to preserve original array order.
  1738. if (!isset($element[$key]['#weight'])) {
  1739. $element[$key]['#weight'] = $count/1000;
  1740. }
  1741. else {
  1742. // If one of the child elements has a weight then we will need to sort
  1743. // later.
  1744. unset($element['#sorted']);
  1745. }
  1746. $element[$key] = form_builder($form_id, $element[$key], $form_state);
  1747. $count++;
  1748. }
  1749. // The #after_build flag allows any piece of a form to be altered
  1750. // after normal input parsing has been completed.
  1751. if (isset($element['#after_build']) && !isset($element['#after_build_done'])) {
  1752. foreach ($element['#after_build'] as $function) {
  1753. $element = $function($element, $form_state);
  1754. }
  1755. $element['#after_build_done'] = TRUE;
  1756. }
  1757. // If there is a file element, we need to flip a flag so later the
  1758. // form encoding can be set.
  1759. if (isset($element['#type']) && $element['#type'] == 'file') {
  1760. $form_state['has_file_element'] = TRUE;
  1761. }
  1762. // Final tasks for the form element after form_builder() has run for all other
  1763. // elements.
  1764. if (isset($element['#type']) && $element['#type'] == 'form') {
  1765. // If there is a file element, we set the form encoding.
  1766. if (isset($form_state['has_file_element'])) {
  1767. $element['#attributes']['enctype'] = 'multipart/form-data';
  1768. }
  1769. // If a form contains a single textfield, and the ENTER key is pressed
  1770. // within it, Internet Explorer submits the form with no POST data
  1771. // identifying any submit button. Other browsers submit POST data as though
  1772. // the user clicked the first button. Therefore, to be as consistent as we
  1773. // can be across browsers, if no 'triggering_element' has been identified
  1774. // yet, default it to the first button.
  1775. if (!$form_state['programmed'] && !isset($form_state['triggering_element']) && !empty($form_state['buttons'])) {
  1776. $form_state['triggering_element'] = $form_state['buttons'][0];
  1777. }
  1778. // If the triggering element specifies "button-level" validation and submit
  1779. // handlers to run instead of the default form-level ones, then add those to
  1780. // the form state.
  1781. foreach (array('validate', 'submit') as $type) {
  1782. if (isset($form_state['triggering_element']['#' . $type])) {
  1783. $form_state[$type . '_handlers'] = $form_state['triggering_element']['#' . $type];
  1784. }
  1785. }
  1786. // If the triggering element executes submit handlers, then set the form
  1787. // state key that's needed for those handlers to run.
  1788. if (!empty($form_state['triggering_element']['#executes_submit_callback'])) {
  1789. $form_state['submitted'] = TRUE;
  1790. }
  1791. // Special processing if the triggering element is a button.
  1792. if (isset($form_state['triggering_element']['#button_type'])) {
  1793. // Because there are several ways in which the triggering element could
  1794. // have been determined (including from input variables set by JavaScript
  1795. // or fallback behavior implemented for IE), and because buttons often
  1796. // have their #name property not derived from their #parents property, we
  1797. // can't assume that input processing that's happened up until here has
  1798. // resulted in $form_state['values'][BUTTON_NAME] being set. But it's
  1799. // common for forms to have several buttons named 'op' and switch on
  1800. // $form_state['values']['op'] during submit handler execution.
  1801. $form_state['values'][$form_state['triggering_element']['#name']] = $form_state['triggering_element']['#value'];
  1802. // @todo Legacy support. Remove in Drupal 8.
  1803. $form_state['clicked_button'] = $form_state['triggering_element'];
  1804. }
  1805. }
  1806. return $element;
  1807. }
  1808. /**
  1809. * Adds the #name and #value properties of an input element before rendering.
  1810. */
  1811. function _form_builder_handle_input_element($form_id, &$element, &$form_state) {
  1812. if (!isset($element['#name'])) {
  1813. $name = array_shift($element['#parents']);
  1814. $element['#name'] = $name;
  1815. if ($element['#type'] == 'file') {
  1816. // To make it easier to handle $_FILES in file.inc, we place all
  1817. // file fields in the 'files' array. Also, we do not support
  1818. // nested file names.
  1819. $element['#name'] = 'files[' . $element['#name'] . ']';
  1820. }
  1821. elseif (count($element['#parents'])) {
  1822. $element['#name'] .= '[' . implode('][', $element['#parents']) . ']';
  1823. }
  1824. array_unshift($element['#parents'], $name);
  1825. }
  1826. // Setting #disabled to TRUE results in user input being ignored, regardless
  1827. // of how the element is themed or whether JavaScript is used to change the
  1828. // control's attributes. However, it's good UI to let the user know that input
  1829. // is not wanted for the control. HTML supports two attributes for this:
  1830. // http://www.w3.org/TR/html401/interact/forms.html#h-17.12. If a form wants
  1831. // to start a control off with one of these attributes for UI purposes only,
  1832. // but still allow input to be processed if it's sumitted, it can set the
  1833. // desired attribute in #attributes directly rather than using #disabled.
  1834. // However, developers should think carefully about the accessibility
  1835. // implications of doing so: if the form expects input to be enterable under
  1836. // some condition triggered by JavaScript, how would someone who has
  1837. // JavaScript disabled trigger that condition? Instead, developers should
  1838. // consider whether a multi-step form would be more appropriate (#disabled can
  1839. // be changed from step to step). If one still decides to use JavaScript to
  1840. // affect when a control is enabled, then it is best for accessibility for the
  1841. // control to be enabled in the HTML, and disabled by JavaScript on document
  1842. // ready.
  1843. if (!empty($element['#disabled'])) {
  1844. if (!empty($element['#allow_focus'])) {
  1845. $element['#attributes']['readonly'] = 'readonly';
  1846. }
  1847. else {
  1848. $element['#attributes']['disabled'] = 'disabled';
  1849. }
  1850. }
  1851. // With JavaScript or other easy hacking, input can be submitted even for
  1852. // elements with #access=FALSE or #disabled=TRUE. For security, these must
  1853. // not be processed. Forms that set #disabled=TRUE on an element do not
  1854. // expect input for the element, and even forms submitted with
  1855. // drupal_form_submit() must not be able to get around this. Forms that set
  1856. // #access=FALSE on an element usually allow access for some users, so forms
  1857. // submitted with drupal_form_submit() may bypass access restriction and be
  1858. // treated as high-privilege users instead.
  1859. $process_input = empty($element['#disabled']) && ($form_state['programmed'] || ($form_state['process_input'] && (!isset($element['#access']) || $element['#access'])));
  1860. // Set the element's #value property.
  1861. if (!isset($element['#value']) && !array_key_exists('#value', $element)) {
  1862. $value_callback = !empty($element['#value_callback']) ? $element['#value_callback'] : 'form_type_' . $element['#type'] . '_value';
  1863. if ($process_input) {
  1864. // Get the input for the current element. NULL values in the input need to
  1865. // be explicitly distinguished from missing input. (see below)
  1866. $input_exists = NULL;
  1867. $input = drupal_array_get_nested_value($form_state['input'], $element['#parents'], $input_exists);
  1868. // For browser-submitted forms, the submitted values do not contain values
  1869. // for certain elements (empty multiple select, unchecked checkbox).
  1870. // During initial form processing, we add explicit NULL values for such
  1871. // elements in $form_state['input']. When rebuilding the form, we can
  1872. // distinguish elements having NULL input from elements that were not part
  1873. // of the initially submitted form and can therefore use default values
  1874. // for the latter, if required. Programmatically submitted forms can
  1875. // submit explicit NULL values when calling drupal_form_submit(), so we do
  1876. // not modify $form_state['input'] for them.
  1877. if (!$input_exists && !$form_state['rebuild'] && !$form_state['programmed']) {
  1878. // Add the necessary parent keys to $form_state['input'] and sets the
  1879. // element's input value to NULL.
  1880. drupal_array_set_nested_value($form_state['input'], $element['#parents'], NULL);
  1881. $input_exists = TRUE;
  1882. }
  1883. // If we have input for the current element, assign it to the #value
  1884. // property, optionally filtered through $value_callback.
  1885. if ($input_exists) {
  1886. if (function_exists($value_callback)) {
  1887. $element['#value'] = $value_callback($element, $input, $form_state);
  1888. }
  1889. if (!isset($element['#value']) && isset($input)) {
  1890. $element['#value'] = $input;
  1891. }
  1892. }
  1893. // Mark all posted values for validation.
  1894. if (isset($element['#value']) || (!empty($element['#required']))) {
  1895. $element['#needs_validation'] = TRUE;
  1896. }
  1897. }
  1898. // Load defaults.
  1899. if (!isset($element['#value'])) {
  1900. // Call #type_value without a second argument to request default_value handling.
  1901. if (function_exists($value_callback)) {
  1902. $element['#value'] = $value_callback($element, FALSE, $form_state);
  1903. }
  1904. // Final catch. If we haven't set a value yet, use the explicit default value.
  1905. // Avoid image buttons (which come with garbage value), so we only get value
  1906. // for the button actually clicked.
  1907. if (!isset($element['#value']) && empty($element['#has_garbage_value'])) {
  1908. $element['#value'] = isset($element['#default_value']) ? $element['#default_value'] : '';
  1909. }
  1910. }
  1911. }
  1912. // Determine which element (if any) triggered the submission of the form and
  1913. // keep track of all the clickable buttons in the form for
  1914. // form_state_values_clean(). Enforce the same input processing restrictions
  1915. // as above.
  1916. if ($process_input) {
  1917. // Detect if the element triggered the submission via Ajax.
  1918. if (_form_element_triggered_scripted_submission($element, $form_state)) {
  1919. $form_state['triggering_element'] = $element;
  1920. }
  1921. // If the form was submitted by the browser rather than via Ajax, then it
  1922. // can only have been triggered by a button, and we need to determine which
  1923. // button within the constraints of how browsers provide this information.
  1924. if (isset($element['#button_type'])) {
  1925. // All buttons in the form need to be tracked for
  1926. // form_state_values_clean() and for the form_builder() code that handles
  1927. // a form submission containing no button information in $_POST.
  1928. $form_state['buttons'][] = $element;
  1929. if (_form_button_was_clicked($element, $form_state)) {
  1930. $form_state['triggering_element'] = $element;
  1931. }
  1932. }
  1933. }
  1934. // Set the element's value in $form_state['values'], but only, if its key
  1935. // does not exist yet (a #value_callback may have already populated it).
  1936. if (!drupal_array_nested_key_exists($form_state['values'], $element['#parents'])) {
  1937. form_set_value($element, $element['#value'], $form_state);
  1938. }
  1939. }
  1940. /**
  1941. * Detects if an element triggered the form submission via Ajax.
  1942. *
  1943. * This detects button or non-button controls that trigger a form submission via
  1944. * Ajax or some other scriptable environment. These environments can set the
  1945. * special input key '_triggering_element_name' to identify the triggering
  1946. * element. If the name alone doesn't identify the element uniquely, the input
  1947. * key '_triggering_element_value' may also be set to require a match on element
  1948. * value. An example where this is needed is if there are several buttons all
  1949. * named 'op', and only differing in their value.
  1950. */
  1951. function _form_element_triggered_scripted_submission($element, &$form_state) {
  1952. if (!empty($form_state['input']['_triggering_element_name']) && $element['#name'] == $form_state['input']['_triggering_element_name']) {
  1953. if (empty($form_state['input']['_triggering_element_value']) || $form_state['input']['_triggering_element_value'] == $element['#value']) {
  1954. return TRUE;
  1955. }
  1956. }
  1957. return FALSE;
  1958. }
  1959. /**
  1960. * Determines if a given button triggered the form submission.
  1961. *
  1962. * This detects button controls that trigger a form submission by being clicked
  1963. * and having the click processed by the browser rather than being captured by
  1964. * JavaScript. Essentially, it detects if the button's name and value are part
  1965. * of the POST data, but with extra code to deal with the convoluted way in
  1966. * which browsers submit data for image button clicks.
  1967. *
  1968. * This does not detect button clicks processed by Ajax (that is done in
  1969. * _form_element_triggered_scripted_submission()) and it does not detect form
  1970. * submissions from Internet Explorer in response to an ENTER key pressed in a
  1971. * textfield (form_builder() has extra code for that).
  1972. *
  1973. * Because this function contains only part of the logic needed to determine
  1974. * $form_state['triggering_element'], it should not be called from anywhere
  1975. * other than within the Form API. Form validation and submit handlers needing
  1976. * to know which button was clicked should get that information from
  1977. * $form_state['triggering_element'].
  1978. */
  1979. function _form_button_was_clicked($element, &$form_state) {
  1980. // First detect normal 'vanilla' button clicks. Traditionally, all
  1981. // standard buttons on a form share the same name (usually 'op'),
  1982. // and the specific return value is used to determine which was
  1983. // clicked. This ONLY works as long as $form['#name'] puts the
  1984. // value at the top level of the tree of $_POST data.
  1985. if (isset($form_state['input'][$element['#name']]) && $form_state['input'][$element['#name']] == $element['#value']) {
  1986. return TRUE;
  1987. }
  1988. // When image buttons are clicked, browsers do NOT pass the form element
  1989. // value in $_POST. Instead they pass an integer representing the
  1990. // coordinates of the click on the button image. This means that image
  1991. // buttons MUST have unique $form['#name'] values, but the details of
  1992. // their $_POST data should be ignored.
  1993. elseif (!empty($element['#has_garbage_value']) && isset($element['#value']) && $element['#value'] !== '') {
  1994. return TRUE;
  1995. }
  1996. return FALSE;
  1997. }
  1998. /**
  1999. * Removes internal Form API elements and buttons from submitted form values.
  2000. *
  2001. * This function can be used when a module wants to store all submitted form
  2002. * values, for example, by serializing them into a single database column. In
  2003. * such cases, all internal Form API values and all form button elements should
  2004. * not be contained, and this function allows to remove them before the module
  2005. * proceeds to storage. Next to button elements, the following internal values
  2006. * are removed:
  2007. * - form_id
  2008. * - form_token
  2009. * - form_build_id
  2010. * - op
  2011. *
  2012. * @param $form_state
  2013. * A keyed array containing the current state of the form, including
  2014. * submitted form values; altered by reference.
  2015. */
  2016. function form_state_values_clean(&$form_state) {
  2017. // Remove internal Form API values.
  2018. unset($form_state['values']['form_id'], $form_state['values']['form_token'], $form_state['values']['form_build_id'], $form_state['values']['op']);
  2019. // Remove button values.
  2020. // form_builder() collects all button elements in a form. We remove the button
  2021. // value separately for each button element.
  2022. foreach ($form_state['buttons'] as $button) {
  2023. // Remove this button's value from the submitted form values by finding
  2024. // the value corresponding to this button.
  2025. // We iterate over the #parents of this button and move a reference to
  2026. // each parent in $form_state['values']. For example, if #parents is:
  2027. // array('foo', 'bar', 'baz')
  2028. // then the corresponding $form_state['values'] part will look like this:
  2029. // array(
  2030. // 'foo' => array(
  2031. // 'bar' => array(
  2032. // 'baz' => 'button_value',
  2033. // ),
  2034. // ),
  2035. // )
  2036. // We start by (re)moving 'baz' to $last_parent, so we are able unset it
  2037. // at the end of the iteration. Initially, $values will contain a
  2038. // reference to $form_state['values'], but in the iteration we move the
  2039. // reference to $form_state['values']['foo'], and finally to
  2040. // $form_state['values']['foo']['bar'], which is the level where we can
  2041. // unset 'baz' (that is stored in $last_parent).
  2042. $parents = $button['#parents'];
  2043. $last_parent = array_pop($parents);
  2044. $key_exists = NULL;
  2045. $values = &drupal_array_get_nested_value($form_state['values'], $parents, $key_exists);
  2046. if ($key_exists && is_array($values)) {
  2047. unset($values[$last_parent]);
  2048. }
  2049. }
  2050. }
  2051. /**
  2052. * Determines the value for an image button form element.
  2053. *
  2054. * @param $form
  2055. * The form element whose value is being populated.
  2056. * @param $input
  2057. * The incoming input to populate the form element. If this is FALSE,
  2058. * the element's default value should be returned.
  2059. * @param $form_state
  2060. * A keyed array containing the current state of the form.
  2061. *
  2062. * @return
  2063. * The data that will appear in the $form_state['values'] collection
  2064. * for this element. Return nothing to use the default.
  2065. */
  2066. function form_type_image_button_value($form, $input, $form_state) {
  2067. if ($input !== FALSE) {
  2068. if (!empty($input)) {
  2069. // If we're dealing with Mozilla or Opera, we're lucky. It will
  2070. // return a proper value, and we can get on with things.
  2071. return $form['#return_value'];
  2072. }
  2073. else {
  2074. // Unfortunately, in IE we never get back a proper value for THIS
  2075. // form element. Instead, we get back two split values: one for the
  2076. // X and one for the Y coordinates on which the user clicked the
  2077. // button. We'll find this element in the #post data, and search
  2078. // in the same spot for its name, with '_x'.
  2079. $input = $form_state['input'];
  2080. foreach (explode('[', $form['#name']) as $element_name) {
  2081. // chop off the ] that may exist.
  2082. if (substr($element_name, -1) == ']') {
  2083. $element_name = substr($element_name, 0, -1);
  2084. }
  2085. if (!isset($input[$element_name])) {
  2086. if (isset($input[$element_name . '_x'])) {
  2087. return $form['#return_value'];
  2088. }
  2089. return NULL;
  2090. }
  2091. $input = $input[$element_name];
  2092. }
  2093. return $form['#return_value'];
  2094. }
  2095. }
  2096. }
  2097. /**
  2098. * Determines the value for a checkbox form element.
  2099. *
  2100. * @param $form
  2101. * The form element whose value is being populated.
  2102. * @param $input
  2103. * The incoming input to populate the form element. If this is FALSE,
  2104. * the element's default value should be returned.
  2105. *
  2106. * @return
  2107. * The data that will appear in the $element_state['values'] collection
  2108. * for this element. Return nothing to use the default.
  2109. */
  2110. function form_type_checkbox_value($element, $input = FALSE) {
  2111. if ($input === FALSE) {
  2112. // Use #default_value as the default value of a checkbox, except change
  2113. // NULL to 0, because _form_builder_handle_input_element() would otherwise
  2114. // replace NULL with empty string, but an empty string is a potentially
  2115. // valid value for a checked checkbox.
  2116. return isset($element['#default_value']) ? $element['#default_value'] : 0;
  2117. }
  2118. else {
  2119. // Checked checkboxes are submitted with a value (possibly '0' or ''):
  2120. // http://www.w3.org/TR/html401/interact/forms.html#successful-controls.
  2121. // For checked checkboxes, browsers submit the string version of
  2122. // #return_value, but we return the original #return_value. For unchecked
  2123. // checkboxes, browsers submit nothing at all, but
  2124. // _form_builder_handle_input_element() detects this, and calls this
  2125. // function with $input=NULL. Returning NULL from a value callback means to
  2126. // use the default value, which is not what is wanted when an unchecked
  2127. // checkbox is submitted, so we use integer 0 as the value indicating an
  2128. // unchecked checkbox. Therefore, modules must not use integer 0 as a
  2129. // #return_value, as doing so results in the checkbox always being treated
  2130. // as unchecked. The string '0' is allowed for #return_value. The most
  2131. // common use-case for setting #return_value to either 0 or '0' is for the
  2132. // first option within a 0-indexed array of checkboxes, and for this,
  2133. // form_process_checkboxes() uses the string rather than the integer.
  2134. return isset($input) ? $element['#return_value'] : 0;
  2135. }
  2136. }
  2137. /**
  2138. * Determines the value for a checkboxes form element.
  2139. *
  2140. * @param $element
  2141. * The form element whose value is being populated.
  2142. * @param $input
  2143. * The incoming input to populate the form element. If this is FALSE,
  2144. * the element's default value should be returned.
  2145. *
  2146. * @return
  2147. * The data that will appear in the $element_state['values'] collection
  2148. * for this element. Return nothing to use the default.
  2149. */
  2150. function form_type_checkboxes_value($element, $input = FALSE) {
  2151. if ($input === FALSE) {
  2152. $value = array();
  2153. $element += array('#default_value' => array());
  2154. foreach ($element['#default_value'] as $key) {
  2155. $value[$key] = $key;
  2156. }
  2157. return $value;
  2158. }
  2159. elseif (is_array($input)) {
  2160. // Programmatic form submissions use NULL to indicate that a checkbox
  2161. // should be unchecked; see drupal_form_submit(). We therefore remove all
  2162. // NULL elements from the array before constructing the return value, to
  2163. // simulate the behavior of web browsers (which do not send unchecked
  2164. // checkboxes to the server at all). This will not affect non-programmatic
  2165. // form submissions, since all values in $_POST are strings.
  2166. foreach ($input as $key => $value) {
  2167. if (!isset($value)) {
  2168. unset($input[$key]);
  2169. }
  2170. }
  2171. return drupal_map_assoc($input);
  2172. }
  2173. else {
  2174. return array();
  2175. }
  2176. }
  2177. /**
  2178. * Determines the value for a tableselect form element.
  2179. *
  2180. * @param $element
  2181. * The form element whose value is being populated.
  2182. * @param $input
  2183. * The incoming input to populate the form element. If this is FALSE,
  2184. * the element's default value should be returned.
  2185. *
  2186. * @return
  2187. * The data that will appear in the $element_state['values'] collection
  2188. * for this element. Return nothing to use the default.
  2189. */
  2190. function form_type_tableselect_value($element, $input = FALSE) {
  2191. // If $element['#multiple'] == FALSE, then radio buttons are displayed and
  2192. // the default value handling is used.
  2193. if (isset($element['#multiple']) && $element['#multiple']) {
  2194. // Checkboxes are being displayed with the default value coming from the
  2195. // keys of the #default_value property. This differs from the checkboxes
  2196. // element which uses the array values.
  2197. if ($input === FALSE) {
  2198. $value = array();
  2199. $element += array('#default_value' => array());
  2200. foreach ($element['#default_value'] as $key => $flag) {
  2201. if ($flag) {
  2202. $value[$key] = $key;
  2203. }
  2204. }
  2205. return $value;
  2206. }
  2207. else {
  2208. return is_array($input) ? drupal_map_assoc($input) : array();
  2209. }
  2210. }
  2211. }
  2212. /**
  2213. * Form value callback: Determines the value for a #type radios form element.
  2214. *
  2215. * @param $element
  2216. * The form element whose value is being populated.
  2217. * @param $input
  2218. * (optional) The incoming input to populate the form element. If FALSE, the
  2219. * element's default value is returned. Defaults to FALSE.
  2220. *
  2221. * @return
  2222. * The data that will appear in the $element_state['values'] collection for
  2223. * this element.
  2224. */
  2225. function form_type_radios_value(&$element, $input = FALSE) {
  2226. if ($input !== FALSE) {
  2227. // When there's user input (including NULL), return it as the value.
  2228. // However, if NULL is submitted, _form_builder_handle_input_element() will
  2229. // apply the default value, and we want that validated against #options
  2230. // unless it's empty. (An empty #default_value, such as NULL or FALSE, can
  2231. // be used to indicate that no radio button is selected by default.)
  2232. if (!isset($input) && !empty($element['#default_value'])) {
  2233. $element['#needs_validation'] = TRUE;
  2234. }
  2235. return $input;
  2236. }
  2237. else {
  2238. // For default value handling, simply return #default_value. Additionally,
  2239. // for a NULL default value, set #has_garbage_value to prevent
  2240. // _form_builder_handle_input_element() converting the NULL to an empty
  2241. // string, so that code can distinguish between nothing selected and the
  2242. // selection of a radio button whose value is an empty string.
  2243. $value = isset($element['#default_value']) ? $element['#default_value'] : NULL;
  2244. if (!isset($value)) {
  2245. $element['#has_garbage_value'] = TRUE;
  2246. }
  2247. return $value;
  2248. }
  2249. }
  2250. /**
  2251. * Determines the value for a password_confirm form element.
  2252. *
  2253. * @param $element
  2254. * The form element whose value is being populated.
  2255. * @param $input
  2256. * The incoming input to populate the form element. If this is FALSE,
  2257. * the element's default value should be returned.
  2258. *
  2259. * @return
  2260. * The data that will appear in the $element_state['values'] collection
  2261. * for this element. Return nothing to use the default.
  2262. */
  2263. function form_type_password_confirm_value($element, $input = FALSE) {
  2264. if ($input === FALSE) {
  2265. $element += array('#default_value' => array());
  2266. return $element['#default_value'] + array('pass1' => '', 'pass2' => '');
  2267. }
  2268. }
  2269. /**
  2270. * Determines the value for a select form element.
  2271. *
  2272. * @param $element
  2273. * The form element whose value is being populated.
  2274. * @param $input
  2275. * The incoming input to populate the form element. If this is FALSE,
  2276. * the element's default value should be returned.
  2277. *
  2278. * @return
  2279. * The data that will appear in the $element_state['values'] collection
  2280. * for this element. Return nothing to use the default.
  2281. */
  2282. function form_type_select_value($element, $input = FALSE) {
  2283. if ($input !== FALSE) {
  2284. if (isset($element['#multiple']) && $element['#multiple']) {
  2285. // If an enabled multi-select submits NULL, it means all items are
  2286. // unselected. A disabled multi-select always submits NULL, and the
  2287. // default value should be used.
  2288. if (empty($element['#disabled'])) {
  2289. return (is_array($input)) ? drupal_map_assoc($input) : array();
  2290. }
  2291. else {
  2292. return (isset($element['#default_value']) && is_array($element['#default_value'])) ? $element['#default_value'] : array();
  2293. }
  2294. }
  2295. // Non-multiple select elements may have an empty option preprended to them
  2296. // (see form_process_select()). When this occurs, usually #empty_value is
  2297. // an empty string, but some forms set #empty_value to integer 0 or some
  2298. // other non-string constant. PHP receives all submitted form input as
  2299. // strings, but if the empty option is selected, set the value to match the
  2300. // empty value exactly.
  2301. elseif (isset($element['#empty_value']) && $input === (string) $element['#empty_value']) {
  2302. return $element['#empty_value'];
  2303. }
  2304. else {
  2305. return $input;
  2306. }
  2307. }
  2308. }
  2309. /**
  2310. * Determines the value for a textfield form element.
  2311. *
  2312. * @param $element
  2313. * The form element whose value is being populated.
  2314. * @param $input
  2315. * The incoming input to populate the form element. If this is FALSE,
  2316. * the element's default value should be returned.
  2317. *
  2318. * @return
  2319. * The data that will appear in the $element_state['values'] collection
  2320. * for this element. Return nothing to use the default.
  2321. */
  2322. function form_type_textfield_value($element, $input = FALSE) {
  2323. if ($input !== FALSE && $input !== NULL) {
  2324. // Equate $input to the form value to ensure it's marked for
  2325. // validation.
  2326. return str_replace(array("\r", "\n"), '', $input);
  2327. }
  2328. }
  2329. /**
  2330. * Determines the value for form's token value.
  2331. *
  2332. * @param $element
  2333. * The form element whose value is being populated.
  2334. * @param $input
  2335. * The incoming input to populate the form element. If this is FALSE,
  2336. * the element's default value should be returned.
  2337. *
  2338. * @return
  2339. * The data that will appear in the $element_state['values'] collection
  2340. * for this element. Return nothing to use the default.
  2341. */
  2342. function form_type_token_value($element, $input = FALSE) {
  2343. if ($input !== FALSE) {
  2344. return (string) $input;
  2345. }
  2346. }
  2347. /**
  2348. * Changes submitted form values during form validation.
  2349. *
  2350. * Use this function to change the submitted value of a form element in a form
  2351. * validation function, so that the changed value persists in $form_state
  2352. * through the remaining validation and submission handlers. It does not change
  2353. * the value in $element['#value'], only in $form_state['values'], which is
  2354. * where submitted values are always stored.
  2355. *
  2356. * Note that form validation functions are specified in the '#validate'
  2357. * component of the form array (the value of $form['#validate'] is an array of
  2358. * validation function names). If the form does not originate in your module,
  2359. * you can implement hook_form_FORM_ID_alter() to add a validation function
  2360. * to $form['#validate'].
  2361. *
  2362. * @param $element
  2363. * The form element that should have its value updated; in most cases you can
  2364. * just pass in the element from the $form array, although the only component
  2365. * that is actually used is '#parents'. If constructing yourself, set
  2366. * $element['#parents'] to be an array giving the path through the form
  2367. * array's keys to the element whose value you want to update. For instance,
  2368. * if you want to update the value of $form['elem1']['elem2'], which should be
  2369. * stored in $form_state['values']['elem1']['elem2'], you would set
  2370. * $element['#parents'] = array('elem1','elem2').
  2371. * @param $value
  2372. * The new value for the form element.
  2373. * @param $form_state
  2374. * Form state array where the value change should be recorded.
  2375. */
  2376. function form_set_value($element, $value, &$form_state) {
  2377. drupal_array_set_nested_value($form_state['values'], $element['#parents'], $value, TRUE);
  2378. }
  2379. /**
  2380. * Allows PHP array processing of multiple select options with the same value.
  2381. *
  2382. * Used for form select elements which need to validate HTML option groups
  2383. * and multiple options which may return the same value. Associative PHP arrays
  2384. * cannot handle these structures, since they share a common key.
  2385. *
  2386. * @param $array
  2387. * The form options array to process.
  2388. *
  2389. * @return
  2390. * An array with all hierarchical elements flattened to a single array.
  2391. */
  2392. function form_options_flatten($array) {
  2393. // Always reset static var when first entering the recursion.
  2394. drupal_static_reset('_form_options_flatten');
  2395. return _form_options_flatten($array);
  2396. }
  2397. /**
  2398. * Iterates over an array and returns a flat array with duplicate keys removed.
  2399. *
  2400. * This function also handles cases where objects are passed as array values.
  2401. */
  2402. function _form_options_flatten($array) {
  2403. $return = &drupal_static(__FUNCTION__);
  2404. foreach ($array as $key => $value) {
  2405. if (is_object($value)) {
  2406. _form_options_flatten($value->option);
  2407. }
  2408. elseif (is_array($value)) {
  2409. _form_options_flatten($value);
  2410. }
  2411. else {
  2412. $return[$key] = 1;
  2413. }
  2414. }
  2415. return $return;
  2416. }
  2417. /**
  2418. * Processes a select list form element.
  2419. *
  2420. * This process callback is mandatory for select fields, since all user agents
  2421. * automatically preselect the first available option of single (non-multiple)
  2422. * select lists.
  2423. *
  2424. * @param $element
  2425. * The form element to process. Properties used:
  2426. * - #multiple: (optional) Indicates whether one or more options can be
  2427. * selected. Defaults to FALSE.
  2428. * - #default_value: Must be NULL or not set in case there is no value for the
  2429. * element yet, in which case a first default option is inserted by default.
  2430. * Whether this first option is a valid option depends on whether the field
  2431. * is #required or not.
  2432. * - #required: (optional) Whether the user needs to select an option (TRUE)
  2433. * or not (FALSE). Defaults to FALSE.
  2434. * - #empty_option: (optional) The label to show for the first default option.
  2435. * By default, the label is automatically set to "- Please select -" for a
  2436. * required field and "- None -" for an optional field.
  2437. * - #empty_value: (optional) The value for the first default option, which is
  2438. * used to determine whether the user submitted a value or not.
  2439. * - If #required is TRUE, this defaults to '' (an empty string).
  2440. * - If #required is not TRUE and this value isn't set, then no extra option
  2441. * is added to the select control, leaving the control in a slightly
  2442. * illogical state, because there's no way for the user to select nothing,
  2443. * since all user agents automatically preselect the first available
  2444. * option. But people are used to this being the behavior of select
  2445. * controls.
  2446. * @todo Address the above issue in Drupal 8.
  2447. * - If #required is not TRUE and this value is set (most commonly to an
  2448. * empty string), then an extra option (see #empty_option above)
  2449. * representing a "non-selection" is added with this as its value.
  2450. *
  2451. * @see _form_validate()
  2452. */
  2453. function form_process_select($element) {
  2454. // #multiple select fields need a special #name.
  2455. if ($element['#multiple']) {
  2456. $element['#attributes']['multiple'] = 'multiple';
  2457. $element['#attributes']['name'] = $element['#name'] . '[]';
  2458. }
  2459. // A non-#multiple select needs special handling to prevent user agents from
  2460. // preselecting the first option without intention. #multiple select lists do
  2461. // not get an empty option, as it would not make sense, user interface-wise.
  2462. else {
  2463. $required = $element['#required'];
  2464. // If the element is required and there is no #default_value, then add an
  2465. // empty option that will fail validation, so that the user is required to
  2466. // make a choice. Also, if there's a value for #empty_value or
  2467. // #empty_option, then add an option that represents emptiness.
  2468. if (($required && !isset($element['#default_value'])) || isset($element['#empty_value']) || isset($element['#empty_option'])) {
  2469. $element += array(
  2470. '#empty_value' => '',
  2471. '#empty_option' => $required ? t('- Select -') : t('- None -'),
  2472. );
  2473. // The empty option is prepended to #options and purposively not merged
  2474. // to prevent another option in #options mistakenly using the same value
  2475. // as #empty_value.
  2476. $empty_option = array($element['#empty_value'] => $element['#empty_option']);
  2477. $element['#options'] = $empty_option + $element['#options'];
  2478. }
  2479. }
  2480. return $element;
  2481. }
  2482. /**
  2483. * Returns HTML for a select form element.
  2484. *
  2485. * It is possible to group options together; to do this, change the format of
  2486. * $options to an associative array in which the keys are group labels, and the
  2487. * values are associative arrays in the normal $options format.
  2488. *
  2489. * @param $variables
  2490. * An associative array containing:
  2491. * - element: An associative array containing the properties of the element.
  2492. * Properties used: #title, #value, #options, #description, #extra,
  2493. * #multiple, #required, #name, #attributes, #size.
  2494. *
  2495. * @ingroup themeable
  2496. */
  2497. function theme_select($variables) {
  2498. $element = $variables['element'];
  2499. element_set_attributes($element, array('id', 'name', 'size'));
  2500. _form_set_class($element, array('form-select'));
  2501. return '<select' . drupal_attributes($element['#attributes']) . '>' . form_select_options($element) . '</select>';
  2502. }
  2503. /**
  2504. * Converts a select form element's options array into HTML.
  2505. *
  2506. * @param $element
  2507. * An associative array containing the properties of the element.
  2508. * @param $choices
  2509. * Mixed: Either an associative array of items to list as choices, or an
  2510. * object with an 'option' member that is an associative array. This
  2511. * parameter is only used internally and should not be passed.
  2512. *
  2513. * @return
  2514. * An HTML string of options for the select form element.
  2515. */
  2516. function form_select_options($element, $choices = NULL) {
  2517. if (!isset($choices)) {
  2518. $choices = $element['#options'];
  2519. }
  2520. // array_key_exists() accommodates the rare event where $element['#value'] is NULL.
  2521. // isset() fails in this situation.
  2522. $value_valid = isset($element['#value']) || array_key_exists('#value', $element);
  2523. $value_is_array = $value_valid && is_array($element['#value']);
  2524. $options = '';
  2525. foreach ($choices as $key => $choice) {
  2526. if (is_array($choice)) {
  2527. $options .= '<optgroup label="' . $key . '">';
  2528. $options .= form_select_options($element, $choice);
  2529. $options .= '</optgroup>';
  2530. }
  2531. elseif (is_object($choice)) {
  2532. $options .= form_select_options($element, $choice->option);
  2533. }
  2534. else {
  2535. $key = (string) $key;
  2536. if ($value_valid && (!$value_is_array && (string) $element['#value'] === $key || ($value_is_array && in_array($key, $element['#value'])))) {
  2537. $selected = ' selected="selected"';
  2538. }
  2539. else {
  2540. $selected = '';
  2541. }
  2542. $options .= '<option value="' . check_plain($key) . '"' . $selected . '>' . check_plain($choice) . '</option>';
  2543. }
  2544. }
  2545. return $options;
  2546. }
  2547. /**
  2548. * Returns the indexes of a select element's options matching a given key.
  2549. *
  2550. * This function is useful if you need to modify the options that are
  2551. * already in a form element; for example, to remove choices which are
  2552. * not valid because of additional filters imposed by another module.
  2553. * One example might be altering the choices in a taxonomy selector.
  2554. * To correctly handle the case of a multiple hierarchy taxonomy,
  2555. * #options arrays can now hold an array of objects, instead of a
  2556. * direct mapping of keys to labels, so that multiple choices in the
  2557. * selector can have the same key (and label). This makes it difficult
  2558. * to manipulate directly, which is why this helper function exists.
  2559. *
  2560. * This function does not support optgroups (when the elements of the
  2561. * #options array are themselves arrays), and will return FALSE if
  2562. * arrays are found. The caller must either flatten/restore or
  2563. * manually do their manipulations in this case, since returning the
  2564. * index is not sufficient, and supporting this would make the
  2565. * "helper" too complicated and cumbersome to be of any help.
  2566. *
  2567. * As usual with functions that can return array() or FALSE, do not
  2568. * forget to use === and !== if needed.
  2569. *
  2570. * @param $element
  2571. * The select element to search.
  2572. * @param $key
  2573. * The key to look for.
  2574. *
  2575. * @return
  2576. * An array of indexes that match the given $key. Array will be
  2577. * empty if no elements were found. FALSE if optgroups were found.
  2578. */
  2579. function form_get_options($element, $key) {
  2580. $keys = array();
  2581. foreach ($element['#options'] as $index => $choice) {
  2582. if (is_array($choice)) {
  2583. return FALSE;
  2584. }
  2585. elseif (is_object($choice)) {
  2586. if (isset($choice->option[$key])) {
  2587. $keys[] = $index;
  2588. }
  2589. }
  2590. elseif ($index == $key) {
  2591. $keys[] = $index;
  2592. }
  2593. }
  2594. return $keys;
  2595. }
  2596. /**
  2597. * Returns HTML for a fieldset form element and its children.
  2598. *
  2599. * @param $variables
  2600. * An associative array containing:
  2601. * - element: An associative array containing the properties of the element.
  2602. * Properties used: #attributes, #children, #collapsed, #collapsible,
  2603. * #description, #id, #title, #value.
  2604. *
  2605. * @ingroup themeable
  2606. */
  2607. function theme_fieldset($variables) {
  2608. $element = $variables['element'];
  2609. element_set_attributes($element, array('id'));
  2610. _form_set_class($element, array('form-wrapper'));
  2611. $output = '<fieldset' . drupal_attributes($element['#attributes']) . '>';
  2612. if (!empty($element['#title'])) {
  2613. // Always wrap fieldset legends in a SPAN for CSS positioning.
  2614. $output .= '<legend><span class="fieldset-legend">' . $element['#title'] . '</span></legend>';
  2615. }
  2616. $output .= '<div class="fieldset-wrapper">';
  2617. if (!empty($element['#description'])) {
  2618. $output .= '<div class="fieldset-description">' . $element['#description'] . '</div>';
  2619. }
  2620. $output .= $element['#children'];
  2621. if (isset($element['#value'])) {
  2622. $output .= $element['#value'];
  2623. }
  2624. $output .= '</div>';
  2625. $output .= "</fieldset>\n";
  2626. return $output;
  2627. }
  2628. /**
  2629. * Returns HTML for a radio button form element.
  2630. *
  2631. * Note: The input "name" attribute needs to be sanitized before output, which
  2632. * is currently done by passing all attributes to drupal_attributes().
  2633. *
  2634. * @param $variables
  2635. * An associative array containing:
  2636. * - element: An associative array containing the properties of the element.
  2637. * Properties used: #required, #return_value, #value, #attributes, #title,
  2638. * #description
  2639. *
  2640. * @ingroup themeable
  2641. */
  2642. function theme_radio($variables) {
  2643. $element = $variables['element'];
  2644. $element['#attributes']['type'] = 'radio';
  2645. element_set_attributes($element, array('id', 'name', '#return_value' => 'value'));
  2646. if (isset($element['#return_value']) && $element['#value'] !== FALSE && $element['#value'] == $element['#return_value']) {
  2647. $element['#attributes']['checked'] = 'checked';
  2648. }
  2649. _form_set_class($element, array('form-radio'));
  2650. return '<input' . drupal_attributes($element['#attributes']) . ' />';
  2651. }
  2652. /**
  2653. * Returns HTML for a set of radio button form elements.
  2654. *
  2655. * @param $variables
  2656. * An associative array containing:
  2657. * - element: An associative array containing the properties of the element.
  2658. * Properties used: #title, #value, #options, #description, #required,
  2659. * #attributes, #children.
  2660. *
  2661. * @ingroup themeable
  2662. */
  2663. function theme_radios($variables) {
  2664. $element = $variables['element'];
  2665. $attributes = array();
  2666. if (isset($element['#id'])) {
  2667. $attributes['id'] = $element['#id'];
  2668. }
  2669. $attributes['class'] = 'form-radios';
  2670. if (!empty($element['#attributes']['class'])) {
  2671. $attributes['class'] .= ' ' . implode(' ', $element['#attributes']['class']);
  2672. }
  2673. if (isset($element['#attributes']['title'])) {
  2674. $attributes['title'] = $element['#attributes']['title'];
  2675. }
  2676. return '<div' . drupal_attributes($attributes) . '>' . (!empty($element['#children']) ? $element['#children'] : '') . '</div>';
  2677. }
  2678. /**
  2679. * Expand a password_confirm field into two text boxes.
  2680. */
  2681. function form_process_password_confirm($element) {
  2682. $element['pass1'] = array(
  2683. '#type' => 'password',
  2684. '#title' => t('Password'),
  2685. '#value' => empty($element['#value']) ? NULL : $element['#value']['pass1'],
  2686. '#required' => $element['#required'],
  2687. '#attributes' => array('class' => array('password-field')),
  2688. );
  2689. $element['pass2'] = array(
  2690. '#type' => 'password',
  2691. '#title' => t('Confirm password'),
  2692. '#value' => empty($element['#value']) ? NULL : $element['#value']['pass2'],
  2693. '#required' => $element['#required'],
  2694. '#attributes' => array('class' => array('password-confirm')),
  2695. );
  2696. $element['#element_validate'] = array('password_confirm_validate');
  2697. $element['#tree'] = TRUE;
  2698. if (isset($element['#size'])) {
  2699. $element['pass1']['#size'] = $element['pass2']['#size'] = $element['#size'];
  2700. }
  2701. return $element;
  2702. }
  2703. /**
  2704. * Validates a password_confirm element.
  2705. */
  2706. function password_confirm_validate($element, &$element_state) {
  2707. $pass1 = trim($element['pass1']['#value']);
  2708. $pass2 = trim($element['pass2']['#value']);
  2709. if (!empty($pass1) || !empty($pass2)) {
  2710. if (strcmp($pass1, $pass2)) {
  2711. form_error($element, t('The specified passwords do not match.'));
  2712. }
  2713. }
  2714. elseif ($element['#required'] && !empty($element_state['input'])) {
  2715. form_error($element, t('Password field is required.'));
  2716. }
  2717. // Password field must be converted from a two-element array into a single
  2718. // string regardless of validation results.
  2719. form_set_value($element['pass1'], NULL, $element_state);
  2720. form_set_value($element['pass2'], NULL, $element_state);
  2721. form_set_value($element, $pass1, $element_state);
  2722. return $element;
  2723. }
  2724. /**
  2725. * Returns HTML for a date selection form element.
  2726. *
  2727. * @param $variables
  2728. * An associative array containing:
  2729. * - element: An associative array containing the properties of the element.
  2730. * Properties used: #title, #value, #options, #description, #required,
  2731. * #attributes.
  2732. *
  2733. * @ingroup themeable
  2734. */
  2735. function theme_date($variables) {
  2736. $element = $variables['element'];
  2737. $attributes = array();
  2738. if (isset($element['#id'])) {
  2739. $attributes['id'] = $element['#id'];
  2740. }
  2741. if (!empty($element['#attributes']['class'])) {
  2742. $attributes['class'] = (array) $element['#attributes']['class'];
  2743. }
  2744. $attributes['class'][] = 'container-inline';
  2745. return '<div' . drupal_attributes($attributes) . '>' . drupal_render_children($element) . '</div>';
  2746. }
  2747. /**
  2748. * Expands a date element into year, month, and day select elements.
  2749. */
  2750. function form_process_date($element) {
  2751. // Default to current date
  2752. if (empty($element['#value'])) {
  2753. $element['#value'] = array(
  2754. 'day' => format_date(REQUEST_TIME, 'custom', 'j'),
  2755. 'month' => format_date(REQUEST_TIME, 'custom', 'n'),
  2756. 'year' => format_date(REQUEST_TIME, 'custom', 'Y'),
  2757. );
  2758. }
  2759. $element['#tree'] = TRUE;
  2760. // Determine the order of day, month, year in the site's chosen date format.
  2761. $format = variable_get('date_format_short', 'm/d/Y - H:i');
  2762. $sort = array();
  2763. $sort['day'] = max(strpos($format, 'd'), strpos($format, 'j'));
  2764. $sort['month'] = max(strpos($format, 'm'), strpos($format, 'M'));
  2765. $sort['year'] = strpos($format, 'Y');
  2766. asort($sort);
  2767. $order = array_keys($sort);
  2768. // Output multi-selector for date.
  2769. foreach ($order as $type) {
  2770. switch ($type) {
  2771. case 'day':
  2772. $options = drupal_map_assoc(range(1, 31));
  2773. $title = t('Day');
  2774. break;
  2775. case 'month':
  2776. $options = drupal_map_assoc(range(1, 12), 'map_month');
  2777. $title = t('Month');
  2778. break;
  2779. case 'year':
  2780. $options = drupal_map_assoc(range(1900, 2050));
  2781. $title = t('Year');
  2782. break;
  2783. }
  2784. $element[$type] = array(
  2785. '#type' => 'select',
  2786. '#title' => $title,
  2787. '#title_display' => 'invisible',
  2788. '#value' => $element['#value'][$type],
  2789. '#attributes' => $element['#attributes'],
  2790. '#options' => $options,
  2791. );
  2792. }
  2793. return $element;
  2794. }
  2795. /**
  2796. * Validates the date type to prevent invalid dates (e.g., February 30, 2006).
  2797. */
  2798. function date_validate($element) {
  2799. if (!checkdate($element['#value']['month'], $element['#value']['day'], $element['#value']['year'])) {
  2800. form_error($element, t('The specified date is invalid.'));
  2801. }
  2802. }
  2803. /**
  2804. * Helper function for usage with drupal_map_assoc to display month names.
  2805. */
  2806. function map_month($month) {
  2807. $months = &drupal_static(__FUNCTION__, array(
  2808. 1 => 'Jan',
  2809. 2 => 'Feb',
  2810. 3 => 'Mar',
  2811. 4 => 'Apr',
  2812. 5 => 'May',
  2813. 6 => 'Jun',
  2814. 7 => 'Jul',
  2815. 8 => 'Aug',
  2816. 9 => 'Sep',
  2817. 10 => 'Oct',
  2818. 11 => 'Nov',
  2819. 12 => 'Dec',
  2820. ));
  2821. return t($months[$month]);
  2822. }
  2823. /**
  2824. * Sets the value for a weight element, with zero as a default.
  2825. */
  2826. function weight_value(&$form) {
  2827. if (isset($form['#default_value'])) {
  2828. $form['#value'] = $form['#default_value'];
  2829. }
  2830. else {
  2831. $form['#value'] = 0;
  2832. }
  2833. }
  2834. /**
  2835. * Expands a radios element into individual radio elements.
  2836. */
  2837. function form_process_radios($element) {
  2838. if (count($element['#options']) > 0) {
  2839. $weight = 0;
  2840. foreach ($element['#options'] as $key => $choice) {
  2841. // Maintain order of options as defined in #options, in case the element
  2842. // defines custom option sub-elements, but does not define all option
  2843. // sub-elements.
  2844. $weight += 0.001;
  2845. $element += array($key => array());
  2846. // Generate the parents as the autogenerator does, so we will have a
  2847. // unique id for each radio button.
  2848. $parents_for_id = array_merge($element['#parents'], array($key));
  2849. $element[$key] += array(
  2850. '#type' => 'radio',
  2851. '#title' => $choice,
  2852. // The key is sanitized in drupal_attributes() during output from the
  2853. // theme function.
  2854. '#return_value' => $key,
  2855. // Use default or FALSE. A value of FALSE means that the radio button is
  2856. // not 'checked'.
  2857. '#default_value' => isset($element['#default_value']) ? $element['#default_value'] : FALSE,
  2858. '#attributes' => $element['#attributes'],
  2859. '#parents' => $element['#parents'],
  2860. '#id' => drupal_html_id('edit-' . implode('-', $parents_for_id)),
  2861. '#ajax' => isset($element['#ajax']) ? $element['#ajax'] : NULL,
  2862. '#weight' => $weight,
  2863. );
  2864. }
  2865. }
  2866. return $element;
  2867. }
  2868. /**
  2869. * Returns HTML for a checkbox form element.
  2870. *
  2871. * @param $variables
  2872. * An associative array containing:
  2873. * - element: An associative array containing the properties of the element.
  2874. * Properties used: #title, #value, #return_value, #description, #required,
  2875. * #attributes, #checked.
  2876. *
  2877. * @ingroup themeable
  2878. */
  2879. function theme_checkbox($variables) {
  2880. $element = $variables['element'];
  2881. $element['#attributes']['type'] = 'checkbox';
  2882. element_set_attributes($element, array('id', 'name', '#return_value' => 'value'));
  2883. // Unchecked checkbox has #value of integer 0.
  2884. if (!empty($element['#checked'])) {
  2885. $element['#attributes']['checked'] = 'checked';
  2886. }
  2887. _form_set_class($element, array('form-checkbox'));
  2888. return '<input' . drupal_attributes($element['#attributes']) . ' />';
  2889. }
  2890. /**
  2891. * Returns HTML for a set of checkbox form elements.
  2892. *
  2893. * @param $variables
  2894. * An associative array containing:
  2895. * - element: An associative array containing the properties of the element.
  2896. * Properties used: #children, #attributes.
  2897. *
  2898. * @ingroup themeable
  2899. */
  2900. function theme_checkboxes($variables) {
  2901. $element = $variables['element'];
  2902. $attributes = array();
  2903. if (isset($element['#id'])) {
  2904. $attributes['id'] = $element['#id'];
  2905. }
  2906. $attributes['class'][] = 'form-checkboxes';
  2907. if (!empty($element['#attributes']['class'])) {
  2908. $attributes['class'] = array_merge($attributes['class'], $element['#attributes']['class']);
  2909. }
  2910. if (isset($element['#attributes']['title'])) {
  2911. $attributes['title'] = $element['#attributes']['title'];
  2912. }
  2913. return '<div' . drupal_attributes($attributes) . '>' . (!empty($element['#children']) ? $element['#children'] : '') . '</div>';
  2914. }
  2915. /**
  2916. * Adds form element theming to an element if its title or description is set.
  2917. *
  2918. * This is used as a pre render function for checkboxes and radios.
  2919. */
  2920. function form_pre_render_conditional_form_element($element) {
  2921. $t = get_t();
  2922. // Set the element's title attribute to show #title as a tooltip, if needed.
  2923. if (isset($element['#title']) && $element['#title_display'] == 'attribute') {
  2924. $element['#attributes']['title'] = $element['#title'];
  2925. if (!empty($element['#required'])) {
  2926. // Append an indication that this field is required.
  2927. $element['#attributes']['title'] .= ' (' . $t('Required') . ')';
  2928. }
  2929. }
  2930. if (isset($element['#title']) || isset($element['#description'])) {
  2931. $element['#theme_wrappers'][] = 'form_element';
  2932. }
  2933. return $element;
  2934. }
  2935. /**
  2936. * Sets the #checked property of a checkbox element.
  2937. */
  2938. function form_process_checkbox($element, $form_state) {
  2939. $value = $element['#value'];
  2940. $return_value = $element['#return_value'];
  2941. // On form submission, the #value of an available and enabled checked
  2942. // checkbox is #return_value, and the #value of an available and enabled
  2943. // unchecked checkbox is integer 0. On not submitted forms, and for
  2944. // checkboxes with #access=FALSE or #disabled=TRUE, the #value is
  2945. // #default_value (integer 0 if #default_value is NULL). Most of the time,
  2946. // a string comparison of #value and #return_value is sufficient for
  2947. // determining the "checked" state, but a value of TRUE always means checked
  2948. // (even if #return_value is 'foo'), and a value of FALSE or integer 0 always
  2949. // means unchecked (even if #return_value is '' or '0').
  2950. if ($value === TRUE || $value === FALSE || $value === 0) {
  2951. $element['#checked'] = (bool) $value;
  2952. }
  2953. else {
  2954. // Compare as strings, so that 15 is not considered equal to '15foo', but 1
  2955. // is considered equal to '1'. This cast does not imply that either #value
  2956. // or #return_value is expected to be a string.
  2957. $element['#checked'] = ((string) $value === (string) $return_value);
  2958. }
  2959. return $element;
  2960. }
  2961. /**
  2962. * Processes a checkboxes form element.
  2963. */
  2964. function form_process_checkboxes($element) {
  2965. $value = is_array($element['#value']) ? $element['#value'] : array();
  2966. $element['#tree'] = TRUE;
  2967. if (count($element['#options']) > 0) {
  2968. if (!isset($element['#default_value']) || $element['#default_value'] == 0) {
  2969. $element['#default_value'] = array();
  2970. }
  2971. $weight = 0;
  2972. foreach ($element['#options'] as $key => $choice) {
  2973. // Integer 0 is not a valid #return_value, so use '0' instead.
  2974. // @see form_type_checkbox_value().
  2975. // @todo For Drupal 8, cast all integer keys to strings for consistency
  2976. // with form_process_radios().
  2977. if ($key === 0) {
  2978. $key = '0';
  2979. }
  2980. // Maintain order of options as defined in #options, in case the element
  2981. // defines custom option sub-elements, but does not define all option
  2982. // sub-elements.
  2983. $weight += 0.001;
  2984. $element += array($key => array());
  2985. $element[$key] += array(
  2986. '#type' => 'checkbox',
  2987. '#title' => $choice,
  2988. '#return_value' => $key,
  2989. '#default_value' => isset($value[$key]) ? $key : NULL,
  2990. '#attributes' => $element['#attributes'],
  2991. '#ajax' => isset($element['#ajax']) ? $element['#ajax'] : NULL,
  2992. '#weight' => $weight,
  2993. );
  2994. }
  2995. }
  2996. return $element;
  2997. }
  2998. /**
  2999. * Processes a form actions container element.
  3000. *
  3001. * @param $element
  3002. * An associative array containing the properties and children of the
  3003. * form actions container.
  3004. * @param $form_state
  3005. * The $form_state array for the form this element belongs to.
  3006. *
  3007. * @return
  3008. * The processed element.
  3009. */
  3010. function form_process_actions($element, &$form_state) {
  3011. $element['#attributes']['class'][] = 'form-actions';
  3012. return $element;
  3013. }
  3014. /**
  3015. * Processes a container element.
  3016. *
  3017. * @param $element
  3018. * An associative array containing the properties and children of the
  3019. * container.
  3020. * @param $form_state
  3021. * The $form_state array for the form this element belongs to.
  3022. *
  3023. * @return
  3024. * The processed element.
  3025. */
  3026. function form_process_container($element, &$form_state) {
  3027. // Generate the ID of the element if it's not explicitly given.
  3028. if (!isset($element['#id'])) {
  3029. $element['#id'] = drupal_html_id(implode('-', $element['#parents']) . '-wrapper');
  3030. }
  3031. return $element;
  3032. }
  3033. /**
  3034. * Returns HTML to wrap child elements in a container.
  3035. *
  3036. * Used for grouped form items. Can also be used as a #theme_wrapper for any
  3037. * renderable element, to surround it with a <div> and add attributes such as
  3038. * classes or an HTML id.
  3039. *
  3040. * @param $variables
  3041. * An associative array containing:
  3042. * - element: An associative array containing the properties of the element.
  3043. * Properties used: #id, #attributes, #children.
  3044. *
  3045. * @ingroup themeable
  3046. */
  3047. function theme_container($variables) {
  3048. $element = $variables['element'];
  3049. // Special handling for form elements.
  3050. if (isset($element['#array_parents'])) {
  3051. // Assign an html ID.
  3052. if (!isset($element['#attributes']['id'])) {
  3053. $element['#attributes']['id'] = $element['#id'];
  3054. }
  3055. // Add the 'form-wrapper' class.
  3056. $element['#attributes']['class'][] = 'form-wrapper';
  3057. }
  3058. return '<div' . drupal_attributes($element['#attributes']) . '>' . $element['#children'] . '</div>';
  3059. }
  3060. /**
  3061. * Returns HTML for a table with radio buttons or checkboxes.
  3062. *
  3063. * @param $variables
  3064. * An associative array containing:
  3065. * - element: An associative array containing the properties and children of
  3066. * the tableselect element. Properties used: #header, #options, #empty,
  3067. * and #js_select. The #options property is an array of selection options;
  3068. * each array element of #options is an array of properties. These
  3069. * properties can include #attributes, which is added to the
  3070. * table row's HTML attributes; see theme_table(). An example of per-row
  3071. * options:
  3072. * @code
  3073. * $options = array(
  3074. * array(
  3075. * 'title' => 'How to Learn Drupal',
  3076. * 'content_type' => 'Article',
  3077. * 'status' => 'published',
  3078. * '#attributes' => array('class' => array('article-row')),
  3079. * ),
  3080. * array(
  3081. * 'title' => 'Privacy Policy',
  3082. * 'content_type' => 'Page',
  3083. * 'status' => 'published',
  3084. * '#attributes' => array('class' => array('page-row')),
  3085. * ),
  3086. * );
  3087. * $header = array(
  3088. * 'title' => t('Title'),
  3089. * 'content_type' => t('Content type'),
  3090. * 'status' => t('Status'),
  3091. * );
  3092. * $form['table'] = array(
  3093. * '#type' => 'tableselect',
  3094. * '#header' => $header,
  3095. * '#options' => $options,
  3096. * '#empty' => t('No content available.'),
  3097. * );
  3098. * @endcode
  3099. *
  3100. * @ingroup themeable
  3101. */
  3102. function theme_tableselect($variables) {
  3103. $element = $variables['element'];
  3104. $rows = array();
  3105. $header = $element['#header'];
  3106. if (!empty($element['#options'])) {
  3107. // Generate a table row for each selectable item in #options.
  3108. foreach (element_children($element) as $key) {
  3109. $row = array();
  3110. $row['data'] = array();
  3111. if (isset($element['#options'][$key]['#attributes'])) {
  3112. $row += $element['#options'][$key]['#attributes'];
  3113. }
  3114. // Render the checkbox / radio element.
  3115. $row['data'][] = drupal_render($element[$key]);
  3116. // As theme_table only maps header and row columns by order, create the
  3117. // correct order by iterating over the header fields.
  3118. foreach ($element['#header'] as $fieldname => $title) {
  3119. $row['data'][] = $element['#options'][$key][$fieldname];
  3120. }
  3121. $rows[] = $row;
  3122. }
  3123. // Add an empty header or a "Select all" checkbox to provide room for the
  3124. // checkboxes/radios in the first table column.
  3125. if ($element['#js_select']) {
  3126. // Add a "Select all" checkbox.
  3127. drupal_add_js('misc/tableselect.js');
  3128. array_unshift($header, array('class' => array('select-all')));
  3129. }
  3130. else {
  3131. // Add an empty header when radio buttons are displayed or a "Select all"
  3132. // checkbox is not desired.
  3133. array_unshift($header, '');
  3134. }
  3135. }
  3136. return theme('table', array('header' => $header, 'rows' => $rows, 'empty' => $element['#empty'], 'attributes' => $element['#attributes']));
  3137. }
  3138. /**
  3139. * Creates checkbox or radio elements to populate a tableselect table.
  3140. *
  3141. * @param $element
  3142. * An associative array containing the properties and children of the
  3143. * tableselect element.
  3144. *
  3145. * @return
  3146. * The processed element.
  3147. */
  3148. function form_process_tableselect($element) {
  3149. if ($element['#multiple']) {
  3150. $value = is_array($element['#value']) ? $element['#value'] : array();
  3151. }
  3152. else {
  3153. // Advanced selection behavior makes no sense for radios.
  3154. $element['#js_select'] = FALSE;
  3155. }
  3156. $element['#tree'] = TRUE;
  3157. if (count($element['#options']) > 0) {
  3158. if (!isset($element['#default_value']) || $element['#default_value'] === 0) {
  3159. $element['#default_value'] = array();
  3160. }
  3161. // Create a checkbox or radio for each item in #options in such a way that
  3162. // the value of the tableselect element behaves as if it had been of type
  3163. // checkboxes or radios.
  3164. foreach ($element['#options'] as $key => $choice) {
  3165. // Do not overwrite manually created children.
  3166. if (!isset($element[$key])) {
  3167. if ($element['#multiple']) {
  3168. $title = '';
  3169. if (!empty($element['#options'][$key]['title']['data']['#title'])) {
  3170. $title = t('Update @title', array(
  3171. '@title' => $element['#options'][$key]['title']['data']['#title'],
  3172. ));
  3173. }
  3174. $element[$key] = array(
  3175. '#type' => 'checkbox',
  3176. '#title' => $title,
  3177. '#title_display' => 'invisible',
  3178. '#return_value' => $key,
  3179. '#default_value' => isset($value[$key]) ? $key : NULL,
  3180. '#attributes' => $element['#attributes'],
  3181. );
  3182. }
  3183. else {
  3184. // Generate the parents as the autogenerator does, so we will have a
  3185. // unique id for each radio button.
  3186. $parents_for_id = array_merge($element['#parents'], array($key));
  3187. $element[$key] = array(
  3188. '#type' => 'radio',
  3189. '#title' => '',
  3190. '#return_value' => $key,
  3191. '#default_value' => ($element['#default_value'] == $key) ? $key : NULL,
  3192. '#attributes' => $element['#attributes'],
  3193. '#parents' => $element['#parents'],
  3194. '#id' => drupal_html_id('edit-' . implode('-', $parents_for_id)),
  3195. '#ajax' => isset($element['#ajax']) ? $element['#ajax'] : NULL,
  3196. );
  3197. }
  3198. if (isset($element['#options'][$key]['#weight'])) {
  3199. $element[$key]['#weight'] = $element['#options'][$key]['#weight'];
  3200. }
  3201. }
  3202. }
  3203. }
  3204. else {
  3205. $element['#value'] = array();
  3206. }
  3207. return $element;
  3208. }
  3209. /**
  3210. * Processes a machine-readable name form element.
  3211. *
  3212. * @param $element
  3213. * The form element to process. Properties used:
  3214. * - #machine_name: An associative array containing:
  3215. * - exists: A function name to invoke for checking whether a submitted
  3216. * machine name value already exists. The submitted value is passed as
  3217. * argument. In most cases, an existing API or menu argument loader
  3218. * function can be re-used. The callback is only invoked, if the submitted
  3219. * value differs from the element's #default_value.
  3220. * - source: (optional) The #array_parents of the form element containing
  3221. * the human-readable name (i.e., as contained in the $form structure) to
  3222. * use as source for the machine name. Defaults to array('name').
  3223. * - label: (optional) A text to display as label for the machine name value
  3224. * after the human-readable name form element. Defaults to "Machine name".
  3225. * - replace_pattern: (optional) A regular expression (without delimiters)
  3226. * matching disallowed characters in the machine name. Defaults to
  3227. * '[^a-z0-9_]+'.
  3228. * - replace: (optional) A character to replace disallowed characters in the
  3229. * machine name via JavaScript. Defaults to '_' (underscore). When using a
  3230. * different character, 'replace_pattern' needs to be set accordingly.
  3231. * - error: (optional) A custom form error message string to show, if the
  3232. * machine name contains disallowed characters.
  3233. * - standalone: (optional) Whether the live preview should stay in its own
  3234. * form element rather than in the suffix of the source element. Defaults
  3235. * to FALSE.
  3236. * - #maxlength: (optional) Should be set to the maximum allowed length of the
  3237. * machine name. Defaults to 64.
  3238. * - #disabled: (optional) Should be set to TRUE in case an existing machine
  3239. * name must not be changed after initial creation.
  3240. */
  3241. function form_process_machine_name($element, &$form_state) {
  3242. // Apply default form element properties.
  3243. $element += array(
  3244. '#title' => t('Machine-readable name'),
  3245. '#description' => t('A unique machine-readable name. Can only contain lowercase letters, numbers, and underscores.'),
  3246. '#machine_name' => array(),
  3247. '#field_prefix' => '',
  3248. '#field_suffix' => '',
  3249. '#suffix' => '',
  3250. );
  3251. // A form element that only wants to set one #machine_name property (usually
  3252. // 'source' only) would leave all other properties undefined, if the defaults
  3253. // were defined in hook_element_info(). Therefore, we apply the defaults here.
  3254. $element['#machine_name'] += array(
  3255. 'source' => array('name'),
  3256. 'target' => '#' . $element['#id'],
  3257. 'label' => t('Machine name'),
  3258. 'replace_pattern' => '[^a-z0-9_]+',
  3259. 'replace' => '_',
  3260. 'standalone' => FALSE,
  3261. 'field_prefix' => $element['#field_prefix'],
  3262. 'field_suffix' => $element['#field_suffix'],
  3263. );
  3264. // By default, machine names are restricted to Latin alphanumeric characters.
  3265. // So, default to LTR directionality.
  3266. if (!isset($element['#attributes'])) {
  3267. $element['#attributes'] = array();
  3268. }
  3269. $element['#attributes'] += array('dir' => 'ltr');
  3270. // The source element defaults to array('name'), but may have been overidden.
  3271. if (empty($element['#machine_name']['source'])) {
  3272. return $element;
  3273. }
  3274. // Retrieve the form element containing the human-readable name from the
  3275. // complete form in $form_state. By reference, because we may need to append
  3276. // a #field_suffix that will hold the live preview.
  3277. $key_exists = NULL;
  3278. $source = drupal_array_get_nested_value($form_state['complete form'], $element['#machine_name']['source'], $key_exists);
  3279. if (!$key_exists) {
  3280. return $element;
  3281. }
  3282. $suffix_id = $source['#id'] . '-machine-name-suffix';
  3283. $element['#machine_name']['suffix'] = '#' . $suffix_id;
  3284. if ($element['#machine_name']['standalone']) {
  3285. $element['#suffix'] .= ' <small id="' . $suffix_id . '">&nbsp;</small>';
  3286. }
  3287. else {
  3288. // Append a field suffix to the source form element, which will contain
  3289. // the live preview of the machine name.
  3290. $source += array('#field_suffix' => '');
  3291. $source['#field_suffix'] .= ' <small id="' . $suffix_id . '">&nbsp;</small>';
  3292. $parents = array_merge($element['#machine_name']['source'], array('#field_suffix'));
  3293. drupal_array_set_nested_value($form_state['complete form'], $parents, $source['#field_suffix']);
  3294. }
  3295. $js_settings = array(
  3296. 'type' => 'setting',
  3297. 'data' => array(
  3298. 'machineName' => array(
  3299. '#' . $source['#id'] => $element['#machine_name'],
  3300. ),
  3301. ),
  3302. );
  3303. $element['#attached']['js'][] = 'misc/machine-name.js';
  3304. $element['#attached']['js'][] = $js_settings;
  3305. return $element;
  3306. }
  3307. /**
  3308. * Form element validation handler for machine_name elements.
  3309. *
  3310. * Note that #maxlength is validated by _form_validate() already.
  3311. */
  3312. function form_validate_machine_name(&$element, &$form_state) {
  3313. // Verify that the machine name not only consists of replacement tokens.
  3314. if (preg_match('@^' . $element['#machine_name']['replace'] . '+$@', $element['#value'])) {
  3315. form_error($element, t('The machine-readable name must contain unique characters.'));
  3316. }
  3317. // Verify that the machine name contains no disallowed characters.
  3318. if (preg_match('@' . $element['#machine_name']['replace_pattern'] . '@', $element['#value'])) {
  3319. if (!isset($element['#machine_name']['error'])) {
  3320. // Since a hyphen is the most common alternative replacement character,
  3321. // a corresponding validation error message is supported here.
  3322. if ($element['#machine_name']['replace'] == '-') {
  3323. form_error($element, t('The machine-readable name must contain only lowercase letters, numbers, and hyphens.'));
  3324. }
  3325. // Otherwise, we assume the default (underscore).
  3326. else {
  3327. form_error($element, t('The machine-readable name must contain only lowercase letters, numbers, and underscores.'));
  3328. }
  3329. }
  3330. else {
  3331. form_error($element, $element['#machine_name']['error']);
  3332. }
  3333. }
  3334. // Verify that the machine name is unique.
  3335. if ($element['#default_value'] !== $element['#value']) {
  3336. $function = $element['#machine_name']['exists'];
  3337. if ($function($element['#value'], $element, $form_state)) {
  3338. form_error($element, t('The machine-readable name is already in use. It must be unique.'));
  3339. }
  3340. }
  3341. }
  3342. /**
  3343. * Arranges fieldsets into groups.
  3344. *
  3345. * @param $element
  3346. * An associative array containing the properties and children of the
  3347. * fieldset. Note that $element must be taken by reference here, so processed
  3348. * child elements are taken over into $form_state.
  3349. * @param $form_state
  3350. * The $form_state array for the form this fieldset belongs to.
  3351. *
  3352. * @return
  3353. * The processed element.
  3354. */
  3355. function form_process_fieldset(&$element, &$form_state) {
  3356. $parents = implode('][', $element['#parents']);
  3357. // Each fieldset forms a new group. The #type 'vertical_tabs' basically only
  3358. // injects a new fieldset.
  3359. $form_state['groups'][$parents]['#group_exists'] = TRUE;
  3360. $element['#groups'] = &$form_state['groups'];
  3361. // Process vertical tabs group member fieldsets.
  3362. if (isset($element['#group'])) {
  3363. // Add this fieldset to the defined group (by reference).
  3364. $group = $element['#group'];
  3365. $form_state['groups'][$group][] = &$element;
  3366. }
  3367. // Contains form element summary functionalities.
  3368. $element['#attached']['library'][] = array('system', 'drupal.form');
  3369. // The .form-wrapper class is required for #states to treat fieldsets like
  3370. // containers.
  3371. if (!isset($element['#attributes']['class'])) {
  3372. $element['#attributes']['class'] = array();
  3373. }
  3374. // Collapsible fieldsets
  3375. if (!empty($element['#collapsible'])) {
  3376. $element['#attached']['library'][] = array('system', 'drupal.collapse');
  3377. $element['#attributes']['class'][] = 'collapsible';
  3378. if (!empty($element['#collapsed'])) {
  3379. $element['#attributes']['class'][] = 'collapsed';
  3380. }
  3381. }
  3382. return $element;
  3383. }
  3384. /**
  3385. * Adds members of this group as actual elements for rendering.
  3386. *
  3387. * @param $element
  3388. * An associative array containing the properties and children of the
  3389. * fieldset.
  3390. *
  3391. * @return
  3392. * The modified element with all group members.
  3393. */
  3394. function form_pre_render_fieldset($element) {
  3395. // Fieldsets may be rendered outside of a Form API context.
  3396. if (!isset($element['#parents']) || !isset($element['#groups'])) {
  3397. return $element;
  3398. }
  3399. // Inject group member elements belonging to this group.
  3400. $parents = implode('][', $element['#parents']);
  3401. $children = element_children($element['#groups'][$parents]);
  3402. if (!empty($children)) {
  3403. foreach ($children as $key) {
  3404. // Break references and indicate that the element should be rendered as
  3405. // group member.
  3406. $child = (array) $element['#groups'][$parents][$key];
  3407. $child['#group_fieldset'] = TRUE;
  3408. // Inject the element as new child element.
  3409. $element[] = $child;
  3410. $sort = TRUE;
  3411. }
  3412. // Re-sort the element's children if we injected group member elements.
  3413. if (isset($sort)) {
  3414. $element['#sorted'] = FALSE;
  3415. }
  3416. }
  3417. if (isset($element['#group'])) {
  3418. $group = $element['#group'];
  3419. // If this element belongs to a group, but the group-holding element does
  3420. // not exist, we need to render it (at its original location).
  3421. if (!isset($element['#groups'][$group]['#group_exists'])) {
  3422. // Intentionally empty to clarify the flow; we simply return $element.
  3423. }
  3424. // If we injected this element into the group, then we want to render it.
  3425. elseif (!empty($element['#group_fieldset'])) {
  3426. // Intentionally empty to clarify the flow; we simply return $element.
  3427. }
  3428. // Otherwise, this element belongs to a group and the group exists, so we do
  3429. // not render it.
  3430. elseif (element_children($element['#groups'][$group])) {
  3431. $element['#printed'] = TRUE;
  3432. }
  3433. }
  3434. return $element;
  3435. }
  3436. /**
  3437. * Creates a group formatted as vertical tabs.
  3438. *
  3439. * @param $element
  3440. * An associative array containing the properties and children of the
  3441. * fieldset.
  3442. * @param $form_state
  3443. * The $form_state array for the form this vertical tab widget belongs to.
  3444. *
  3445. * @return
  3446. * The processed element.
  3447. */
  3448. function form_process_vertical_tabs($element, &$form_state) {
  3449. // Inject a new fieldset as child, so that form_process_fieldset() processes
  3450. // this fieldset like any other fieldset.
  3451. $element['group'] = array(
  3452. '#type' => 'fieldset',
  3453. '#theme_wrappers' => array(),
  3454. '#parents' => $element['#parents'],
  3455. );
  3456. // The JavaScript stores the currently selected tab in this hidden
  3457. // field so that the active tab can be restored the next time the
  3458. // form is rendered, e.g. on preview pages or when form validation
  3459. // fails.
  3460. $name = implode('__', $element['#parents']);
  3461. if (isset($form_state['values'][$name . '__active_tab'])) {
  3462. $element['#default_tab'] = $form_state['values'][$name . '__active_tab'];
  3463. }
  3464. $element[$name . '__active_tab'] = array(
  3465. '#type' => 'hidden',
  3466. '#default_value' => $element['#default_tab'],
  3467. '#attributes' => array('class' => array('vertical-tabs-active-tab')),
  3468. );
  3469. return $element;
  3470. }
  3471. /**
  3472. * Returns HTML for an element's children fieldsets as vertical tabs.
  3473. *
  3474. * @param $variables
  3475. * An associative array containing:
  3476. * - element: An associative array containing the properties and children of
  3477. * the fieldset. Properties used: #children.
  3478. *
  3479. * @ingroup themeable
  3480. */
  3481. function theme_vertical_tabs($variables) {
  3482. $element = $variables['element'];
  3483. // Add required JavaScript and Stylesheet.
  3484. drupal_add_library('system', 'drupal.vertical-tabs');
  3485. $output = '<h2 class="element-invisible">' . t('Vertical Tabs') . '</h2>';
  3486. $output .= '<div class="vertical-tabs-panes">' . $element['#children'] . '</div>';
  3487. return $output;
  3488. }
  3489. /**
  3490. * Returns HTML for a submit button form element.
  3491. *
  3492. * @param $variables
  3493. * An associative array containing:
  3494. * - element: An associative array containing the properties of the element.
  3495. * Properties used: #attributes, #button_type, #name, #value.
  3496. *
  3497. * @ingroup themeable
  3498. */
  3499. function theme_submit($variables) {
  3500. return theme('button', $variables['element']);
  3501. }
  3502. /**
  3503. * Returns HTML for a button form element.
  3504. *
  3505. * @param $variables
  3506. * An associative array containing:
  3507. * - element: An associative array containing the properties of the element.
  3508. * Properties used: #attributes, #button_type, #name, #value.
  3509. *
  3510. * @ingroup themeable
  3511. */
  3512. function theme_button($variables) {
  3513. $element = $variables['element'];
  3514. $element['#attributes']['type'] = 'submit';
  3515. element_set_attributes($element, array('id', 'name', 'value'));
  3516. $element['#attributes']['class'][] = 'form-' . $element['#button_type'];
  3517. if (!empty($element['#attributes']['disabled'])) {
  3518. $element['#attributes']['class'][] = 'form-button-disabled';
  3519. }
  3520. return '<input' . drupal_attributes($element['#attributes']) . ' />';
  3521. }
  3522. /**
  3523. * Returns HTML for an image button form element.
  3524. *
  3525. * @param $variables
  3526. * An associative array containing:
  3527. * - element: An associative array containing the properties of the element.
  3528. * Properties used: #attributes, #button_type, #name, #value, #title, #src.
  3529. *
  3530. * @ingroup themeable
  3531. */
  3532. function theme_image_button($variables) {
  3533. $element = $variables['element'];
  3534. $element['#attributes']['type'] = 'image';
  3535. element_set_attributes($element, array('id', 'name', 'value'));
  3536. $element['#attributes']['src'] = file_create_url($element['#src']);
  3537. if (!empty($element['#title'])) {
  3538. $element['#attributes']['alt'] = $element['#title'];
  3539. $element['#attributes']['title'] = $element['#title'];
  3540. }
  3541. $element['#attributes']['class'][] = 'form-' . $element['#button_type'];
  3542. if (!empty($element['#attributes']['disabled'])) {
  3543. $element['#attributes']['class'][] = 'form-button-disabled';
  3544. }
  3545. return '<input' . drupal_attributes($element['#attributes']) . ' />';
  3546. }
  3547. /**
  3548. * Returns HTML for a hidden form element.
  3549. *
  3550. * @param $variables
  3551. * An associative array containing:
  3552. * - element: An associative array containing the properties of the element.
  3553. * Properties used: #name, #value, #attributes.
  3554. *
  3555. * @ingroup themeable
  3556. */
  3557. function theme_hidden($variables) {
  3558. $element = $variables['element'];
  3559. $element['#attributes']['type'] = 'hidden';
  3560. element_set_attributes($element, array('name', 'value'));
  3561. return '<input' . drupal_attributes($element['#attributes']) . " />\n";
  3562. }
  3563. /**
  3564. * Returns HTML for a textfield form element.
  3565. *
  3566. * @param $variables
  3567. * An associative array containing:
  3568. * - element: An associative array containing the properties of the element.
  3569. * Properties used: #title, #value, #description, #size, #maxlength,
  3570. * #required, #attributes, #autocomplete_path.
  3571. *
  3572. * @ingroup themeable
  3573. */
  3574. function theme_textfield($variables) {
  3575. $element = $variables['element'];
  3576. $element['#attributes']['type'] = 'text';
  3577. element_set_attributes($element, array('id', 'name', 'value', 'size', 'maxlength'));
  3578. _form_set_class($element, array('form-text'));
  3579. $extra = '';
  3580. if ($element['#autocomplete_path'] && drupal_valid_path($element['#autocomplete_path'])) {
  3581. drupal_add_library('system', 'drupal.autocomplete');
  3582. $element['#attributes']['class'][] = 'form-autocomplete';
  3583. $attributes = array();
  3584. $attributes['type'] = 'hidden';
  3585. $attributes['id'] = $element['#attributes']['id'] . '-autocomplete';
  3586. $attributes['value'] = url($element['#autocomplete_path'], array('absolute' => TRUE));
  3587. $attributes['disabled'] = 'disabled';
  3588. $attributes['class'][] = 'autocomplete';
  3589. $extra = '<input' . drupal_attributes($attributes) . ' />';
  3590. }
  3591. $output = '<input' . drupal_attributes($element['#attributes']) . ' />';
  3592. return $output . $extra;
  3593. }
  3594. /**
  3595. * Returns HTML for a form.
  3596. *
  3597. * @param $variables
  3598. * An associative array containing:
  3599. * - element: An associative array containing the properties of the element.
  3600. * Properties used: #action, #method, #attributes, #children
  3601. *
  3602. * @ingroup themeable
  3603. */
  3604. function theme_form($variables) {
  3605. $element = $variables['element'];
  3606. if (isset($element['#action'])) {
  3607. $element['#attributes']['action'] = drupal_strip_dangerous_protocols($element['#action']);
  3608. }
  3609. element_set_attributes($element, array('method', 'id'));
  3610. if (empty($element['#attributes']['accept-charset'])) {
  3611. $element['#attributes']['accept-charset'] = "UTF-8";
  3612. }
  3613. // Anonymous DIV to satisfy XHTML compliance.
  3614. return '<form' . drupal_attributes($element['#attributes']) . '><div>' . $element['#children'] . '</div></form>';
  3615. }
  3616. /**
  3617. * Returns HTML for a textarea form element.
  3618. *
  3619. * @param $variables
  3620. * An associative array containing:
  3621. * - element: An associative array containing the properties of the element.
  3622. * Properties used: #title, #value, #description, #rows, #cols, #required,
  3623. * #attributes
  3624. *
  3625. * @ingroup themeable
  3626. */
  3627. function theme_textarea($variables) {
  3628. $element = $variables['element'];
  3629. element_set_attributes($element, array('id', 'name', 'cols', 'rows'));
  3630. _form_set_class($element, array('form-textarea'));
  3631. $wrapper_attributes = array(
  3632. 'class' => array('form-textarea-wrapper'),
  3633. );
  3634. // Add resizable behavior.
  3635. if (!empty($element['#resizable'])) {
  3636. drupal_add_library('system', 'drupal.textarea');
  3637. $wrapper_attributes['class'][] = 'resizable';
  3638. }
  3639. $output = '<div' . drupal_attributes($wrapper_attributes) . '>';
  3640. $output .= '<textarea' . drupal_attributes($element['#attributes']) . '>' . check_plain($element['#value']) . '</textarea>';
  3641. $output .= '</div>';
  3642. return $output;
  3643. }
  3644. /**
  3645. * Returns HTML for a password form element.
  3646. *
  3647. * @param $variables
  3648. * An associative array containing:
  3649. * - element: An associative array containing the properties of the element.
  3650. * Properties used: #title, #value, #description, #size, #maxlength,
  3651. * #required, #attributes.
  3652. *
  3653. * @ingroup themeable
  3654. */
  3655. function theme_password($variables) {
  3656. $element = $variables['element'];
  3657. $element['#attributes']['type'] = 'password';
  3658. element_set_attributes($element, array('id', 'name', 'size', 'maxlength'));
  3659. _form_set_class($element, array('form-text'));
  3660. return '<input' . drupal_attributes($element['#attributes']) . ' />';
  3661. }
  3662. /**
  3663. * Expands a weight element into a select element.
  3664. */
  3665. function form_process_weight($element) {
  3666. $element['#is_weight'] = TRUE;
  3667. // If the number of options is small enough, use a select field.
  3668. $max_elements = variable_get('drupal_weight_select_max', DRUPAL_WEIGHT_SELECT_MAX);
  3669. if ($element['#delta'] <= $max_elements) {
  3670. $element['#type'] = 'select';
  3671. for ($n = (-1 * $element['#delta']); $n <= $element['#delta']; $n++) {
  3672. $weights[$n] = $n;
  3673. }
  3674. $element['#options'] = $weights;
  3675. $element += element_info('select');
  3676. }
  3677. // Otherwise, use a text field.
  3678. else {
  3679. $element['#type'] = 'textfield';
  3680. // Use a field big enough to fit most weights.
  3681. $element['#size'] = 10;
  3682. $element['#element_validate'] = array('element_validate_integer');
  3683. $element += element_info('textfield');
  3684. }
  3685. return $element;
  3686. }
  3687. /**
  3688. * Returns HTML for a file upload form element.
  3689. *
  3690. * For assistance with handling the uploaded file correctly, see the API
  3691. * provided by file.inc.
  3692. *
  3693. * @param $variables
  3694. * An associative array containing:
  3695. * - element: An associative array containing the properties of the element.
  3696. * Properties used: #title, #name, #size, #description, #required,
  3697. * #attributes.
  3698. *
  3699. * @ingroup themeable
  3700. */
  3701. function theme_file($variables) {
  3702. $element = $variables['element'];
  3703. $element['#attributes']['type'] = 'file';
  3704. element_set_attributes($element, array('id', 'name', 'size'));
  3705. _form_set_class($element, array('form-file'));
  3706. return '<input' . drupal_attributes($element['#attributes']) . ' />';
  3707. }
  3708. /**
  3709. * Returns HTML for a form element.
  3710. *
  3711. * Each form element is wrapped in a DIV container having the following CSS
  3712. * classes:
  3713. * - form-item: Generic for all form elements.
  3714. * - form-type-#type: The internal element #type.
  3715. * - form-item-#name: The internal form element #name (usually derived from the
  3716. * $form structure and set via form_builder()).
  3717. * - form-disabled: Only set if the form element is #disabled.
  3718. *
  3719. * In addition to the element itself, the DIV contains a label for the element
  3720. * based on the optional #title_display property, and an optional #description.
  3721. *
  3722. * The optional #title_display property can have these values:
  3723. * - before: The label is output before the element. This is the default.
  3724. * The label includes the #title and the required marker, if #required.
  3725. * - after: The label is output after the element. For example, this is used
  3726. * for radio and checkbox #type elements as set in system_element_info().
  3727. * If the #title is empty but the field is #required, the label will
  3728. * contain only the required marker.
  3729. * - invisible: Labels are critical for screen readers to enable them to
  3730. * properly navigate through forms but can be visually distracting. This
  3731. * property hides the label for everyone except screen readers.
  3732. * - attribute: Set the title attribute on the element to create a tooltip
  3733. * but output no label element. This is supported only for checkboxes
  3734. * and radios in form_pre_render_conditional_form_element(). It is used
  3735. * where a visual label is not needed, such as a table of checkboxes where
  3736. * the row and column provide the context. The tooltip will include the
  3737. * title and required marker.
  3738. *
  3739. * If the #title property is not set, then the label and any required marker
  3740. * will not be output, regardless of the #title_display or #required values.
  3741. * This can be useful in cases such as the password_confirm element, which
  3742. * creates children elements that have their own labels and required markers,
  3743. * but the parent element should have neither. Use this carefully because a
  3744. * field without an associated label can cause accessibility challenges.
  3745. *
  3746. * @param $variables
  3747. * An associative array containing:
  3748. * - element: An associative array containing the properties of the element.
  3749. * Properties used: #title, #title_display, #description, #id, #required,
  3750. * #children, #type, #name.
  3751. *
  3752. * @ingroup themeable
  3753. */
  3754. function theme_form_element($variables) {
  3755. $element = &$variables['element'];
  3756. // This function is invoked as theme wrapper, but the rendered form element
  3757. // may not necessarily have been processed by form_builder().
  3758. $element += array(
  3759. '#title_display' => 'before',
  3760. );
  3761. // Add element #id for #type 'item'.
  3762. if (isset($element['#markup']) && !empty($element['#id'])) {
  3763. $attributes['id'] = $element['#id'];
  3764. }
  3765. // Add element's #type and #name as class to aid with JS/CSS selectors.
  3766. $attributes['class'] = array('form-item');
  3767. if (!empty($element['#type'])) {
  3768. $attributes['class'][] = 'form-type-' . strtr($element['#type'], '_', '-');
  3769. }
  3770. if (!empty($element['#name'])) {
  3771. $attributes['class'][] = 'form-item-' . strtr($element['#name'], array(' ' => '-', '_' => '-', '[' => '-', ']' => ''));
  3772. }
  3773. // Add a class for disabled elements to facilitate cross-browser styling.
  3774. if (!empty($element['#attributes']['disabled'])) {
  3775. $attributes['class'][] = 'form-disabled';
  3776. }
  3777. $output = '<div' . drupal_attributes($attributes) . '>' . "\n";
  3778. // If #title is not set, we don't display any label or required marker.
  3779. if (!isset($element['#title'])) {
  3780. $element['#title_display'] = 'none';
  3781. }
  3782. $prefix = isset($element['#field_prefix']) ? '<span class="field-prefix">' . $element['#field_prefix'] . '</span> ' : '';
  3783. $suffix = isset($element['#field_suffix']) ? ' <span class="field-suffix">' . $element['#field_suffix'] . '</span>' : '';
  3784. switch ($element['#title_display']) {
  3785. case 'before':
  3786. case 'invisible':
  3787. $output .= ' ' . theme('form_element_label', $variables);
  3788. $output .= ' ' . $prefix . $element['#children'] . $suffix . "\n";
  3789. break;
  3790. case 'after':
  3791. $output .= ' ' . $prefix . $element['#children'] . $suffix;
  3792. $output .= ' ' . theme('form_element_label', $variables) . "\n";
  3793. break;
  3794. case 'none':
  3795. case 'attribute':
  3796. // Output no label and no required marker, only the children.
  3797. $output .= ' ' . $prefix . $element['#children'] . $suffix . "\n";
  3798. break;
  3799. }
  3800. if (!empty($element['#description'])) {
  3801. $output .= '<div class="description">' . $element['#description'] . "</div>\n";
  3802. }
  3803. $output .= "</div>\n";
  3804. return $output;
  3805. }
  3806. /**
  3807. * Returns HTML for a marker for required form elements.
  3808. *
  3809. * @param $variables
  3810. * An associative array containing:
  3811. * - element: An associative array containing the properties of the element.
  3812. *
  3813. * @ingroup themeable
  3814. */
  3815. function theme_form_required_marker($variables) {
  3816. // This is also used in the installer, pre-database setup.
  3817. $t = get_t();
  3818. $attributes = array(
  3819. 'class' => 'form-required',
  3820. 'title' => $t('This field is required.'),
  3821. );
  3822. return '<span' . drupal_attributes($attributes) . '>*</span>';
  3823. }
  3824. /**
  3825. * Returns HTML for a form element label and required marker.
  3826. *
  3827. * Form element labels include the #title and a #required marker. The label is
  3828. * associated with the element itself by the element #id. Labels may appear
  3829. * before or after elements, depending on theme_form_element() and
  3830. * #title_display.
  3831. *
  3832. * This function will not be called for elements with no labels, depending on
  3833. * #title_display. For elements that have an empty #title and are not required,
  3834. * this function will output no label (''). For required elements that have an
  3835. * empty #title, this will output the required marker alone within the label.
  3836. * The label will use the #id to associate the marker with the field that is
  3837. * required. That is especially important for screenreader users to know
  3838. * which field is required.
  3839. *
  3840. * @param $variables
  3841. * An associative array containing:
  3842. * - element: An associative array containing the properties of the element.
  3843. * Properties used: #required, #title, #id, #value, #description.
  3844. *
  3845. * @ingroup themeable
  3846. */
  3847. function theme_form_element_label($variables) {
  3848. $element = $variables['element'];
  3849. // This is also used in the installer, pre-database setup.
  3850. $t = get_t();
  3851. // If title and required marker are both empty, output no label.
  3852. if ((!isset($element['#title']) || $element['#title'] === '') && empty($element['#required'])) {
  3853. return '';
  3854. }
  3855. // If the element is required, a required marker is appended to the label.
  3856. $required = !empty($element['#required']) ? theme('form_required_marker', array('element' => $element)) : '';
  3857. $title = filter_xss_admin($element['#title']);
  3858. $attributes = array();
  3859. // Style the label as class option to display inline with the element.
  3860. if ($element['#title_display'] == 'after') {
  3861. $attributes['class'] = 'option';
  3862. }
  3863. // Show label only to screen readers to avoid disruption in visual flows.
  3864. elseif ($element['#title_display'] == 'invisible') {
  3865. $attributes['class'] = 'element-invisible';
  3866. }
  3867. if (!empty($element['#id'])) {
  3868. $attributes['for'] = $element['#id'];
  3869. }
  3870. // The leading whitespace helps visually separate fields from inline labels.
  3871. return ' <label' . drupal_attributes($attributes) . '>' . $t('!title !required', array('!title' => $title, '!required' => $required)) . "</label>\n";
  3872. }
  3873. /**
  3874. * Sets a form element's class attribute.
  3875. *
  3876. * Adds 'required' and 'error' classes as needed.
  3877. *
  3878. * @param $element
  3879. * The form element.
  3880. * @param $name
  3881. * Array of new class names to be added.
  3882. */
  3883. function _form_set_class(&$element, $class = array()) {
  3884. if (!empty($class)) {
  3885. if (!isset($element['#attributes']['class'])) {
  3886. $element['#attributes']['class'] = array();
  3887. }
  3888. $element['#attributes']['class'] = array_merge($element['#attributes']['class'], $class);
  3889. }
  3890. // This function is invoked from form element theme functions, but the
  3891. // rendered form element may not necessarily have been processed by
  3892. // form_builder().
  3893. if (!empty($element['#required'])) {
  3894. $element['#attributes']['class'][] = 'required';
  3895. }
  3896. if (isset($element['#parents']) && form_get_error($element) !== NULL && !empty($element['#validated'])) {
  3897. $element['#attributes']['class'][] = 'error';
  3898. }
  3899. }
  3900. /**
  3901. * Form element validation handler for integer elements.
  3902. */
  3903. function element_validate_integer($element, &$form_state) {
  3904. $value = $element['#value'];
  3905. if ($value !== '' && (!is_numeric($value) || intval($value) != $value)) {
  3906. form_error($element, t('%name must be an integer.', array('%name' => $element['#title'])));
  3907. }
  3908. }
  3909. /**
  3910. * Form element validation handler for integer elements that must be positive.
  3911. */
  3912. function element_validate_integer_positive($element, &$form_state) {
  3913. $value = $element['#value'];
  3914. if ($value !== '' && (!is_numeric($value) || intval($value) != $value || $value <= 0)) {
  3915. form_error($element, t('%name must be a positive integer.', array('%name' => $element['#title'])));
  3916. }
  3917. }
  3918. /**
  3919. * Form element validation handler for number elements.
  3920. */
  3921. function element_validate_number($element, &$form_state) {
  3922. $value = $element['#value'];
  3923. if ($value != '' && !is_numeric($value)) {
  3924. form_error($element, t('%name must be a number.', array('%name' => $element['#title'])));
  3925. }
  3926. }
  3927. /**
  3928. * @} End of "defgroup form_api".
  3929. */
  3930. /**
  3931. * @defgroup batch Batch operations
  3932. * @{
  3933. * Creates and processes batch operations.
  3934. *
  3935. * Functions allowing forms processing to be spread out over several page
  3936. * requests, thus ensuring that the processing does not get interrupted
  3937. * because of a PHP timeout, while allowing the user to receive feedback
  3938. * on the progress of the ongoing operations.
  3939. *
  3940. * The API is primarily designed to integrate nicely with the Form API
  3941. * workflow, but can also be used by non-Form API scripts (like update.php)
  3942. * or even simple page callbacks (which should probably be used sparingly).
  3943. *
  3944. * Example:
  3945. * @code
  3946. * $batch = array(
  3947. * 'title' => t('Exporting'),
  3948. * 'operations' => array(
  3949. * array('my_function_1', array($account->uid, 'story')),
  3950. * array('my_function_2', array()),
  3951. * ),
  3952. * 'finished' => 'my_finished_callback',
  3953. * 'file' => 'path_to_file_containing_myfunctions',
  3954. * );
  3955. * batch_set($batch);
  3956. * // Only needed if not inside a form _submit handler.
  3957. * // Setting redirect in batch_process.
  3958. * batch_process('node/1');
  3959. * @endcode
  3960. *
  3961. * Note: if the batch 'title', 'init_message', 'progress_message', or
  3962. * 'error_message' could contain any user input, it is the responsibility of
  3963. * the code calling batch_set() to sanitize them first with a function like
  3964. * check_plain() or filter_xss(). Furthermore, if the batch operation
  3965. * returns any user input in the 'results' or 'message' keys of $context,
  3966. * it must also sanitize them first.
  3967. *
  3968. * Sample batch operations:
  3969. * @code
  3970. * // Simple and artificial: load a node of a given type for a given user
  3971. * function my_function_1($uid, $type, &$context) {
  3972. * // The $context array gathers batch context information about the execution (read),
  3973. * // as well as 'return values' for the current operation (write)
  3974. * // The following keys are provided :
  3975. * // 'results' (read / write): The array of results gathered so far by
  3976. * // the batch processing, for the current operation to append its own.
  3977. * // 'message' (write): A text message displayed in the progress page.
  3978. * // The following keys allow for multi-step operations :
  3979. * // 'sandbox' (read / write): An array that can be freely used to
  3980. * // store persistent data between iterations. It is recommended to
  3981. * // use this instead of $_SESSION, which is unsafe if the user
  3982. * // continues browsing in a separate window while the batch is processing.
  3983. * // 'finished' (write): A float number between 0 and 1 informing
  3984. * // the processing engine of the completion level for the operation.
  3985. * // 1 (or no value explicitly set) means the operation is finished
  3986. * // and the batch processing can continue to the next operation.
  3987. *
  3988. * $node = node_load(array('uid' => $uid, 'type' => $type));
  3989. * $context['results'][] = $node->nid . ' : ' . check_plain($node->title);
  3990. * $context['message'] = check_plain($node->title);
  3991. * }
  3992. *
  3993. * // More advanced example: multi-step operation - load all nodes, five by five
  3994. * function my_function_2(&$context) {
  3995. * if (empty($context['sandbox'])) {
  3996. * $context['sandbox']['progress'] = 0;
  3997. * $context['sandbox']['current_node'] = 0;
  3998. * $context['sandbox']['max'] = db_query('SELECT COUNT(DISTINCT nid) FROM {node}')->fetchField();
  3999. * }
  4000. * $limit = 5;
  4001. * $result = db_select('node')
  4002. * ->fields('node', array('nid'))
  4003. * ->condition('nid', $context['sandbox']['current_node'], '>')
  4004. * ->orderBy('nid')
  4005. * ->range(0, $limit)
  4006. * ->execute();
  4007. * foreach ($result as $row) {
  4008. * $node = node_load($row->nid, NULL, TRUE);
  4009. * $context['results'][] = $node->nid . ' : ' . check_plain($node->title);
  4010. * $context['sandbox']['progress']++;
  4011. * $context['sandbox']['current_node'] = $node->nid;
  4012. * $context['message'] = check_plain($node->title);
  4013. * }
  4014. * if ($context['sandbox']['progress'] != $context['sandbox']['max']) {
  4015. * $context['finished'] = $context['sandbox']['progress'] / $context['sandbox']['max'];
  4016. * }
  4017. * }
  4018. * @endcode
  4019. *
  4020. * Sample 'finished' callback:
  4021. * @code
  4022. * function batch_test_finished($success, $results, $operations) {
  4023. * // The 'success' parameter means no fatal PHP errors were detected. All
  4024. * // other error management should be handled using 'results'.
  4025. * if ($success) {
  4026. * $message = format_plural(count($results), 'One post processed.', '@count posts processed.');
  4027. * }
  4028. * else {
  4029. * $message = t('Finished with an error.');
  4030. * }
  4031. * drupal_set_message($message);
  4032. * // Providing data for the redirected page is done through $_SESSION.
  4033. * foreach ($results as $result) {
  4034. * $items[] = t('Loaded node %title.', array('%title' => $result));
  4035. * }
  4036. * $_SESSION['my_batch_results'] = $items;
  4037. * }
  4038. * @endcode
  4039. */
  4040. /**
  4041. * Adds a new batch.
  4042. *
  4043. * Batch operations are added as new batch sets. Batch sets are used to spread
  4044. * processing (primarily, but not exclusively, forms processing) over several
  4045. * page requests. This helps to ensure that the processing is not interrupted
  4046. * due to PHP timeouts, while users are still able to receive feedback on the
  4047. * progress of the ongoing operations. Combining related operations into
  4048. * distinct batch sets provides clean code independence for each batch set,
  4049. * ensuring that two or more batches, submitted independently, can be processed
  4050. * without mutual interference. Each batch set may specify its own set of
  4051. * operations and results, produce its own UI messages, and trigger its own
  4052. * 'finished' callback. Batch sets are processed sequentially, with the progress
  4053. * bar starting afresh for each new set.
  4054. *
  4055. * @param $batch_definition
  4056. * An associative array defining the batch, with the following elements (all
  4057. * are optional except as noted):
  4058. * - operations: (required) Array of function calls to be performed.
  4059. * Example:
  4060. * @code
  4061. * array(
  4062. * array('my_function_1', array($arg1)),
  4063. * array('my_function_2', array($arg2_1, $arg2_2)),
  4064. * )
  4065. * @endcode
  4066. * - title: A safe, translated string to use as the title for the progress
  4067. * page. Defaults to t('Processing').
  4068. * - init_message: Message displayed while the processing is initialized.
  4069. * Defaults to t('Initializing.').
  4070. * - progress_message: Message displayed while processing the batch. Available
  4071. * placeholders are @current, @remaining, @total, @percentage, @estimate and
  4072. * @elapsed. Defaults to t('Completed @current of @total.').
  4073. * - error_message: Message displayed if an error occurred while processing
  4074. * the batch. Defaults to t('An error has occurred.').
  4075. * - finished: Name of a function to be executed after the batch has
  4076. * completed. This should be used to perform any result massaging that may
  4077. * be needed, and possibly save data in $_SESSION for display after final
  4078. * page redirection.
  4079. * - file: Path to the file containing the definitions of the 'operations' and
  4080. * 'finished' functions, for instance if they don't reside in the main
  4081. * .module file. The path should be relative to base_path(), and thus should
  4082. * be built using drupal_get_path().
  4083. * - css: Array of paths to CSS files to be used on the progress page.
  4084. * - url_options: options passed to url() when constructing redirect URLs for
  4085. * the batch.
  4086. */
  4087. function batch_set($batch_definition) {
  4088. if ($batch_definition) {
  4089. $batch =& batch_get();
  4090. // Initialize the batch if needed.
  4091. if (empty($batch)) {
  4092. $batch = array(
  4093. 'sets' => array(),
  4094. 'has_form_submits' => FALSE,
  4095. );
  4096. }
  4097. // Base and default properties for the batch set.
  4098. // Use get_t() to allow batches during installation.
  4099. $t = get_t();
  4100. $init = array(
  4101. 'sandbox' => array(),
  4102. 'results' => array(),
  4103. 'success' => FALSE,
  4104. 'start' => 0,
  4105. 'elapsed' => 0,
  4106. );
  4107. $defaults = array(
  4108. 'title' => $t('Processing'),
  4109. 'init_message' => $t('Initializing.'),
  4110. 'progress_message' => $t('Completed @current of @total.'),
  4111. 'error_message' => $t('An error has occurred.'),
  4112. 'css' => array(),
  4113. );
  4114. $batch_set = $init + $batch_definition + $defaults;
  4115. // Tweak init_message to avoid the bottom of the page flickering down after
  4116. // init phase.
  4117. $batch_set['init_message'] .= '<br/>&nbsp;';
  4118. // The non-concurrent workflow of batch execution allows us to save
  4119. // numberOfItems() queries by handling our own counter.
  4120. $batch_set['total'] = count($batch_set['operations']);
  4121. $batch_set['count'] = $batch_set['total'];
  4122. // Add the set to the batch.
  4123. if (empty($batch['id'])) {
  4124. // The batch is not running yet. Simply add the new set.
  4125. $batch['sets'][] = $batch_set;
  4126. }
  4127. else {
  4128. // The set is being added while the batch is running. Insert the new set
  4129. // right after the current one to ensure execution order, and store its
  4130. // operations in a queue.
  4131. $index = $batch['current_set'] + 1;
  4132. $slice1 = array_slice($batch['sets'], 0, $index);
  4133. $slice2 = array_slice($batch['sets'], $index);
  4134. $batch['sets'] = array_merge($slice1, array($batch_set), $slice2);
  4135. _batch_populate_queue($batch, $index);
  4136. }
  4137. }
  4138. }
  4139. /**
  4140. * Processes the batch.
  4141. *
  4142. * Unless the batch has been marked with 'progressive' = FALSE, the function
  4143. * issues a drupal_goto and thus ends page execution.
  4144. *
  4145. * This function is generally not needed in form submit handlers;
  4146. * Form API takes care of batches that were set during form submission.
  4147. *
  4148. * @param $redirect
  4149. * (optional) Path to redirect to when the batch has finished processing.
  4150. * @param $url
  4151. * (optional - should only be used for separate scripts like update.php)
  4152. * URL of the batch processing page.
  4153. * @param $redirect_callback
  4154. * (optional) Specify a function to be called to redirect to the progressive
  4155. * processing page. By default drupal_goto() will be used to redirect to a
  4156. * page which will do the progressive page. Specifying another function will
  4157. * allow the progressive processing to be processed differently.
  4158. */
  4159. function batch_process($redirect = NULL, $url = 'batch', $redirect_callback = 'drupal_goto') {
  4160. $batch =& batch_get();
  4161. drupal_theme_initialize();
  4162. if (isset($batch)) {
  4163. // Add process information
  4164. $process_info = array(
  4165. 'current_set' => 0,
  4166. 'progressive' => TRUE,
  4167. 'url' => $url,
  4168. 'url_options' => array(),
  4169. 'source_url' => $_GET['q'],
  4170. 'redirect' => $redirect,
  4171. 'theme' => $GLOBALS['theme_key'],
  4172. 'redirect_callback' => $redirect_callback,
  4173. );
  4174. $batch += $process_info;
  4175. // The batch is now completely built. Allow other modules to make changes
  4176. // to the batch so that it is easier to reuse batch processes in other
  4177. // environments.
  4178. drupal_alter('batch', $batch);
  4179. // Assign an arbitrary id: don't rely on a serial column in the 'batch'
  4180. // table, since non-progressive batches skip database storage completely.
  4181. $batch['id'] = db_next_id();
  4182. // Move operations to a job queue. Non-progressive batches will use a
  4183. // memory-based queue.
  4184. foreach ($batch['sets'] as $key => $batch_set) {
  4185. _batch_populate_queue($batch, $key);
  4186. }
  4187. // Initiate processing.
  4188. if ($batch['progressive']) {
  4189. // Now that we have a batch id, we can generate the redirection link in
  4190. // the generic error message.
  4191. $t = get_t();
  4192. $batch['error_message'] = $t('Please continue to <a href="@error_url">the error page</a>', array('@error_url' => url($url, array('query' => array('id' => $batch['id'], 'op' => 'finished')))));
  4193. // Clear the way for the drupal_goto() redirection to the batch processing
  4194. // page, by saving and unsetting the 'destination', if there is any.
  4195. if (isset($_GET['destination'])) {
  4196. $batch['destination'] = $_GET['destination'];
  4197. unset($_GET['destination']);
  4198. }
  4199. // Store the batch.
  4200. db_insert('batch')
  4201. ->fields(array(
  4202. 'bid' => $batch['id'],
  4203. 'timestamp' => REQUEST_TIME,
  4204. 'token' => drupal_get_token($batch['id']),
  4205. 'batch' => serialize($batch),
  4206. ))
  4207. ->execute();
  4208. // Set the batch number in the session to guarantee that it will stay alive.
  4209. $_SESSION['batches'][$batch['id']] = TRUE;
  4210. // Redirect for processing.
  4211. $function = $batch['redirect_callback'];
  4212. if (function_exists($function)) {
  4213. $function($batch['url'], array('query' => array('op' => 'start', 'id' => $batch['id'])));
  4214. }
  4215. }
  4216. else {
  4217. // Non-progressive execution: bypass the whole progressbar workflow
  4218. // and execute the batch in one pass.
  4219. require_once DRUPAL_ROOT . '/includes/batch.inc';
  4220. _batch_process();
  4221. }
  4222. }
  4223. }
  4224. /**
  4225. * Retrieves the current batch.
  4226. */
  4227. function &batch_get() {
  4228. // Not drupal_static(), because Batch API operates at a lower level than most
  4229. // use-cases for resetting static variables, and we specifically do not want a
  4230. // global drupal_static_reset() resetting the batch information. Functions
  4231. // that are part of the Batch API and need to reset the batch information may
  4232. // call batch_get() and manipulate the result by reference. Functions that are
  4233. // not part of the Batch API can also do this, but shouldn't.
  4234. static $batch = array();
  4235. return $batch;
  4236. }
  4237. /**
  4238. * Populates a job queue with the operations of a batch set.
  4239. *
  4240. * Depending on whether the batch is progressive or not, the BatchQueue or
  4241. * BatchMemoryQueue handler classes will be used.
  4242. *
  4243. * @param $batch
  4244. * The batch array.
  4245. * @param $set_id
  4246. * The id of the set to process.
  4247. *
  4248. * @return
  4249. * The name and class of the queue are added by reference to the batch set.
  4250. */
  4251. function _batch_populate_queue(&$batch, $set_id) {
  4252. $batch_set = &$batch['sets'][$set_id];
  4253. if (isset($batch_set['operations'])) {
  4254. $batch_set += array(
  4255. 'queue' => array(
  4256. 'name' => 'drupal_batch:' . $batch['id'] . ':' . $set_id,
  4257. 'class' => $batch['progressive'] ? 'BatchQueue' : 'BatchMemoryQueue',
  4258. ),
  4259. );
  4260. $queue = _batch_queue($batch_set);
  4261. $queue->createQueue();
  4262. foreach ($batch_set['operations'] as $operation) {
  4263. $queue->createItem($operation);
  4264. }
  4265. unset($batch_set['operations']);
  4266. }
  4267. }
  4268. /**
  4269. * Returns a queue object for a batch set.
  4270. *
  4271. * @param $batch_set
  4272. * The batch set.
  4273. *
  4274. * @return
  4275. * The queue object.
  4276. */
  4277. function _batch_queue($batch_set) {
  4278. static $queues;
  4279. // The class autoloader is not available when running update.php, so make
  4280. // sure the files are manually included.
  4281. if (!isset($queues)) {
  4282. $queues = array();
  4283. require_once DRUPAL_ROOT . '/modules/system/system.queue.inc';
  4284. require_once DRUPAL_ROOT . '/includes/batch.queue.inc';
  4285. }
  4286. if (isset($batch_set['queue'])) {
  4287. $name = $batch_set['queue']['name'];
  4288. $class = $batch_set['queue']['class'];
  4289. if (!isset($queues[$class][$name])) {
  4290. $queues[$class][$name] = new $class($name);
  4291. }
  4292. return $queues[$class][$name];
  4293. }
  4294. }
  4295. /**
  4296. * @} End of "defgroup batch".
  4297. */

Functions

Namesort descending Description
batch_get Retrieves the current batch.
batch_process Processes the batch.
batch_set Adds a new batch.
date_validate Validates the date type to prevent invalid dates (e.g., February 30, 2006).
drupal_build_form Builds and process a form based on a form id.
drupal_form_submit Retrieves, populates, and processes a form.
drupal_get_form Returns a renderable form array for a given form ID.
drupal_prepare_form Prepares a structured form array.
drupal_process_form Processes a form submission.
drupal_rebuild_form Constructs a new $form from the information in $form_state.
drupal_redirect_form Redirects the user to a URL after a form has been processed.
drupal_retrieve_form Retrieves the structured array that defines a given form.
drupal_validate_form Validates user-submitted form data in the $form_state array.
element_validate_integer Form element validation handler for integer elements.
element_validate_integer_positive Form element validation handler for integer elements that must be positive.
element_validate_number Form element validation handler for number elements.
form_builder Builds and processes all elements in the structured form array.
form_clear_error Clears all errors against all form elements made by form_set_error().
form_error Flags an element as having an error.
form_execute_handlers Executes custom validation and submission handlers for a given form.
form_get_cache Fetches a form from cache.
form_get_error Returns the error message filed against the given form element.
form_get_errors Returns an associative array of all errors.
form_get_options Returns the indexes of a select element's options matching a given key.
form_load_include Ensures an include file is loaded whenever the form is processed.
form_options_flatten Allows PHP array processing of multiple select options with the same value.
form_pre_render_conditional_form_element Adds form element theming to an element if its title or description is set.
form_pre_render_fieldset Adds members of this group as actual elements for rendering.
form_process_actions Processes a form actions container element.
form_process_checkbox Sets the #checked property of a checkbox element.
form_process_checkboxes Processes a checkboxes form element.
form_process_container Processes a container element.
form_process_date Expands a date element into year, month, and day select elements.
form_process_fieldset Arranges fieldsets into groups.
form_process_machine_name Processes a machine-readable name form element.
form_process_password_confirm Expand a password_confirm field into two text boxes.
form_process_radios Expands a radios element into individual radio elements.
form_process_select Processes a select list form element.
form_process_tableselect Creates checkbox or radio elements to populate a tableselect table.
form_process_vertical_tabs Creates a group formatted as vertical tabs.
form_process_weight Expands a weight element into a select element.
form_select_options Converts a select form element's options array into HTML.
form_set_cache Stores a form in the cache.
form_set_error Files an error against a form element.
form_set_value Changes submitted form values during form validation.
form_state_defaults Retrieves default values for the $form_state array.
form_state_keys_no_cache Returns an array of $form_state keys that shouldn't be cached.
form_state_values_clean Removes internal Form API elements and buttons from submitted form values.
form_type_checkboxes_value Determines the value for a checkboxes form element.
form_type_checkbox_value Determines the value for a checkbox form element.
form_type_image_button_value Determines the value for an image button form element.
form_type_password_confirm_value Determines the value for a password_confirm form element.
form_type_radios_value Form value callback: Determines the value for a #type radios form element.
form_type_select_value Determines the value for a select form element.
form_type_tableselect_value Determines the value for a tableselect form element.
form_type_textfield_value Determines the value for a textfield form element.
form_type_token_value Determines the value for form's token value.
form_validate_machine_name Form element validation handler for machine_name elements.
map_month Helper function for usage with drupal_map_assoc to display month names.
password_confirm_validate Validates a password_confirm element.
theme_button Returns HTML for a button form element.
theme_checkbox Returns HTML for a checkbox form element.
theme_checkboxes Returns HTML for a set of checkbox form elements.
theme_container Returns HTML to wrap child elements in a container.
theme_date Returns HTML for a date selection form element.
theme_fieldset Returns HTML for a fieldset form element and its children.
theme_file Returns HTML for a file upload form element.
theme_form Returns HTML for a form.
theme_form_element Returns HTML for a form element.
theme_form_element_label Returns HTML for a form element label and required marker.
theme_form_required_marker Returns HTML for a marker for required form elements.
theme_hidden Returns HTML for a hidden form element.
theme_image_button Returns HTML for an image button form element.
theme_password Returns HTML for a password form element.
theme_radio Returns HTML for a radio button form element.
theme_radios Returns HTML for a set of radio button form elements.
theme_select Returns HTML for a select form element.
theme_submit Returns HTML for a submit button form element.
theme_tableselect Returns HTML for a table with radio buttons or checkboxes.
theme_textarea Returns HTML for a textarea form element.
theme_textfield Returns HTML for a textfield form element.
theme_vertical_tabs Returns HTML for an element's children fieldsets as vertical tabs.
weight_value Sets the value for a weight element, with zero as a default.
_batch_populate_queue Populates a job queue with the operations of a batch set.
_batch_queue Returns a queue object for a batch set.
_form_builder_handle_input_element Adds the #name and #value properties of an input element before rendering.
_form_button_was_clicked Determines if a given button triggered the form submission.
_form_element_triggered_scripted_submission Detects if an element triggered the form submission via Ajax.
_form_options_flatten Iterates over an array and returns a flat array with duplicate keys removed.
_form_set_class Sets a form element's class attribute.
_form_validate Performs validation on form elements.