You are here

Home » API reference » Exif 8 » ExifWidgetBase.php

abstract class ExifWidgetBase in Exif 8

Same name and namespace in other branches
  1. 8.2 src/Plugin/Field/FieldWidget/ExifWidgetBase.php \Drupal\exif\Plugin\Field\FieldWidget\ExifWidgetBase

Base class for 'Exif Field widget' plugin implementations.

Hierarchy

Expanded class hierarchy of ExifWidgetBase

File

src/Plugin/Field/FieldWidget/ExifWidgetBase.php, line 15

Namespace

Drupal\exif\Plugin\Field\FieldWidget
View source 
abstract class ExifWidgetBase extends WidgetBase {
  const EXIF_BASE_DEFAULT_SETTINGS = [
    'image_field' => NULL,
  ];

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return ExifWidgetBase::EXIF_BASE_DEFAULT_SETTINGS + parent::defaultSettings();
  }

  /**
   * Validate field to ensure it is linked to a image field.
   *
   * Use in settingsForm callback.
   *
   * @param array $element
   *   A form element array containing basic properties for the widget.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   * @param array $form
   *   The form structure where widgets are being attached to.
   */
  public static function validateImageField(array $element, FormStateInterface $form_state, array $form) {
    $elementSettings = $form_state
      ->getValue($element['#parents']);
    if (!$elementSettings) {
      $field_storage_definitions = Drupal::getContainer()
        ->get('entity_field.manager')
        ->getFieldStorageDefinitions($form['#entity_type']);
      $field_storage = $field_storage_definitions[$element['#field_name']];
      if ($field_storage) {
        $args = [
          '%field' => $field_storage
            ->getName(),
        ];
        $message = t('Field %field must be link to an image field.', $args);
      }
      else {
        $message = t('Field must be link to an image field.');
      }
      $form_state
        ->setErrorByName('image_field', $message);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $element = parent::settingsForm($form, $form_state);
    if ($form['#entity_type'] == "node" || $form['#entity_type'] == "media") {
      $image_fields = $this
        ->retrieveImageFieldFromBundle($form['#entity_type'], $form['#bundle']);
      $default_image_value = $this
        ->retrieveImageFieldDefaultValue($element, $image_fields);
      $element['image_field'] = [
        '#type' => 'radios',
        '#title' => t('image field to use to retrieve data'),
        '#description' => t('determine the image used to look for exif and iptc metadata'),
        '#options' => $image_fields,
        '#default_value' => $default_image_value,
        '#element_validate' => [
          [
            get_class($this),
            'validateImageField',
          ],
        ],
      ];
    }
    if ($form['#entity_type'] == "file") {
      $element['image_field'] = [
        '#type' => 'hidden',
        '#default_value' => "file",
        '#value' => "file",
      ];
    }
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = parent::settingsSummary();
    $image_field = $this
      ->getSetting('image_field');
    if (isset($image_field)) {
      $bundle_name = $this->fieldDefinition
        ->getTargetBundle();
      $entity_type = $this->fieldDefinition
        ->getTargetEntityTypeId();
      $image_field_config = Drupal::getContainer()
        ->get('entity_field.manager')
        ->getFieldDefinitions($entity_type, $bundle_name)[$image_field];
      if ($image_field_config instanceof FieldConfig) {
        if ($image_field_config
          ->getType() == "image" || $image_field_config
          ->getType() == "media") {
          $label = t("'@image_linked_label' (id: @image_linked_id)", [
            '@image_linked_label' => $image_field_config
              ->getLabel(),
            '@image_linked_id' => $image_field,
          ]);
        }
        else {
          $label = $image_field;
        }
      }
      $image_field_msg = t("exif will be extracted from image field @image", [
        '@image' => $label,
      ]);
    }
    else {
      $image_field_msg = t('No image chosen. field will stay empty.');
    }
    array_unshift($summary, $image_field_msg);
    return $summary;
  }

  /**
   * Retrieve list of image field labels by key of image field.
   *
   * @param string $entity_type
   *   Entity Type name.
   * @param string $bundle_name
   *   Name bundle.
   *
   * @return array
   *   Map of all images fields contained in this bundle by key and description.
   */
  protected function retrieveImageFieldFromBundle($entity_type, $bundle_name) {
    $fields_of_bundle = Drupal::getContainer()
      ->get('entity_field.manager')
      ->getFieldDefinitions($entity_type, $bundle_name);
    $result = [];
    foreach ($fields_of_bundle as $key => $value) {
      if ($value instanceof FieldConfig) {
        if ($value
          ->getType() == "image" || $value
          ->getType() == "media") {
          $result[$key] = $value
            ->getLabel() . " (" . $key . ")";
        }
      }
    }
    return $result;
  }

  /**
   * Calculate default value for settings form.
   *
   * More precisely, it calculate default value
   * for image_field setting of widget.
   *
   * simple implementation: Look for the first image field found.
   *
   * @param array $widget
   *   Widget we are checking.
   * @param array $image_fields
   *   Image fields links to this widget.
   *
   * @return string
   *   First image field found or NULL if none.
   */
  protected function retrieveImageFieldDefaultValue(array $widget, array $image_fields) {
    if (array_key_exists('settings', $widget) && array_key_exists('image_field', $widget['settings'])) {
      $result = $widget['settings']['image_field'];
    }
    else {
      $result = NULL;
    }
    if (empty($result)) {

      // Look for the first image field found.
      $temp = array_keys($image_fields);
      if (!empty($temp) && is_array($temp)) {
        $result = $temp[0];
      }
    }
    return $result;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AllowedTagsXssTrait::allowedTags public function Returns a list of tags allowed by AllowedTagsXssTrait::fieldFilterXss().
AllowedTagsXssTrait::displayAllowedTags public function Returns a human-readable list of allowed tags for display in help texts.
AllowedTagsXssTrait::fieldFilterXss public function Filters an HTML string to prevent XSS vulnerabilities.
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
ExifWidgetBase::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings 2
ExifWidgetBase::EXIF_BASE_DEFAULT_SETTINGS constant
ExifWidgetBase::retrieveImageFieldDefaultValue protected function Calculate default value for settings form.
ExifWidgetBase::retrieveImageFieldFromBundle protected function Retrieve list of image field labels by key of image field.
ExifWidgetBase::settingsForm public function Returns a form to configure settings for the widget. Overrides WidgetBase::settingsForm 1
ExifWidgetBase::settingsSummary public function Returns a short summary for the current widget settings. Overrides WidgetBase::settingsSummary 1
ExifWidgetBase::validateImageField public static function Validate field to ensure it is linked to a image field.
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.
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::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 5
WidgetBase::errorElement public function Assigns a field-level validation error to the right widget sub-element. Overrides WidgetInterface::errorElement 8
WidgetBase::extractFormValues public function Extracts field values from submitted form values. Overrides WidgetBaseInterface::extractFormValues 2
WidgetBase::flagErrors public function Reports field-level validation errors against actual form elements. Overrides WidgetBaseInterface::flagErrors 2
WidgetBase::form public function Creates a form element for a field. Overrides WidgetBaseInterface::form 3
WidgetBase::formMultipleElements protected function Special handling to create form elements for multiple values. 1
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::massageFormValues public function Massages the form values into the format expected for field values. Overrides WidgetInterface::massageFormValues 7
WidgetBase::setWidgetState public static function Stores processing information about the widget in $form_state. Overrides WidgetBaseInterface::setWidgetState
WidgetBase::__construct public function Constructs a WidgetBase object. Overrides PluginBase::__construct 5
WidgetInterface::formElement public function Returns the form for a single field widget. 22