interface FormBuilderPropertyInterface in Form Builder 7

Hierarchy

• interface \FormBuilderPropertyInterface

File

./form_builder.classes.inc, line 921

interface FormBuilderPropertyInterface {

  /**
   * Construct a new instance of this property class.
   *
   * @param string $property
   *   Name of the property to be manipulated by this object.
   * @param array $params
   *   Additional parameters passed to hook_form_builder_properties().
   */
  public function __construct($property, $params, $form_type_name);

  /**
   * Generate form-API elements for editing this property.
   *
   * @param array $form_state
   *   Form API form_state of the field configure form.
   * @param FormBuilderFormElement $element
   *   The currently stored element. Use this to get the "current" values.
   *
   * @return array
   *   Form-API array that will be merged into the field configure form.
   */
  public function form(&$form_state, $element);

  /**
   * Submit handler for the editing form().
   *
   * This function is responsible to store the new value into the $form_state.
   * The value must be located at $form_state['values'][$property].
   *
   * @param array $form_state
   *   Form API form_state of the field configure form.
   */
  public function submit($form, &$form_state);

}

Members

Name	Modifiers	Type	Description	Overrides
FormBuilderPropertyInterface::form	public	function	Generate form-API elements for editing this property.	1
FormBuilderPropertyInterface::submit	public	function	Submit handler for the editing form().	1
FormBuilderPropertyInterface::__construct	public	function	Construct a new instance of this property class.	1