io-8.x-1.x-dev/modules/io_browser/src/Plugin/EntityBrowser/FieldWidgetDisplay/IoBrowserFieldWidgetDisplayBase.php

<?php

namespace Drupal\io_browser\Plugin\EntityBrowser\FieldWidgetDisplay;

use Drupal\Component\Render\FormattableMarkup;
use Drupal\Core\Entity\EntityInterface;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
use Drupal\blazy\Traits\PluginScopesTrait;
use Drupal\entity_browser\FieldWidgetDisplayBase;
use Drupal\io_browser\IoBrowserDefault;
use Drupal\io_browser\IoBrowserUtil;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Base class for IO Browser entity display and or entity selection.
 */
abstract class IoBrowserFieldWidgetDisplayBase extends FieldWidgetDisplayBase implements ContainerFactoryPluginInterface {

  use PluginScopesTrait;

  /**
   * The current delta.
   *
   * @var int
   * @todo remove once we figure out the deltas.
   */
  protected $delta = -1;

  /**
   * The io browser service.
   *
   * @var \Drupal\io_browser\IoBrowserInterface
   */
  protected $ioBrowser;

  /**
   * The blazy entity service.
   *
   * @var \Drupal\blazy\BlazyEntityInterface
   */
  protected $blazyEntity;

  /**
   * The blazy formatter service.
   *
   * @var \Drupal\blazy\BlazyFormatterInterface
   */
  protected $formatter;

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

  /**
   * Entity type to be displayed.
   *
   * @var string
   */
  protected $targetEntityType;

  /**
   * Bundle to be displayed.
   *
   * @var string
   */
  protected $bundle;

  /**
   * A list of field definitions eligible for configuration in this display.
   *
   * @var \Drupal\Core\Field\FieldDefinitionInterface[]
   */
  protected $fieldDefinitions;

  /**
   * {@inheritdoc}
   */
  public static function create(
    ContainerInterface $container,
    array $configuration,
    $plugin_id,
    $plugin_definition,
  ) {
    $instance = new static(
      $configuration,
      $plugin_id,
      $plugin_definition
    );
    return static::injectServices($instance, $container);
  }

  /**
   * Injects DI services.
   */
  protected static function injectServices(
    $instance,
    ContainerInterface $container,
  ) {
    $instance->ioBrowser = $container->get('io_browser');
    $instance->blazyEntity = $instance->blazyEntity ?? $instance->ioBrowser->blazyEntity();
    $instance->formatter = $instance->formatter ?? $instance->ioBrowser->formatter();
    $instance->entityFieldManager = $instance->entityFieldManager ?? $container->get('entity_field.manager');
    return $instance;
  }

  /**
   * {@inheritdoc}
   *
   * This form is only called for non-file/image widgets:  media, entities, etc.
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $is_widget = isset($form['#fields']);
    $element = [];

    // This form can be either on Entity browser display, or widget plugin.
    $element['ib_context'] = [
      '#type' => 'hidden',
      '#default_value' => $is_widget ? 'widget' : 'selection',
    ];

    // Do not use hook_field_widget_third_party_settings_form(), as this form is
    // also duplicated at "Manage form display" page.
    // Cases:
    // - Media any cardinality (1, > 1, -1). Unless using Media library widget.
    // - File cardinality -1. Not 1 nor > 1. The reason: EB has no plugin
    // selector except for -1 to load this form.
    if ($is_widget) {
      $definition = $this->getScopedFormElements($is_widget);
      $this->bundle = $definition['bundle'] = $form['#bundle'];
      $this->targetEntityType = $form['#entity_type'];

      $this->checkFieldDefinitions($definition, $form_state);
      $target_type = $definition['target_type'] ?? '';

      if ($target_type == 'file') {
        return $element;
      }

      // Build this plugin specific form.
      $this->ioBrowser->buildWigetSettingsForm($element, $definition);
    }
    else {
      // This is the selection previews normally tiny thumbnails or labels.
      $element['selection_position'] = [
        '#type'    => 'select',
        '#title'   => $this->t('Selection position'),
        '#options' => [
          'left'   => $this->t('Left'),
          'right'  => $this->t('Right'),
          'bottom' => $this->t('Bottom'),
        ],
        '#default_value' => $this->configuration['selection_position'] ?? 'bottom',
        '#description'   => $this->t('Left and Right positions are more suitable for large displays such as Modal. They are affected by the IO Browser: Tabs positioning. If Tabs is placed at Top or Bottom, Selection position can be placed on the Right or Left, otherwise resulting in too narrow form. Basically if Tabs Left, Selection should be Left. If Tabs Right, Selection should be Right. Adjust it accordingly.'),
      ];
    }

    return $element;
  }

  /**
   * Gets EB widget settings.
   */
  public function buildSettings($defaults = []) {
    $defaults = $defaults ?: IoBrowserDefault::widgetMediaSettings();
    $settings = array_merge($defaults, $this->configuration);

    $blazies = $this->formatter->verifySafely($settings);

    $switch = $settings['media_switch'] ?? NULL;
    $thumb = $settings['thumbnail_style'] ?? NULL;
    $settings['media_switch'] = $switch ?: 'media';
    $settings['thumbnail_style'] = $thumb ?: 'io_browser_thumbnail';

    // Enforces thumbnail without video iframes for tiny selection thumbnail.
    $selection = $settings['ib_context'] == 'selection';
    if ($selection) {
      $settings['ratio'] = '';
      $settings['media_switch'] = '';

      $blazies->set('lazy', [])
        ->set('ratio', '')
        ->set('switch', '')
        ->set('is.noiframe', TRUE)
        ->set('is.unlazy', TRUE);
    }

    // Only load the Blazy library if using SB browsers, but not SB widgets.
    // @todo remove $settings for blazies.
    $entity_type = $this->configuration['entity_type'] ?? '';
    $settings['entity_type'] = $entity_type;
    $settings['plugin_id_entity_display'] = $this->getPluginId();

    $blazies->set('is.detached', !empty($settings['style']))
      ->set('entity.type', $entity_type);

    return array_merge(IoBrowserDefault::entitySettings(), $settings);
  }

  /**
   * Returns a message if access to view the entity is denied.
   *
   * @todo use $this->formatter->denied($entity) post blazy:2.17.
   */
  protected function denied(EntityInterface $entity): array {
    if (!$entity->access('view')) {
      $parameters = [
        '@label' => $entity->getEntityType()->getSingularLabel(),
        '@id' => $entity->id(),
        '@langcode' => $entity->language()->getId(),
        '@title' => $entity->label(),
      ];
      $restricted_access_label = $entity->access('view label')
       ? new FormattableMarkup('@label @id (@title)', $parameters)
       : new FormattableMarkup('@label @id', $parameters);
      return ['#markup' => $restricted_access_label];
    }
    return [];
  }

  /**
   * Gets the field definition of a field.
   */
  protected function getFieldDefinition($field_name) {
    $definitions = $this->getFieldDefinitions();
    return $definitions[$field_name] ?? [];
  }

  /**
   * Gets the definitions of the fields that are candidate for display.
   */
  protected function getFieldDefinitions() {
    if (!isset($this->fieldDefinitions)) {
      $this->fieldDefinitions = $this->entityFieldManager->getFieldDefinitions($this->targetEntityType, $this->bundle);
    }
    return $this->fieldDefinitions;
  }

  /**
   * Defines the scope for the form elements.
   */
  public function getScopedFormElements($is_widget = FALSE) {
    return [
      'settings' => $this->configuration,
      'target_type' => $this->configuration['entity_type'] ?? '',
    ]
    + $this->buildSettings()
    + IoBrowserUtil::scopedFormElements();
  }

  /**
   * {@inheritdoc}
   */
  public function calculateDependencies() {
    $dependencies = parent::calculateDependencies();
    foreach (['image_style', 'thumbnail_style'] as $style) {
      $existing_style = $this->configuration[$style] ?? NULL;
      if ($existing_style
        && $image_style = $this->formatter->load($existing_style, 'image_style')) {
        $dependencies[$image_style->getConfigDependencyKey()][] = $image_style->getConfigDependencyName();
      }
    }
    return $dependencies;
  }

  /**
   * Checks for the current definitions with various AJAX contents.
   */
  private function checkFieldDefinitions(array &$definition, FormStateInterface $form_state) {
    $field_name = NULL;
    $plugin_id = $this->getPluginId();

    // Unrealiable when changing from File without AJAX to Media.
    $definition['plugin_id_entity_display'] = $plugin_id;

    // We want a consistent field_name regardless the current AJAX states.
    $triggers = $form_state->getTriggeringElement();
    if (isset($triggers['#field_name'])) {
      $field_name = $triggers['#field_name'];
    }
    elseif (isset($triggers['#parents'])
      && mb_substr($triggers['#parents'][1], 0, 6) === 'field_') {
      $field_name = $triggers['#parents'][1];
    }

    // We must travel around just to get cardinality here. This is needed so
    // to serve the correct Display style: Grid/Column/Native, or Single.
    if ($field_name) {
      // This one is changing when EB starts picking up plugin selectors.
      if ($values = $form_state->getValues()) {
        if ($data = $values['fields'][$field_name] ?? []) {
          // entity_browser_entity_reference, entity_browser_file:
          // AJAX, media entity, when clicking radios:
          $ajaxed = $data['settings_edit_form']['settings']['entity_browser'] ?? NULL;
          // Non AJAX:
          $definition['plugin_id_widget'] = $ajaxed ?? $data['type'] ?? '';
        }
      }

      $definition['field_name'] = $field_name;
      $definition['field_definition'] = $this->getFieldDefinition($field_name);
    }
  }

}