FormComponentTypeInterface.php in Flexiform 8

Namespace

Drupal\flexiform\FormComponent

File

src/FormComponent/FormComponentTypeInterface.php

<?php

namespace Drupal\flexiform\FormComponent;

use Drupal\flexiform\FlexiformEntityFormDisplay;

/**
 * Interface for form component type plugins.
 */
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);

}

Interfaces

Name	Description
FormComponentTypeInterface	Interface for form component type plugins.