View source
<?php
namespace Drupal\fotorama_gallery\Plugin\Field\FieldFormatter;
use Drupal\Core\Config\ConfigFactory;
use Drupal\Core\Config\ConfigFactoryInterface;
use Drupal\Core\Field\FieldDefinitionInterface;
use Drupal\Core\Field\FieldItemListInterface;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Session\AccountInterface;
use Drupal\image\Plugin\Field\FieldFormatter\ImageFormatter;
use Drupal\Core\Link;
use Drupal\Core\Url;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Drupal\Core\Entity\EntityStorageInterface;
class FotoramaGalleryFormatter extends ImageFormatter {
protected $configFactory;
public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, $label, $view_mode, array $third_party_settings, AccountInterface $current_user, EntityStorageInterface $image_style_storage, ConfigFactoryInterface $config_factory) {
parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings, $current_user, $image_style_storage);
$this->configFactory = $config_factory;
}
public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
return new static($plugin_id, $plugin_definition, $configuration['field_definition'], $configuration['settings'], $configuration['label'], $configuration['view_mode'], $configuration['third_party_settings'], $container
->get('current_user'), $container
->get('entity.manager')
->getStorage('image_style'), $container
->get('config.factory'));
}
public static function defaultSettings() {
$default_settings = [];
$selects_fields = \Drupal::config('fotorama_gallery.settings')
->get('SelectFields');
$check_box_fields = \Drupal::config('fotorama_gallery.settings')
->get('CheckBoxFields');
$dimensions_fields = \Drupal::config('fotorama_gallery.settings')
->get('NumberFields');
$all_fields = $selects_fields + $check_box_fields + $dimensions_fields;
foreach ($all_fields as $field) {
$default_settings[$field['group']][$field['key']] = $field['defaultvalue'];
if ($field['group'] == 'dimensions') {
$default_settings['dimensions']['percent_' . $field['key']] = FALSE;
}
}
$default_settings['dimensions']['ratio'] = '';
return $default_settings + parent::defaultSettings();
}
public function settingsForm(array $form, FormStateInterface $form_state) {
$element = parent::settingsForm($form, $form_state);
unset($element['image_link']);
$url_options = [
'attributes' => [
'target' => '_blank',
],
];
$element['dimensions'] = [
'#type' => 'details',
'#title' => $this
->t('Dimensions'),
'#description' => Link::fromTextAndUrl($this
->t('Documentation: Dimensions'), Url::fromUri('http://fotorama.io/customize/dimensions/', $url_options)),
];
$element['others'] = [
'#type' => 'details',
'#title' => $this
->t('Others'),
];
$element['autoplay'] = [
'#type' => 'details',
'#title' => $this
->t('Autoplay'),
];
$element['navigation'] = [
'#type' => 'details',
'#title' => $this
->t('Navigation'),
];
$element['transition'] = [
'#type' => 'details',
'#title' => $this
->t('Transition'),
];
$element['dimensions']['ratio'] = [
'#type' => 'textfield',
'#open' => 1,
'#title' => $this
->t('Ratio'),
'#size' => 10,
'#default_value' => $this
->getSetting('dimensions')['ratio'],
];
$this
->settingsFormSelectsFields($element, $url_options);
$this
->settingsFormCheckBoxFields($element, $url_options);
$this
->settingsFormNumberFields($element);
return $element;
}
public function settingsSummary() {
$summary[] = "Fotorama Gallery Settings";
$summary += parent::settingsSummary();
$value = $this
->getSetting('dimensions')['ratio'];
if (!empty($value)) {
$summary[] = $this
->t('data-ratio: @value', [
'@value' => $value,
]);
}
$this
->settingsSummarySelectsFields($summary);
$this
->settingsSummaryNumberFields($summary);
$this
->settingsSummaryCheckBoxFields($summary);
return $summary;
}
public function viewElements(FieldItemListInterface $items, $langcode) {
$elements = parent::viewElements($items, $langcode);
$elements['#theme'] = 'fotorama_gallery_field';
$elements['attributes'] = $this
->viewElementsSelectsFields() + $this
->viewElementsNumberFields() + $this
->viewElementsCheckBoxFields();
if (!empty($this
->getSetting('dimensions')['ratio'])) {
$elements['attributes']['data-ratio'] = $this
->getSetting('dimensions')['ratio'];
}
return $elements;
}
private function settingsFormSelectsFields(array &$element, array $url_options) {
$selects_fields = $this->configFactory
->get('fotorama_gallery.settings')
->get('SelectFields');
foreach ($selects_fields as $field) {
$element[$field['group']][$field['key']] = [
'#type' => 'select',
'#title' => $field['data'],
'#options' => $field['options'],
'#default_value' => $this
->getSetting($field['group'])[$field['key']],
'#description' => Link::fromTextAndUrl($this
->t('Documentation: @field', [
'@field' => $field['data'],
]), Url::fromUri($field['documentation'], $url_options)),
];
}
}
private function settingsFormCheckBoxFields(array &$element, array $url_options) {
$check_box_fields = $this->configFactory
->get('fotorama_gallery.settings')
->get('CheckBoxFields');
foreach ($check_box_fields as $field) {
$element[$field['group']][$field['key']] = [
'#type' => 'checkbox',
'#title' => $field['data'],
'#default_value' => $this
->getSetting($field['group'])[$field['key']],
'#description' => Link::fromTextAndUrl($this
->t('Documentation: @field', [
'@field' => $field['data'],
]), Url::fromUri($field['documentation'], $url_options)),
];
}
}
private function settingsFormNumberFields(array &$element) {
$dimensions_fields = $this->configFactory
->get('fotorama_gallery.settings')
->get('NumberFields');
foreach ($dimensions_fields as $field) {
$element['dimensions'][$field['key']] = $this
->fieldDimensionsNumberBuilder($field['data'], $field['key']);
$element['dimensions'][$field['percent']] = $this
->fieldDimensionsCheckBoxBuilder($field['percent']);
}
}
private function settingsSummarySelectsFields(array &$summary) {
$selects_fields = $this->configFactory
->get('fotorama_gallery.settings')
->get('SelectFields');
foreach ($selects_fields as $field) {
$value = $this
->getSetting($field['group'])[$field['key']];
if ($value != $field['defaultvalue']) {
$summary[] = $this
->t('@label: @value', [
'@label' => $field['data'],
'@value' => $field['options'][$value],
]);
}
}
}
private function settingsSummaryNumberFields(array &$summary) {
$dimensions_fields = $this->configFactory
->get('fotorama_gallery.settings')
->get('NumberFields');
foreach ($dimensions_fields as $field) {
$value = $this
->getSetting('dimensions')[$field['key']];
$value_formatted = $this
->getNumberFieldsValuePercent($field['key'], $field['percent']);
if (!empty($value)) {
$summary[] = $this
->t('@label: @value', [
'@label' => $field['data'],
'@value' => $value_formatted,
]);
}
}
}
private function settingsSummaryCheckBoxFields(array &$summary) {
$check_box_fields = $this->configFactory
->get('fotorama_gallery.settings')
->get('CheckBoxFields');
foreach ($check_box_fields as $field) {
$value = $this
->getSetting($field['group'])[$field['key']];
if ($value != $field['defaultvalue']) {
$value = $value ? 'true' : 'false';
$summary[] = $this
->t('@label: @value', [
'@label' => $field['data'],
'@value' => $value,
]);
}
}
}
private function viewElementsSelectsFields() {
$selects_fields = $this->configFactory
->get('fotorama_gallery.settings')
->get('SelectFields');
$attributes = [];
foreach ($selects_fields as $field) {
$value = $this
->getSetting($field['group'])[$field['key']];
if (array_search($field['options'][$value], $field['options']) != $field['defaultvalue']) {
$attributes[$field['data']] = $field['options'][$value];
}
}
return $attributes;
}
private function viewElementsCheckBoxFields() {
$check_box_fields = $this->configFactory
->get('fotorama_gallery.settings')
->get('CheckBoxFields');
$attributes = [];
foreach ($check_box_fields as $field) {
$value = $this
->getSetting($field['group'])[$field['key']];
$value_formatted = $value ? 'true' : 'false';
$value_boolean = $value ? 1 : 0;
if ($field['defaultvalue'] != $value_boolean) {
$attributes[$field['data']] = $value_formatted;
}
}
return $attributes;
}
private function viewElementsNumberFields() {
$dimensions_fields = $this->configFactory
->get('fotorama_gallery.settings')
->get('NumberFields');
$attributes = [];
foreach ($dimensions_fields as $field) {
$value = $this
->getSetting('dimensions')[$field['key']];
$value_formatted = $this
->getNumberFieldsValuePercent($field['key'], $field['percent']);
if ($value) {
$attributes[$field['data']] = $value_formatted;
}
}
return $attributes;
}
private function fieldDimensionsNumberBuilder($label, $field_key) {
return [
'#title' => $label,
'#type' => 'number',
'#size' => 4,
'#default_value' => $this
->getSetting('dimensions')[$field_key],
];
}
private function fieldDimensionsCheckBoxBuilder($field_key) {
return [
'#type' => 'checkbox',
'#title' => $this
->t('Check if the value is a percentage'),
'#default_value' => $this
->getSetting('dimensions')[$field_key],
];
}
private function getNumberFieldsValuePercent($field_key, $field_percent) {
$value = $this
->getSetting('dimensions')[$field_key];
if (array_key_exists($field_percent, $this
->getSetting('dimensions')) && $this
->getSetting('dimensions')[$field_percent]) {
return $value . '%';
}
else {
return $value;
}
}
}