View source
<?php
namespace Drupal\bynder\Plugin\Field\FieldFormatter;
use Drupal\bynder\Plugin\media\Source\Bynder;
use Drupal\Core\Access\AccessResult;
use Drupal\Core\Field\FieldItemListInterface;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Link;
use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
use GuzzleHttp\Exception\ConnectException;
use Symfony\Component\DependencyInjection\ContainerInterface;
class BynderFormatter extends BynderFormatterBase implements ContainerFactoryPluginInterface {
protected $entityRepository;
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;
}
public static function defaultSettings() {
return [
'thumbnail' => 'webimage',
'alt_field' => '',
'title_field' => '',
'dat_query' => '',
'responsive_sizes' => '',
'dat_query_responsive' => '',
] + parent::defaultSettings();
}
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;
}
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;
}
public function viewElements(FieldItemListInterface $items, $langcode) {
$settings = $this
->getSettings();
$element = [];
$is_entityreference = $this->fieldDefinition
->getType() == 'entity_reference';
foreach ($items as $delta => $item) {
if ($media_entity = $is_entityreference ? $item->entity : $items
->getEntity()) {
$media_entity = $this->entityRepository
->getTranslationFromContext($media_entity, $langcode);
$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',
],
],
];
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',
'#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;
}
}
