You are here

Home » API reference » Field tools 8 » EntityDisplaySettingsBulkCopyForm.php

class EntityDisplaySettingsBulkCopyForm in Field tools 8

Provides a form to copy displays settings between displays.

Hierarchy

Expanded class hierarchy of EntityDisplaySettingsBulkCopyForm

File

src/Form/EntityDisplaySettingsBulkCopyForm.php, line 17

Namespace

Drupal\field_tools\Form
View source 
class EntityDisplaySettingsBulkCopyForm extends FormBase {

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * The entity type bundle info service.
   *
   * @var \Drupal\Core\Entity\EntityTypeBundleInfoInterface
   */
  protected $entityTypeBundleInfo;

  /**
   * The entity field manager service.
   *
   * @var \Drupal\Core\Entity\EntityFieldManagerInterface
   */
  protected $entityFieldManager;

  /**
   * The entity display repository service.
   *
   * @var \Drupal\Core\Entity\EntityDisplayRepositoryInterface
   */
  protected $entityDisplayRepository;

  /**
   * The field cloner.
   *
   * @var \Drupal\field_tools\DisplaySettingsCopier
   */
  protected $displaySettingsCopier;

  /**
   * Creates a Clone instance.
   *
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\Core\Entity\EntityTypeBundleInfoInterface $entity_type_bundle_info
   *   The entity type bundle info service.
   * @param \Drupal\Core\Entity\EntityFieldManagerInterface $entity_field_manager
   *   The entity field manager service.
   * @param \Drupal\Core\Entity\EntityDisplayRepositoryInterface $entity_display_repository
   *   The entity display repository service.
   * @param \Drupal\field_tools\DisplaySettingsCopier $display_settings_copier
   *   The display settings copier.
   */
  public function __construct(EntityTypeManagerInterface $entity_type_manager, EntityTypeBundleInfoInterface $entity_type_bundle_info, EntityFieldManagerInterface $entity_field_manager, EntityDisplayRepositoryInterface $entity_display_repository, DisplaySettingsCopier $display_settings_copier) {
    $this->entityTypeManager = $entity_type_manager;
    $this->entityTypeBundleInfo = $entity_type_bundle_info;
    $this->entityFieldManager = $entity_field_manager;
    $this->entityDisplayRepository = $entity_display_repository;
    $this->displaySettingsCopier = $display_settings_copier;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('entity_type.manager'), $container
      ->get('entity_type.bundle.info'), $container
      ->get('entity_field.manager'), $container
      ->get('entity_display.repository'), $container
      ->get('field_tools.display_settings_copier'));
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'field_tools_display_settings_copy_form';
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, $entity_type_id = NULL, $bundle = NULL) {
    $bundle_fields = array_filter($this->entityFieldManager
      ->getFieldDefinitions($entity_type_id, $bundle), function ($field_definition) {
      return !$field_definition
        ->isComputed();
    });
    foreach ($bundle_fields as $field_name => $field_definition) {
      $source_field_options[$field_name] = $field_definition
        ->getLabel();
    }
    natcasesort($source_field_options);
    $form['source_fields'] = array(
      '#type' => 'checkboxes',
      '#title' => $this
        ->t('Fields to copy'),
      '#description' => $this
        ->t("Select the fields whose display settings should be copied."),
      '#options' => $source_field_options,
      '#required' => TRUE,
    );

    // Source display.
    $form['source_display'] = array(
      '#type' => 'select',
      '#title' => $this
        ->t('Source display'),
      '#description' => $this
        ->t("Select the display to copy settings from and to"),
      '#required' => TRUE,
      '#options' => $this
        ->getDisplayOptions('entity_form_display', $entity_type_id, $bundle),
      // Workaround for core bug: https://www.drupal.org/node/2906113
      '#empty_value' => '',
    );

    // Destination bundles.
    $destination_bundle_options = [];
    $other_bundles = $this->entityTypeBundleInfo
      ->getBundleInfo($entity_type_id);
    foreach ($other_bundles as $other_bundle_name => $info) {
      $destination_bundle_options[$other_bundle_name] = $info['label'];
    }
    $form['destination_bundles'] = array(
      '#type' => 'checkboxes',
      '#title' => $this
        ->t('Destination bundles'),
      '#description' => $this
        ->t("Select the bundles to copy the settings to."),
      '#options' => $destination_bundle_options,
      '#required' => TRUE,
    );

    // Mark the current bundle as disabled.
    $form['destination_bundles'][$bundle]['#disabled'] = TRUE;
    $form['destination_bundles'][$bundle]['#description'] = $this
      ->t("This is the current bundle.");
    $form['submit'] = array(
      '#type' => 'submit',
      '#value' => $this
        ->t('Copy field settings'),
    );
    return $form;
  }

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

    // Get the original parameters given to buildForm().
    // TODO: is this the right way to do this?
    $build_info = $form_state
      ->getBuildInfo();
    list($entity_type_id, $bundle) = $build_info['args'];
    $values = $form_state
      ->getValues();
    $source_fields = array_filter($values['source_fields']);
    list($source_display_type, $source_display_id) = explode(':', $values['source_display']);
    $source_display = $this->entityTypeManager
      ->getStorage($source_display_type)
      ->load($source_display_id);
    $destination_bundles = array_filter($values['destination_bundles']);
    $bundle_fields = $this->entityFieldManager
      ->getFieldDefinitions($entity_type_id, $bundle);
    foreach ($source_fields as $source_field_name) {
      $field_definition = $bundle_fields[$source_field_name];
      foreach ($destination_bundles as $bundle) {
        $this->displaySettingsCopier
          ->copyDisplaySettings($field_definition, $source_display, $bundle);
        $this
          ->messenger()
          ->addMessage($this
          ->t("Copied settings for @field-name to @bundle.", [
          // TODO: use human-readable labels here.
          '@field-name' => $source_field_name,
          '@bundle' => $bundle,
        ]));
      }
    }
  }

  /**
   * Get the form options for a display type.
   *
   * @todo refactor to a trait.
   *
   * @param $type
   *  The entity type ID of the display type.
   * @param $entity_type_id
   *  The target entity type ID of the displays.
   * @param $bundle
   *  The target bundle.
   *
   * @return
   *  An array of form options.
   */
  protected function getDisplayOptions($type, $entity_type_id, $bundle) {
    $display_options = [];
    $types = [
      'entity_form_display' => 'Form',
      'entity_view_display' => 'View',
    ];
    foreach ($types as $type => $label) {
      $display_ids = $this->entityTypeManager
        ->getStorage($type)
        ->getQuery()
        ->condition('targetEntityType', $entity_type_id)
        ->condition('bundle', $bundle)
        ->execute();
      $displays = $this->entityTypeManager
        ->getStorage($type)
        ->loadMultiple($display_ids);

      // Unfortunately, getDisplayModesByEntityType() is protected :(
      if ($type == 'entity_form_display') {
        $mode_options = $this->entityDisplayRepository
          ->getFormModeOptions($entity_type_id);
      }
      else {
        $mode_options = $this->entityDisplayRepository
          ->getViewModeOptions($entity_type_id);
      }
      foreach ($displays as $id => $display) {

        // The label() method of displays returns NULL always, so we get the label
        // from the related mode.
        $display_options[$type . ':' . $id] = $label . ': ' . $mode_options[$display
          ->getMode()];
      }

      // Sort within each type.
      asort($display_options);
    }
    return $display_options;
  }

}

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
EntityDisplaySettingsBulkCopyForm::$displaySettingsCopier protected property The field cloner.
EntityDisplaySettingsBulkCopyForm::$entityDisplayRepository protected property The entity display repository service.
EntityDisplaySettingsBulkCopyForm::$entityFieldManager protected property The entity field manager service.
EntityDisplaySettingsBulkCopyForm::$entityTypeBundleInfo protected property The entity type bundle info service.
EntityDisplaySettingsBulkCopyForm::$entityTypeManager protected property The entity type manager.
EntityDisplaySettingsBulkCopyForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
EntityDisplaySettingsBulkCopyForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
EntityDisplaySettingsBulkCopyForm::getDisplayOptions protected function Get the form options for a display type.
EntityDisplaySettingsBulkCopyForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
EntityDisplaySettingsBulkCopyForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
EntityDisplaySettingsBulkCopyForm::__construct public function Creates a Clone instance.
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
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.