abstract class ExtraFieldFormBase in Extra Field 8.2

Base class for Extra field Form plugins.

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\extra_field\Plugin\ExtraFieldFormBase implements ExtraFieldFormInterface uses StringTranslationTrait

4 files declare their use of ExtraFieldFormBase

CustomSubmit.php in modules/extra_field_example/src/Plugin/ExtraField/Form/CustomSubmit.php

ExampleCustomInput.php in modules/extra_field_example/src/Plugin/ExtraField/Form/ExampleCustomInput.php

ExampleMarkup.php in modules/extra_field_example/src/Plugin/ExtraField/Form/ExampleMarkup.php

SingleItemTest.php in tests/extra_field_test/src/Plugin/ExtraField/Form/SingleItemTest.php

File

src/Plugin/ExtraFieldFormBase.php, line 13

Namespace

Drupal\extra_field\Plugin

abstract class ExtraFieldFormBase extends PluginBase implements ExtraFieldFormInterface {
  use StringTranslationTrait;

  /**
   * The field's parent entity.
   *
   * @var \Drupal\Core\Entity\ContentEntityInterface
   */
  protected $entity;

  /**
   * The form mode.
   *
   * @var string
   */
  protected $formMode;

  /**
   * The entity form display.
   *
   * Contains the form display options configured for the entity components.
   *
   * @var \Drupal\Core\Entity\Display\EntityFormDisplayInterface
   */
  protected $entityFormDisplay;

  /**
   * {@inheritdoc}
   */
  public function setEntity(ContentEntityInterface $entity) {
    $this->entity = $entity;
  }

  /**
   * {@inheritdoc}
   */
  public function getEntity() {
    return $this->entity;
  }

  /**
   * {@inheritdoc}
   */
  public function setEntityFormDisplay(EntityFormDisplayInterface $display) {
    $this->entityFormDisplay = $display;
  }

  /**
   * {@inheritdoc}
   */
  public function getEntityFormDisplay() {
    return $this->entityFormDisplay;
  }

  /**
   * {@inheritdoc}
   */
  public function setFormMode($form_mode) {
    $this->formMode = $form_mode;
  }

  /**
   * {@inheritdoc}
   */
  public function getFormMode() {
    return $this->formMode;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ExtraFieldFormBase::$entity	protected	property	The field's parent entity.
ExtraFieldFormBase::$entityFormDisplay	protected	property	The entity form display.
ExtraFieldFormBase::$formMode	protected	property	The form mode.
ExtraFieldFormBase::getEntity	public	function	Returns the field's parent entity. Overrides ExtraFieldFormInterface::getEntity
ExtraFieldFormBase::getEntityFormDisplay	public	function	Returns the entity form display object of the field's host entity. Overrides ExtraFieldFormInterface::getEntityFormDisplay
ExtraFieldFormBase::getFormMode	public	function	Returns the entity form mode of the field's host entity. Overrides ExtraFieldFormInterface::getFormMode
ExtraFieldFormBase::setEntity	public	function	Stores the field's parent entity. Overrides ExtraFieldFormInterface::setEntity
ExtraFieldFormBase::setEntityFormDisplay	public	function	Stores the entity form display. Overrides ExtraFieldFormInterface::setEntityFormDisplay
ExtraFieldFormBase::setFormMode	public	function	Stores the entity form mode. Overrides ExtraFieldFormInterface::setFormMode
ExtraFieldFormInterface::formElement	public	function	Builds a renderable array for the field.	4
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	92
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.