You are here

interface FormComponentTypeInterface in Flexiform 8

Interface for form component type plugins.

Hierarchy

Expanded class hierarchy of FormComponentTypeInterface

All classes that implement FormComponentTypeInterface

File

src/FormComponent/FormComponentTypeInterface.php, line 10

Namespace

Drupal\flexiform\FormComponent
View source
interface FormComponentTypeInterface {

  /**
   * Get the form entity manager.
   *
   * @return \Drupal\flexiform\FormEntity\FlexiformFormEntityManager
   *   The form entity manager.
   */
  public function getFormEntityManager();

  /**
   * Set the form display.
   *
   * @param \Drupal\flexiform\FlexiformEntityFormDisplay $form_display
   *   The form display.
   *
   * @return \Drupal\Flexiform\FormComponent\FormComponentTypeInterface
   *   The form component type plugin with the form display set.
   */
  public function setFormDisplay(FlexiformEntityFormDisplay $form_display);

  /**
   * Get the form display.
   *
   * @return \Drupal\flexiform\FlexiformEntityFormDisplay
   *   The form display
   */
  public function getFormDisplay();

  /**
   * Get a component object.
   *
   * @param string $name
   *   The name of the component.
   * @param array $options
   *   The options for the component.
   *
   * @return \Drupal\flexiform\FormComponent\FormComponentInterface
   *   The form component.
   */
  public function getComponent($name, array $options);

}

Members

Namesort descending Modifiers Type Description Overrides
FormComponentTypeInterface::getComponent public function Get a component object. 1
FormComponentTypeInterface::getFormDisplay public function Get the form display. 1
FormComponentTypeInterface::getFormEntityManager public function Get the form entity manager. 1
FormComponentTypeInterface::setFormDisplay public function Set the form display. 1