class ImageWidget in Panopoly 8.2

Class ImageWidget.

Used in place of the core image widget.

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\Core\Field\PluginSettingsBase implements DependentPluginInterface, PluginSettingsInterface
    class \Drupal\Core\Field\WidgetBase implements WidgetInterface, ContainerFactoryPluginInterface uses AllowedTagsXssTrait
    class \Drupal\file\Plugin\Field\FieldWidget\FileWidget implements ContainerFactoryPluginInterface
    class \Drupal\image\Plugin\Field\FieldWidget\ImageWidget
    class \Drupal\panopoly_media\Plugin\Field\FieldWidget\ImageWidget

Expanded class hierarchy of ImageWidget

1 file declares its use of ImageWidget

panopoly_media.module in modules/panopoly/panopoly_media/panopoly_media.module: Hook implementations for Panopoly Media.

File

modules/panopoly/panopoly_media/src/Plugin/Field/FieldWidget/ImageWidget.php, line 14

Namespace

Drupal\panopoly_media\Plugin\Field\FieldWidget

View source

class ImageWidget extends CoreImageWidget {

  /**
   * {@inheritdoc}
   */
  public static function process($element, FormStateInterface $form_state, $form) {
    $element = parent::process($element, $form_state, $form);
    $entityType = $element['#entity_type'];

    // Only deal with media entities for now.
    if ($entityType != 'media') {
      return $element;
    }

    // If we've got files, use the first one.
    if (!empty($element['#files'])) {
      $files = $element['#files'];

      /** @var \Drupal\file\Entity\File $file */
      $file = reset($files);

      // Add IPTC handling to form.
      $iptc = self::getDataService()
        ->getData($file
        ->getFileUri());
      $iptc['name'] = empty($iptc['title']) ? $file
        ->getFilename() : $iptc['title'];
      $parents = array_slice($element['#parents'], 0, -2);

      // Allow JS processing.
      $element['#attached']['library'][] = 'panopoly_media/img_data';
      $element['panopoly_media_img_data'] = [
        '#type' => 'container',
        '#attributes' => [
          'data-type' => [
            'panopolyMediaImgData',
          ],
          'data-entity-type' => $entityType,
          'data-form-parents' => $parents,
        ],
      ];
      foreach (array_filter($iptc) as $property => $value) {
        $element['panopoly_media_img_data']['#attributes']['data-iptc-' . $property] = $value;
      }
      $map = static::getDataService()
        ->getElementMap($entityType);
      $element['#attached']['drupalSettings']['panopolyMediaImgDataMap'][$entityType] = $map;

      // Allow the IPTC values to be altered.
      static::getModuleHandler()
        ->alter('panopoly_media_iptc_values', $iptc, $entityType);

      // Set IPTC data onto the backend form handling.
      foreach ($map as $mapData) {
        if (isset($mapData['element']) && !empty($iptc[$mapData['iptc']])) {

          // Set directly into the widget's element.
          $name = array_merge($mapData['element'], [
            '#default_value',
          ]);
          $val = NestedArray::getValue($element, $name);
          if (empty($val)) {
            NestedArray::setValue($element, $name, $iptc[$mapData['iptc']]);
          }
        }
      }
    }
    return $element;
  }

  /**
   * Gets the module handler service.
   *
   * @return \Drupal\Core\Extension\ModuleHandlerInterface
   *   The module handler service.
   */
  protected static function getModuleHandler() {
    return \Drupal::moduleHandler();
  }

  /**
   * Gets the image data service.
   *
   * @return \Drupal\panopoly_media\ImgData
   *   The image data service.
   */
  protected static function getDataService() {
    return \Drupal::service('panopoly_media.img_data');
  }

}

Members

Name	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
FileWidget::create	public static	function	Creates an instance of the plugin. Overrides WidgetBase::create
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.
ImageWidget::$imageFactory	protected	property	The image factory service.
ImageWidget::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides PluginSettingsBase::calculateDependencies
ImageWidget::defaultSettings	public static	function	Defines the default settings for this plugin. Overrides FileWidget::defaultSettings
ImageWidget::formElement	public	function	Returns the form for a single field widget. Overrides FileWidget::formElement
ImageWidget::formMultipleElements	protected	function	Overrides \Drupal\file\Plugin\Field\FieldWidget\FileWidget::formMultipleElements(). Overrides FileWidget::formMultipleElements
ImageWidget::getDataService	protected static	function	Gets the image data service.
ImageWidget::getModuleHandler	protected static	function	Gets the module handler service.
ImageWidget::onDependencyRemoval	public	function	Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsBase::onDependencyRemoval
ImageWidget::process	public static	function	Form API callback: Processes a image_image field element. Overrides ImageWidget::process
ImageWidget::settingsForm	public	function	Returns a form to configure settings for the widget. Overrides FileWidget::settingsForm
ImageWidget::settingsSummary	public	function	Returns a short summary for the current widget settings. Overrides FileWidget::settingsSummary
ImageWidget::validateRequiredFields	public static	function	Validate callback for alt and title field, if the user wants them required.
ImageWidget::__construct	public	function	Constructs an ImageWidget object. Overrides FileWidget::__construct
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::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::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::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

You are here

class ImageWidget in Panopoly 8.2

Hierarchy

File

Namespace

Members

API Navigation