You are here

Home » API reference » Svg Image 2.x » SvgResponsiveImageFormatter.php

class SvgResponsiveImageFormatter in Svg Image 2.x

Same name and namespace in other branches
  1. 8 modules/svg_image_responsive/src/Plugin/Field/FieldFormatter/SvgResponsiveImageFormatter.php \Drupal\svg_image_responsive\Plugin\Field\FieldFormatter\SvgResponsiveImageFormatter
  2. 1.x modules/svg_image_responsive/src/Plugin/Field/FieldFormatter/SvgResponsiveImageFormatter.php \Drupal\svg_image_responsive\Plugin\Field\FieldFormatter\SvgResponsiveImageFormatter

Plugin implementation of the 'responsive_image' formatter.

We have to fully override standard field formatter, so we will keep original label and formatter ID.

Plugin annotation


@FieldFormatter(
  id = "responsive_image",
  label = @Translation("Responsive image"),
  field_types = {
    "image"
  },
  quickedit = {
    "editor" = "image"
  }
)

Hierarchy

Expanded class hierarchy of SvgResponsiveImageFormatter

1 file declares its use of SvgResponsiveImageFormatter
svg_image_responsive.module in modules/svg_image_responsive/svg_image_responsive.module
Contains hooks for the svg_image_responsive module.

File

modules/svg_image_responsive/src/Plugin/Field/FieldFormatter/SvgResponsiveImageFormatter.php, line 37

Namespace

Drupal\svg_image_responsive\Plugin\Field\FieldFormatter
View source 
class SvgResponsiveImageFormatter extends ResponsiveImageFormatter {

  /**
   * File logger channel.
   *
   * @var \Drupal\Core\Logger\LoggerChannelInterface
   */
  private $logger;

  /**
   * {@inheritdoc}
   */
  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, $label, $view_mode, array $third_party_settings, EntityStorageInterface $responsive_image_style_storage, EntityStorageInterface $image_style_storage, LinkGeneratorInterface $link_generator, AccountInterface $current_user, LoggerChannelInterface $logger) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings, $responsive_image_style_storage, $image_style_storage, $link_generator, $current_user);
    $this->logger = $logger;
  }

  /**
   * {@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_type.manager')
      ->getStorage('responsive_image_style'), $container
      ->get('entity_type.manager')
      ->getStorage('image_style'), $container
      ->get('link_generator'), $container
      ->get('current_user'), $container
      ->get('logger.channel.file'));
  }

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

    /** @var \Drupal\file\Entity\File[] $files */
    $files = $this
      ->getEntitiesToView($items, $langcode);

    // Early opt-out if the field is empty.
    if (empty($files)) {
      return $elements;
    }
    $url = NULL;
    $imageLinkSetting = $this
      ->getSetting('image_link');

    // Check if the formatter involves a link.
    if ($imageLinkSetting === 'content') {
      $entity = $items
        ->getEntity();
      if (!$entity
        ->isNew()) {
        $url = $entity
          ->toUrl();
      }
    }
    elseif ($imageLinkSetting === 'file') {
      $linkFile = TRUE;
    }

    // Collect cache tags to be added for each item in the field.
    $responsiveImageStyle = $this->responsiveImageStyleStorage
      ->load($this
      ->getSetting('responsive_image_style'));
    $imageStylesToLoad = [];
    $cacheTags = [];
    if ($responsiveImageStyle) {
      $cacheTags = Cache::mergeTags($cacheTags, $responsiveImageStyle
        ->getCacheTags());
      $imageStylesToLoad = $responsiveImageStyle
        ->getImageStyleIds();
    }
    $imageStyles = $this->imageStyleStorage
      ->loadMultiple($imageStylesToLoad);
    foreach ($imageStyles as $image_style) {
      $cacheTags = Cache::mergeTags($cacheTags, $image_style
        ->getCacheTags());
    }
    $svgAttributes = $this
      ->getSetting('svg_attributes');
    foreach ($files as $delta => $file) {
      $attributes = [];
      $isSvg = svg_image_is_file_svg($file);
      if ($isSvg) {
        $attributes = $svgAttributes;
      }
      $cacheContexts = [];
      if (isset($linkFile)) {
        $imageUri = $file
          ->getFileUri();
        $url = Url::fromUri(file_create_url($imageUri));
        $cacheContexts[] = 'url.site';
      }
      $cacheTags = Cache::mergeTags($cacheTags, $file
        ->getCacheTags());

      // Link the <picture> element to the original file.
      if (isset($linkFile)) {
        $url = file_url_transform_relative(file_create_url($file
          ->getFileUri()));
      }

      // 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;
      if (isset($item->_attributes)) {
        $attributes += $item->_attributes;
      }
      unset($item->_attributes);
      if (!$isSvg) {
        $elements[$delta] = [
          '#theme' => 'responsive_image_formatter',
          '#item' => $item,
          '#item_attributes' => $attributes,
          '#responsive_image_style_id' => $responsiveImageStyle ? $responsiveImageStyle
            ->id() : '',
          '#url' => $url,
          '#cache' => [
            'tags' => $cacheTags,
          ],
        ];
      }
      elseif ($this
        ->getSetting('svg_render_as_image')) {
        $elements[$delta] = [
          '#theme' => 'image_formatter',
          '#item' => $item,
          '#item_attributes' => $attributes,
          '#image_style' => NULL,
          '#url' => $url,
          '#cache' => [
            'tags' => $cacheTags,
            'contexts' => $cacheContexts,
          ],
        ];
      }
      else {

        // Render as SVG tag.
        $svgRaw = $this
          ->fileGetContents($file);
        if ($svgRaw) {
          $svgRaw = str_replace('<?xml version="1.0" encoding="UTF-8"?>', '', $svgRaw);
          $svgRaw = trim($svgRaw);
          $elements[$delta] = [
            '#markup' => Markup::create($svgRaw),
            '#cache' => [
              'tags' => $cacheTags,
              'contexts' => $cacheContexts,
            ],
          ];
        }
      }
    }
    return $elements;
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'svg_attributes' => [
        'width' => '',
        'height' => '',
      ],
      'svg_render_as_image' => TRUE,
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $element, FormStateInterface $formState) {
    $element = parent::settingsForm($element, $formState);
    $element['svg_render_as_image'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Render SVG image as &lt;img&gt;'),
      '#description' => $this
        ->t('Render SVG images as usual image in IMG tag instead of &lt;svg&gt; tag'),
      '#default_value' => $this
        ->getSetting('svg_render_as_image'),
    ];
    $element['svg_attributes'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('SVG Images dimensions (attributes)'),
      '#tree' => TRUE,
    ];
    $element['svg_attributes']['width'] = [
      '#type' => 'number',
      '#min' => 0,
      '#title' => $this
        ->t('Width'),
      '#size' => 10,
      '#field_suffix' => 'px',
      '#default_value' => $this
        ->getSetting('svg_attributes')['width'],
    ];
    $element['svg_attributes']['height'] = [
      '#type' => 'number',
      '#min' => 0,
      '#title' => $this
        ->t('Height'),
      '#size' => 10,
      '#field_suffix' => 'px',
      '#default_value' => $this
        ->getSetting('svg_attributes')['height'],
    ];
    return $element;
  }

  /**
   * Provides content of the file.
   *
   * @param \Drupal\file\Entity\File $file
   *   File to handle.
   *
   * @return string
   *   File content.
   */
  protected function fileGetContents(File $file) {
    $fileUri = $file
      ->getFileUri();
    if (file_exists($fileUri)) {
      return file_get_contents($fileUri);
    }
    $this->logger
      ->error('File @file_uri (ID: @file_id) does not exists in filesystem.', [
      '@file_id' => $file
        ->id(),
      '@file_uri' => $fileUri,
    ]);
    return FALSE;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
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. 27
MessengerTrait::messenger public function Gets the messenger. 27
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 2
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::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
ResponsiveImageFormatter::$currentUser protected property The current user.
ResponsiveImageFormatter::$imageStyleStorage protected property The image style entity storage.
ResponsiveImageFormatter::$linkGenerator protected property The link generator.
ResponsiveImageFormatter::$responsiveImageStyleStorage protected property
ResponsiveImageFormatter::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides PluginSettingsBase::calculateDependencies
ResponsiveImageFormatter::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
StringTranslationTrait::$stringTranslation protected property The string translation service. 4
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.
SvgResponsiveImageFormatter::$logger private property File logger channel.
SvgResponsiveImageFormatter::create public static function Creates an instance of the plugin. Overrides ResponsiveImageFormatter::create
SvgResponsiveImageFormatter::defaultSettings public static function Defines the default settings for this plugin. Overrides ResponsiveImageFormatter::defaultSettings
SvgResponsiveImageFormatter::fileGetContents protected function Provides content of the file.
SvgResponsiveImageFormatter::settingsForm public function Returns a form to configure settings for the formatter. Overrides ResponsiveImageFormatter::settingsForm
SvgResponsiveImageFormatter::viewElements public function Builds a renderable array for a field value. Overrides ResponsiveImageFormatter::viewElements
SvgResponsiveImageFormatter::__construct public function Constructs a ResponsiveImageFormatter object. Overrides ResponsiveImageFormatter::__construct