interface FormBuilderElementInterface in Form Builder 7

Hierarchy

• interface \FormBuilderElementInterface

File

./form_builder.classes.inc, line 749

interface FormBuilderElementInterface {
  public function __construct($form_type, $params, &$element, $loader);

  /**
   * (Re-)Render an element.
   *
   * @return array
   *   New FAPI array reflecting all the changes made prior to callig this
   *   method.
   */
  public function render();

  /**
   * Get a list of properties available for this element.
   *
   * @return
   *   An associative array of properties keyed by the property name.
   *   Property classes must implementing FormBuilderPropertyInterface.
   */
  public function getProperties();

  /**
   * Get a list of properties that are supported in any way by this 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.
   *
   * @return
   *   A non-indexed list of properties that may be saved for this element.
   **/
  public function getSaveableProperties();

  /**
   * Get the configuration form for this element.
   */
  public function configurationForm($form, &$form_state);

  /**
   * Submit handler for the configuration form.
   */
  public function configurationSubmit(&$form, &$form_state);

  /**
   * Get a human-readable title for this form element.
   */
  public function title();

}

Members

Name	Modifiers	Type	Description	Overrides
FormBuilderElementInterface::configurationForm	public	function	Get the configuration form for this element.	1
FormBuilderElementInterface::configurationSubmit	public	function	Submit handler for the configuration form.	1
FormBuilderElementInterface::getProperties	public	function	Get a list of properties available for this element.	1
FormBuilderElementInterface::getSaveableProperties	public	function	Get a list of properties that are supported in any way by this element.	1
FormBuilderElementInterface::render	public	function	(Re-)Render an element.	1
FormBuilderElementInterface::title	public	function	Get a human-readable title for this form element.	1
FormBuilderElementInterface::__construct	public	function		1