[ Index ]

PHP Cross Reference of Drupal 6 (yi-drupal)

title

Body

[close]

/sites/all/modules/webform/ -> webform.module (summary)

This module provides a simple way to create forms and questionnaires. The initial development of this module was sponsered by ÅF Industri AB, Open Source City and Karlstad University Library. Continued development sponsored by Lullabot.

Author: Nathan Haug <nate@lullabot.com>
File Size: 3721 lines (139 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 94 functions

  webform_help()
  webform_menu()
  webform_menu_load()
  webform_menu_submission_load()
  webform_menu_component_load()
  webform_menu_email_load()
  webform_submission_access()
  webform_results_access()
  webform_results_clear_access()
  webform_init()
  webform_perm()
  webform_theme()
  webform_elements()
  webform_webform_component_info()
  webform_forms()
  webform_webform_select_options_info()
  webform_webform_submission_actions()
  webform_webform_submission_render_alter()
  webform_file_download()
  webform_node_type()
  webform_nodeapi()
  webform_node_insert()
  webform_node_update()
  webform_node_delete()
  webform_node_defaults()
  webform_node_prepare()
  webform_node_prepare_translation()
  webform_node_load()
  webform_link()
  webform_form_alter()
  webform_form_submit()
  webform_node_view()
  theme_webform_view()
  theme_webform_view_messages()
  webform_mail()
  webform_block()
  webform_block_info()
  webform_block_view()
  webform_block_configure()
  webform_block_save()
  webform_client_form()
  webform_client_form_includes()
  _webform_client_form_rule_check()
  _webform_client_form_add_component()
  webform_client_form_validate()
  _webform_client_form_validate()
  webform_client_form_pages()
  webform_client_form_submit()
  _webform_client_form_submit_process()
  _webform_client_form_submit_flatten()
  _webform_confirmation()
  template_preprocess_webform_form()
  template_preprocess_webform_confirmation()
  template_preprocess_webform_mail_message()
  webform_element_title_display()
  webform_element_wrapper()
  theme_webform_element()
  theme_webform_element_wrapper()
  theme_webform_element_text()
  theme_webform_mail_headers()
  _webform_fetch_draft_sid()
  _webform_filter_values()
  _webform_filter_descriptions()
  _webform_filter_xss()
  webform_ensure_record()
  webform_check_record()
  webform_get_cid()
  webform_variable_get()
  theme_webform_token_help()
  _webform_safe_name()
  webform_format_email_address()
  webform_format_email_subject()
  _webform_components_tree_build()
  _webform_components_tree_flatten()
  _webform_components_sort()
  _webform_components_tree_sort()
  webform_components()
  webform_component_options()
  webform_component_include()
  webform_component_invoke()
  webform_component_implements()
  webform_disable_page_cache()
  webform_set_breadcrumb()
  webform_date_array()
  webform_date_string()
  webform_date_format()
  webform_strtodate()
  webform_strtotime()
  webform_tt()
  webform_email_html_capable()
  webform_views_api()
  webform_content_extra_fields()
  webform_mollom_form_list()
  webform_mollom_form_info()

Functions
Functions that are not part of a class:

webform_help($section = 'admin/help)   X-Ref
Implements hook_help().


webform_menu()   X-Ref
Implements hook_menu().


webform_menu_load($nid)   X-Ref
Menu loader callback. Load a webform node if the given nid is a webform.


webform_menu_submission_load($sid, $nid)   X-Ref
Menu loader callback. Load a webform submission if the given sid is a valid.


webform_menu_component_load($cid, $nid, $type)   X-Ref
Menu loader callback. Load a webform component if the given cid is a valid.


webform_menu_email_load($eid, $nid)   X-Ref
Menu loader callback. Load a webform e-mail if the given eid is a valid.


webform_submission_access($node, $submission, $op = 'view', $account = NULL)   X-Ref
No description

webform_results_access($node, $account = NULL)   X-Ref
Menu access callback. Ensure a user both access and node 'view' permission.


webform_results_clear_access($node, $account = NULL)   X-Ref
No description

webform_init()   X-Ref
Implements hook_init().


webform_perm()   X-Ref
Implements hook_perm().


webform_theme()   X-Ref
Implements hook_theme().


webform_elements()   X-Ref
Implements hook_elements().


webform_webform_component_info()   X-Ref
Implements hook_webform_component_info().


webform_forms($form_id)   X-Ref
Implements hook_forms().

All webform_client_form forms share the same form handler

webform_webform_select_options_info()   X-Ref
Implements hook_webform_select_options_info().


webform_webform_submission_actions($node, $submission)   X-Ref
Implements hook_webform_webform_submission_actions().


webform_webform_submission_render_alter(&$renderable)   X-Ref
Implements hook_webform_submission_render_alter().


webform_file_download($file)   X-Ref
Implements hook_file_download().

Only allow users with view webform submissions to download files.

webform_node_type($op, $info)   X-Ref
Implements hook_node_type().


webform_nodeapi(&$node, $op, $teaser = NULL, $page = NULL)   X-Ref
Implements hook_nodeapi().


webform_node_insert($node)   X-Ref
Implements hook_node_insert().


webform_node_update($node)   X-Ref
Implements hook_node_update().


webform_node_delete($node)   X-Ref
Implements hook_delete().


webform_node_defaults()   X-Ref
Default settings for a newly created webform node.


webform_node_prepare(&$node)   X-Ref
Implements hook_node_prepare().


webform_node_prepare_translation(&$node)   X-Ref
Implements hook_node_prepare_translation().


webform_node_load($node)   X-Ref
Implements hook_node_load().


webform_link($type, $node = NULL, $teaser = FALSE)   X-Ref
Implements hook_link().
Always add a "view form" link.


webform_form_alter(&$form, $form_state, $form_id)   X-Ref
Implements hook_form_alter().


webform_form_submit($form, &$form_state)   X-Ref
Submit handler for the webform node form.

Redirect the user to the components form on new node inserts. Note that this
fires after the hook_submit() function above.

webform_node_view(&$node, $teaser, $page)   X-Ref
Implements hook_node_view().


theme_webform_view($node, $teaser, $page, $form, $enabled)   X-Ref
Output the Webform into the node content.

param: $node
param: $teaser
param: $page
param: $form
param: $enabled

theme_webform_view_messages($node, $teaser, $page, $submission_count, $user_limit_exceeded, $total_limit_exceeded, $allowed_roles, $closed, $cached)   X-Ref
Display a message to a user if they are not allowed to fill out a form.

param: $node
param: $teaser
param: $page
param: $submission_count
param: $user_limit_exceeded
param: $total_limit_exceeded
param: $allowed_roles
param: $closed
param: $cached

webform_mail($key, &$message, $params)   X-Ref
Implements hook_mail().


webform_block($op = 'list', $delta = 0, $edit = array()   X-Ref
Implements hook_block().


webform_block_info()   X-Ref
Implements hook_block_info().


webform_block_view($delta = '')   X-Ref
Implements hook_block_view().


webform_block_configure($delta = '')   X-Ref
Implements hook_block_configure().


webform_block_save($delta = '', $edit = array()   X-Ref
Implements hook_block_save().


webform_client_form(&$form_state, $node, $submission, $is_draft = FALSE, $filter = TRUE)   X-Ref
Client form generation function. If this is displaying an existing
submission, pass in the $submission variable with the contents of the
submission to be displayed.

param: $form_state
param: $node
param: $submission
param: $is_draft
param: $filter

webform_client_form_includes($form, $form_state)   X-Ref
Process function for webform_client_form().

Include all the enabled components for this form to ensure availability.

_webform_client_form_rule_check($node, $component, $page_num, $form_state = NULL, $submission = NULL)   X-Ref
Check if a component should be displayed on the current page.


_webform_client_form_add_component($node, $component, $component_value, &$parent_fieldset, &$form, $form_state, $submission, $format = 'form', $page_num = 0, $filter = TRUE)   X-Ref
Add a component to a renderable array. Called recursively for fieldsets.

This function assists in the building of the client form, as well as the
display of results, and the text of e-mails.

param: $component
param: $component_value
param: $parent_fieldset
param: $form
param: $form_state
param: $submission
param: $format
param: $filter

webform_client_form_validate($form, &$form_state)   X-Ref
No description

_webform_client_form_validate($elements, &$form_state, $first_run = TRUE)   X-Ref
Recursive validation function to trigger normal Drupal validation.

This function imitates _form_validate in Drupal's form.inc, only it sets
a different property to ensure that validation has occurred.

webform_client_form_pages($form, &$form_state)   X-Ref
Handle the processing of pages and conditional logic.


webform_client_form_submit($form, &$form_state)   X-Ref
Submit handler for saving the form values and sending e-mails.


_webform_client_form_submit_process($node, &$form_values, $types = NULL, $parent = 0)   X-Ref
Post processes the submission tree with any updates from components.

param: $node
param: $form_values
param: $types
param: $parent

_webform_client_form_submit_flatten($node, $fieldset, $parent = 0)   X-Ref
Flattens a submitted form back into a single array representation (rather than nested fields)


_webform_confirmation($node)   X-Ref
Prints the confirmation message after a successful submission.


template_preprocess_webform_form(&$vars)   X-Ref
Prepare for theming of the webform form.


template_preprocess_webform_confirmation(&$vars)   X-Ref
Prepare for theming of the webform submission confirmation.


template_preprocess_webform_mail_message(&$vars)   X-Ref
Prepare to theme the contents of e-mails sent by webform.


webform_element_title_display($element)   X-Ref
A Form API #pre_render function. Sets display based on #title_display.

This function is used regularly in D6 for all elements, but specifically for
fieldsets in D7, which don't support #title_display natively.

webform_element_wrapper($content, $elements)   X-Ref
A Form API #post_render function. Wraps displayed elements in their label.

Note: this entire function may be removed in Drupal 7, which supports
#theme_wrappers natively.

theme_webform_element($element, $value)   X-Ref
Replacement for theme_form_element().


theme_webform_element_wrapper($element, $content)   X-Ref
Wrap form elements in a DIV with appropriate classes and an ID.

This is a temporary work-around until we can use theme_webform_element() for
all webform form elements in Drupal 7.

theme_webform_element_text($element, $value)   X-Ref
Output a form element in plain text format.


theme_webform_mail_headers($node, $submission, $email)   X-Ref
Theme the headers when sending an email from webform.

param: $node
param: $submission
param: $email
return:

_webform_fetch_draft_sid($nid, $uid)   X-Ref
Check if current user has a draft of this webform, and return the sid.


_webform_filter_values($string, $node = NULL, $submission = NULL, $email = NULL, $strict = TRUE, $allow_anonymous = FALSE)   X-Ref
Filters all special tokens provided by webform, such as %post and %profile.

param: $string
param: $node
param: $submission
param: $email
param: $strict
param: $allow_anonymous

_webform_filter_descriptions($string, $node = NULL, $submission = NULL)   X-Ref
Filters all special tokens provided by webform, and allows basic layout in descriptions.


_webform_filter_xss($string)   X-Ref
Filter labels for display by running through XSS checks.


webform_ensure_record(&$node)   X-Ref
Utility function to ensure that a webform record exists in the database.

param: $node
return:

webform_check_record(&$node)   X-Ref
Utility function to check if a webform record is necessary in the database.

If the node is no longer using any webform settings, this function will
delete the settings from the webform table. Note that this function will NOT
delete rows from the webform table if the node-type is exclusively used for
webforms (per the "webform_node_types_primary" variable).

param: $node
return:

webform_get_cid(&$node, $form_key, $pid)   X-Ref
Given a form_key and a list of form_key parents, determine the cid.

param: $node
param: $form_key
param: $parent

webform_variable_get($variable)   X-Ref
Retreive a Drupal variable with the appropriate default value.


theme_webform_token_help($groups = array()   X-Ref
No description

_webform_safe_name($name)   X-Ref
No description

webform_format_email_address($address, $name, $node = NULL, $submission = NULL, $encode = TRUE, $single = TRUE, $format = NULL)   X-Ref
Given an email address and a name, format an e-mail address.

param: $address
param: $name
param: $node
param: $submission
param: $encode
param: $single
param: $format

webform_format_email_subject($subject, $node = NULL, $submission = NULL)   X-Ref
Given an email subject, format it with any needed replacements.


_webform_components_tree_build($src, &$tree, $parent, &$page_count)   X-Ref
Convert an array of components into a tree


_webform_components_tree_flatten($tree)   X-Ref
Flatten a component tree into a flat list.


_webform_components_sort($a, $b)   X-Ref
Helper for the uasort in webform_tree_sort()


_webform_components_tree_sort($tree)   X-Ref
Sort each level of a component tree by weight and name


webform_components($include_disabled = FALSE, $reset = FALSE)   X-Ref
Get a list of all available component definitions.


webform_component_options($include_disabled = FALSE)   X-Ref
Build a list of components suitable for use as select list options.


webform_component_include($component_type)   X-Ref
Load a component file into memory.

param: $component_type

webform_component_invoke($type, $callback)   X-Ref
Invoke a component callback.

param: $type
param: $callback
param: ...

webform_component_implements($type, $callback)   X-Ref
Check if a component implements a particular hook.

param: $type
param: $callback

webform_disable_page_cache()   X-Ref
Disable the Drupal page cache.


webform_set_breadcrumb($node, $submission = NULL)   X-Ref
Set the necessary breadcrumb for the page we are on.


webform_date_array($string, $type = NULL)   X-Ref
Convert an ISO 8601 date or time into an array.

This converts full format dates or times. Either a date or time may be
provided, in which case only those portions will be returned. Dashes and
colons must be used, never implied.

Formats:
Dates: YYYY-MM-DD
Times: HH:MM:SS
Datetimes: YYYY-MM-DDTHH:MM:SS

param: $string
param: $type

webform_date_string($array, $type = NULL)   X-Ref
Convert an array of a date or time into an ISO 8601 compatible string.

param: $array
param: $type

webform_date_format($size = 'medium')   X-Ref
Get a date format according to the site settings.

param: $size

webform_strtodate($format, $string, $timezone_name = NULL)   X-Ref
Return a date in the desired format taking into consideration user timezones.


webform_strtotime($date)   X-Ref
Get a timestamp in GMT time, ensuring timezone accuracy.


webform_tt($name, $string, $langcode = NULL, $update = FALSE)   X-Ref
Wrapper function for tt() if i18nstrings enabled.


webform_email_html_capable()   X-Ref
Check if any available HTML mail handlers are available for Webform to use.


webform_views_api()   X-Ref
Implements hook_views_api().


webform_content_extra_fields($type_name)   X-Ref
Implements hook_content_extra_fields().


webform_mollom_form_list()   X-Ref
Implements hook_mollom_form_list().


webform_mollom_form_info($form_id)   X-Ref
Implements hook_mollom_form_info().




Generated: Mon Jul 9 18:01:44 2012 Cross-referenced by PHPXref 0.7