form.inc
Version 1.419 (checked in on 2009/12/14 at 13:51:56 by dries)
Functions
| Name | Description |
|---|---|
| batch_get | Retrieves the current batch. |
| batch_process | Processes the batch. |
| batch_set | Opens a new batch. |
| date_validate | Validates the date type to stop dates like February 30, 2006. |
| drupal_build_form | Build and process a form based on a form id. |
| drupal_form_submit | Retrieves a form using a form_id, populates it with $form_state['values'], processes it, and returns any validation errors encountered. This function is the programmatic counterpart to drupal_get_form(). |
| drupal_get_form | Wrapper for drupal_build_form() for use when $form_state is not needed. |
| drupal_prepare_form | Prepares a structured form array by adding required elements, executing any hook_form_alter functions, and optionally inserting a validation token to prevent tampering. |
| drupal_process_form | Processes a form submission. |
| drupal_rebuild_form | Retrieves a form, caches it and processes it again. |
| 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 from the $form_state using the validate functions defined in a structured form array. |
| form_builder | Walk through the structured form array, adding any required properties to each element and mapping the incoming input data to the proper elements. Also, execute any #process handlers attached to a specific element. |
| form_clear_error | Clear all errors against all form elements made by form_set_error(). |
| form_error | Flag an element as having an error. |
| form_execute_handlers | A helper function used to execute custom validation and submission handlers for a given form. Button-specific handlers are checked first. If none exist, the function falls back to form-level handlers. |
| form_get_cache | Fetch a form from cache. |
| form_get_error | Return the error message filed against the form with the specified name. |
| form_get_errors | Return an associative array of all errors. |
| form_get_options | Traverses a select element's #option array looking for any values that hold the given key. Returns an array of indexes that match. |
| form_options_flatten | |
| form_pre_render_conditional_form_element | Add form_element theming to an element if title or description is set. |
| form_pre_render_fieldset | Adds members of this group as actual elements for rendering. |
| form_process_checkboxes | |
| form_process_container | Processes a container element. |
| form_process_date | Roll out a single date element. |
| form_process_fieldset | Adds fieldsets to the specified group or adds group members to this fieldset. |
| form_process_password_confirm | Expand a password_confirm field into two text boxes. |
| form_process_radios | Roll out a single radios element to a list of radios, using the options array as index. |
| form_process_tableselect | Create the correct amount of checkbox or radio elements to populate the table. |
| form_process_text_format | Add text format selector to text elements with the #text_format property. |
| form_process_vertical_tabs | Creates a group formatted as vertical tabs. |
| form_process_weight | Expand weight elements into selects. |
| form_select_options | Convert a select form element's options array into an HTML. |
| form_set_cache | Store a form in the cache. |
| form_set_error | Files an error against a form element. |
| form_set_value | Change submitted form values during form validation. |
| form_state_defaults | Retrieve 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 | Helper function to determine the value for a checkboxes form element. |
| form_type_checkbox_value | Helper function to determine the value for a checkbox form element. |
| form_type_image_button_value | Helper function to determine the value for an image button form element. |
| form_type_password_confirm_value | Helper function to determine the value for a password_confirm form element. |
| form_type_select_value | Helper function to determine the value for a select form element. |
| form_type_textfield_value | Helper function to determine the value for a textfield form element. |
| form_type_token_value | Helper function to determine the value for form's token value. |
| map_month | Helper function for usage with drupal_map_assoc to display month names. |
| password_confirm_validate | Validate password_confirm element. |
| theme_button | Theme a button form element. |
| theme_checkbox | Theme a checkbox form element. |
| theme_checkboxes | Theme a set of checkbox form elements. |
| theme_container | Adds a container for grouped items |
| theme_date | Theme a date selection form element. |
| theme_fieldset | Theme a fieldset form element. |
| theme_file | Theme a file upload form element. |
| theme_form | Theme a form. |
| theme_form_element | Theme a form element. |
| theme_form_element_label | Theme a form element label and required marker. |
| theme_form_required_marker | Theme the marker for required form elements. |
| theme_hidden | Theme a hidden form element. |
| theme_image_button | Theme a image button form element. |
| theme_password | Theme a password form element. |
| theme_radio | Theme a radio button form element. |
| theme_radios | Theme a set of radio button form elements. |
| theme_select | Theme select form element. |
| theme_submit | Theme a submit button form element. |
| theme_tableselect | Format a table with radio buttons or checkboxes. |
| theme_textarea | Theme a textarea form element. |
| theme_textfield | Theme a textfield form element. |
| theme_text_format_wrapper | Theme a text format form element. |
| theme_vertical_tabs | Makes the element's children fieldsets be vertical tabs. |
| weight_value | If no default value is set for weight select boxes, use 0. |
| _form_builder_handle_input_element | Populate the #value and #name properties of input elements so they can be processed and rendered. |
| _form_builder_ie_cleanup | In IE, if only one submit button is present, AND the enter key is used to submit the form, no form value is sent for it and our normal button detection code will never detect a match. We call this function after all other button-detection is complete... |
| _form_button_was_clicked | Helper function to handle the sometimes-convoluted logic of button click detection. |
| _form_set_class | Sets a form element's class attribute. |
| _form_set_value | Helper function for form_set_value() and _form_builder_handle_input_element(). |
| _form_validate | Performs validation on form elements. First ensures required fields are completed, #maxlength is not exceeded, and selected options were in the list of options given to the user. Then calls user-defined validators. |