You are here

Home » API reference » Form mode manager 8.2 » FormModeManagerDisplayEditForm.php

class FormModeManagerDisplayEditForm in Form mode manager 8.2

Same name and namespace in other branches
  1. 8 src/Form/FormModeManagerDisplayEditForm.php \Drupal\form_mode_manager\Form\FormModeManagerDisplayEditForm

Form Mode Manager enhancements for edit form of the EntityFormDisplay.

This class permit to add a more specific caches and routes invalidate onto, formDisplay entity form elements. We haven't more common way to be plugged, in EntityDisplay form edit event and identify with precision when an user, add a form-mode onto an EntityType. With following code we have a flexible, and light way to add Form Mode Manager custom comportements like field_ui, way with `EntityFormDisplayEditForm`.

Hierarchy

Expanded class hierarchy of FormModeManagerDisplayEditForm

File

src/Form/FormModeManagerDisplayEditForm.php, line 25

Namespace

Drupal\form_mode_manager\Form
View source 
class FormModeManagerDisplayEditForm extends EntityFormDisplayEditForm {

  /**
   * The cache tags invalidator.
   *
   * @var \Drupal\Core\Cache\CacheTagsInvalidatorInterface
   */
  protected $cacheTagsInvalidator;

  /**
   * The route builder service.
   *
   * @var \Drupal\Core\Routing\RouteBuilderInterface
   */
  protected $routeBuilder;

  /**
   * Constructs a new FormModeManagerDisplayEditForm.
   *
   * @param \Drupal\Core\Field\FieldTypePluginManagerInterface $field_type_manager
   *   The field type manager.
   * @param \Drupal\Component\Plugin\PluginManagerBase $plugin_manager
   *   The widget or formatter plugin manager.
   * @param \Drupal\Core\Entity\EntityDisplayRepositoryInterface|null $entity_display_repository
   *   (optional) The entity display_repository.
   * @param \Drupal\Core\Entity\EntityFieldManagerInterface|null $entity_field_manager
   *   (optional) The entity field manager.
   * @param \Drupal\Core\Cache\CacheTagsInvalidatorInterface $cache_tags_invalidator
   *   The cache tags invalidator.
   * @param \Drupal\Core\Routing\RouteBuilderInterface $route_builder
   *   The route builder service.
   */
  public function __construct(FieldTypePluginManagerInterface $field_type_manager, PluginManagerBase $plugin_manager, EntityDisplayRepositoryInterface $entity_display_repository, EntityFieldManagerInterface $entity_field_manager, CacheTagsInvalidatorInterface $cache_tags_invalidator, RouteBuilderInterface $route_builder) {
    parent::__construct($field_type_manager, $plugin_manager, $entity_display_repository, $entity_field_manager);
    $this->cacheTagsInvalidator = $cache_tags_invalidator;
    $this->routeBuilder = $route_builder;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('plugin.manager.field.field_type'), $container
      ->get('plugin.manager.field.widget'), $container
      ->get('entity_display.repository'), $container
      ->get('entity_field.manager'), $container
      ->get('cache_tags.invalidator'), $container
      ->get('router.builder'));
  }

  /**
   * {@inheritdoc}
   *
   * Add more precise cache/routes invalidation when we are sure these,
   * form-mode as added/deleted onto entities.
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    parent::submitForm($form, $form_state);
    if ($this
      ->isDefaultForm() && $this
      ->formModesUpdated($form, $form_state)) {
      $this->cacheTagsInvalidator
        ->invalidateTags([
        'local_action',
        'local_tasks',
        'entity_types',
        'rendered',
      ]);
      $this->routeBuilder
        ->rebuild();
    }
  }

  /**
   * Determine if the current form-mode is 'default'.
   *
   * @return bool
   *   True if this entityFormDisplay do rebuild routes.
   */
  public function isDefaultForm() {
    return 'default' === $this->entity
      ->getMode();
  }

  /**
   * Determine whenever a formMode(s) has added/deleted onto entityTypes.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   *
   * @return bool
   *   True if this entityFormDisplay do rebuild routes.
   */
  private function formModesUpdated(array $form, FormStateInterface $form_state) {
    if (!isset($form['modes'])) {
      return FALSE;
    }
    if ($this
      ->isNewFormMode($this
      ->defaultDisplayModes($form), $this
      ->submittedDisplayModes($form_state))) {
      return TRUE;
    }
    if ($this
      ->updateDisplayModes($form, $form_state)) {
      return TRUE;
    }
    return FALSE;
  }

  /**
   * Determine whenever a formMode(s) has added/deleted onto entityTypes.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   *
   * @return bool
   *   True if this entityFormDisplay do rebuild routes.
   */
  public function updateDisplayModes(array $form, FormStateInterface $form_state) {
    return !empty(array_diff_assoc($this
      ->getDefaultModes($form), $this
      ->getSubmittedModes($form_state)));
  }

  /**
   * Retrieve all form-modes selected before changes.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   *
   * @return array
   *   An array with all form-modes selected or empty.
   */
  public function defaultDisplayModes(array $form) {
    $display_modes = $this
      ->getDefaultModes($form);
    if (!empty($display_modes)) {
      return $display_modes;
    }
    return [];
  }

  /**
   * Retrieve all form-modes submitted form-modes.
   *
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   *
   * @return array
   *   An array with all form-modes selected or empty.
   */
  public function submittedDisplayModes(FormStateInterface $form_state) {
    $display_modes = $this
      ->getSubmittedModes($form_state);
    if (!empty($display_modes) && is_array($display_modes)) {
      return array_keys($display_modes);
    }
    return [];
  }

  /**
   * Get value of 'display_modes_custom' element.
   *
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   *
   * @return array|null
   *   An array with form-mode-id selected by users.
   */
  public function getSubmittedModes(FormStateInterface $form_state) {
    return $form_state
      ->getValue('display_modes_custom');
  }

  /**
   * Get value of 'display_modes_custom' element.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   *
   * @return array|null
   *   An array with form-mode-id present before submission.
   */
  public function getDefaultModes(array $form) {
    return $form['modes']['display_modes_custom']['#default_value'];
  }

  /**
   * Determine if we haven't any form-modes checked previously.
   *
   * @param array $form_mode_enabled
   *   An associative array containing all form-modes already used.
   * @param array $display_mode_selected
   *   An associative array containing all form-modes to be enabled.
   *
   * @return bool
   *   True if this submit is the first form-mode to enable.
   */
  private function isNewFormMode(array $form_mode_enabled, array $display_mode_selected) {
    return empty($form_mode_enabled) && !empty($display_mode_selected);
  }

}

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
EntityDisplayFormBase::$entity protected property The entity being used by this form. Overrides EntityForm::$entity
EntityDisplayFormBase::$entityDisplayRepository protected property The entity display repository.
EntityDisplayFormBase::$entityFieldManager protected property The entity field manager.
EntityDisplayFormBase::$fieldTypes protected property A list of field types.
EntityDisplayFormBase::$pluginManager protected property The widget or formatter plugin manager.
EntityDisplayFormBase::buildExtraFieldRow protected function Builds the table row structure for a single extra field.
EntityDisplayFormBase::copyFormValuesToEntity protected function Copies top-level form values to entity properties Overrides EntityForm::copyFormValuesToEntity
EntityDisplayFormBase::form public function Gets the actual form array to be built. Overrides EntityForm::form
EntityDisplayFormBase::getApplicablePluginOptions protected function Returns an array of applicable widget or formatter options for a field.
EntityDisplayFormBase::getDisplays protected function Returns entity (form) displays for the current entity display type.
EntityDisplayFormBase::getDisplayStatuses protected function Returns form or view modes statuses for the bundle used by this form.
EntityDisplayFormBase::getEntityFromRouteMatch public function Determines which entity will be used by this form from a RouteMatch object. Overrides EntityForm::getEntityFromRouteMatch
EntityDisplayFormBase::getExtraFields protected function Returns the extra fields of the entity type and bundle used by this form.
EntityDisplayFormBase::getFieldDefinitions protected function Collects the definitions of fields whose display is configurable.
EntityDisplayFormBase::getRegionOptions public function Returns an associative array of all regions.
EntityDisplayFormBase::getRegions public function Get the regions needed to create the overview form.
EntityDisplayFormBase::getRowRegion public function Returns the region to which a row in the display overview belongs.
EntityDisplayFormBase::multistepAjax public function Ajax handler for multistep buttons.
EntityDisplayFormBase::multistepSubmit public function Form submission handler for multistep buttons.
EntityDisplayFormBase::reduceOrder Deprecated public function Determines the rendering order of an array representing a tree.
EntityDisplayFormBase::saveDisplayStatuses protected function Saves the updated display mode statuses.
EntityDisplayFormBase::tablePreRender Deprecated public function Performs pre-render tasks on field_ui_table elements.
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::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::save public function Form submission handler for the 'save' action. Overrides EntityFormInterface::save 41
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
EntityFormDisplayEditForm::$displayContext protected property The display context. Either 'view' or 'form'. Overrides EntityDisplayFormBase::$displayContext
EntityFormDisplayEditForm::alterSettingsSummary protected function Alters the widget or formatter settings summary. Overrides EntityDisplayFormBase::alterSettingsSummary
EntityFormDisplayEditForm::buildFieldRow protected function Builds the table row structure for a single field. Overrides EntityDisplayFormBase::buildFieldRow
EntityFormDisplayEditForm::getDefaultPlugin protected function Returns the ID of the default widget or formatter plugin for a field type. Overrides EntityDisplayFormBase::getDefaultPlugin
EntityFormDisplayEditForm::getDisplayModeOptions protected function Returns an array of form or view mode options. Overrides EntityDisplayFormBase::getDisplayModeOptions
EntityFormDisplayEditForm::getDisplayModes protected function Returns the form or view modes used by this form. Overrides EntityDisplayFormBase::getDisplayModes
EntityFormDisplayEditForm::getDisplayModesLink protected function Returns a link to the form or view mode admin page. Overrides EntityDisplayFormBase::getDisplayModesLink
EntityFormDisplayEditForm::getEntityDisplay protected function Returns an entity display object to be used by this form. Overrides EntityDisplayFormBase::getEntityDisplay
EntityFormDisplayEditForm::getOverviewUrl protected function Returns the Url object for a specific entity (form) display edit form. Overrides EntityDisplayFormBase::getOverviewUrl
EntityFormDisplayEditForm::getTableHeader protected function Returns an array containing the table headers. Overrides EntityDisplayFormBase::getTableHeader
EntityFormDisplayEditForm::thirdPartySettingsForm protected function Adds the widget or formatter third party settings forms. Overrides EntityDisplayFormBase::thirdPartySettingsForm
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.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 62
FormModeManagerDisplayEditForm::$cacheTagsInvalidator protected property The cache tags invalidator.
FormModeManagerDisplayEditForm::$routeBuilder protected property The route builder service.
FormModeManagerDisplayEditForm::create public static function Instantiates a new instance of this class. Overrides EntityFormDisplayEditForm::create
FormModeManagerDisplayEditForm::defaultDisplayModes public function Retrieve all form-modes selected before changes.
FormModeManagerDisplayEditForm::formModesUpdated private function Determine whenever a formMode(s) has added/deleted onto entityTypes.
FormModeManagerDisplayEditForm::getDefaultModes public function Get value of 'display_modes_custom' element.
FormModeManagerDisplayEditForm::getSubmittedModes public function Get value of 'display_modes_custom' element.
FormModeManagerDisplayEditForm::isDefaultForm public function Determine if the current form-mode is 'default'.
FormModeManagerDisplayEditForm::isNewFormMode private function Determine if we haven't any form-modes checked previously.
FormModeManagerDisplayEditForm::submitForm public function Add more precise cache/routes invalidation when we are sure these, form-mode as added/deleted onto entities. Overrides EntityDisplayFormBase::submitForm
FormModeManagerDisplayEditForm::submittedDisplayModes public function Retrieve all form-modes submitted form-modes.
FormModeManagerDisplayEditForm::updateDisplayModes public function Determine whenever a formMode(s) has added/deleted onto entityTypes.
FormModeManagerDisplayEditForm::__construct public function Constructs a new FormModeManagerDisplayEditForm. Overrides EntityDisplayFormBase::__construct
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.