[ Index ]

PHP Cross Reference of Drupal 6 (gatewave)

title

Body

[close]

/sites/all/modules/form_builder/includes/ -> form_builder.api.inc (summary)

(no description)

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

Defines 12 functions

  form_builder_get_properties()
  form_builder_get_form_type()
  form_builder_get_element_properties()
  form_builder_get_saveable_properties()
  form_builder_get_element()
  form_builder_get_elements()
  form_builder_set_element()
  form_builder_unset_element()
  form_builder_get_element_ids()
  form_builder_load_form()
  form_builder_save_form()
  form_builder_add_default_properties()

Functions
Functions that are not part of a class:

form_builder_get_properties($form_type, $reset = FALSE)   X-Ref
Get a list of all properties that are supported within a form type.


form_builder_get_form_type($form_type = NULL, $reset = FALSE)   X-Ref
Get a list of all properties that are supported by a particular form type.


form_builder_get_element_properties($form_type, $element_type)   X-Ref
Given an element type, return properties that are supported by Form builder.

param: $form_type
param: $element_type
param:

form_builder_get_saveable_properties($form_type, $element)   X-Ref
Get a list of properties that are supported in any way by an element.

This returns a list of all supported properties within an element, even
if some of those properties do not have an interface for editing or are
only used internally by the module providing the form type this element
is being saved in.

param: $form_type
param: $element
return:

form_builder_get_element(&$form, $element_id)   X-Ref
Function to retrieve a single element within a form structure.

If needing to retreive multiple elements at once, use
form_builder_get_elements().

param: $form
param: $element_id
return:

form_builder_get_elements(&$form, $element_ids)   X-Ref
Recursive function to retrieve multiple elements within a form structure.

param: $form
param: $element_ids
return:

form_builder_set_element(&$form, $element, &$entire_form = NULL, $parent_id = FORM_BUILDER_ROOT)   X-Ref
Recursive function to set an element within a form structure.


form_builder_unset_element(&$form, $element_id)   X-Ref
Recursive function to unset an element within a form structure.


form_builder_get_element_ids($form)   X-Ref
Recursive function to check if an element exists at all within a form.


form_builder_load_form($form_type, $form_id)   X-Ref
Loader function to retrieve a form builder configuration array.

param: $form_type
param: $form_id

form_builder_save_form(&$form, $form_type, $form_id)   X-Ref
Execute the save methods for a form array.


form_builder_add_default_properties($form, $form_type, $key = NULL, $parent_id = FORM_BUILDER_ROOT)   X-Ref
Helper function to add default #form_builder properties to a form.




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