You are here

Home » API reference » Entity Extra Field 8 » EntityExtraFieldForm.php

class EntityExtraFieldForm in Entity Extra Field 8

Same name and namespace in other branches
  1. 2.0.x src/Form/EntityExtraFieldForm.php \Drupal\entity_extra_field\Form\EntityExtraFieldForm

Define entity extra field form.

Hierarchy

Expanded class hierarchy of EntityExtraFieldForm

File

src/Form/EntityExtraFieldForm.php, line 23

Namespace

Drupal\entity_extra_field\Form
View source 
class EntityExtraFieldForm extends EntityForm {

  /**
   * @var \Drupal\Core\Cache\CacheBackendInterface
   */
  protected $cacheDiscovery;

  /**
   * @var \Drupal\Core\Cache\CacheTagsInvalidatorInterface
   */
  protected $cacheTagsInvalidator;

  /**
   * @var \Drupal\Component\Plugin\PluginManagerInterface
   */
  protected $extraFieldTypeManager;

  /**
   * @var \Drupal\Component\Plugin\PluginManagerInterface
   */
  protected $conditionPluginManager;

  /**
   * @var \Drupal\Core\Entity\EntityDisplayRepositoryInterface
   */
  protected $entityDisplayRepository;

  /**
   * Define the extra field type manager.
   *
   * @param \Drupal\Core\Cache\CacheBackendInterface $cache_discovery_backend
   *   The cache discovery backend service.
   * @param \Drupal\Component\Plugin\PluginManagerInterface $extra_field_type_manager
   *   The extra field type plugin manager.
   * @param \Drupal\Component\Plugin\PluginManagerInterface $condition_plugin_manager
   *   The condition plugin manager.
   * @param \Drupal\Core\Cache\CacheTagsInvalidatorInterface $cache_tags_invalidator
   *   The cache tags invalidator service.
   * @param \Drupal\Core\Entity\EntityDisplayRepositoryInterface $entity_display_repository
   *   The entity display repository.
   */
  public function __construct(CacheBackendInterface $cache_discovery_backend, PluginManagerInterface $extra_field_type_manager, PluginManagerInterface $condition_plugin_manager, CacheTagsInvalidatorInterface $cache_tags_invalidator, EntityDisplayRepositoryInterface $entity_display_repository) {
    $this->cacheDiscovery = $cache_discovery_backend;
    $this->cacheTagsInvalidator = $cache_tags_invalidator;
    $this->extraFieldTypeManager = $extra_field_type_manager;
    $this->conditionPluginManager = $condition_plugin_manager;
    $this->entityDisplayRepository = $entity_display_repository;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('cache.discovery'), $container
      ->get('plugin.manager.extra_field_type'), $container
      ->get('plugin.manager.condition'), $container
      ->get('cache_tags.invalidator'), $container
      ->get('entity_display.repository'));
  }

  /**
   * {@inheritdoc}
   */
  public function form(array $form, FormStateInterface $form_state) {

    /** @var \Drupal\entity_extra_field\Entity\EntityExtraField $entity */
    $entity = $this->entity;
    $form = parent::form($form, $form_state);
    $form['#parents'] = [];
    $form['#prefix'] = '<div id="entity-extra-field">';
    $form['#suffix'] = '</div>';
    $form['label'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Field Name'),
      '#maxlength' => 255,
      '#default_value' => $entity
        ->label(),
      '#description' => $this
        ->t('Input the extra field name.'),
      '#required' => TRUE,
    ];
    $form['name'] = [
      '#type' => 'machine_name',
      '#machine_name' => [
        'exists' => [
          $entity,
          'exists',
        ],
      ],
      '#disabled' => !$entity
        ->isNew(),
      '#default_value' => $entity
        ->name(),
    ];
    $form['display_label'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Display Label'),
      '#description' => $this
        ->t('Display the extra field name.'),
      '#default_value' => $entity
        ->displayLabel(),
    ];
    $form['display'] = [
      '#type' => 'container',
      '#tree' => TRUE,
    ];
    $form['display']['type'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Display Type'),
      '#description' => $this
        ->t('Select the extra field display type. <br/>
        The <em>View</em> display will render within the entity view. <br/>
        The <em>Form</em> display will render within the entity edit form.'),
      '#required' => TRUE,
      '#options' => [
        'form' => $this
          ->t('Form'),
        'view' => $this
          ->t('View'),
      ],
      '#empty_option' => $this
        ->t('- Select -'),
      '#default_value' => $this
        ->getEntityFormStateValue([
        'display',
        'type',
      ], $form_state),
    ];
    $form['description'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('Description'),
      '#default_value' => $entity
        ->description(),
    ];
    $field_type_id = $this
      ->getEntityFormStateValue('field_type_id', $form_state);
    $form['field_type_id'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Field Type'),
      '#required' => TRUE,
      '#options' => $this
        ->getExtraFieldTypeOptions(),
      '#empty_option' => $this
        ->t('- Select -'),
      '#default_value' => $field_type_id,
      '#ajax' => [
        'event' => 'change',
        'method' => 'replace',
        'wrapper' => 'entity-extra-field',
        'callback' => [
          $this,
          'entityExtraFieldAjax',
        ],
      ],
    ];
    if (isset($field_type_id) && !empty($field_type_id)) {
      $field_type_instance = $this
        ->createFieldTypeInstance($field_type_id, $form_state);
      if ($field_type_instance !== FALSE && $field_type_instance instanceof PluginFormInterface) {
        $subform = [
          '#parents' => [
            'field_type_config',
          ],
        ];
        $form['field_type_config'] = [
          '#type' => 'fieldset',
          '#title' => $this
            ->t('Field Type Configuration'),
          '#tree' => TRUE,
        ];
        $form['field_type_config'] += $field_type_instance
          ->buildConfigurationForm($subform, SubformState::createForSubform($subform, $form, $form_state));
      }
    }
    $this
      ->attachFieldTypeConditionForm($form, $form_state, ContextDefinition::create("entity:{$this->getExtraFieldBaseEntityTypeId()}"));
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    parent::validateForm($form, $form_state);
    if ($field_type_id = $form_state
      ->getValue('field_type_id')) {
      $field_type_instance = $this
        ->createFieldTypeInstance($field_type_id, $form_state);
      if ($field_type_instance !== FALSE && $field_type_instance instanceof PluginFormInterface) {
        $subform = [
          '#parents' => [
            'field_type_config',
          ],
        ];
        $field_type_instance
          ->validateConfigurationForm($subform, SubformState::createForSubform($subform, $form, $form_state));
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    if ($field_type_id = $form_state
      ->getValue('field_type_id')) {
      $field_type_instance = $this
        ->createFieldTypeInstance($field_type_id, $form_state);
      if ($field_type_instance !== FALSE && $field_type_instance instanceof PluginFormInterface) {
        $subform = [
          '#parents' => [
            'field_type_config',
          ],
        ];
        $field_type_instance
          ->submitConfigurationForm($subform, SubformState::createForSubform($subform, $form, $form_state));
        $form_state
          ->setValue('field_type_config', $field_type_instance
          ->getConfiguration());
      }
    }
    $this
      ->submitFieldTypeConditionForm($form, $form_state);
    parent::submitForm($form, $form_state);
  }

  /**
   * Ajax callback for entity extra field.
   *
   * @param array $form
   *   An array of form elements.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   A form state instance.
   *
   * @return array
   *   An array of the form elements.
   */
  public function entityExtraFieldAjax(array $form, FormStateInterface $form_state) {
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function save(array $form, FormStateInterface $form_state) {

    /** @var \Drupal\entity_extra_field\Entity\EntityExtraField $entity */
    $entity = $this->entity;
    $status = parent::save($form, $form_state);
    $form_state
      ->setRedirectUrl($entity
      ->toUrl('collection'));
    $this
      ->flushAllCaches();
    return $status;
  }

  /**
   * {@inheritdoc}
   */
  public function getEntityFromRouteMatch(RouteMatchInterface $route_match, $entity_type_id) {
    if ($route_match
      ->getRawParameter($entity_type_id) !== NULL) {
      $entity = $route_match
        ->getParameter($entity_type_id);
    }
    else {
      $values = [];
      $type_manager = $this->entityTypeManager;
      if ($base_entity_type_id = $route_match
        ->getParameter('entity_type_id')) {
        $definition = $type_manager
          ->getDefinition($base_entity_type_id);
        $values['base_entity_type_id'] = $base_entity_type_id;
        $bundle_type = $definition
          ->getBundleEntityType();
        if ($base_bundle_type = $route_match
          ->getParameter($bundle_type)) {
          $values['base_bundle_type_id'] = $base_bundle_type
            ->id();
        }
      }
      $entity = $type_manager
        ->getStorage($entity_type_id)
        ->create($values);
    }
    return $entity;
  }

  /**
   * Create extra field type plugin instance.
   *
   * @param $plugin_id
   *   The field type plugin identifier.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The form state instance.
   *
   * @return \Drupal\entity_extra_field\ExtraFieldTypePluginInterface|FALSE
   *   Return the extra field type plugin instance; otherwise FALSE if it
   *   doesn't exist.
   *
   * @throws \Drupal\Component\Plugin\Exception\PluginException
   */
  protected function createFieldTypeInstance($plugin_id, FormStateInterface $form_state) {
    $field_type_manager = $this->extraFieldTypeManager;
    if (!$field_type_manager
      ->hasDefinition($plugin_id)) {
      return FALSE;
    }
    return $field_type_manager
      ->createInstance($plugin_id, $this
      ->getEntityFormStateValue('field_type_config', $form_state, []));
  }

  /**
   * Get extra field base entity type identifier.
   *
   * @return string
   *   The extra field base entity type identifier.
   */
  protected function getExtraFieldBaseEntityTypeId() {

    /** @var \Drupal\entity_extra_field\Entity\EntityExtraField $entity_extra_field */
    $entity_extra_field = $this->entity;
    return $entity_extra_field
      ->getBaseEntityTypeId();
  }

  /**
   * Get condition definitions by context.
   *
   * @param \Drupal\Core\Plugin\Context\ContextDefinitionInterface $context
   *   The context definition.
   *
   * @return array
   *   An array of condition definition based on the given context.
   */
  protected function getConditionDefinitionsByContext(ContextDefinitionInterface $context) {
    return $this->conditionPluginManager
      ->getDefinitionsForContexts([
      new Context($context),
    ]);
  }

  /**
   * Attach field type condition form.
   *
   * @param array $form
   *   An array of form elements.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The form state instance.
   * @param \Drupal\Core\Plugin\Context\ContextDefinitionInterface $context
   *   The context definition.
   *
   * @return \Drupal\entity_extra_field\Form\EntityExtraFieldForm
   *
   * @throws \Drupal\Component\Plugin\Exception\PluginException
   */
  protected function attachFieldTypeConditionForm(array &$form, FormStateInterface $form_state, ContextDefinitionInterface $context) {
    $parents = [
      'field_type_condition',
    ];
    $form['conditions'] = [
      '#type' => 'vertical_tabs',
      '#title' => $this
        ->t('Field Type Conditions'),
    ];
    $form['field_type_condition']['#tree'] = TRUE;
    foreach ($this
      ->getConditionDefinitionsByContext($context) as $plugin_id => $definition) {
      $form['field_type_condition'][$plugin_id] = [
        '#type' => 'details',
        '#title' => $definition['label'],
        '#group' => 'conditions',
      ];
      $subform_parents = array_merge($parents, [
        $plugin_id,
      ]);
      $configuration = $this
        ->getEntityFormStateValue($subform_parents, $form_state, []);

      /** @var \Drupal\Core\Condition\ConditionInterface $condition */
      $condition = $this->conditionPluginManager
        ->createInstance($plugin_id, $configuration);
      $subform = [
        '#parents' => $subform_parents,
      ];
      $form['field_type_condition'][$plugin_id] += $condition
        ->buildConfigurationForm($subform, SubformState::createForSubform($subform, $form, $form_state));

      /**
       * @todo Remove workaround once
       * https://www.drupal.org/project/drupal/issues/2783897 is fixed.
       */
      if ($plugin_id === 'current_theme') {
        $form['field_type_condition'][$plugin_id]['theme']['#empty_option'] = $this
          ->t('- None -');
      }
    }
    $form['field_conditions_all_pass'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('All Conditions Must Pass'),
      '#description' => $this
        ->t('If checked, then all conditions must evaluate true.'),
      '#default_value' => $this
        ->getEntityFormStateValue('field_conditions_all_pass', $form_state),
    ];
    return $this;
  }

  /**
   * Submit field type condition form.
   *
   * @param array $form
   *   An array of form elements.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The form state instance.
   *
   * @return \Drupal\entity_extra_field\Form\EntityExtraFieldForm
   *
   * @throws \Drupal\Component\Plugin\Exception\PluginException
   */
  protected function submitFieldTypeConditionForm(array &$form, FormStateInterface $form_state) {
    $parents = [
      'field_type_condition',
    ];
    if ($condition = $form_state
      ->getValue($parents)) {
      foreach ($condition as $plugin_id => $configuration) {
        $subform_parents = array_merge($parents, [
          $plugin_id,
        ]);

        /** @var \Drupal\Core\Condition\ConditionInterface $instance */
        $instance = $this->conditionPluginManager
          ->createInstance($plugin_id, $configuration);
        $subform = [
          '#parents' => $subform_parents,
        ];
        $instance
          ->submitConfigurationForm($subform, SubformState::createForSubform($subform, $form, $form_state));
        $form_state
          ->setValue($subform_parents, $instance
          ->getConfiguration());
      }
    }
    return $this;
  }

  /**
   * Flush all caches related to this form.
   */
  protected function flushAllCaches() {

    /** @var \Drupal\entity_extra_field\Entity\EntityExtraField $entity */
    $entity = $this->entity;
    $this->cacheDiscovery
      ->delete($entity
      ->getCacheDiscoveryId());
    $this->cacheTagsInvalidator
      ->invalidateTags([
      $entity
        ->getCacheRenderTag(),
    ]);
    return $this;
  }

  /**
   * Get extra field type options.
   *
   * @return array
   *   An array of extra field type options.
   */
  protected function getExtraFieldTypeOptions() {
    $options = [];
    foreach ($this->extraFieldTypeManager
      ->getDefinitions() as $plugin_id => $definition) {
      if (!isset($definition['label'])) {
        continue;
      }
      $options[$plugin_id] = $definition['label'];
    }
    return $options;
  }

  /**
   * Get the form state value.
   *
   * @param string|array $key
   *   The element key.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The form state instance.
   * @param null $default
   *   The default value if nothing is found.
   *
   * @return mixed|null
   *   The form value; otherwise FALSE if the value can't be found.
   */
  protected function getEntityFormStateValue($key, FormStateInterface $form_state, $default = NULL) {

    /** @var \Drupal\entity_extra_field\Entity\EntityExtraField $entity */
    $entity = $this->entity;
    $key = !is_array($key) ? [
      $key,
    ] : $key;
    $inputs = [
      $form_state
        ->cleanValues()
        ->getValues(),
    ];
    if ($entity
      ->id() !== NULL) {
      $inputs[] = $entity
        ->toArray();
    }
    foreach ($inputs as $input) {
      $value = NestedArray::getValue($input, $key, $key_exists);
      if (!isset($value) && !$key_exists) {
        continue;
      }
      return $value;
    }
    return $default;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
EntityExtraFieldForm::$cacheDiscovery protected property
EntityExtraFieldForm::$cacheTagsInvalidator protected property
EntityExtraFieldForm::$conditionPluginManager protected property
EntityExtraFieldForm::$entityDisplayRepository protected property
EntityExtraFieldForm::$extraFieldTypeManager protected property
EntityExtraFieldForm::attachFieldTypeConditionForm protected function Attach field type condition form.
EntityExtraFieldForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
EntityExtraFieldForm::createFieldTypeInstance protected function Create extra field type plugin instance.
EntityExtraFieldForm::entityExtraFieldAjax public function Ajax callback for entity extra field.
EntityExtraFieldForm::flushAllCaches protected function Flush all caches related to this form.
EntityExtraFieldForm::form public function Gets the actual form array to be built. Overrides EntityForm::form
EntityExtraFieldForm::getConditionDefinitionsByContext protected function Get condition definitions by context.
EntityExtraFieldForm::getEntityFormStateValue protected function Get the form state value.
EntityExtraFieldForm::getEntityFromRouteMatch public function Determines which entity will be used by this form from a RouteMatch object. Overrides EntityForm::getEntityFromRouteMatch
EntityExtraFieldForm::getExtraFieldBaseEntityTypeId protected function Get extra field base entity type identifier.
EntityExtraFieldForm::getExtraFieldTypeOptions protected function Get extra field type options.
EntityExtraFieldForm::save public function Form submission handler for the 'save' action. Overrides EntityForm::save
EntityExtraFieldForm::submitFieldTypeConditionForm protected function Submit field type condition form.
EntityExtraFieldForm::submitForm public function This is the default entity object builder function. It is called before any other submit handler to build the new entity object to be used by the following submit handlers. At this point of the form workflow the entity is validated and the form state… Overrides EntityForm::submitForm
EntityExtraFieldForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
EntityExtraFieldForm::__construct public function Define the extra field type manager.
EntityForm::$entity protected property The entity being used by this form. 7
EntityForm::$entityTypeManager protected property The entity type manager. 3
EntityForm::$moduleHandler protected property The module handler service.
EntityForm::$operation protected property The name of the current operation.
EntityForm::$privateEntityManager private property The entity manager.
EntityForm::actions protected function Returns an array of supported actions for the current entity form. 29
EntityForm::actionsElement protected function Returns the action form element for the current entity form.
EntityForm::afterBuild public function Form element #after_build callback: Updates the entity with submitted data.
EntityForm::buildEntity public function Builds an updated entity object based upon the submitted form values. Overrides EntityFormInterface::buildEntity 2
EntityForm::buildForm public function Form constructor. Overrides FormInterface::buildForm 10
EntityForm::copyFormValuesToEntity protected function Copies top-level form values to entity properties 7
EntityForm::getBaseFormId public function Returns a string identifying the base form. Overrides BaseFormIdInterface::getBaseFormId 5
EntityForm::getEntity public function Gets the form entity. Overrides EntityFormInterface::getEntity
EntityForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId 10
EntityForm::getOperation public function Gets the operation identifying the form. Overrides EntityFormInterface::getOperation
EntityForm::init protected function Initialize the form state and the entity before the first form build. 3
EntityForm::prepareEntity protected function Prepares the entity object before the form is built first. 3
EntityForm::prepareInvokeAll protected function Invokes the specified prepare hook variant.
EntityForm::processForm public function Process callback: assigns weights and hides extra fields.
EntityForm::setEntity public function Sets the form entity. Overrides EntityFormInterface::setEntity
EntityForm::setEntityManager public function Sets the entity manager for this form. Overrides EntityFormInterface::setEntityManager
EntityForm::setEntityTypeManager public function Sets the entity type manager for this form. Overrides EntityFormInterface::setEntityTypeManager
EntityForm::setModuleHandler public function Sets the module handler for this form. Overrides EntityFormInterface::setModuleHandler
EntityForm::setOperation public function Sets the operation for this form. Overrides EntityFormInterface::setOperation
EntityForm::__get public function
EntityForm::__set public function
FormBase::$configFactory protected property The config factory. 1
FormBase::$requestStack protected property The request stack. 1
FormBase::$routeMatch protected property The route match.
FormBase::config protected function Retrieves a configuration object.
FormBase::configFactory protected function Gets the config factory for this form. 1
FormBase::container private function Returns the service container.
FormBase::currentUser protected function Gets the current user.
FormBase::getRequest protected function Gets the request object.
FormBase::getRouteMatch protected function Gets the route match.
FormBase::logger protected function Gets the logger for a specific channel.
FormBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
FormBase::resetConfigFactory public function Resets the configuration factory.
FormBase::setConfigFactory public function Sets the config factory for this form.
FormBase::setRequestStack public function Sets the request stack object to use.
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
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.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.