interface FlexiformFormEntityInterface in Flexiform 7

Interface for all flexiform entities.

Hierarchy

• interface \FlexiformFormEntityInterface

1 string reference to 'FlexiformFormEntityInterface'

FlexiformFormEntityManagerDefault::getEntityHandler in includes/flexiform.form_entity_manager.inc

Get the entity handler class.

File

includes/flexiform.form_entity.inc, line 10

Contains interface and base class for flexiform entities.

interface FlexiformFormEntityInterface {

  /**
   * Get the entity for the form.
   *
   * @return
   *   A loaded or created entity object ready for use in the form.
   */
  public function getEntity();

  /**
   * Save the entity upon submission of the form.
   *
   * @param $entity
   *   The entity object being saved.
   */
  public function saveEntity($entity);

  /**
   * Get the Configuration Form.
   */
  public function configForm($form, &$form_state);

  /**
   * Validate the configuration form.
   */
  public function configFormValidate($form, &$form_state);

  /**
   * Submit the Configuration Form.
   */
  public function configFormSubmit($form, &$form_state);

}

Members

Name	Modifiers	Type	Description	Overrides
FlexiformFormEntityInterface::configForm	public	function	Get the Configuration Form.	1
FlexiformFormEntityInterface::configFormSubmit	public	function	Submit the Configuration Form.	1
FlexiformFormEntityInterface::configFormValidate	public	function	Validate the configuration form.	1
FlexiformFormEntityInterface::getEntity	public	function	Get the entity for the form.	1
FlexiformFormEntityInterface::saveEntity	public	function	Save the entity upon submission of the form.	1