You are here

Home » API reference » Jssor Slider 8 » JssorFieldFormatter.php

class JssorFieldFormatter in Jssor Slider 8

Plugin for responsive image formatter.

Plugin annotation


@FieldFormatter(
  id = "jssor_formatter",
  label = @Translation("Jssor Gallery"),
  field_types = {
    "image",
  }
)

Hierarchy

Expanded class hierarchy of JssorFieldFormatter

File

src/Plugin/Field/FieldFormatter/JssorFieldFormatter.php, line 34
Contains \Drupal\jssor\Plugin\Field\FieldFormatter\JssorFieldFormatter.

Namespace

Drupal\jssor\Plugin\Field\FieldFormatter
View source 
class JssorFieldFormatter extends ImageFormatterBase implements ContainerFactoryPluginInterface {

  /*
   * The image style entity storage.
   *
   * @var \Drupal\Core\Entity\EntityStorageInterface
   */
  protected $imageStyleStorage;

  /**
   * The current user.
   *
   * @var \Drupal\Core\Session\AccountInterface
   */
  protected $currentUser;

  /**
   * The link generator.
   *
   * @var \Drupal\Core\Utility\LinkGeneratorInterface
   */
  protected $linkGenerator;

  /**
   * The UUID service.
   *
   * @var \Drupal\Component\Uuid\UuidInterface
   */
  protected $uuidService;

  /**
   * Constructs a ResponsiveImageFormatter object.
   *
   * @param string $plugin_id
   *   The plugin_id for the formatter.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
   *   The definition of the field to which the formatter is associated.
   * @param array $settings
   *   The formatter settings.
   * @param string $label
   *   The formatter label display setting.
   * @param string $view_mode
   *   The view mode.
   * @param array $third_party_settings
   *   Any third party settings.
   * @param \Drupal\Core\Entity\EntityStorageInterface $image_style_storage
   *   The image style storage.
   * @param \Drupal\Core\Utility\LinkGeneratorInterface $link_generator
   *   The link generator service.
   * @param \Drupal\Core\Session\AccountInterface $current_user
   *   The current user.
   */
  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, $label, $view_mode, array $third_party_settings, EntityStorageInterface $image_style_storage, LinkGeneratorInterface $link_generator, AccountInterface $current_user, UuidInterface $uuid_service) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings);
    $this->imageStyleStorage = $image_style_storage;
    $this->linkGenerator = $link_generator;
    $this->currentUser = $current_user;
    $this->uuidService = $uuid_service;
  }

  /**
   * {@inheritdoc}
   */
  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('entity.manager')
      ->getStorage('image_style'), $container
      ->get('link_generator'), $container
      ->get('current_user'), $container
      ->get('uuid'));
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return array(
      'image_style' => '',
      'autoplay' => TRUE,
      'autoplayinterval' => 3000,
      'arrownavigator' => TRUE,
      'bulletnavigator' => TRUE,
      'caption' => FALSE,
    ) + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $image_options = array();
    $image_styles = $this->imageStyleStorage
      ->loadMultiple();
    if ($image_styles && !empty($image_styles)) {
      foreach ($image_styles as $machine_name => $image_style) {
        $image_options[$machine_name] = $image_style
          ->label();
      }
    }
    $element['image_style'] = array(
      '#title' => t('Image style'),
      '#type' => 'select',
      '#default_value' => $this
        ->getSetting('image_style'),
      '#required' => TRUE,
      '#options' => $image_options,
    );
    $element['autoplay'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Enable to auto play.'),
      '#default_value' => $this
        ->getSetting('autoplay'),
    );
    $element['arrownavigator'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Arrow navigator'),
      '#default_value' => $this
        ->getSetting('arrownavigator'),
      '#description' => t('Enable arrow navigator.'),
    );
    $element['bulletnavigator'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Bullet navigator'),
      '#default_value' => $this
        ->getSetting('bulletnavigator'),
      '#description' => t('Enable bullet navigator.'),
    );
    $element['caption'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Caption'),
      '#default_value' => $this
        ->getSetting('caption'),
      '#description' => t('Enable caption.'),
    );
    $element['autoplayinterval'] = array(
      '#type' => 'number',
      '#title' => $this
        ->t('Autoplay interval'),
      '#attributes' => array(
        'min' => 0,
        'step' => 1,
        'value' => $this
          ->getSetting('autoplayinterval'),
      ),
      '#description' => t('Interval (in milliseconds) to go for next slide since the previous stopped.'),
    );
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $settings = $this
      ->getSettings();
    $summary = [];
    $image_style = $this->imageStyleStorage
      ->load($settings['image_style']);
    if ($image_style) {
      $summary[] = t('Image style: @image_style', array(
        '@image_style' => $image_style
          ->label(),
      ));
    }
    if ($this
      ->getSetting('arrownavigator')) {
      $summary[] = t('Arrow navigator');
    }
    if ($this
      ->getSetting('bulletnavigator')) {
      $summary[] = t('Bullet navigator');
    }
    if ($this
      ->getSetting('caption')) {
      $summary[] = t('Caption');
    }
    $summary[] = t('Autoplay : @autoplay', array(
      '@autoplay' => $settings['autoplay'],
    ));
    $summary[] = t('Autoplay interval : @autoplayinterval', array(
      '@autoplayinterval' => $settings['autoplayinterval'],
    ));
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $elements = array();
    $entity = $items
      ->getEntity();
    $field_instance = $items
      ->getFieldDefinition();
    $entity_type_id = $entity
      ->getEntityTypeId();
    $entity_id = $entity
      ->id();
    $field_name = $field_instance
      ->getName();
    $display_name = $this->viewMode;
    $files = $this
      ->getEntitiesToView($items, $langcode);
    $settings = $this
      ->getSettings();

    // Early opt-out if the field is empty.
    if (empty($files)) {
      return $elements;
    }

    // Let's get a unique uuid.
    if ($this->uuidService) {
      $uuid = $this->uuidService
        ->generate();
    }
    $image_style_setting = $this
      ->getSetting('image_style');

    // Collect cache tags to be added to the container.
    $images_cache_tags = array();
    if (!empty($image_style_setting)) {
      $image_style = $this->imageStyleStorage
        ->load($image_style_setting);
      $images_cache_tags = $image_style
        ->getCacheTags();
    }
    foreach ($files as $delta => $file) {

      // Collect cache tags to be added for each item in the field.
      $image_cache_tags = array();
      if (!empty($image_style_setting)) {
        $image_style = $this->imageStyleStorage
          ->load($image_style_setting);
        $image_cache_tags = $image_style
          ->getCacheTags();
      }
      $images_cache_tags = Cache::mergeTags($images_cache_tags, $file
        ->getCacheTags());
      $image_cache_tags = Cache::mergeTags($image_cache_tags, $file
        ->getCacheTags());

      // Extract field item attributes for the theme function, and unset them
      // from the $item so that the field template does not re-render them.
      $item = $file->_referringItem;
      $item_attributes = $item->_attributes;
      unset($item->_attributes);
      $elements[$delta] = array(
        '#theme' => 'image_jssor_formatter',
        '#item' => $item,
        '#item_attributes' => $item_attributes,
        '#image_style' => $image_style_setting,
        '#caption' => $this
          ->getSetting('caption'),
        '#url' => '',
        '#settings' => $settings,
        '#cache' => array(
          'tags' => $image_cache_tags,
        ),
      );
    }
    $container = array(
      '#theme' => 'images_jssor_formatter',
      '#children' => $elements,
      '#settings' => $settings,
      '#attributes' => array(
        'class' => array(
          'slider',
        ),
        'id' => array(
          'slider-dom-id-' . $uuid,
        ),
      ),
      '#cache' => array(
        'tags' => $images_cache_tags,
      ),
    );

    // Attach library.
    $container['#attached']['library'][] = 'jssor/jquery.jssor.slider';

    // Build settings.
    $settings = [];

    // Unique Uuid.
    $settings['view_dom_id'] = $uuid;

    // Global settings.
    $settings['$ArrowKeyNavigation'] = TRUE;

    // Arrows navigator.
    if ($this
      ->getSetting('arrownavigator')) {
      $settings['$ArrowNavigatorOptions'] = array(
        '$Class' => '$JssorArrowNavigator$',
        '$ChanceToShow' => 1,
        // Mouse Over.
        '$AutoCenter' => 2,
        // Vertical.
        '$Scale' => TRUE,
      );
    }

    // Bullets navigator.
    if ($this
      ->getSetting('bulletnavigator')) {
      $settings['$BulletNavigatorOptions'] = array(
        '$Class' => '$JssorBulletNavigator$',
        '$ChanceToShow' => 2,
        // Always.
        '$AutoCenter' => 1,
        // Vertical.
        '$Scale' => TRUE,
      );
    }

    // Attach settings.
    $container['#attached']['drupalSettings']['views']['jssorViews'][] = $settings;
    return $container;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
EntityReferenceFormatterBase::prepareView public function Loads the entities referenced in that field across all the entities being viewed. Overrides FormatterBase::prepareView
EntityReferenceFormatterBase::view public function Overrides FormatterBase::view
FileFormatterBase::checkAccess protected function Checks access to the given entity. Overrides EntityReferenceFormatterBase::checkAccess
FileFormatterBase::needsEntityLoad protected function Returns whether the entity referenced by an item needs to be loaded. Overrides EntityReferenceFormatterBase::needsEntityLoad 1
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::isApplicable public static function Returns if the formatter can be used for the provided field. Overrides FormatterInterface::isApplicable 14
ImageFormatterBase::getEntitiesToView protected function Returns the referenced entities for display. Overrides EntityReferenceFormatterBase::getEntitiesToView
JssorFieldFormatter::$currentUser protected property The current user.
JssorFieldFormatter::$imageStyleStorage protected property
JssorFieldFormatter::$linkGenerator protected property The link generator.
JssorFieldFormatter::$uuidService protected property The UUID service.
JssorFieldFormatter::create public static function Creates an instance of the plugin. Overrides FormatterBase::create
JssorFieldFormatter::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
JssorFieldFormatter::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
JssorFieldFormatter::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
JssorFieldFormatter::viewElements public function Builds a renderable array for a field value. Overrides FormatterInterface::viewElements
JssorFieldFormatter::__construct public function Constructs a ResponsiveImageFormatter object. Overrides FormatterBase::__construct
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
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 3
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. 1
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.