You are here

Home » API reference » Lightgallery 8 » LightgalleryFormatter.php

class LightgalleryFormatter in Lightgallery 8

Light gallery formatter.

Plugin annotation


@FieldFormatter(
  id = "lightgallery",
  label = @Translation("Lightgallery"),
  field_types = {
    "image"
  }
)

Hierarchy

Expanded class hierarchy of LightgalleryFormatter

File

src/Plugin/Field/FieldFormatter/LightgalleryFormatter.php, line 29

Namespace

Drupal\lightgallery\Plugin\Field\FieldFormatter
View source 
class LightgalleryFormatter extends FileFormatterBase {

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    $default_settings = [];
    $lightgallery_groups = GroupsEnum::toArray();
    foreach ($lightgallery_groups as $lightgallery_group) {
      $default_settings[$lightgallery_group] = [];
    }
    return $default_settings + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $fields_settings = LightgalleryManager::getSettingFields();

    /*
     * @var \Drupal\lightgallery\Field\FieldInterface $field
     * @var \Drupal\lightgallery\Group\GroupInterface $group
     */
    foreach ($fields_settings as $field) {
      $group = $field
        ->getGroup();
      if (empty($element[$group
        ->getName()])) {

        // Attach group to form.
        $element[$group
          ->getName()] = [
          '#type' => 'details',
          '#title' => $group
            ->getTitle(),
          '#open' => $group
            ->isOpen(),
        ];
      }
      if ($field
        ->appliesToFieldFormatter()) {

        // Attach field to group and form.
        $element[$group
          ->getName()][$field
          ->getName()] = [
          '#type' => $field
            ->getType(),
          '#title' => $field
            ->getTitle(),
          '#default_value' => isset($this->settings[$group
            ->getName()][$field
            ->getName()]) ? $this->settings[$group
            ->getName()][$field
            ->getName()] : $field
            ->getDefaultValue(),
          '#description' => $field
            ->getDescription(),
          '#required' => $field
            ->isRequired(),
        ];
        if (!empty($field
          ->getOptions())) {

          // Set field options.
          if (is_callable($field
            ->getOptions())) {
            $element[$group
              ->getName()][$field
              ->getName()]['#options'] = call_user_func($field
              ->getOptions());
          }
        }
      }
    }
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = [];
    $image_styles = LightgalleryManager::getImageStyles();

    // Unset possible 'No defined styles' option.
    unset($image_styles['']);
    $thumb_image_style = new FieldThumbImageStyle();
    $lightgallery_image_style = new FieldLightgalleryImageStyle();
    $use_thumbnails = new FieldUseThumbs();
    $title_source = new FieldTitleSource();
    if (isset($image_styles[$this->settings[$lightgallery_image_style
      ->getGroup()
      ->getName()][$lightgallery_image_style
      ->getName()]])) {
      $summary[] = t('Lightgallery image style: @style', [
        '@style' => $image_styles[$this->settings[$lightgallery_image_style
          ->getGroup()
          ->getName()][$lightgallery_image_style
          ->getName()]],
      ]);
    }
    else {
      $summary[] = t('Lightgallery image style: Original image');
    }
    if (isset($image_styles[$this->settings[$thumb_image_style
      ->getGroup()
      ->getName()][$thumb_image_style
      ->getName()]])) {
      $summary[] = t('Thumbnail image style: @style', [
        '@style' => $image_styles[$this->settings[$thumb_image_style
          ->getGroup()
          ->getName()][$thumb_image_style
          ->getName()]],
      ]);
    }
    else {
      $summary[] = t('Thumbnail image style: Original image');
    }
    $summary[] = $this->settings[$use_thumbnails
      ->getGroup()
      ->getName()][$use_thumbnails
      ->getName()] ? t('Use thumbs in gallery: Yes') : t('Use thumbs in gallery: No');
    $summary[] = !empty($this->settings[$title_source
      ->getGroup()
      ->getName()][$title_source
      ->getName()]) ? t('Value used as title: @title', [
      '@title' => $this->settings[$title_source
        ->getGroup()
        ->getName()][$title_source
        ->getName()],
    ]) : t('Value used as title: none');
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {

    /*
     * @var \Drupal\image\Plugin\Field\FieldType\ImageItem $item
     */
    $item_list = [];
    $files = $this
      ->getEntitiesToView($items, $langcode);

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

    // Init lightgallery image style field.
    $lightgallery_image_style_field = new FieldLightgalleryImageStyle();

    // Fetch lightgallery image style.
    $lightgallery_image_style = $this->settings[$lightgallery_image_style_field
      ->getGroup()
      ->getName()][$lightgallery_image_style_field
      ->getName()];

    // Init thumb image style field.
    $thumb_image_style_field = new FieldThumbImageStyle();

    // Fetch thumb image style.
    $thumb_image_style = $this->settings[$thumb_image_style_field
      ->getGroup()
      ->getName()][$thumb_image_style_field
      ->getName()];

    // Init title source field.
    $title_source_field = new FieldTitleSource();
    $title_source = $this->settings[$title_source_field
      ->getGroup()
      ->getName()][$title_source_field
      ->getName()];
    foreach ($files as $file) {
      if ($uri = $file
        ->getFileUri()) {

        // The reffering item is the image.
        $item = $file->_referringItem;

        // Load image urls.
        if (!empty($lightgallery_image_style)) {
          $item_detail['slide'] = $item_detail['thumb'] = ImageStyle::load($lightgallery_image_style)
            ->buildUrl($uri);
        }
        else {
          $item_detail['slide'] = $item_detail['thumb'] = file_create_url($uri);
        }

        // If image styles are different, also load thumb.
        if ($thumb_image_style != $lightgallery_image_style) {
          if (!empty($thumb_image_style)) {

            // Load thumb url.
            $item_detail['thumb'] = ImageStyle::load($thumb_image_style)
              ->buildUrl($uri);
          }
          else {
            $item_detail['thumb'] = file_create_url($uri);
          }
        }
        if (!empty($title_source) && !empty($item->{$title_source})) {

          // Set title of slide.
          $item_detail['title'] = [
            '#markup' => Xss::filterAdmin($item->{$title_source}),
          ];
        }
      }
      $item_list[] = $item_detail;
    }

    // Flatten settings array.
    $options = LightgalleryManager::flattenArray($this->settings);

    // Set unique id, so that multiple instances on one page can be created.
    $unique_id = uniqid();

    // Load libraries.
    $lightgallery_optionset = new LightgalleryOptionset($options);
    $lightgallery_manager = new LightgalleryManager($lightgallery_optionset);

    // Build render array.
    $content = [
      '#theme' => 'lightgallery',
      '#items' => $item_list,
      '#id' => $unique_id,
      '#attached' => $lightgallery_manager
        ->loadLibraries($unique_id),
    ];
    return $content;
  }

}

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::getEntitiesToView protected function Returns the referenced entities for display. 1
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::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 11
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
FormatterBase::__construct public function Constructs a FormatterBase object. Overrides PluginBase::__construct 11
LightgalleryFormatter::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
LightgalleryFormatter::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
LightgalleryFormatter::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
LightgalleryFormatter::viewElements public function Builds a renderable array for a field value. Overrides FormatterInterface::viewElements
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.