class ImageZoomGalleryFormatter in Image Zoom 8.2
Image Zoom gallery field formatter for Image fields.
Plugin annotation
@FieldFormatter(
id = "imagezoom_gallery",
label = @Translation("Image Zoom Gallery"),
field_types = {
"image"
}
)
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\FormatterBase implements FormatterInterface, ContainerFactoryPluginInterface
- class \Drupal\Core\Field\Plugin\Field\FieldFormatter\EntityReferenceFormatterBase
- class \Drupal\file\Plugin\Field\FieldFormatter\FileFormatterBase
- class \Drupal\image\Plugin\Field\FieldFormatter\ImageFormatterBase
- class \Drupal\imagezoom\Plugin\Field\FieldFormatter\ImageZoomFormatter implements ContainerFactoryPluginInterface
- class \Drupal\imagezoom_gallery\Plugin\Field\FieldFormatter\ImageZoomGalleryFormatter
- class \Drupal\imagezoom\Plugin\Field\FieldFormatter\ImageZoomFormatter implements ContainerFactoryPluginInterface
- class \Drupal\image\Plugin\Field\FieldFormatter\ImageFormatterBase
- class \Drupal\file\Plugin\Field\FieldFormatter\FileFormatterBase
- class \Drupal\Core\Field\Plugin\Field\FieldFormatter\EntityReferenceFormatterBase
- class \Drupal\Core\Field\FormatterBase implements FormatterInterface, ContainerFactoryPluginInterface
- class \Drupal\Core\Field\PluginSettingsBase implements DependentPluginInterface, PluginSettingsInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of ImageZoomGalleryFormatter
File
- modules/
imagezoom_gallery/ src/ Plugin/ Field/ FieldFormatter/ ImageZoomGalleryFormatter.php, line 20
Namespace
Drupal\imagezoom_gallery\Plugin\Field\FieldFormatterView source
class ImageZoomGalleryFormatter extends ImageZoomFormatter {
/**
* {@inheritdoc}
*/
public static function defaultSettings() {
return [
'imagezoom_thumb_style' => '',
] + parent::defaultSettings();
}
/**
* {@inheritdoc}
*/
public function settingsForm(array $form, FormStateInterface $form_state) {
$element = parent::settingsForm($form, $form_state);
$image_styles = image_style_options(FALSE);
$element['imagezoom_thumb_style'] = [
'#type' => 'select',
'#title' => $this
->t('Thumbnail image style'),
'#options' => $image_styles,
'#empty_option' => $this
->t('None (original image)'),
'#default_value' => $this
->getSetting('imagezoom_thumb_style'),
];
return $element;
}
/**
* {@inheritdoc}
*/
public function settingsSummary() {
$summary = parent::settingsSummary();
$image_styles = image_style_options(FALSE);
unset($image_styles['']);
$summary[] = t('Thumbnail image style: @style', [
'@style' => isset($image_styles[$this
->getSetting('imagezoom_thumb_style')]) ? $image_styles[$this
->getSetting('imagezoom_thumb_style')] : 'original',
]);
return $summary;
}
/**
* {@inheritdoc}
*/
public function viewElements(FieldItemListInterface $items, $langcode) {
$settings = [
'zoomType' => $this
->getSetting('imagezoom_zoom_type'),
'gallery' => 'imagezoom-thumb-wrapper',
];
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);
$element[] = [
'#theme' => 'imagezoom_gallery',
'#items' => $items,
'#display_style' => $this
->getSetting('imagezoom_display_style'),
'#zoom_style' => $this
->getSetting('imagezoom_zoom_style'),
'#thumb_style' => $this
->getSetting('imagezoom_thumb_style'),
'#settings' => $settings,
];
$element['#attached'] = [
'library' => [
'imagezoom/elevatezoom',
],
'drupalSettings' => [
'imagezoom' => $settings,
],
];
return $element;
}
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
EntityReferenceFormatterBase:: |
public | function |
Loads the entities referenced in that field across all the entities being
viewed. Overrides FormatterBase:: |
|
EntityReferenceFormatterBase:: |
public | function |
Overrides FormatterBase:: |
|
FileFormatterBase:: |
protected | function |
Checks access to the given entity. Overrides EntityReferenceFormatterBase:: |
|
FileFormatterBase:: |
protected | function |
Returns whether the entity referenced by an item needs to be loaded. Overrides EntityReferenceFormatterBase:: |
1 |
FormatterBase:: |
protected | property | The field definition. | |
FormatterBase:: |
protected | property | The label display setting. | |
FormatterBase:: |
protected | property |
The formatter settings. Overrides PluginSettingsBase:: |
|
FormatterBase:: |
protected | property | The view mode. | |
FormatterBase:: |
protected | function | Returns the value of a field setting. | |
FormatterBase:: |
protected | function | Returns the array of field settings. | |
FormatterBase:: |
public static | function |
Returns if the formatter can be used for the provided field. Overrides FormatterInterface:: |
14 |
ImageFormatterBase:: |
protected | function |
Returns the referenced entities for display. Overrides EntityReferenceFormatterBase:: |
|
ImageZoomFormatter:: |
protected | property | The module handler service. | |
ImageZoomFormatter:: |
public | function | Validate additional settings. | |
ImageZoomFormatter:: |
public static | function |
Creates an instance of the plugin. Overrides FormatterBase:: |
|
ImageZoomFormatter:: |
protected | function | Convert a settings string to an array. | |
ImageZoomFormatter:: |
protected | function | Returns an array of available zoom types. | |
ImageZoomFormatter:: |
public | function |
Constructs an ImageZoomFormatter object. Overrides FormatterBase:: |
|
ImageZoomGalleryFormatter:: |
public static | function |
Defines the default settings for this plugin. Overrides ImageZoomFormatter:: |
|
ImageZoomGalleryFormatter:: |
public | function |
Returns a form to configure settings for the formatter. Overrides ImageZoomFormatter:: |
|
ImageZoomGalleryFormatter:: |
public | function |
Returns a short summary for the current formatter settings. Overrides ImageZoomFormatter:: |
|
ImageZoomGalleryFormatter:: |
public | function |
Builds a renderable array for a field value. Overrides ImageZoomFormatter:: |
|
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
3 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
PluginSettingsBase:: |
protected | property | Whether default settings have been merged into the current $settings. | |
PluginSettingsBase:: |
protected | property | The plugin settings injected by third party modules. | |
PluginSettingsBase:: |
public | function |
Calculates dependencies for the configured plugin. Overrides DependentPluginInterface:: |
6 |
PluginSettingsBase:: |
public | function |
Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface:: |
|
PluginSettingsBase:: |
protected | function | Merges default settings values into $settings. | |
PluginSettingsBase:: |
public | function |
Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface:: |
3 |
PluginSettingsBase:: |
public | function |
Sets the value of a setting for the plugin. Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Sets the settings for the plugin. Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Unsets a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |