You are here

Home » API reference » Exif 8 » ExifFieldWidgetBase.php

abstract class ExifFieldWidgetBase in Exif 8

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

Class ExifFieldWidgetBase provide base methods for all widgets.

@package Drupal\exif\Plugin\Field\FieldWidget

Hierarchy

Expanded class hierarchy of ExifFieldWidgetBase

File

src/Plugin/Field/FieldWidget/ExifFieldWidgetBase.php, line 13

Namespace

Drupal\exif\Plugin\Field\FieldWidget
View source 
abstract class ExifFieldWidgetBase extends ExifWidgetBase {

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'exif_field_separator' => '',
      'exif_field' => 'naming_convention',
    ] + parent::defaultSettings();
  }

  /**
   * Ensure field is correctly configured.
   *
   * @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 validateExifField(array $element, FormStateInterface $form_state, array $form) {
    $elementSettings = $form_state
      ->getValue($element['#parents']);
    if (!$elementSettings) {
      $message = t('you must choose at least one method to retrieve image metadata.');
      $form_state
        ->setErrorByName('exif_field', $message);
    }
  }

  /**
   * Ensure field separator is correctly configured.
   *
   * @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.
   */
  public static function validateExifFieldSeparator(array $element, FormStateInterface &$form_state) {
    $elementSettings = $form_state
      ->getValue($element['#parents']);
    if (!empty($elementSettings) && strlen($elementSettings) > 1) {
      $message = t('the separator is only one character long.');
      $form_state
        ->setErrorByName('exif_field_separator', $message);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $element = parent::settingsForm($form, $form_state);
    $exif_fields = $this
      ->retrieveExifFields();
    $default_exif_value = $this
      ->retrieveExifFieldDefaultValue();
    $default_exif_separator_value = $this
      ->retrieveExifFieldDefaultSeparatorValue();
    $element['exif_field'] = [
      '#type' => 'select',
      '#title' => t('exif field data'),
      '#description' => t('choose to retrieve data from the image field referenced with the selected name or by naming convention.'),
      '#options' => array_merge([
        'naming_convention' => 'name of the field is used as the exif field name',
      ], $exif_fields),
      '#default_value' => $default_exif_value,
      '#element_validate' => [
        [
          get_class($this),
          'validateExifField',
        ],
      ],
    ];
    $element['exif_field_separator'] = [
      '#type' => 'textfield',
      '#title' => t('exif field separator'),
      '#description' => t('separator used to split values (if field definition support several values). let it empty if you do not want to split values.'),
      '#default_value' => $default_exif_separator_value,
      '#element_validate' => [
        [
          get_class($this),
          'validateExifFieldSeparator',
        ],
      ],
    ];
    return $element;
  }

  /**
   * List of possible fields.
   *
   * @return array
   *   List of possible exif fields.
   */
  private function retrieveExifFields() {
    $exif = ExifFactory::getExifInterface();
    return $exif
      ->getFieldKeys();
  }

  /**
   * Get exif field name associated to this drupal field.
   *
   * If none found, use naming convention.
   *
   * @return string
   *   name of the exif field or string 'naming_convention'.
   */
  private function retrieveExifFieldDefaultValue() {
    $result = $this
      ->getSetting('exif_field');
    if (empty($result)) {
      $result = 'naming_convention';
    }
    return $result;
  }

  /**
   * Get separator value from settings.
   *
   * @return string
   *   separator value or empty string.
   */
  private function retrieveExifFieldDefaultSeparatorValue() {
    $result = $this
      ->getSetting('exif_field_separator');
    if (empty($result)) {
      $result = '';
    }
    return $result;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = parent::settingsSummary();
    $exif_field_separator = $this
      ->getSetting('exif_field_separator');
    if (isset($exif_field_separator) && strlen($exif_field_separator) == 1) {
      $exif_field_msg = t("exif value will be split using character separator '@separator'", [
        '@separator' => $exif_field_separator,
      ]);
    }
    else {
      $exif_field_msg = t('exif value will be extracted as one value');
    }
    array_unshift($summary, $exif_field_msg);
    $exif_field = $this
      ->getSetting('exif_field');
    if (isset($exif_field) && $exif_field != 'naming_convention') {
      $exif_field_msg = t("exif data will be extracted from image metadata field '@metadata'", [
        '@metadata' => $exif_field,
      ]);
    }
    else {
      $fieldname = $this->fieldDefinition
        ->getName();
      $exif_field = str_replace("field_", "", $fieldname);
      $exif_field_msg = t("Using naming convention. so the exif data will be extracted from image metadata field '@metadata'", [
        '@metadata' => $exif_field,
      ]);
    }
    array_unshift($summary, $exif_field_msg);
    return $summary;
  }

}

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
ExifFieldWidgetBase::defaultSettings public static function Defines the default settings for this plugin. Overrides ExifWidgetBase::defaultSettings
ExifFieldWidgetBase::retrieveExifFieldDefaultSeparatorValue private function Get separator value from settings.
ExifFieldWidgetBase::retrieveExifFieldDefaultValue private function Get exif field name associated to this drupal field.
ExifFieldWidgetBase::retrieveExifFields private function List of possible fields.
ExifFieldWidgetBase::settingsForm public function Returns a form to configure settings for the widget. Overrides ExifWidgetBase::settingsForm
ExifFieldWidgetBase::settingsSummary public function Returns a short summary for the current widget settings. Overrides ExifWidgetBase::settingsSummary
ExifFieldWidgetBase::validateExifField public static function Ensure field is correctly configured.
ExifFieldWidgetBase::validateExifFieldSeparator public static function Ensure field separator is correctly configured.
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::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