class BaguetteboxFormatter in baguetteBox.js 8

Plugin implementation of the 'baguettebox' formatter.

Plugin annotation


@FieldFormatter(
  id = "baguettebox",
  module = "baguettebox",
  label = @Translation("BaguetteBox"),
  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\baguettebox\Plugin\Field\FieldFormatter\BaguetteboxFormatter

Expanded class hierarchy of BaguetteboxFormatter

File

src/Plugin/Field/FieldFormatter/BaguetteboxFormatter.php, line 20

Namespace

Drupal\baguettebox\Plugin\Field\FieldFormatter

View source

class BaguetteboxFormatter extends ImageFormatter {

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'image_style' => '',
      'baguette_image_style' => '',
      'baguette_image_style_responsive' => [
        [
          'width' => NULL,
          'image_style' => NULL,
        ],
        [
          'width' => NULL,
          'image_style' => NULL,
        ],
        [
          'width' => NULL,
          'image_style' => NULL,
        ],
        [
          'width' => NULL,
          'image_style' => NULL,
        ],
        [
          'width' => NULL,
          'image_style' => NULL,
        ],
      ],
      'animation' => 'slideIn',
      'captions_source' => 'image_alt',
      'buttons' => TRUE,
      'fullscreen' => FALSE,
      'hide_scrollbars' => FALSE,
      'inline' => FALSE,
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $settings = $this
      ->getSettings();
    $image_styles = image_style_options(FALSE);
    $element['image_style'] = [
      '#title' => $this
        ->t('Image style'),
      '#type' => 'select',
      '#default_value' => $this
        ->getSetting('image_style'),
      '#empty_option' => $this
        ->t('None (original image)'),
      '#options' => $image_styles,
    ];
    $element['baguette_image_style'] = $element['image_style'];
    $element['baguette_image_style']['#title'] = $this
      ->t('BaguetteBox image style (default)');
    $element['baguette_image_style']['#default_value'] = $this
      ->getSetting('baguette_image_style');
    $element['baguette_image_style_responsive'] = [
      '#type' => 'item',
      '#title' => $this
        ->t('BaguetteBox image style (responsive)'),
      '#tree' => TRUE,
    ];
    for ($i = 0; $i <= 4; $i++) {
      $element['baguette_image_style_responsive'][$i] = [
        '#type' => 'container',
        '#attributes' => [
          'class' => 'container-inline',
        ],
      ];
      $element['baguette_image_style_responsive'][$i]['width'] = [
        '#type' => 'number',
        '#title' => $this
          ->t('Width'),
        '#title_display' => 'none',
        '#placeholder' => $this
          ->t('Width'),
        '#min' => 1,
        '#max' => 99000,
        '#default_value' => $settings['baguette_image_style_responsive'][$i]['width'],
      ];
      $element['baguette_image_style_responsive'][$i]['image_style'] = [
        '#title' => $this
          ->t('Image style'),
        '#title_display' => 'none',
        '#type' => 'select',
        '#default_value' => $settings['baguette_image_style_responsive'][$i]['image_style'],
        '#empty_option' => $this
          ->t('None (original image)'),
        '#options' => $image_styles,
      ];
    }
    $element['animation'] = [
      '#title' => $this
        ->t('Animation'),
      '#type' => 'select',
      '#default_value' => $this
        ->getSetting('animation'),
      '#options' => $this
        ->animationOptions(),
    ];
    $element['captions_source'] = [
      '#title' => $this
        ->t('Captions source'),
      '#type' => 'select',
      '#default_value' => $this
        ->getSetting('captions_source'),
      '#options' => $this
        ->captionsSourceOptions(),
    ];
    $element['buttons'] = [
      '#title' => $this
        ->t('Display buttons'),
      '#type' => 'checkbox',
      '#default_value' => $this
        ->getSetting('buttons'),
    ];
    $element['fullscreen'] = [
      '#title' => $this
        ->t('Enable full screen mode'),
      '#type' => 'checkbox',
      '#default_value' => $this
        ->getSetting('fullscreen'),
    ];
    $element['hide_scrollbars'] = [
      '#title' => $this
        ->t('Hide scrollbars when gallery is displayed'),
      '#type' => 'checkbox',
      '#default_value' => $this
        ->getSetting('hide_scrollbars'),
    ];
    $element['inline'] = [
      '#title' => $this
        ->t('Display as inline elements'),
      '#type' => 'checkbox',
      '#default_value' => $this
        ->getSetting('inline'),
    ];
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $image_styles = image_style_options(FALSE);

    // Unset possible 'No defined styles' option.
    unset($image_styles['']);
    $image_style_setting = $this
      ->getSetting('image_style');
    $style = $image_styles[$image_style_setting] ?? $this
      ->t('Original image');
    $summary[] = $this
      ->t('Image style: @style', [
      '@style' => $style,
    ]);
    $image_style_setting = $this
      ->getSetting('baguette_image_style');
    $style = $image_styles[$image_style_setting] ?? $this
      ->t('Original image');
    $summary[] = $this
      ->t('Baguette image style (default): @style', [
      '@style' => $style,
    ]);
    foreach ($this
      ->getSetting('baguette_image_style_responsive') as $preset) {
      if ($preset['width']) {
        $style = $image_styles[$preset['image_style']] ?? $this
          ->t('Original image');
        $summary[] = $this
          ->t('Baguette image style (@width): @style', [
          '@width' => $preset['width'],
          '@style' => $style,
        ]);
      }
    }
    $animation_options = $this
      ->animationOptions();
    $summary[] = $this
      ->t('Animation: @animation', [
      '@animation' => $animation_options[$this
        ->getSetting('animation')],
    ]);
    $captions_source_options = $this
      ->captionsSourceOptions();
    $summary[] = $this
      ->t('Captions source: @captions_source', [
      '@captions_source' => $captions_source_options[$this
        ->getSetting('captions_source')],
    ]);
    $summary[] = $this
      ->t('Display buttons: @display_buttons', [
      '@display_buttons' => $this
        ->getBooleanSettingLabel('buttons'),
    ]);
    $summary[] = $this
      ->t('Enable full screen mode: @fullscreen', [
      '@fullscreen' => $this
        ->getBooleanSettingLabel('fullscreen'),
    ]);
    $summary[] = $this
      ->t('Hide scrollbars: @hide_scrollbars', [
      '@hide_scrollbars' => $this
        ->getBooleanSettingLabel('hide_scrollbars'),
    ]);
    $summary[] = $this
      ->t('Inline: @inline', [
      '@inline' => $this
        ->getBooleanSettingLabel('inline'),
    ]);
    return $summary;
  }

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

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

    // Collect cache tags to be added for each item in the field.
    $cache_tags = [];
    if ($settings['image_style']) {
      $image_style = $this->imageStyleStorage
        ->load($settings['image_style']);
      $cache_tags = $image_style
        ->getCacheTags();
    }

    // Prepare image styles.
    if ($settings['baguette_image_style']) {

      /** @var \Drupal\image\ImageStyleInterface $baguette_image_style */
      $baguette_image_style = $this->imageStyleStorage
        ->load($settings['baguette_image_style']);
    }
    $baguette_image_style_responsive = [];
    foreach ($settings['baguette_image_style_responsive'] as $preset) {
      if ($preset['width']) {
        $baguette_image_style_responsive[$preset['width']] = $this->imageStyleStorage
          ->load($preset['image_style']);
      }
    }

    /** @var \Drupal\file\FileInterface[] $files */
    foreach ($files as $delta => $file) {
      $cache_contexts = [];
      $cache_contexts[] = 'url.site';
      $cache_tags = Cache::mergeTags($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);
      $image_uri = $file
        ->getFileUri();
      $default_url = file_create_url($image_uri);
      $link_attributes = [];
      foreach ($baguette_image_style_responsive as $width => $image_style) {
        $link_attributes['data-at-' . $width] = $image_style ? $image_style
          ->buildUrl($image_uri) : $default_url;
      }
      $elements[$delta] = [
        '#theme' => 'baguettebox_formatter',
        '#item' => $item,
        '#item_attributes' => $item_attributes,
        '#link_attributes' => $link_attributes,
        '#image_style' => $settings['image_style'],
        '#url' => empty($baguette_image_style) ? $default_url : $baguette_image_style
          ->buildUrl($image_uri),
        '#cache' => [
          'tags' => $cache_tags,
          'contexts' => $cache_contexts,
        ],
      ];
    }
    $elements['#attached']['drupalSettings']['baguettebox'] = $settings;
    $elements['#attached']['library'][] = 'baguettebox/formatter';
    $elements['#attributes']['class'][] = 'baguettebox';
    if ($settings['inline']) {
      $elements['#attributes']['class'][] = 'container-inline';
    }
    return $elements;
  }

  /**
   * Returns animation options.
   */
  protected function animationOptions() {
    return [
      'none' => $this
        ->t('None'),
      'slideIn' => $this
        ->t('Slide'),
      'fadeIn' => $this
        ->t('Fade'),
    ];
  }

  /**
   * Returns captions source options.
   */
  protected function captionsSourceOptions() {
    return [
      'none' => $this
        ->t('None'),
      'image_title' => $this
        ->t('Image title attribute'),
      'image_alt' => $this
        ->t('Image alt attribute'),
    ];
  }

  /**
   * Returns labels for boolean settings.
   */
  protected function getBooleanSettingLabel($setting) {
    return $this
      ->getSetting($setting) ? $this
      ->t('Yes') : $this
      ->t('No');
  }

}

Members

Name	Modifiers	Type	Description	Overrides
BaguetteboxFormatter::animationOptions	protected	function	Returns animation options.
BaguetteboxFormatter::captionsSourceOptions	protected	function	Returns captions source options.
BaguetteboxFormatter::defaultSettings	public static	function	Defines the default settings for this plugin. Overrides ImageFormatter::defaultSettings
BaguetteboxFormatter::getBooleanSettingLabel	protected	function	Returns labels for boolean settings.
BaguetteboxFormatter::settingsForm	public	function	Returns a form to configure settings for the formatter. Overrides ImageFormatter::settingsForm
BaguetteboxFormatter::settingsSummary	public	function	Returns a short summary for the current formatter settings. Overrides ImageFormatter::settingsSummary
BaguetteboxFormatter::viewElements	public	function	Builds a renderable array for a field value. Overrides ImageFormatter::viewElements
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::create	public static	function	Creates an instance of the plugin. Overrides FormatterBase::create	1
ImageFormatter::onDependencyRemoval	public	function	Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsBase::onDependencyRemoval
ImageFormatter::__construct	public	function	Constructs an ImageFormatter object. Overrides FormatterBase::__construct	1
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
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 BaguetteboxFormatter in baguetteBox.js 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation