You are here

Home » API reference » SVG Formatter 8 » SvgFormatter.php

class SvgFormatter in SVG Formatter 8

Plugin implementation of the 'svg_formatter' formatter.

Plugin annotation


@FieldFormatter(
  id = "svg_formatter",
  label = @Translation("SVG Formatter"),
  field_types = {
    "file",
    "image"
  }
)

Hierarchy

Expanded class hierarchy of SvgFormatter

File

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

Namespace

Drupal\svg_formatter\Plugin\Field\FieldFormatter
View source 
class SvgFormatter extends FormatterBase implements ContainerFactoryPluginInterface {

  /**
   * The name of the field to which the formatter is associated.
   *
   * @var string
   */
  protected $fieldName;

  /**
   * Module handler.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  protected $moduleHandler;

  /**
   * Token service.
   *
   * @var \Drupal\Core\Utility\Token
   */
  protected $token;

  /**
   * The entity repository.
   *
   * @var \Drupal\Core\Entity\EntityRepositoryInterface
   */
  protected $entityRepository;

  /**
   * {@inheritdoc}
   */
  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, $label, $view_mode, array $third_party_settings, ModuleHandlerInterface $module_handler, Token $token, EntityRepositoryInterface $entity_repository) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings);
    $this->fieldName = $field_definition
      ->getName();
    $this->moduleHandler = $module_handler;
    $this->token = $token;
    $this->entityRepository = $entity_repository;
  }

  /**
   * {@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('module_handler'), $container
      ->get('token'), $container
      ->get('entity.repository'));
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'inline' => FALSE,
      'sanitize' => TRUE,
      'apply_dimensions' => TRUE,
      'width' => 100,
      'height' => 100,
      'enable_alt' => TRUE,
      'alt_string' => '',
      'enable_title' => TRUE,
      'title_string' => '',
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $form = parent::settingsForm($form, $form_state);
    $token_module = $this->moduleHandler
      ->moduleExists('token');
    $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.'),
    ];
    $sanitize_attributes = $this
      ->isSanitizerInstalled() ? [] : [
      'disabled' => 'disabled',
    ];
    $form['sanitize'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Sanitize inline SVG'),
      '#default_value' => $this
        ->getSetting('sanitize'),
      '#description' => $this
        ->t('For this to work you must install "enshrined/svg-sanitize" library with composer.'),
      '#states' => [
        'visible' => [
          ':input[name="fields[' . $this->fieldName . '][settings_edit_form][settings][inline]"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
      '#attributes' => $sanitize_attributes,
    ];
    $form['apply_dimensions'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Set image dimensions.'),
      '#default_value' => $this
        ->getSetting('apply_dimensions'),
    ];
    $form['width'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Image width.'),
      '#default_value' => $this
        ->getSetting('width'),
      '#states' => [
        'visible' => [
          ':input[name="fields[' . $this->fieldName . '][settings_edit_form][settings][apply_dimensions]"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $form['height'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Image height.'),
      '#default_value' => $this
        ->getSetting('height'),
      '#states' => [
        'visible' => [
          ':input[name="fields[' . $this->fieldName . '][settings_edit_form][settings][apply_dimensions]"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $form['enable_alt'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Enable alt attribute.'),
      '#default_value' => $this
        ->getSetting('enable_alt'),
      '#states' => [
        'visible' => [
          ':input[name="fields[' . $this->fieldName . '][settings_edit_form][settings][inline]"]' => [
            'checked' => FALSE,
          ],
        ],
      ],
    ];
    $form['alt_string'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Token with alt value'),
      '#description' => $token_module ? $this
        ->t('Use the token help link below to select the token.') : $this
        ->t('Install token module to see available tokens.'),
      '#default_value' => $this
        ->getSetting('alt_string'),
      '#states' => [
        'visible' => [
          ':input[name="fields[' . $this->fieldName . '][settings_edit_form][settings][enable_alt]"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $form['enable_title'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Enable title attribute.'),
      '#default_value' => $this
        ->getSetting('enable_title'),
      '#states' => [
        'visible' => [
          ':input[name="fields[' . $this->fieldName . '][settings_edit_form][settings][inline]"]' => [
            'checked' => FALSE,
          ],
        ],
      ],
    ];
    $form['title_string'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Token with title value'),
      '#description' => $token_module ? $this
        ->t('Use the token help link below to select the token.') : $this
        ->t('Install token module to see available tokens.'),
      '#default_value' => $this
        ->getSetting('title_string'),
      '#states' => [
        'visible' => [
          ':input[name="fields[' . $this->fieldName . '][settings_edit_form][settings][enable_title]"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    if ($token_module) {
      $form['token_help'] = [
        '#theme' => 'token_tree_link',
        '#token_types' => [
          $this->fieldDefinition
            ->getTargetEntityTypeId(),
          'file',
        ],
      ];
    }
    return $form;
  }

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

    // Implement settings summary.
    if ($this
      ->getSetting('inline')) {
      $summary[] = $this
        ->t('Inline SVG');
    }
    if ($this
      ->getSetting('sanitize')) {
      $summary[] = $this
        ->t('Sanitize inline SVG');
    }
    if ($this
      ->getSetting('apply_dimensions') && $this
      ->getSetting('width')) {
      $summary[] = $this
        ->t('Image width:') . ' ' . $this
        ->getSetting('width');
    }
    if ($this
      ->getSetting('apply_dimensions') && $this
      ->getSetting('height')) {
      $summary[] = $this
        ->t('Image height:') . ' ' . $this
        ->getSetting('height');
    }
    if ($this
      ->getSetting('enable_alt') && !$this
      ->getSetting('inline')) {
      $summary[] = $this
        ->t('Alt enabled');
      if ($this
        ->getSetting('alt_string')) {
        $summary[] = $this
          ->t('Alt token:') . ' ' . $this
          ->getSetting('alt_string');
      }
    }
    if ($this
      ->getSetting('enable_title') && !$this
      ->getSetting('inline')) {
      $summary[] = $this
        ->t('Title enabled');
      if ($this
        ->getSetting('title_string')) {
        $summary[] = $this
          ->t('Title token:') . ' ' . $this
          ->getSetting('title_string');
      }
    }
    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');
    }
    foreach ($items as $delta => $item) {
      if ($item->entity) {
        $file = $item->entity;
        $parent = $items
          ->getParent()
          ->getEntity();

        // Skip if this is not a SVG image.
        if ($item->entity
          ->getMimeType() !== 'image/svg+xml') {
          continue;
        }
        $filename = $item->entity
          ->getFilename();
        $default_alt = $this
          ->generateAltAttribute($filename);
        $token_data = [
          'file' => $this->entityRepository
            ->getTranslationFromContext($file),
          $parent
            ->getEntityTypeId() => $this->entityRepository
            ->getTranslationFromContext($parent),
        ];
        $replace_options = [
          'clear' => TRUE,
        ];
        if ($this
          ->getSetting('enable_alt')) {
          if ($this
            ->getSetting('alt_string')) {
            if ($alt = $this->token
              ->replace($this
              ->getSetting('alt_string'), $token_data, $replace_options)) {
              $attributes['alt'] = $alt;
            }
          }
          else {
            $attributes['alt'] = $default_alt;
          }
        }
        if ($this
          ->getSetting('enable_title')) {
          if ($this
            ->getSetting('title_string')) {
            if ($title = $this->token
              ->replace($this
              ->getSetting('title_string'), $token_data, $replace_options)) {
              $attributes['title'] = $title;
            }
          }
          else {
            $attributes['title'] = $default_alt;
          }
        }
        $uri = $item->entity
          ->getFileUri();
        $svg_data = NULL;
        if ($this
          ->getSetting('inline')) {
          $svg_file = file_exists($uri) ? file_get_contents($uri) : NULL;

          // Sanitize inline SVG if sanitizing library is installed.
          if ($svg_file && $this
            ->isSanitizerInstalled() && $this
            ->getSetting('sanitize')) {
            $sanitizer = new Sanitizer();
            $svg_file = $sanitizer
              ->sanitize($svg_file);
          }
          if ($svg_file) {
            $dom = new \DOMDocument();
            libxml_use_internal_errors(TRUE);
            $dom
              ->loadXML($svg_file);
            if ($this
              ->getSetting('apply_dimensions') && isset($dom->documentElement)) {
              $dom->documentElement
                ->setAttribute('height', $attributes['height']);
              $dom->documentElement
                ->setAttribute('width', $attributes['width']);
            }
            if ($this
              ->getSetting('enable_title') && isset($dom->documentElement)) {
              $title = $dom
                ->createElement('title', $attributes['title']);
              $title_id = $this->fieldName . '__title-' . $delta;
              $title
                ->setAttribute('id', $title_id);
              $dom->documentElement
                ->insertBefore($title, $dom->documentElement->firstChild);
              $dom->documentElement
                ->setAttribute('aria-labelledby', $title_id);
            }
            $svg_data = $dom
              ->saveXML($dom->documentElement);
          }
        }
        $elements[$delta] = [
          '#theme' => 'svg_formatter',
          '#inline' => $this
            ->getSetting('inline') ? TRUE : FALSE,
          '#attributes' => $attributes,
          '#uri' => $this
            ->getSetting('inline') ? NULL : $uri,
          '#svg_data' => $this
            ->getSetting('inline') ? $svg_data : NULL,
        ];
      }
    }
    return $elements;
  }

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

  /**
   * Checks if "enshrined/svg-sanitize" library is installed.
   */
  protected function isSanitizerInstalled() {
    return class_exists('\\enshrined\\svgSanitize\\Sanitizer');
  }

  /**
   * {@inheritdoc}
   */
  public static function isApplicable(FieldDefinitionInterface $field_definition) {
    if ($field_definition
      ->getType() == 'image') {
      $module_handler = \Drupal::service('module_handler');
      if ($module_handler
        ->moduleExists('svg_image')) {
        return TRUE;
      }
      else {
        return FALSE;
      }
    }
    return TRUE;
  }

}

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
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::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. 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.
SvgFormatter::$entityRepository protected property The entity repository.
SvgFormatter::$fieldName protected property The name of the field to which the formatter is associated.
SvgFormatter::$moduleHandler protected property Module handler.
SvgFormatter::$token protected property Token service.
SvgFormatter::create public static function Creates an instance of the plugin. Overrides FormatterBase::create
SvgFormatter::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
SvgFormatter::generateAltAttribute protected function Generates alt attribute from an image filename.
SvgFormatter::isApplicable public static function Returns if the formatter can be used for the provided field. Overrides FormatterBase::isApplicable
SvgFormatter::isSanitizerInstalled protected function Checks if "enshrined/svg-sanitize" library is installed.
SvgFormatter::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
SvgFormatter::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
SvgFormatter::viewElements public function Builds a renderable array for a field value. Overrides FormatterInterface::viewElements
SvgFormatter::__construct public function Constructs a FormatterBase object. Overrides FormatterBase::__construct