You are here

Home » API reference » SVG Image Field 2.0.x » SvgImageFieldWidget.php

class SvgImageFieldWidget in SVG Image Field 2.0.x

Same name and namespace in other branches
  1. 8 src/Plugin/Field/FieldWidget/SvgImageFieldWidget.php \Drupal\svg_image_field\Plugin\Field\FieldWidget\SvgImageFieldWidget
  2. 2.1.x src/Plugin/Field/FieldWidget/SvgImageFieldWidget.php \Drupal\svg_image_field\Plugin\Field\FieldWidget\SvgImageFieldWidget

Plugin implementation of the 'image_image' widget.

Plugin annotation


@FieldWidget(
  id = "svg_image_field_widget",
  label = @Translation("SVG image"),
  field_types = {
    "svg_image_field"
  }
)

Hierarchy

Expanded class hierarchy of SvgImageFieldWidget

File

src/Plugin/Field/FieldWidget/SvgImageFieldWidget.php, line 27

Namespace

Drupal\svg_image_field\Plugin\Field\FieldWidget
View source 
class SvgImageFieldWidget extends FileWidget {

  /**
   * The renderer service.
   *
   * @var \Drupal\Core\Render\Renderer
   */
  protected $renderer;

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

  /**
   * {@inheritdoc}
   */
  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, array $third_party_settings, ElementInfoManagerInterface $element_info, Renderer $renderer, EntityRepositoryInterface $entity_repository) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $third_party_settings, $element_info);
    $this->renderer = $renderer;
    $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['third_party_settings'], $container
      ->get('element_info'), $container
      ->get('renderer'), $container
      ->get('entity.repository'));
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'progress_indicator' => 'throbber',
      'preview_image_max_width' => 300,
      'preview_image_max_height' => 300,
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $element = parent::settingsForm($form, $form_state);
    $element['preview_image_max_width'] = [
      '#title' => t('Preview image max width'),
      '#type' => 'number',
      '#default_value' => $this
        ->getSetting('preview_image_max_width'),
      '#weight' => 15,
    ];
    $element['preview_image_max_height'] = [
      '#title' => t('Preview image max height'),
      '#type' => 'number',
      '#default_value' => $this
        ->getSetting('preview_image_max_height'),
      '#weight' => 16,
    ];
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = parent::settingsSummary();
    $preview_image_max_width = t('Preview image width: @width', [
      '@width' => $this
        ->getSetting('preview_image_max_width'),
    ]);
    $preview_image_max_height = t('Preview image height: @height', [
      '@height' => $this
        ->getSetting('preview_image_max_height'),
    ]);
    array_unshift($summary, $preview_image_max_width);
    array_unshift($summary, $preview_image_max_height);
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  protected function formMultipleElements(FieldItemListInterface $items, array &$form, FormStateInterface $form_state) {
    $elements = parent::formMultipleElements($items, $form, $form_state);
    $cardinality = $this->fieldDefinition
      ->getFieldStorageDefinition()
      ->getCardinality();
    $file_upload_help = [
      '#theme' => 'file_upload_help',
      '#description' => '',
      '#upload_validators' => $elements[0]['#upload_validators'],
      '#cardinality' => $cardinality,
    ];
    if ($cardinality == 1) {

      // If there's only one field, return it as delta 0.
      if (empty($elements[0]['#default_value']['fids'])) {
        $file_upload_help['#description'] = $this
          ->getFilteredDescription();
        $elements[0]['#description'] = $this->renderer
          ->renderPlain($file_upload_help);
      }
    }
    else {
      $elements['#file_upload_description'] = $file_upload_help;
    }
    return $elements;
  }

  /**
   * {@inheritdoc}
   */
  public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
    $element = parent::formElement($items, $delta, $element, $form, $form_state);
    $field_settings = $this
      ->getFieldSettings();
    $element['#upload_validators']['file_validate_extensions'][0] = 'svg';
    $element['#upload_validators']['svg_image_field_validate_mime_type'] = [];

    // Add properties needed by process() method.
    $element['#preview_image_max_width'] = $this
      ->getSetting('preview_image_max_width');
    $element['#preview_image_max_height'] = $this
      ->getSetting('preview_image_max_height');
    $element['#title_field'] = $field_settings['title_field'];
    $element['#title_field_required'] = $field_settings['title_field_required'];
    $element['#alt_field'] = $field_settings['alt_field'];
    $element['#alt_field_required'] = $field_settings['alt_field_required'];

    // Default image.
    $default_image = $field_settings['default_image'];
    if (empty($default_image['uuid'])) {
      $default_image = $this->fieldDefinition
        ->getFieldStorageDefinition()
        ->getSetting('default_image');
    }

    // Convert the stored UUID into a file ID.
    if (!empty($default_image['uuid']) && ($entity = $this->entityRepository
      ->loadEntityByUuid('file', $default_image['uuid']))) {
      $default_image['fid'] = $entity
        ->id();
    }
    $element['#default_image'] = !empty($default_image['fid']) ? $default_image : [];
    return $element;
  }

  /**
   * Form API callback: Processes a image_image field element.
   *
   * Expands the image_image type to include the alt and title fields.
   *
   * This method is assigned as a #process callback in formElement() method.
   */
  public static function process($element, FormStateInterface $form_state, $form) {
    $item = $element['#value'];
    $item['fids'] = $element['fids']['#value'];
    $element['#theme'] = 'image_widget';

    // Add the image preview.
    if (!empty($element['#files']) && ($element['#preview_image_max_width'] || $element['#preview_image_max_height'])) {
      $file = reset($element['#files']);
      $attributes = [
        'style' => '',
      ];
      if (!empty($element['#preview_image_max_width'])) {
        $attributes['style'] = "max-width: {$element['#preview_image_max_width']}px;";
        $attributes['width'] = $element['#preview_image_max_width'];
      }
      if (!empty($element['#preview_image_max_height'])) {
        $attributes['style'] .= "max-height: {$element['#preview_image_max_height']}px;";
        if (empty($attributes['width'])) {
          $attributes['height'] = $element['#preview_image_max_height'];
        }
      }
      if (!empty($item['alt'])) {
        $attributes['alt'] = $item['alt'];
        $attributes['title'] = $attributes['alt'];
      }
      $element['preview'] = [
        '#theme' => 'svg_image_field_formatter',
        '#inline' => FALSE,
        '#attributes' => $attributes,
        '#uri' => $file
          ->getFileUri(),
        '#svg_data' => NULL,
      ];
    }
    elseif (!empty($element['#default_image'])) {
      $default_image = $element['#default_image'];
      $file = File::load($default_image['fid']);
      if (!empty($file)) {
        $attributes = [
          'style' => '',
        ];
        if (!empty($element['#preview_image_max_width'])) {
          $attributes['style'] = "max-width={$element['#preview_image_max_width']}px;";
          $attributes['width'] = $element['#preview_image_max_width'];
        }
        if (!empty($element['#preview_image_max_height'])) {
          $attributes['style'] .= "max-height={$element['#preview_image_max_height']}px;";
          if (empty($attributes['width'])) {
            $attributes['height'] = $element['#preview_image_max_height'];
          }
        }
        $element['preview'] = [
          '#weight' => -10,
          '#theme' => 'svg_image_field_formatter',
          '#inline' => FALSE,
          '#attributes' => $attributes,
          '#uri' => $file
            ->getFileUri(),
          '#svg_data' => NULL,
        ];
      }
    }

    // Add the additional alt and title fields.
    $element['alt'] = [
      '#title' => t('Alternative text'),
      '#type' => 'textfield',
      '#default_value' => isset($item['alt']) ? $item['alt'] : '',
      '#description' => t('This text will be used by screen readers, search engines, or when the image cannot be loaded.'),
      // @see https://www.drupal.org/node/465106#alt-text
      '#maxlength' => 512,
      '#weight' => -12,
      '#access' => (bool) $item['fids'] && $element['#alt_field'],
      '#required' => $element['#alt_field_required'],
      '#element_validate' => $element['#alt_field_required'] == 1 ? [
        [
          get_called_class(),
          'validateRequiredFields',
        ],
      ] : [],
    ];
    $element['title'] = [
      '#type' => 'textfield',
      '#title' => t('Title'),
      '#default_value' => isset($item['title']) ? $item['title'] : '',
      '#description' => t('The title is used as a tool tip when the user hovers the mouse over the image.'),
      '#maxlength' => 1024,
      '#weight' => -11,
      '#access' => (bool) $item['fids'] && $element['#title_field'],
      '#required' => $element['#title_field_required'],
      '#element_validate' => $element['#title_field_required'] == 1 ? [
        [
          get_called_class(),
          'validateRequiredFields',
        ],
      ] : [],
    ];
    return parent::process($element, $form_state, $form);
  }

  /**
   * Validate callback for alt and title field, if the user wants them required.
   *
   * This is separated in a validate function instead of a #required flag to
   * avoid being validated on the process callback.
   */
  public static function validateRequiredFields($element, FormStateInterface $form_state) {

    // Only do validation if the function is triggered from other places than
    // the image process form.
    if (!empty($form_state
      ->getTriggeringElement()['#submit']) && !in_array('file_managed_file_submit', $form_state
      ->getTriggeringElement()['#submit'])) {

      // If the image is not there, we do not check for empty values.
      $parents = $element['#parents'];
      $field = array_pop($parents);
      $image_field = NestedArray::getValue($form_state
        ->getUserInput(), $parents);

      // We check for the array key, so that it can be NULL (like if the user
      // submits the form without using the "upload" button).
      if (!array_key_exists($field, $image_field)) {
        return;
      }
    }
    else {
      $form_state
        ->setLimitValidationErrors([]);
    }
  }

}

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
FileWidget::extractFormValues public function Extracts field values from submitted form values. Overrides WidgetBase::extractFormValues
FileWidget::flagErrors public function Reports field-level validation errors against actual form elements. Overrides WidgetBase::flagErrors
FileWidget::getDescriptionFromElement protected static function Retrieves the file description from a field field element.
FileWidget::massageFormValues public function Massages the form values into the format expected for field values. Overrides WidgetBase::massageFormValues
FileWidget::processMultiple public static function Form API callback: Processes a group of file_generic field elements.
FileWidget::submit public static function Form submission handler for upload/remove button of formElement().
FileWidget::validateMultipleCount public static function Form element validation callback for upload element on file widget. Checks if user has uploaded more files than allowed.
FileWidget::value public static function Form API callback. Retrieves the value for the file_generic field element.
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.
SvgImageFieldWidget::$entityRepository protected property The entity repository Service.
SvgImageFieldWidget::$renderer protected property The renderer service.
SvgImageFieldWidget::create public static function Creates an instance of the plugin. Overrides FileWidget::create
SvgImageFieldWidget::defaultSettings public static function Defines the default settings for this plugin. Overrides FileWidget::defaultSettings
SvgImageFieldWidget::formElement public function Returns the form for a single field widget. Overrides FileWidget::formElement
SvgImageFieldWidget::formMultipleElements protected function Overrides \Drupal\Core\Field\WidgetBase::formMultipleElements(). Overrides FileWidget::formMultipleElements
SvgImageFieldWidget::process public static function Form API callback: Processes a image_image field element. Overrides FileWidget::process
SvgImageFieldWidget::settingsForm public function Returns a form to configure settings for the widget. Overrides FileWidget::settingsForm
SvgImageFieldWidget::settingsSummary public function Returns a short summary for the current widget settings. Overrides FileWidget::settingsSummary
SvgImageFieldWidget::validateRequiredFields public static function Validate callback for alt and title field, if the user wants them required.
SvgImageFieldWidget::__construct public function Constructs a WidgetBase object. Overrides FileWidget::__construct
WidgetBase::$fieldDefinition protected property The field definition.
WidgetBase::$settings protected property The widget settings. Overrides PluginSettingsBase::$settings
WidgetBase::addMoreAjax public static function Ajax callback for the "Add another item" button.
WidgetBase::addMoreSubmit public static function Submission handler for the "Add another item" button.
WidgetBase::afterBuild public static function After-build handler for field elements in a form.
WidgetBase::errorElement public function Assigns a field-level validation error to the right widget sub-element. Overrides WidgetInterface::errorElement 8
WidgetBase::form public function Creates a form element for a field. Overrides WidgetBaseInterface::form 3
WidgetBase::formSingleElement protected function Generates the form element for a single copy of the widget.
WidgetBase::getFieldSetting protected function Returns the value of a field setting.
WidgetBase::getFieldSettings protected function Returns the array of field settings.
WidgetBase::getFilteredDescription protected function Returns the filtered field description.
WidgetBase::getWidgetState public static function Retrieves processing information about the widget from $form_state. Overrides WidgetBaseInterface::getWidgetState
WidgetBase::getWidgetStateParents protected static function Returns the location of processing information within $form_state.
WidgetBase::handlesMultipleValues protected function Returns whether the widget handles multiple values.
WidgetBase::isApplicable public static function Returns if the widget can be used for the provided field. Overrides WidgetInterface::isApplicable 4
WidgetBase::isDefaultValueWidget protected function Returns whether the widget used for default value form.
WidgetBase::setWidgetState public static function Stores processing information about the widget in $form_state. Overrides WidgetBaseInterface::setWidgetState