You are here

Home » API reference » Bootstrap Carousel Image Formatter 8.3 » BootstrapCarouselImageFormatter.php

class BootstrapCarouselImageFormatter in Bootstrap Carousel Image Formatter 8.3

Plugin implementation of the 'bootstrap_image_carousel_formatter' formatter.

Plugin annotation


@FieldFormatter(
  id = "bootstrap_carousel_image_formatter",
  label = @Translation("Bootstrap Carousel"),
  field_types = {
    "image"
  }
)

Hierarchy

Expanded class hierarchy of BootstrapCarouselImageFormatter

File

src/Plugin/Field/FieldFormatter/BootstrapCarouselImageFormatter.php, line 28

Namespace

Drupal\bootstrap_carousel_if\Plugin\Field\FieldFormatter
View source 
class BootstrapCarouselImageFormatter extends ImageFormatterBase implements ContainerFactoryPluginInterface {

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

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

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

  /**
   * {@inheritdoc}
   *
   * @see \Drupal\Core\Field\FormatterBase::__construct()
   */
  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, $label, $view_mode, array $third_party_settings, AccountInterface $current_user, LinkGeneratorInterface $link_generator, EntityTypeManagerInterface $etm) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings);
    $this->currentUser = $current_user;
    $this->linkGenerator = $link_generator;
    $this->imageStyleStorage = $etm
      ->getStorage('image_style');
  }

  /**
   * {@inheritdoc}
   *
   * @see \Drupal\Core\Plugin\ContainerFactoryPluginInterface::create()
   */
  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('link_generator'), $container
      ->get('entity_type.manager'));
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'interval' => '5000',
      'pause' => 0,
      'wrap' => 0,
      'indicators' => 1,
      'controls' => 1,
      'image_style' => '',
      // Not configurable on settingsForm.
      'background' => 0,
      'background_pos' => 'center center',
      'keyboard' => 0,
      'height' => '100px',
      'width' => '100%',
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $element = [];
    $yesNo = [
      0 => $this
        ->t('No'),
      1 => $this
        ->t('Yes'),
    ];
    $element['interval'] = [
      '#title' => $this
        ->t('Interval'),
      '#type' => 'textfield',
      '#default_value' => $this
        ->getSetting('interval'),
      '#size' => 10,
      '#required' => TRUE,
    ];
    $element['pause'] = [
      '#title' => $this
        ->t('Pause on hover'),
      '#type' => 'select',
      '#options' => $yesNo,
      '#default_value' => $this
        ->getSetting('pause'),
    ];
    $element['wrap'] = [
      '#title' => $this
        ->t('Wrap'),
      '#type' => 'select',
      '#options' => $yesNo,
      '#default_value' => $this
        ->getSetting('wrap'),
    ];
    $element['indicators'] = [
      '#title' => $this
        ->t('Indicators'),
      '#type' => 'select',
      '#options' => $yesNo,
      '#default_value' => $this
        ->getSetting('indicators'),
    ];
    $element['controls'] = [
      '#title' => $this
        ->t('Controls'),
      '#type' => 'select',
      '#options' => $yesNo,
      '#default_value' => $this
        ->getSetting('controls'),
    ];
    $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,
      '#description' => [
        '#markup' => $this->linkGenerator
          ->generate($this
          ->t('Configure Image Styles'), new Url('entity.image_style.collection')),
        '#access' => $this->currentUser
          ->hasPermission('administer image styles'),
      ],
    ];
    return $element;
  }

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

    // Unset possible 'No defined styles' option.
    unset($image_styles['']);
    $settings = $this
      ->getSettings();

    // Styles could be lost because of enabled/disabled modules that defines
    // their styles in code.
    $image_style_setting = $settings['image_style'];
    if (isset($image_styles[$image_style_setting])) {
      $summary[] = $this
        ->t('Bootstrap carousel : @style', [
        '@style' => $image_styles[$image_style_setting],
      ]);
    }
    else {
      $summary[] = $this
        ->t('Bootstrap carousel : Original image');
    }
    $summary[] = $this
      ->t('Interval @interval, @pause, @wrap, @indicators, @controls', [
      '@interval' => $settings['interval'],
      '@pause' => $settings['pause'] ? $this
        ->t('pause on hover') : $this
        ->t('no pause'),
      '@wrap' => $settings['wrap'] ? $this
        ->t('with wrap') : $this
        ->t('no wrap'),
      '@indicators' => $settings['indicators'] ? $this
        ->t('with indicators') : $this
        ->t('no indicators'),
      '@controls' => $settings['controls'] ? $this
        ->t('with controls') : $this
        ->t('no controls'),
    ]);
    return $summary;
  }

  /**
   * {@inheritdoc}
   *
   * @see \Drupal\Core\Field\FormatterInterface::viewElements()
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $slides = [];
    $element = [];

    // Build files array.
    $files = $this
      ->getEntitiesToView($items, $langcode);

    // Early opt-out if the field is empty.
    if (empty($files)) {
      return $slides;
    }
    $image_style_setting = $this
      ->getSetting('image_style');

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

      // Extract field item attributes for the theme function.
      $item = $file->_referringItem;
      $item_attributes = $item->_attributes;
      $slides[$delta] = [
        'title' => !empty($items[$delta]) ? $items[$delta]
          ->getValue()['title'] : '',
        'image' => [
          '#theme' => 'image_formatter',
          '#item' => $item,
          '#item_attributes' => $item_attributes,
          '#image_style' => $image_style_setting,
          '#cache' => [
            'tags' => $cache_tags,
          ],
        ],
      ];
    }

    // Build theme array.
    $element[0] = [
      '#theme' => 'bootstrap_carousel',
      '#slides' => $slides,
      '#interval' => $this
        ->getSetting('interval'),
      '#pause' => $this
        ->getSetting('pause'),
      '#wrap' => $this
        ->getSetting('wrap'),
      '#indicators' => count($slides) == 1 ? '0' : $this
        ->getSetting('indicators'),
      '#controls' => count($slides) == 1 ? '0' : $this
        ->getSetting('controls'),
    ];
    return $element;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
BootstrapCarouselImageFormatter::$currentUser protected property The current user.
BootstrapCarouselImageFormatter::$imageStyleStorage protected property The image style entity storage.
BootstrapCarouselImageFormatter::$linkGenerator protected property The link generator.
BootstrapCarouselImageFormatter::create public static function Overrides FormatterBase::create
BootstrapCarouselImageFormatter::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
BootstrapCarouselImageFormatter::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
BootstrapCarouselImageFormatter::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
BootstrapCarouselImageFormatter::viewElements public function Overrides FormatterInterface::viewElements
BootstrapCarouselImageFormatter::__construct public function Overrides FormatterBase::__construct
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
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.