View source
<?php
namespace Drupal\imagefield_slideshow\Plugin\Field\FieldFormatter;
use Drupal\Core\Field\FieldDefinitionInterface;
use Drupal\Core\Field\FieldItemListInterface;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Link;
use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
use Drupal\Core\Session\AccountInterface;
use Drupal\Core\Url;
use Drupal\image\Entity\ImageStyle;
use Drupal\Core\Entity\EntityTypeManagerInterface;
use Drupal\image\Plugin\Field\FieldFormatter\ImageFormatterBase;
use Symfony\Component\DependencyInjection\ContainerInterface;
class ImagefieldSlideshowFieldFormatter extends ImageFormatterBase implements ContainerFactoryPluginInterface {
protected $currentUser;
protected $entityTypeManager;
protected $imageStyleStorage;
public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, $label, $view_mode, array $third_party_settings, AccountInterface $current_user, EntityTypeManagerInterface $entity_type_manager) {
parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings);
$this->currentUser = $current_user;
$this->entityTypeManager = $entity_type_manager;
$this->imageStyleStorage = $this->entityTypeManager
->getStorage('image_style');
}
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_type.manager'));
}
public static function defaultSettings() {
return [
'imagefield_slideshow_style' => 'large',
'imagefield_slideshow_style_effects' => 'fade',
'imagefield_slideshow_style_pause' => 'false',
'imagefield_slideshow_prev_next' => 'true',
'imagefield_slideshow_transition_speed' => 100,
'imagefield_slideshow_timeout' => 100,
'imagefield_slideshow_pager' => TRUE,
] + parent::defaultSettings();
}
public function settingsForm(array $form, FormStateInterface $form_state) {
$image_styles = image_style_options(FALSE);
$description_link = Link::fromTextAndUrl($this
->t("Configure Image Styles"), Url::fromRoute('entity.image_style.collection'));
$element['imagefield_slideshow_style'] = [
'#title' => t("Image style"),
'#type' => 'select',
'#default_value' => $this
->getSetting('imagefield_slideshow_style'),
'#empty_option' => t("None (original image)"),
'#options' => $image_styles,
'#description' => $description_link
->toRenderable() + [
'#access' => $this->currentUser
->hasPermission('administer image styles'),
],
];
$effects = [
'none' => 'none',
'fade' => 'fade',
'fadeout' => 'fadeout',
'scrollHorz' => 'scrollHorz',
'flipHorz' => 'flipHorz',
'flipVert' => 'flipVert',
'shuffle' => 'shuffle',
];
$element['imagefield_slideshow_style_effects'] = [
'#type' => 'select',
'#title' => t("Effect"),
'#options' => $effects,
'#default_value' => $this
->getSetting('imagefield_slideshow_style_effects'),
'#description' => t("The transition effect that will be used to change between images. Not all options below may be relevant depending on the effect. <a href='http://jquery.malsup.com/cycle/browser.html' target='_black'>Follow this link to see examples of each effect.</a>"),
];
$image_pause = [
'true' => "Yes",
'false' => "No",
];
$element['imagefield_slideshow_style_pause'] = [
'#title' => t("Image pause"),
'#type' => 'select',
'#default_value' => $this
->getSetting('imagefield_slideshow_style_pause'),
'#options' => $image_pause,
'#description' => t("Should image be paused on hover."),
];
$element['imagefield_slideshow_prev_next'] = [
'#title' => $this
->t("Enable Prev & Next button"),
'#type' => 'checkbox',
'#default_value' => $this
->getSetting('imagefield_slideshow_prev_next'),
'#description' => $this
->t('This will show the Prev and Next button for slideshow.'),
];
$range0 = array_combine(range(100, 1000, 100), range(100, 1000, 100));
$range1 = array_combine(range(2000, 10000, 1000), range(2000, 10000, 1000));
$transition_speed = array_replace($range0, $range1);
$element['imagefield_slideshow_transition_speed'] = [
'#type' => 'select',
'#title' => t("Transition Speed"),
'#options' => $transition_speed,
'#default_value' => $this
->getSetting('imagefield_slideshow_transition_speed'),
'#description' => t("The transition speed between images."),
];
$range3 = array_combine(range(0, 1000, 100), range(0, 1000, 100));
$timeout = array_replace($range3, $range1);
$element['imagefield_slideshow_timeout'] = [
'#type' => 'select',
'#title' => t("Timeout"),
'#options' => $timeout,
'#default_value' => $this
->getSetting('imagefield_slideshow_timeout'),
'#description' => t("The timeout for slides."),
];
$element['imagefield_slideshow_pager'] = [
'#title' => $this
->t("Enable Pager ?"),
'#type' => 'checkbox',
'#default_value' => $this
->getSetting('imagefield_slideshow_pager'),
'#description' => $this
->t('This will show the Pager on slideshow.'),
];
return $element;
}
public function settingsSummary() {
$summary = [];
$image_styles = image_style_options(FALSE);
unset($image_styles['']);
$image_style_setting = $this
->getSetting('imagefield_slideshow_style');
if (isset($image_styles[$image_style_setting])) {
$summary[] = t("Image style: @style", [
'@style' => $image_styles[$image_style_setting],
]);
}
else {
$summary[] = $this
->t("Original image");
}
$image_style_effect = $this
->getSetting('imagefield_slideshow_style_effects');
if (isset($image_style_effect)) {
$summary[] .= $this
->t("Effect: @image_style_effect", [
"@image_style_effect" => $image_style_effect,
]);
}
$image_style_pause = $this
->getSetting('imagefield_slideshow_style_pause');
if (!empty($image_style_pause)) {
$summary[] .= $this
->t("Pause: @image_style_pause", [
"@image_style_pause" => $image_style_pause,
]);
}
$image_prev_next = $this
->getSetting('imagefield_slideshow_prev_next');
if ($image_prev_next) {
$summary[] .= $this
->t("Prev & Next: @image_prev_next", [
"@image_prev_next" => $image_prev_next,
]);
}
$image_transition_speed = $this
->getSetting('imagefield_slideshow_transition_speed');
if ($image_transition_speed) {
$summary[] .= $this
->t("Transition Speed: @image_transition_speed fx", [
"@image_transition_speed" => $image_transition_speed,
]);
}
$image_slideshow_timeout = $this
->getSetting('imagefield_slideshow_timeout');
if ($image_slideshow_timeout) {
$summary[] .= $this
->t("Timeout: @image_slideshow_timeout", [
"@image_slideshow_timeout" => $image_slideshow_timeout,
]);
}
$image_pager = $this
->getSetting('imagefield_slideshow_pager');
if ($image_pager) {
$summary[] .= $this
->t("Pager: @image_pager", [
"@image_pager" => $image_pager,
]);
}
return $summary;
}
public function viewElements(FieldItemListInterface $items, $langcode) {
$elements = [];
$file = $items
->getEntity()
->toArray();
$images = $this
->getEntitiesToView($items, $langcode);
if (empty($images)) {
return $elements;
}
$image_style_setting = $this
->getSetting('imagefield_slideshow_style');
$image_style = NULL;
if (!empty($image_style_setting)) {
$image_style = \Drupal::entityTypeManager()
->getStorage('image_style')
->load($image_style_setting);
}
$image_uri_values = [];
foreach ($images as $image) {
$image_uri = $image
->getFileUri();
if ($image_style) {
$image_uri = ImageStyle::load($image_style
->getName())
->buildUrl($image_uri);
}
else {
$image_uri = $image
->createFileUrl(FALSE);
}
$fid = $image
->toArray()['fid'][0]['value'];
$image_uri_values[$fid] = [
'uri' => $image_uri,
];
}
foreach ([
'title',
'alt',
] as $element_name) {
$field_name = $this->fieldDefinition
->getName();
if (array_key_exists($field_name, $file)) {
foreach ($file[$field_name] as $key => $value) {
$image_uri_values[$value['target_id']]['alt'] = $value['alt'];
$image_uri_values[$value['target_id']]['title'] = $value['title'];
}
}
}
$prev_next = $this
->getSetting('imagefield_slideshow_prev_next');
if (count($image_uri_values) <= 1) {
$prev_next = FALSE;
}
$elements[] = [
'#theme' => 'imagefield_slideshow',
'#url' => $image_uri_values,
'#prev_next' => $prev_next,
'#effect' => $this
->getSetting('imagefield_slideshow_style_effects'),
'#pause' => $this
->getSetting('imagefield_slideshow_style_pause'),
'#speed' => $this
->getSetting('imagefield_slideshow_transition_speed'),
'#timeout' => $this
->getSetting('imagefield_slideshow_timeout'),
'#pager' => $this
->getSetting('imagefield_slideshow_pager'),
];
$elements['#attached']['library'][] = 'imagefield_slideshow/imagefield_slideshow';
$elements['#cache']['max-age'] = 0;
return $elements;
}
}