[ Index ]

PHP Cross Reference of Drupal 6 (gatewave)

title

Body

[close]

/sites/all/modules/webform/ -> webform_hooks.php (summary)

(no description)

File Size: 674 lines (22 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 26 functions

  hook_webform_select_options_info()
  hook_webform_submission_load()
  hook_webform_submission_presave()
  hook_webform_submission_insert()
  hook_webform_submission_update()
  hook_webform_submission_delete()
  hook_webform_submission_render_alter()
  hook_webform_component_load()
  hook_webform_component_presave()
  hook_webform_component_insert()
  hook_webform_component_update()
  hook_webform_component_delete()
  hook_webform_component_info()
  hook_webform_component_info_alter()
  _webform_defaults_component()
  _webform_edit_component()
  _webform_render_component()
  _webform_display_component()
  _webform_submit_component()
  _webform_delete_component()
  _webform_help_component()
  _webform_theme_component()
  _webform_analysis_component()
  _webform_table_component()
  _webform_csv_headers_component()
  _webform_csv_data_component()

Functions
Functions that are not part of a class:

hook_webform_select_options_info()   X-Ref
Define callbacks that can be used as select list options.

return:

hook_webform_submission_load(&$submissions)   X-Ref
Respond to the loading of Webform submissions.

param: $submissions

hook_webform_submission_presave($node, &$submission)   X-Ref
Modify a Webform submission, prior to saving it in the database.

param: $node
param: $submission

hook_webform_submission_insert($node, $submission)   X-Ref
Respond to a Webform submission being inserted.

Note that this hook is called after a submission has already been saved to
the database. If needing to modify the submission prior to insertion, use
hook_webform_submission_presave().

param: $node
param: $submission

hook_webform_submission_update($node, $submission)   X-Ref
Respond to a Webform submission being updated.

Note that this hook is called after a submission has already been saved to
the database. If needing to modify the submission prior to updating, use
hook_webform_submission_presave().

param: $node
param: $submission

hook_webform_submission_delete($node, $submission)   X-Ref
Respond to a Webform submission being deleted.

param: $node
param: $submission

hook_webform_submission_render_alter(&$renderable)   X-Ref
Alter the display of a Webform submission.

This function applies to both e-mails sent by Webform and normal display of
submissions when viewing through the adminsitrative interface.

param: $renderable

hook_webform_component_load()   X-Ref
Modify a loaded Webform component.

IMPORTANT: This hook does not actually exist because components are loaded
in bulk as part of webform_node_load(). Use hook_nodeapi() to modify loaded
components when the node is loaded. This example is provided merely to point
to hook_nodeapi().


hook_webform_component_presave(&$component)   X-Ref
Modify a Webform component before it is saved to the database.

Note that most of the time this hook is not necessary, because Webform will
automatically add data to the component based on the component form. Using
hook_form_alter() will be sufficient in most cases.

param: $component

hook_webform_component_insert($component)   X-Ref
Respond to a Webform component being inserted into the database.


hook_webform_component_update($component)   X-Ref
Respond to a Webform component being updated in the database.


hook_webform_component_delete($component)   X-Ref
Respond to a Webform component being deleted.


hook_webform_component_info()   X-Ref
Define components to Webform.

return:

hook_webform_component_info_alter(&$components)   X-Ref
Alter the list of available Webform components.

param: $components

_webform_defaults_component()   X-Ref
Specify the default properties of a component.

return:

_webform_edit_component($component)   X-Ref
Generate the form for editing a component.

Create a set of form elements to be displayed on the form for editing this
component. Use care naming the form items, as this correlates directly to the
database schema. The component "Name" and "Description" fields are added to
every component type and are not necessary to specify here (although they
may be overridden if desired).

param: $component
return:

_webform_render_component($component, $value = NULL)   X-Ref
Render a Webform component to be part of a form.

param: $component
param: $value

_webform_display_component($component, $value, $format = 'html')   X-Ref
Display the result of a submission for a component.

The output of this function will be displayed under the "Results" tab then
"Submissions". This should output the saved data in some reasonable manner.

param: $component
param: $value
param: $format
return:

_webform_submit_component($component, $value)   X-Ref
A hook for changing the input values before saving to the database.

Note that Webform will save the result of this function directly into the
database.

param: $component
param: $value
return:

_webform_delete_component($component, $value)   X-Ref
Delete operation for a component or submission.

param: $component
param: $value

_webform_help_component($section)   X-Ref
Module specific instance of hook_help().

This allows each Webform component to add information into hook_help().

_webform_theme_component()   X-Ref
Module specific instance of hook_theme().

This allows each Webform component to add information into hook_theme().

_webform_analysis_component($component, $sids = array()   X-Ref
Calculate and returns statistics about results for this component.

This takes into account all submissions to this webform. The output of this
function will be displayed under the "Results" tab then "Analysis".

param: $component
param: $sids
param: $single
return:

_webform_table_component($component, $value)   X-Ref
Return the result of a component value for display in a table.

The output of this function will be displayed under the "Results" tab then
"Table".

param: $component
param: $value
return:

_webform_csv_headers_component($component, $export_options)   X-Ref
Return the header for this component to be displayed in a CSV file.

The output of this function will be displayed under the "Results" tab then
"Download".

param: $component
param: $export_options
return:

_webform_csv_data_component($component, $export_options, $value)   X-Ref
Format the submitted data of a component for CSV downloading.

The output of this function will be displayed under the "Results" tab then
"Download".

param: $component
param: $export_options
param: $value
return:



Generated: Thu Mar 24 11:18:33 2011 Cross-referenced by PHPXref 0.7