You are here

Home » API reference » Bynder 4.0.x » BynderFormatter.php

class BynderFormatter in Bynder 4.0.x

Same name and namespace in other branches
  1. 8.3 src/Plugin/Field/FieldFormatter/BynderFormatter.php \Drupal\bynder\Plugin\Field\FieldFormatter\BynderFormatter
  2. 8 src/Plugin/Field/FieldFormatter/BynderFormatter.php \Drupal\bynder\Plugin\Field\FieldFormatter\BynderFormatter
  3. 8.2 src/Plugin/Field/FieldFormatter/BynderFormatter.php \Drupal\bynder\Plugin\Field\FieldFormatter\BynderFormatter

Plugin implementation of the 'Bynder' formatter.

Plugin annotation


@FieldFormatter(
  id = "bynder",
  label = @Translation("Bynder (Image)"),
  field_types = {"string", "string_long", "entity_reference"}
)

Hierarchy

Expanded class hierarchy of BynderFormatter

File

src/Plugin/Field/FieldFormatter/BynderFormatter.php, line 23

Namespace

Drupal\bynder\Plugin\Field\FieldFormatter
View source 
class BynderFormatter extends BynderFormatterBase implements ContainerFactoryPluginInterface {

  /**
   * The entity repository service.
   *
   * @var \Drupal\Core\Entity\EntityRepositoryInterface;
   */
  protected $entityRepository;

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    $instance = parent::create($container, $configuration, $plugin_id, $plugin_definition);
    $instance->entityRepository = $container
      ->get('entity.repository');
    return $instance;
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'thumbnail' => 'webimage',
      'alt_field' => '',
      'title_field' => '',
      'dat_query' => '',
      'responsive_sizes' => '',
      'dat_query_responsive' => '',
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $elements = parent::settingsForm($form, $form_state);
    try {
      $derivatives = array_merge([
        'mini',
        'webimage',
        'thul',
      ], array_map(function ($item) {
        return $item['prefix'];
      }, $this->bynder
        ->getDerivatives()));
    } catch (ConnectException $e) {
      $derivatives = [];
    }
    $elements['thumbnail'] = [
      '#type' => 'select',
      '#options' => array_combine($derivatives, $derivatives),
      '#title' => $this
        ->t('Derivative'),
      '#description' => $this
        ->t('Select the name of the derivative to be used to display the image. Besides custom derivatives that you created in Bynder there are also default thumbnail sizes available that can be used. Go to @form and reload derivatives.', [
        '@form' => Link::createFromRoute($this
          ->t('Bynder configuration form'), 'bynder.configuration_form')
          ->toString(),
      ]),
      '#default_value' => $this
        ->getSetting('thumbnail'),
      '#attributes' => [
        'class' => [
          'bynder-derivative',
        ],
      ],
    ];
    $field_candidates = $this
      ->getAttributesFieldsCandidates();
    $elements['alt_field'] = [
      '#type' => 'select',
      '#options' => $field_candidates,
      '#title' => $this
        ->t('Alt attribute field'),
      '#description' => $this
        ->t('Select the name of the field that should be used for the "alt" attribute of the image.'),
      '#default_value' => $this
        ->getSetting('alt_field'),
      '#empty_value' => '',
    ];
    $elements['title_field'] = [
      '#type' => 'select',
      '#options' => $field_candidates,
      '#title' => $this
        ->t('Title attribute field'),
      '#description' => $this
        ->t('Select the name of the field that should be used for the "title" attribute of the image.'),
      '#default_value' => $this
        ->getSetting('title_field'),
      '#empty_value' => '',
    ];
    $dat_documentation = 'https://support.bynder.com/hc/en-us/articles/360018559260-Dynamic-Asset-Transformations-DAT-';
    $elements['dat_query'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('DAT query field'),
      '#description' => $this
        ->t('Attributes that should be applied to the images. See  <a href=":dat_help">here</a> for explanation on possible values. Should start right after the "?", e.g. "io=transform:fill,width:100,height:200" If the following Responsive image fields are filled, this field defines the fallback image if the responsive settings are broken.', array(
        ':dat_help' => $dat_documentation,
      )),
      '#default_value' => $this
        ->getSetting('dat_query'),
      '#states' => [
        'visible' => [
          ':input.bynder-derivative' => [
            'value' => 'DAT',
          ],
        ],
        'required' => [
          ':input.bynder-derivative' => [
            'value' => 'DAT',
          ],
        ],
      ],
    ];
    $elements['responsive_sizes'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('Sizes for responsive images'),
      '#description' => $this
        ->t('With this and the next field filled, a set of responsive images is generated. String that will be fed in the "sizes" attribute of the img object.'),
      '#default_value' => $this
        ->getSetting('responsive_sizes'),
      '#states' => [
        'visible' => [
          ':input.bynder-derivative' => [
            'value' => 'DAT',
          ],
        ],
      ],
    ];
    $elements['dat_query_responsive'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('The set of responsive images (srcset)'),
      '#description' => $this
        ->t('The different images to be used in a responsive setting. It should have the form: "io=transform:fill,width:100,height:200 100w, io=transform:fill,width:200,height:400 200w, ...", with the "io=..." following <a href=":dat_help">these</a> guidelines, and the second argument being the width of the image. Make sure to separate each setting with ", ".', array(
        ':dat_help' => $dat_documentation,
      )),
      '#default_value' => $this
        ->getSetting('dat_query_responsive'),
      '#states' => [
        'visible' => [
          ':input.bynder-derivative' => [
            'value' => 'DAT',
          ],
        ],
      ],
    ];
    return $elements;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = parent::settingsSummary();
    $settings = $this
      ->getSettings();
    if ($settings['thumbnail'] == 'DAT') {
      if (!empty($settings['dat_query_responsive']) && !empty($settings['responsive_sizes'])) {
        $summary[] = $this
          ->t('DAT configuration: Responsive, fallback: @dat', [
          '@dat' => $settings['dat_query'],
        ]);
      }
      else {
        $summary[] = $this
          ->t('DAT configuration: @dat', [
          '@dat' => $settings['dat_query'],
        ]);
      }
    }
    else {
      $summary[] = $this
        ->t('Derivative: @style', [
        '@style' => $settings['thumbnail'],
      ]);
    }
    $field_candidates = $this
      ->getAttributesFieldsCandidates();
    if (empty($settings['title_field'])) {
      $summary[] = $this
        ->t('Title attribute not displayed (not recommended).');
    }
    else {
      $summary[] = $this
        ->t('Title attribute field: @field', [
        '@field' => $field_candidates[$settings['title_field']],
      ]);
    }
    if (empty($settings['alt_field'])) {
      $summary[] = $this
        ->t('Alt attribute not displayed (not recommended).');
    }
    else {
      $summary[] = $this
        ->t('Alt attribute field: @field', [
        '@field' => $field_candidates[$settings['alt_field']],
      ]);
    }
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $settings = $this
      ->getSettings();
    $element = [];
    $is_entityreference = $this->fieldDefinition
      ->getType() == 'entity_reference';
    foreach ($items as $delta => $item) {

      /** @var \Drupal\media\MediaInterface $media_entity */
      if ($media_entity = $is_entityreference ? $item->entity : $items
        ->getEntity()) {

        /** @var \Drupal\media\MediaInterface $media_entity */
        $media_entity = $this->entityRepository
          ->getTranslationFromContext($media_entity, $langcode);

        /** @var \Drupal\media\MediaSourceInterface $source_plugin */
        $source_plugin = $media_entity
          ->getSource();
        if ($source_plugin instanceof Bynder && ($thumbnails = $source_plugin
          ->getMetadata($media_entity, 'thumbnail_urls'))) {
          $element['#attached']['library'][] = 'bynder/formatter';
          $element[$delta]['bynder_wrapper'] = [
            '#type' => 'container',
            '#attributes' => [
              'class' => [
                'bynder-wrapper',
              ],
            ],
          ];
          if ($settings['thumbnail'] == 'DAT' && isset($thumbnails['transformBaseUrl']) && !empty($settings['dat_query'])) {
            $thumbnail_uri = $thumbnails['transformBaseUrl'] . '?' . $this
              ->getSetting('dat_query');
          }
          else {
            $thumbnail_uri = $thumbnails[$settings['thumbnail']] ?? $thumbnails['webimage'];
          }
          $element[$delta]['bynder_wrapper']['image'] = [
            '#theme' => 'image',
            '#uri' => $thumbnail_uri,
            '#attributes' => [
              'class' => [
                'bynder-image',
              ],
            ],
          ];

          // Set responsive specific attributes.
          if ($this
            ->getSetting('thumbnail') == 'DAT' && isset($thumbnails['transformBaseUrl']) && isset($settings['dat_query_responsive']) && isset($settings['responsive_sizes'])) {
            $element[$delta]['bynder_wrapper']['image']['#attributes']['srcset'] = str_replace('io=', $thumbnails['transformBaseUrl'] . '?io=', $settings['dat_query_responsive']);
            $element[$delta]['bynder_wrapper']['image']['#attributes']['sizes'] = $settings['responsive_sizes'];
          }
          if ($settings['title_field'] && $media_entity
            ->hasField($settings['title_field']) && !$media_entity
            ->get($settings['title_field'])
            ->isEmpty()) {
            $element[$delta]['bynder_wrapper']['image']['#title'] = $media_entity
              ->get($settings['title_field'])->value;
          }
          if ($settings['alt_field'] && $media_entity
            ->hasField($settings['alt_field']) && !$media_entity
            ->get($settings['alt_field'])
            ->isEmpty()) {
            $element[$delta]['bynder_wrapper']['image']['#alt'] = $media_entity
              ->get($settings['alt_field'])->value;
          }
          $this->renderer
            ->addCacheableDependency($element[$delta]['bynder_wrapper']['image'], $item);
          $element[$delta]['bynder_wrapper']['usage_image'] = [
            '#theme' => 'image',
            '#uri' => \Drupal::moduleHandler()
              ->getModule('bynder')
              ->getPath() . '/images/icons/bynder-logo.png',
            '#alt' => 'usage-image',
            // @todo Information is not available yet. Fix when API supports it.
            '#title' => $this
              ->t('Usage info is not available yet. Usage restriction level: @restriction', [
              '@restriction' => get_media_restriction($source_plugin
                ->getMetadata($media_entity, 'propertyOptions')),
            ]),
            '#attributes' => [
              'class' => [
                'usage-image',
              ],
            ],
            '#access' => AccessResult::allowedIfHasPermission($this->currentUser, 'view bynder media usage'),
          ];
          $this->renderer
            ->addCacheableDependency($element[$delta]['bynder_wrapper']['usage_image'], $this->configFactory
            ->get('bynder.settings'));
        }
      }
    }
    return $element;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
BynderFormatter::$entityRepository protected property The entity repository service.
BynderFormatter::create public static function Creates an instance of the plugin. Overrides BynderFormatterBase::create
BynderFormatter::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
BynderFormatter::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
BynderFormatter::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
BynderFormatter::viewElements public function Builds a renderable array for a field value. Overrides FormatterInterface::viewElements
BynderFormatterBase::$bynder protected property The Bynder API service.
BynderFormatterBase::$configFactory protected property The config factory.
BynderFormatterBase::$currentUser protected property The current user.
BynderFormatterBase::$entityFieldManager protected property The entity field manager service.
BynderFormatterBase::$entityTypeManager protected property The entity type manager service.
BynderFormatterBase::$renderer protected property Renderer object.
BynderFormatterBase::getAttributesFieldsCandidates protected function Gets list of fields that are candidates for IMG attributes.
BynderFormatterBase::isApplicable public static function Returns if the formatter can be used for the provided field. Overrides FormatterBase::isApplicable
BynderFormatterBase::__construct public function Constructs a BynderFormatter object. Overrides FormatterBase::__construct
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
FormatterBase::$fieldDefinition protected property The field definition.
FormatterBase::$label protected property The label display setting.
FormatterBase::$settings protected property The formatter settings. Overrides PluginSettingsBase::$settings
FormatterBase::$viewMode protected property The view mode.
FormatterBase::getFieldSetting protected function Returns the value of a field setting.
FormatterBase::getFieldSettings protected function Returns the array of field settings.
FormatterBase::prepareView public function Allows formatters to load information for field values being displayed. Overrides FormatterInterface::prepareView 2
FormatterBase::view public function Builds a renderable array for a fully themed field. Overrides FormatterInterface::view 1
MessengerTrait::$messenger protected property The messenger. 27
MessengerTrait::messenger public function Gets the messenger. 27
MessengerTrait::setMessenger public function Sets the messenger.
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 2
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.
PluginSettingsBase::$defaultSettingsMerged protected property Whether default settings have been merged into the current $settings.
PluginSettingsBase::$thirdPartySettings protected property The plugin settings injected by third party modules.
PluginSettingsBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies 6
PluginSettingsBase::getSetting public function Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface::getSetting
PluginSettingsBase::getSettings public function Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface::getSettings
PluginSettingsBase::getThirdPartyProviders public function Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
PluginSettingsBase::getThirdPartySetting public function Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
PluginSettingsBase::getThirdPartySettings public function Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
PluginSettingsBase::mergeDefaults protected function Merges default settings values into $settings.
PluginSettingsBase::onDependencyRemoval public function Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface::onDependencyRemoval 3
PluginSettingsBase::setSetting public function Sets the value of a setting for the plugin. Overrides PluginSettingsInterface::setSetting
PluginSettingsBase::setSettings public function Sets the settings for the plugin. Overrides PluginSettingsInterface::setSettings
PluginSettingsBase::setThirdPartySetting public function Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
PluginSettingsBase::unsetThirdPartySetting public function Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
StringTranslationTrait::$stringTranslation protected property The string translation service. 4
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.