You are here

Home » API reference » Image Hotspots 8 » ImageHotspotsFormatter.php

class ImageHotspotsFormatter in Image Hotspots 8

Plugin implementation of the 'image_with_hotspots' formatter.

Plugin annotation


@FieldFormatter(
  id = "image_with_hotspots",
  label = @Translation("Image with Hotspots"),
  field_types = {
    "image"
  }
)

Hierarchy

Expanded class hierarchy of ImageHotspotsFormatter

File

src/Plugin/Field/FieldFormatter/ImageHotspotsFormatter.php, line 27

Namespace

Drupal\image_hotspots\Plugin\Field\FieldFormatter
View source 
class ImageHotspotsFormatter extends ImageFormatter implements ContainerFactoryPluginInterface {

  /**
   * The language manager.
   *
   * @var \Drupal\Core\Language\LanguageManagerInterface
   */
  protected $languageManager;

  /**
   * Constructs an ImageFormatter object.
   *
   * @param string $plugin_id
   *   The plugin_id for the formatter.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
   *   The definition of the field to which the formatter is associated.
   * @param array $settings
   *   The formatter settings.
   * @param string $label
   *   The formatter label display setting.
   * @param string $view_mode
   *   The view mode.
   * @param array $third_party_settings
   *   Any third party settings settings.
   * @param \Drupal\Core\Session\AccountInterface $current_user
   *   The current user.
   * @param \Drupal\Core\Entity\EntityStorageInterface $image_style_storage
   *   The image style storage.
   * @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
   *   The language manager.
   */
  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, $label, $view_mode, array $third_party_settings, AccountInterface $current_user, EntityStorageInterface $image_style_storage, LanguageManagerInterface $language_manager) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings, $current_user, $image_style_storage);
    $this->languageManager = $language_manager;
  }

  /**
   * {@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('current_user'), $container
      ->get('entity_type.manager')
      ->getStorage('image_style'), $container
      ->get('language_manager'));
  }

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

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $element['image_hotspots_style'] = [
      '#title' => $this
        ->t('Hotspot style'),
      '#type' => 'select',
      '#options' => [
        'tooltip' => $this
          ->t('Tooltip (hover)'),
        'modal' => $this
          ->t('Modal (click)'),
      ],
      '#default_value' => $this
        ->getSetting('image_hotspots_style'),
    ];
    return $element + parent::settingsForm($form, $form_state);

    // TODO: Change the autogenerated stub
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $elements = parent::viewElements($items, $langcode);
    $image_hotspots_style = $this
      ->getSetting('image_hotspots_style');
    $image_style = !empty($this
      ->getSetting('image_style')) ? $this
      ->getSetting('image_style') : 'none';
    $field_name = $items
      ->getName();
    $files = $this
      ->getEntitiesToView($items, $langcode);
    $info = [
      'field_name' => $field_name,
      'image_style' => $image_style,
    ];
    $default_lang = $this->languageManager
      ->getDefaultLanguage()
      ->getId();

    /** @var \Drupal\file\FileInterface $file */
    foreach ($files as $delta => $file) {
      $info['fid'] = $file
        ->id();
      $hotspots = ImageHotspot::loadByTarget($info);

      // Get translations if they exist.
      if ($langcode != $default_lang) {
        foreach ($hotspots as $hid => $hotspot) {
          if ($hotspot
            ->hasTranslation($langcode)) {
            $hotspots[$hid] = $hotspot
              ->getTranslation($langcode);
          }
        }
      }
      $editable = FALSE;
      $translatable = FALSE;

      // Load library for edit hotspots if user in permission.
      if ($this->currentUser
        ->hasPermission('edit image hotspots')) {
        $editable = TRUE;

        // Only allow translation if the editor is not viewing the default lang.
        if ($langcode != $default_lang) {
          $translatable = TRUE;
          $elements[$delta]['#attached']['library'][] = 'image_hotspots/translate';
        }
        else {
          $elements[$delta]['#attached']['library'][] = 'image_hotspots/edit';
        }
      }

      // Attach hotspots data to js settings.

      /** @var \Drupal\image_hotspots\Entity\ImageHotspot $hotspot */
      $hotspots_to_show = [];
      foreach ($hotspots as $hid => $hotspot) {
        $title = $hotspot
          ->getTitle();
        $description = $hotspot
          ->getDescription();
        $link = $hotspot
          ->getLink();
        $target = $hotspot
          ->getTargetLink();
        $value = [
          'title' => $title,
          'description' => !is_null($description) ? $description : '',
          'link' => !is_null($link) ? $link : '',
          'target' => !is_null($target) ? $target : '',
        ];
        foreach ($hotspot
          ->getCoordinates() as $coordinate => $val) {
          $value[$coordinate] = $val;
        }
        $hotspots_to_show[$hid] = $value;
      }

      // Add cache tag 'hotspots:field_name:fid:image_style'.
      $elements[$delta]['#cache']['tags'][] = 'hotspots:' . $info['field_name'] . ':' . $info['fid'] . ':' . $info['image_style'];

      // Attache libraries.
      $elements[$delta]['#attached']['drupalSettings']['image_hotspots'][$field_name][$file
        ->id()][$image_style][$image_hotspots_style][$langcode]['hotspots'] = $hotspots_to_show;
      $elements[$delta]['#attached']['library'][] = 'image_hotspots/view';
      $elements[$delta]['#attached']['library'][] = 'core/drupal.dialog.ajax';

      // Change element theme from 'image_formatter'.
      $elements[$delta]['#theme'] = 'image_formatter_with_hotspots';

      // Add additional info for render.
      $elements[$delta]['#info'] = $info;
      $elements[$delta]['#info']['hotspots_style'] = $image_hotspots_style;
      $elements[$delta]['#info']['langcode'] = $langcode;
      $elements[$delta]['#info']['editable'] = $editable;
      $elements[$delta]['#info']['translatable'] = $translatable;
    }
    return $elements;
  }

}

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
EntityReferenceFormatterBase::prepareView public function Loads the entities referenced in that field across all the entities being viewed. Overrides FormatterBase::prepareView
EntityReferenceFormatterBase::view public function Overrides FormatterBase::view
FileFormatterBase::checkAccess protected function Checks access to the given entity. Overrides EntityReferenceFormatterBase::checkAccess
FileFormatterBase::needsEntityLoad protected function Returns whether the entity referenced by an item needs to be loaded. Overrides EntityReferenceFormatterBase::needsEntityLoad 1
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::isApplicable public static function Returns if the formatter can be used for the provided field. Overrides FormatterInterface::isApplicable 14
ImageFormatter::$currentUser protected property The current user.
ImageFormatter::$imageStyleStorage protected property The image style entity storage.
ImageFormatter::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides PluginSettingsBase::calculateDependencies
ImageFormatter::onDependencyRemoval public function Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsBase::onDependencyRemoval
ImageFormatter::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary 2
ImageFormatterBase::getEntitiesToView protected function Returns the referenced entities for display. Overrides EntityReferenceFormatterBase::getEntitiesToView
ImageHotspotsFormatter::$languageManager protected property The language manager.
ImageHotspotsFormatter::create public static function Creates an instance of the plugin. Overrides ImageFormatter::create
ImageHotspotsFormatter::defaultSettings public static function Defines the default settings for this plugin. Overrides ImageFormatter::defaultSettings
ImageHotspotsFormatter::settingsForm public function Returns a form to configure settings for the formatter. Overrides ImageFormatter::settingsForm
ImageHotspotsFormatter::viewElements public function Builds a renderable array for a field value. Overrides ImageFormatter::viewElements
ImageHotspotsFormatter::__construct public function Constructs an ImageFormatter object. Overrides ImageFormatter::__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.