class SliderProFormatter in Slider Pro 8

Plugin annotation


@FieldFormatter(
  id = "slider_pro",
  label = @Translation("Slider Pro"),
  field_types = {
    "image"
  }
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\Core\Field\PluginSettingsBase implements DependentPluginInterface, PluginSettingsInterface
    class \Drupal\Core\Field\FormatterBase implements FormatterInterface, ContainerFactoryPluginInterface
    class \Drupal\Core\Field\Plugin\Field\FieldFormatter\EntityReferenceFormatterBase
    class \Drupal\file\Plugin\Field\FieldFormatter\FileFormatterBase
    class \Drupal\image\Plugin\Field\FieldFormatter\ImageFormatterBase
    class \Drupal\image\Plugin\Field\FieldFormatter\ImageFormatter implements ContainerFactoryPluginInterface
    class \Drupal\slider_pro\Plugin\Field\FieldFormatter\SliderProFormatter

Expanded class hierarchy of SliderProFormatter

File

src/Plugin/Field/FieldFormatter/SliderProFormatter.php, line 27

Namespace

Drupal\slider_pro\Plugin\Field\FieldFormatter

View source

class SliderProFormatter extends ImageFormatter {
  protected $sliderProManager;

  /**
   * SliderProFormatter constructor.
   */
  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, SliderProManager $slider_pro_manager) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings, $current_user, $image_style_storage);
    $this->sliderProManager = $slider_pro_manager;
  }

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

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'optionset' => 'default',
      'image_style' => '',
      'image_style_thumb' => '',
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  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['optionset'] = [
      '#title' => t('Option set'),
      '#type' => 'select',
      '#options' => $this->sliderProManager
        ->getOptionList(),
      '#default_value' => $this
        ->getSetting('optionset'),
      '#required' => TRUE,
    ];
    $element['image_style'] = [
      '#title' => t('Image style'),
      '#type' => 'select',
      '#default_value' => $this
        ->getSetting('image_style'),
      '#empty_option' => t('None (original image)'),
      '#options' => $image_styles,
      '#description' => $description_link
        ->toRenderable() + [
        '#access' => $this->currentUser
          ->hasPermission('administer image styles'),
      ],
    ];
    $element['image_style_thumb'] = [
      '#title' => t('Image style thumbnail'),
      '#type' => 'select',
      '#default_value' => $this
        ->getSetting('image_style_thumb'),
      '#empty_option' => t('None (original image)'),
      '#options' => $image_styles,
      '#description' => $description_link
        ->toRenderable() + [
        '#access' => $this->currentUser
          ->hasPermission('administer image styles'),
      ],
    ];
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = [];
    $image_styles = image_style_options(FALSE);
    $optionset = SliderPro::load($this
      ->getSetting('optionset'));
    $summary[] = $this
      ->t('Optionset: @optionset', [
      '@optionset' => $optionset
        ->label(),
    ]);

    // Unset possible 'No defined styles' option.
    unset($image_styles['']);

    // Styles could be lost because of enabled/disabled modules that defines
    // their styles in code.
    $image_style_setting = $this
      ->getSetting('image_style');
    if (isset($image_styles[$image_style_setting])) {
      $summary[] = $this
        ->t('Image style: @style', [
        '@style' => $image_styles[$image_style_setting],
      ]);
    }
    else {
      $summary[] = $this
        ->t('Image style: Original image');
    }
    $image_style_thumb_setting = $this
      ->getSetting('image_style_thumb');
    if (isset($image_styles[$image_style_thumb_setting])) {
      $summary[] = $this
        ->t('Image style thumbnail: @style', [
        '@style' => $image_styles[$image_style_thumb_setting],
      ]);
    }
    else {
      $summary[] = $this
        ->t('Image style thumbnail: Original image');
    }
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $rows = [];
    $files = $this
      ->getEntitiesToView($items, $langcode);

    // Early opt-out if the field is empty.
    if (empty($files)) {
      return [];
    }
    if (!($optionset = SliderPro::load($this
      ->getSetting('optionset')))) {

      // For some reason, no optionset could be loaded.
      return [];
    }
    $image_style_setting = $this
      ->getSetting('image_style');
    $image_style_thumb_setting = $this
      ->getSetting('image_style_thumb');

    // Collect cache tags to be added for each item in the field.
    $base_cache_tags = [
      'image_style' => [],
      'image_style_thumb' => [],
    ];
    if (!empty($image_style_setting)) {
      $image_style = $this->imageStyleStorage
        ->load($image_style_setting);
      $base_cache_tags['image_style'] = $image_style
        ->getCacheTags();
    }
    if (!empty($image_style_thumb_setting)) {
      $image_style = $this->imageStyleStorage
        ->load($image_style_thumb_setting);
      $base_cache_tags['image_style_thumb'] = $image_style
        ->getCacheTags();
    }
    foreach ($files as $delta => $file) {

      /** @var \Drupal\file\FileInterface $file */
      $cache_contexts = [];
      $image_style_cache_tags = Cache::mergeTags($base_cache_tags['image_style'], $file
        ->getCacheTags());
      $image_style_thumb_cache_tags = Cache::mergeTags($base_cache_tags['image_style_thumb'], $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);
      $rows[$delta]['slide']['image'] = [
        '#theme' => 'image_formatter',
        '#item' => $item,
        '#item_attributes' => $item_attributes,
        '#image_style' => $image_style_setting,
        '#cache' => [
          'tags' => $image_style_cache_tags,
          'contexts' => $cache_contexts,
        ],
      ];
      $rows[$delta]['thumb']['image'] = [
        '#theme' => 'image_formatter',
        '#item' => $item,
        '#item_attributes' => $item_attributes,
        '#image_style' => $image_style_thumb_setting,
        '#cache' => [
          'tags' => $image_style_thumb_cache_tags,
          'contexts' => $cache_contexts,
        ],
      ];
    }

    // Build render array.
    $id = 'slider-pro-' . uniqid();
    $content = array(
      '#theme' => 'slider_pro',
      '#rows' => $rows,
      '#uses_thumbnails' => $optionset
        ->hasThumbnails(),
      '#id' => $id,
    );
    $attached = [];

    // JavaScript settings
    $js_settings = array(
      'instances' => array(
        $id => $optionset
          ->toOptionSet(),
      ),
    );

    // Add JS.
    $attached['library'][] = 'slider_pro/slider.pro.load';
    $content['#attached'] = [
      'library' => [
        'slider_pro/slider.pro.load',
      ],
      'drupalSettings' => [
        'sliderPro' => $js_settings,
      ],
    ];
    return $content;
  }

}

Members

Name	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
ImageFormatter::$currentUser	protected	property	The current user.
ImageFormatter::$imageStyleStorage	protected	property	The image style entity storage.
ImageFormatter::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides PluginSettingsBase::calculateDependencies
ImageFormatter::onDependencyRemoval	public	function	Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsBase::onDependencyRemoval
ImageFormatterBase::getEntitiesToView	protected	function	Returns the referenced entities for display. Overrides EntityReferenceFormatterBase::getEntitiesToView
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::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::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
SliderProFormatter::$sliderProManager	protected	property
SliderProFormatter::create	public static	function	Creates an instance of the plugin. Overrides ImageFormatter::create
SliderProFormatter::defaultSettings	public static	function	Defines the default settings for this plugin. Overrides ImageFormatter::defaultSettings
SliderProFormatter::settingsForm	public	function	Returns a form to configure settings for the formatter. Overrides ImageFormatter::settingsForm
SliderProFormatter::settingsSummary	public	function	Returns a short summary for the current formatter settings. Overrides ImageFormatter::settingsSummary
SliderProFormatter::viewElements	public	function	Builds a renderable array for a field value. Overrides ImageFormatter::viewElements
SliderProFormatter::__construct	public	function	SliderProFormatter constructor. Overrides ImageFormatter::__construct
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.

You are here

class SliderProFormatter in Slider Pro 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation