You are here

Home » API reference » Image Zoom 8.2 » ImageZoomFormatter.php

class ImageZoomFormatter in Image Zoom 8.2

Same name and namespace in other branches
  1. 8.3 src/Plugin/Field/FieldFormatter/ImageZoomFormatter.php \Drupal\imagezoom\Plugin\Field\FieldFormatter\ImageZoomFormatter

Image Zoom field formatter for Image fields.

Plugin annotation


@FieldFormatter(
 id = "imagezoom",
 label = @Translation("Image Zoom"),
 field_types = {
    "image"
  }
)

Hierarchy

Expanded class hierarchy of ImageZoomFormatter

1 file declares its use of ImageZoomFormatter
ImageZoomGalleryFormatter.php in modules/imagezoom_gallery/src/Plugin/Field/FieldFormatter/ImageZoomGalleryFormatter.php

File

src/Plugin/Field/FieldFormatter/ImageZoomFormatter.php, line 26

Namespace

Drupal\imagezoom\Plugin\Field\FieldFormatter
View source 
class ImageZoomFormatter extends ImageFormatterBase implements ContainerFactoryPluginInterface {

  /**
   * The module handler service.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  protected $moduleHandler;

  /**
   * Constructs an ImageZoomFormatter 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\Extension\ModuleHandlerInterface $module_handler
   *   The module handler service.
   */
  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, $label, $view_mode, array $third_party_settings, ModuleHandlerInterface $module_handler) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings);
    $this->moduleHandler = $module_handler;
  }

  /**
   * {@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('module_handler'));
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'imagezoom_zoom_type' => '',
      'imagezoom_display_style' => '',
      'imagezoom_zoom_style' => '',
      'imagezoom_disable' => '',
      'imagezoom_disable_width' => '',
      'imagezoom_additional' => '',
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $element['imagezoom_zoom_type'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Zoom type'),
      '#options' => $this
        ->zoomTypes(),
      '#default_value' => $this
        ->getSetting('imagezoom_zoom_type'),
    ];
    $image_styles = image_style_options(FALSE);
    $element['imagezoom_display_style'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Image style'),
      '#options' => $image_styles,
      '#empty_option' => $this
        ->t('None (original image)'),
      '#default_value' => $this
        ->getSetting('imagezoom_display_style'),
    ];
    $element['imagezoom_zoom_style'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Zoomed Image style'),
      '#options' => $image_styles,
      '#empty_option' => $this
        ->t('None (original image)'),
      '#default_value' => $this
        ->getSetting('imagezoom_zoom_style'),
    ];
    $element['imagezoom_disable'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Disable zoom on small screens'),
      '#return_value' => 1,
      '#default_value' => $this
        ->getSetting('imagezoom_disable'),
      '#weight' => 10,
    ];
    $element['imagezoom_disable_width'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Minimum width for zoom to display'),
      '#min' => 0,
      '#states' => [
        'invisible' => [
          ':input[name="fields[field_image][settings_edit_form][settings][imagezoom_disable]"]' => [
            'checked' => FALSE,
          ],
        ],
      ],
      '#default_value' => $this
        ->getSetting('imagezoom_disable_width'),
      '#weight' => 10,
    ];
    $docs = Link::fromTextAndUrl($this
      ->t('documentation'), Url::fromUri('http://igorlino.github.io/elevatezoom-plus/api.htm'));
    $element['imagezoom_additional'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('Additional settings'),
      '#element_validate' => [
        [
          $this,
          'additionalSettingsValidate',
        ],
      ],
      '#description' => $this
        ->t('Add additional settings. For a list of available options, see the @docs. Settings should be added in the following format: <pre>@code</pre>', [
        '@docs' => $docs
          ->toString(),
        '@code' => 'option: value',
      ]),
      '#default_value' => $this
        ->getSetting('imagezoom_additional'),
      '#weight' => 20,
    ];
    return $element;
  }

  /**
   * Validate additional settings.
   */
  public function additionalSettingsValidate($element, FormStateInterface $form_state) {
    $settings_array = explode("\n", $element['#value']);
    foreach ($settings_array as $setting) {
      if (!empty($setting)) {
        if (!preg_match('/^[a-z][a-zA-Z0-9-_]*: ?[a-z0-9-_]*$/i', trim($setting))) {
          $form_state
            ->setErrorByName('imagezoom_additional', $this
            ->t('Additional settings must be in the format "option: value".'));
        }
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $zoom_types = $this
      ->zoomTypes();
    $summary[] = $this
      ->t('Zoom type: @type', [
      '@type' => $zoom_types[$this
        ->getSetting('imagezoom_zoom_type')],
    ]);
    $image_styles = image_style_options(FALSE);
    unset($image_styles['']);
    $summary[] = $this
      ->t('Display image style: @style', [
      '@style' => isset($image_styles[$this
        ->getSetting('imagezoom_display_style')]) ? $image_styles[$this
        ->getSetting('imagezoom_display_style')] : 'original',
    ]);
    $summary[] = $this
      ->t('Zoomed image style: @style', [
      '@style' => isset($image_styles[$this
        ->getSetting('imagezoom_zoom_style')]) ? $image_styles[$this
        ->getSetting('imagezoom_zoom_style')] : 'original',
    ]);
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $settings = [
      'zoomType' => $this
        ->getSetting('imagezoom_zoom_type'),
    ];
    if ($this
      ->getSetting('imagezoom_disable')) {
      $settings['responsive'] = TRUE;
      $settings['respond'] = [
        [
          'range' => '0 - ' . $this
            ->getSetting('imagezoom_disable_width'),
          'enabled' => FALSE,
        ],
      ];
    }
    $additonal_settings = $this
      ->settingsToArray($this
      ->getSetting('imagezoom_additional'));
    $settings += $additonal_settings;
    $this->moduleHandler
      ->alter('imagezoom_settings', $settings);
    $elements = [];
    foreach ($items as $delta => $item) {
      $elements[$delta] = [
        '#theme' => 'imagezoom_image',
        '#item' => $item,
        '#display_style' => $this
          ->getSetting('imagezoom_display_style'),
        '#zoom_style' => $this
          ->getSetting('imagezoom_zoom_style'),
        '#settings' => $settings,
      ];
    }
    $elements['#attached'] = [
      'library' => [
        'imagezoom/elevatezoom',
      ],
      'drupalSettings' => [
        'imagezoom' => $settings,
      ],
    ];
    return $elements;
  }

  /**
   * Returns an array of available zoom types.
   */
  protected function zoomTypes() {
    $types = [
      'window' => $this
        ->t('Window'),
      'inner' => $this
        ->t('Inner'),
      'lens' => $this
        ->t('Lens'),
    ];
    return $types;
  }

  /**
   * Convert a settings string to an array.
   */
  protected function settingsToArray($string) {
    $settings = [];
    if (!empty($string)) {
      $array = explode("\n", $string);
      foreach ($array as $option) {
        $parts = explode(':', $option);
        if (count($parts) == 2) {
          $key = trim($parts[0]);
          $value = trim($parts[1]);
          $settings[$key] = $value;
        }
      }
    }
    return $settings;
  }

}

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
ImageFormatterBase::getEntitiesToView protected function Returns the referenced entities for display. Overrides EntityReferenceFormatterBase::getEntitiesToView
ImageZoomFormatter::$moduleHandler protected property The module handler service.
ImageZoomFormatter::additionalSettingsValidate public function Validate additional settings.
ImageZoomFormatter::create public static function Creates an instance of the plugin. Overrides FormatterBase::create
ImageZoomFormatter::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings 1
ImageZoomFormatter::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm 1
ImageZoomFormatter::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary 1
ImageZoomFormatter::settingsToArray protected function Convert a settings string to an array.
ImageZoomFormatter::viewElements public function Builds a renderable array for a field value. Overrides FormatterInterface::viewElements 1
ImageZoomFormatter::zoomTypes protected function Returns an array of available zoom types.
ImageZoomFormatter::__construct public function Constructs an ImageZoomFormatter object. Overrides FormatterBase::__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::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.