interface FlexiformDisplayInterface in Flexiform 7

Interface for all display classes.

Hierarchy

• interface \FlexiformDisplayInterface

File

includes/flexiform.display.inc, line 10

Specify base display classes for flexiforms.

interface FlexiformDisplayInterface {

  /**
   * Get the base entity for the flexible form.
   *
   * @param Flexiform $flexiform
   *   A flexiform object.
   * @param array $configuration
   *   The configration as stored in the flexiform.
   * @param array $context
   *   (optional) An array of settings and values to help the plugin return the
   *   entity.
   *
   * @return stdClass|Entity
   *   The base entity for the form.
   */
  public function getBaseEntity($context = array());

  /**
   * Build the form ready for rendering.
   */
  public function build($context = array());

  /**
   * Get the title for a built form.
   */
  public function title($context = array());

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

  /**
   * Retrieve the flexiform for this display.
   *
   * @return Flexiform
   */
  public function getFlexiform();

  /**
   * Get the path, if applicable, for the display.
   *
   * @param $base_entity_id
   *   The identifier for the base entity.
   * @param ...
   *  Any additional arguments.
   *
   * @return string|NULL
   *   The path to the flexiform or NULL if there is none.
   */
  public function getPath($base_entity_id = NULL);

  /**
   * Check the access for this form display.
   *
   * @param array $context
   *   (optional) An array of settings and values to help the plugin return the
   *   entity
   *
   * @return bool
   *   TRUE if the user can access this display. False otherwise.
   */
  public function access($context = array());

}

Members

Name	Modifiers	Type	Description	Overrides
FlexiformDisplayInterface::access	public	function	Check the access for this form display.	1
FlexiformDisplayInterface::build	public	function	Build the form ready for rendering.	1
FlexiformDisplayInterface::configForm	public	function	Get the config form.	1
FlexiformDisplayInterface::getBaseEntity	public	function	Get the base entity for the flexible form.	1
FlexiformDisplayInterface::getFlexiform	public	function	Retrieve the flexiform for this display.	1
FlexiformDisplayInterface::getPath	public	function	Get the path, if applicable, for the display.	1
FlexiformDisplayInterface::title	public	function	Get the title for a built form.	1