form.inc

You are here

  1. 7 includes/form.inc
  2. 4.7 includes/form.inc
  3. 5 includes/form.inc
  4. 6 includes/form.inc
  5. 8 core/includes/form.inc

Functions for form and batch generation and processing.

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.

File

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