You are here

Home » API reference » SVG Image Field 2.1.x » SvgImageFieldFormatter.php

class SvgImageFieldFormatter in SVG Image Field 2.1.x

Same name and namespace in other branches
  1. 8 src/Plugin/Field/FieldFormatter/SvgImageFieldFormatter.php \Drupal\svg_image_field\Plugin\Field\FieldFormatter\SvgImageFieldFormatter
  2. 2.0.x src/Plugin/Field/FieldFormatter/SvgImageFieldFormatter.php \Drupal\svg_image_field\Plugin\Field\FieldFormatter\SvgImageFieldFormatter

Plugin implementation of the 'svg_formatter' formatter.

Plugin annotation


@FieldFormatter(
  id = "svg_image_field_formatter",
  label = @Translation("SVG Image Field formatter"),
  field_types = {
    "svg_image_field"
  }
)

Hierarchy

Expanded class hierarchy of SvgImageFieldFormatter

File

src/Plugin/Field/FieldFormatter/SvgImageFieldFormatter.php, line 26

Namespace

Drupal\svg_image_field\Plugin\Field\FieldFormatter
View source 
class SvgImageFieldFormatter extends FormatterBase implements ContainerFactoryPluginInterface {

  /**
   * Logger.
   *
   * @var \Drupal\Core\Logger\LoggerChannelInterface
   */
  public $logger;

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      // Implement default settings.
      'inline' => FALSE,
      'apply_dimensions' => TRUE,
      'width' => 25,
      'height' => 25,
      'enable_alt' => TRUE,
      'enable_title' => TRUE,
      'link' => '',
      'force_fill' => FALSE,
      'sanitize' => TRUE,
      'sanitize_remote' => FALSE,
    ] + parent::defaultSettings();
  }

  /**
   * Link types.
   *
   * @return array
   *   Link type options for formatter setting
   */
  private function getLinkTypes() {
    return [
      'content' => $this
        ->t('Content'),
      'file' => $this
        ->t('File'),
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $form = parent::settingsForm($form, $form_state);
    $form['inline'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Output SVG inline'),
      '#default_value' => $this
        ->getSetting('inline'),
      '#description' => $this
        ->t('Check this option if you want to manipulate the SVG image with CSS and JavaScript.
       Notice only trusted users should use fields with this option enabled because of
       <a href="@svg_security_link">inline svg security</a>', [
        '@svg_security_link' => 'https://www.w3.org/wiki/SVG_Security',
      ]),
    ];
    $inline_name = '[settings_edit_form][settings][inline]';
    $form['apply_dimensions'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Apply dimensions.'),
      '#default_value' => $this
        ->getSetting('apply_dimensions'),
      '#states' => [
        'visible' => [
          ':input[name$="' . $inline_name . '"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $dimensions_name = '[settings_edit_form][settings][apply_dimensions]';
    $form['width'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Image width.'),
      '#default_value' => $this
        ->getSetting('width'),
      '#states' => [
        'visible' => [
          ':input[name$="' . $inline_name . '"]' => [
            'checked' => TRUE,
          ],
          ':input[name$="' . $dimensions_name . '"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $form['height'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Image height.'),
      '#default_value' => $this
        ->getSetting('height'),
      '#states' => [
        'visible' => [
          ':input[name$="' . $inline_name . '"]' => [
            'checked' => TRUE,
          ],
          ':input[name$="' . $dimensions_name . '"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $form['force_fill'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Force the fill to currentColor'),
      '#description' => $this
        ->t('This can allow the SVG to inherit coloring from the enclosing tag, such as a link tag.'),
      '#default_value' => $this
        ->getSetting('force_fill'),
      '#states' => [
        'visible' => [
          ':input[name$="' . $inline_name . '"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $form['sanitize'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Sanitize SVG code'),
      '#description' => $this
        ->t('Sanitize the SVG XML code and prevent XSS attacks.'),
      '#default_value' => $this
        ->getSetting('sanitize'),
      '#states' => [
        'visible' => [
          ':input[name$="' . $inline_name . '"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $sanitize_name = '[settings_edit_form][settings][sanitize]';
    $form['sanitize_remote'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Sanitize: Remove remote references'),
      '#description' => $this
        ->t('Remove attributes that reference remote files, this will stop HTTP leaks but will add an overhead to the sanitizer.'),
      '#default_value' => $this
        ->getSetting('sanitize_remote'),
      '#states' => [
        'visible' => [
          ':input[name$="' . $inline_name . '"]' => [
            'checked' => TRUE,
          ],
          ':input[name$="' . $sanitize_name . '"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $form['link'] = [
      '#title' => $this
        ->t('Link image to'),
      '#type' => 'select',
      '#default_value' => $this
        ->getSetting('link'),
      '#empty_option' => $this
        ->t('Nothing'),
      '#options' => $this
        ->getLinkTypes(),
    ];
    $form['enable_alt'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Enable alt attribute.'),
      '#default_value' => $this
        ->getSetting('enable_alt'),
    ];
    $form['enable_title'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Enable title attribute.'),
      '#default_value' => $this
        ->getSetting('enable_title'),
    ];
    $form['notice'] = [
      '#type' => 'markup',
      '#markup' => '<div><small>' . $this
        ->t('Alt and title attributes will be created from an image filename by removing file extension and replacing eventual underscores and dashes with spaces.') . '</small></div>',
    ];
    return $form;
  }

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

    // Implement settings summary.
    if ($this
      ->getSetting('inline')) {
      $summary[] = $this
        ->t('Inline SVG');
    }
    if ($this
      ->getSetting('apply_dimensions') && $this
      ->getSetting('width')) {
      $summary[] = $this
        ->t('Image width: @width', [
        '@width' => $this
          ->getSetting('width'),
      ]);
    }
    if ($this
      ->getSetting('apply_dimensions') && $this
      ->getSetting('width')) {
      $summary[] = $this
        ->t('Image height: @height', [
        '@height' => $this
          ->getSetting('height'),
      ]);
    }
    if ($this
      ->getSetting('enable_alt')) {
      $summary[] = $this
        ->t('Alt enabled');
    }
    if ($this
      ->getSetting('enable_title')) {
      $summary[] = $this
        ->t('Title enabled');
    }
    $link_types = $this
      ->getLinkTypes();

    // Display this setting only if image is linked.
    $image_link_setting = $this
      ->getSetting('link');
    if (isset($link_types[$image_link_setting])) {
      $summary[] = $link_types[$image_link_setting];
    }
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $elements = [];
    $attributes = [];
    if ($this
      ->getSetting('apply_dimensions')) {
      $attributes['width'] = $this
        ->getSetting('width');
      $attributes['height'] = $this
        ->getSetting('height');
    }
    $url = NULL;
    $image_link_setting = $this
      ->getSetting('link');

    // Check if the formatter involves a link.
    if ($image_link_setting == 'content') {
      $entity = $items
        ->getEntity();
      if (!$entity
        ->isNew()) {
        $url = $entity
          ->toUrl();
      }
    }
    foreach ($items as $delta => $item) {
      if (!$item->entity) {
        continue;
      }
      $uri = $item->entity
        ->getFileUri();
      if (file_exists($uri) === FALSE) {
        $this->logger
          ->error('The specified file %file could not be displayed by image formatter due file not exists.', [
          '%file' => $uri,
        ]);
        continue;
      }
      $filename = $item->entity
        ->getFilename();
      $alt = !empty($item->alt) ? $item->alt : $this
        ->generateAltAttribute($filename);
      if ($this
        ->getSetting('enable_alt')) {
        if ($alt == '""') {
          $alt = '';
        }
        $attributes['alt'] = $alt;
      }
      if ($this
        ->getSetting('enable_title') && !empty($item->title)) {
        $attributes['title'] = $item->title;
      }
      $svg_data = NULL;
      if ($this
        ->getSetting('inline')) {
        $svg_file = file_get_contents($uri);
        $dom = new \DOMDocument();
        libxml_use_internal_errors(TRUE);
        $dom
          ->loadXML($svg_file);
        if ($this
          ->getSetting('force_fill')) {
          $dom->documentElement
            ->setAttribute('fill', 'currentColor');
        }
        if (isset($dom->documentElement)) {
          if ($this
            ->getSetting('apply_dimensions')) {
            $dom->documentElement
              ->setAttribute('height', $attributes['height']);
            $dom->documentElement
              ->setAttribute('width', $attributes['width']);
          }
          $svg_data = $dom
            ->saveXML($dom->documentElement);
        }
        else {
          $svg_data = $dom
            ->saveXML();
        }
        if ($this
          ->getSetting('sanitize')) {
          $svgSanitizer = new Sanitizer();
          if ($this
            ->getSetting('sanitize_remote')) {
            $svgSanitizer
              ->removeRemoteReferences(TRUE);
          }
          $svg_data = $svgSanitizer
            ->sanitize($svg_data);
        }
      }
      $cache_contexts = [];
      if ($image_link_setting == 'file') {

        // @todo Wrap in file_url_transform_relative(). This is currently
        // impossible. As a work-around, we currently add the 'url.site' cache
        // context to ensure different file URLs are generated for different
        // sites in a multisite setup, including HTTP and HTTPS versions of the
        // same site. Fix in https://www.drupal.org/node/2646744.
        $url = Url::fromUri(file_create_url($uri));
        $cache_contexts[] = 'url.site';
      }
      $elements[$delta] = [
        '#theme' => 'svg_image_field_formatter',
        '#inline' => $this
          ->getSetting('inline') ? TRUE : FALSE,
        '#attributes' => $attributes,
        '#uri' => $this
          ->getSetting('inline') ? NULL : $uri,
        '#svg_data' => $svg_data,
        '#link_url' => $url,
        '#cache' => [
          'tags' => $item->entity
            ->getCacheTags(),
          'contexts' => $cache_contexts,
        ],
      ];
    }
    return $elements;
  }

  /**
   * Generate alt attribute from an image filename.
   */
  private function generateAltAttribute($filename) {
    $alt = str_replace([
      '.svg',
      '-',
      '_',
    ], [
      '',
      ' ',
      ' ',
    ], $filename);
    $alt = ucfirst($alt);
    return $alt;
  }

  /**
   * Constructs a SvgImageFieldFormatter object.
   *
   * @param string $plugin_id
   *   The plugin_id for the formatter.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
   *   The definition of the field to which the formatter is associated.
   * @param array $settings
   *   The formatter settings.
   * @param string $label
   *   The formatter label display setting.
   * @param string $view_mode
   *   The view mode.
   * @param array $third_party_settings
   *   Any third party settings.
   * @param \Drupal\Core\Logger\LoggerChannelFactoryInterface $logger
   *   Logger.
   */
  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, $label, $view_mode, array $third_party_settings, LoggerChannelFactoryInterface $logger) {
    $this->logger = $logger
      ->get('svg_image_field');
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings);
  }

  /**
   * {@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('logger.factory'));
  }

}

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
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
FormatterBase::prepareView public function Allows formatters to load information for field values being displayed. Overrides FormatterInterface::prepareView 2
FormatterBase::view public function Builds a renderable array for a fully themed field. Overrides FormatterInterface::view 1
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::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. 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.
SvgImageFieldFormatter::$logger public property Logger.
SvgImageFieldFormatter::create public static function Creates an instance of the plugin. Overrides FormatterBase::create
SvgImageFieldFormatter::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
SvgImageFieldFormatter::generateAltAttribute private function Generate alt attribute from an image filename.
SvgImageFieldFormatter::getLinkTypes private function Link types.
SvgImageFieldFormatter::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
SvgImageFieldFormatter::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
SvgImageFieldFormatter::viewElements public function Builds a renderable array for a field value. Overrides FormatterInterface::viewElements
SvgImageFieldFormatter::__construct public function Constructs a SvgImageFieldFormatter object. Overrides FormatterBase::__construct