class MediaDirectoriesImageDimensionsFormatter in Media Directories 2.x
Same name and namespace in other branches
- 8 modules/media_directories_editor/src/Plugin/Field/FieldFormatter/MediaDirectoriesImageDimensionsFormatter.php \Drupal\media_directories_editor\Plugin\Field\FieldFormatter\MediaDirectoriesImageDimensionsFormatter
Plugin implementation of the 'media_directories_editor_thumbnail' formatter.
Plugin annotation
@FieldFormatter(
id = "media_directories_image_dimensions",
label = @Translation("Image with dimensions"),
field_types = {
"entity_reference"
}
)
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\image\Plugin\Field\FieldFormatter\ImageFormatter
- class \Drupal\media\Plugin\Field\FieldFormatter\MediaThumbnailFormatter
- class \Drupal\media_directories_editor\Plugin\Field\FieldFormatter\MediaDirectoriesImageDimensionsFormatter
- class \Drupal\media\Plugin\Field\FieldFormatter\MediaThumbnailFormatter
- class \Drupal\image\Plugin\Field\FieldFormatter\ImageFormatter
- 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 MediaDirectoriesImageDimensionsFormatter
File
- modules/
media_directories_editor/ src/ Plugin/ Field/ FieldFormatter/ MediaDirectoriesImageDimensionsFormatter.php, line 26
Namespace
Drupal\media_directories_editor\Plugin\Field\FieldFormatterView source
class MediaDirectoriesImageDimensionsFormatter extends MediaThumbnailFormatter {
/**
* The configuration factory service.
*
* @var \Drupal\Core\Config\ConfigFactoryInterface
*/
protected $configFactory;
/**
* Constructs an MediaThumbnailFormatter 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\image\ImageStyleStorageInterface $image_style_storage
* The image style entity storage handler.
* @param \Drupal\Core\Render\RendererInterface $renderer
* The renderer service.
* @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
* The configuration factory service.
*/
public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, $label, $view_mode, array $third_party_settings, AccountInterface $current_user, ImageStyleStorageInterface $image_style_storage, RendererInterface $renderer, ConfigFactoryInterface $config_factory) {
parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings, $current_user, $image_style_storage, $renderer);
$this->configFactory = $config_factory;
}
/**
* {@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('renderer'), $container
->get('config.factory'));
}
/**
* {@inheritdoc}
*/
public static function defaultSettings() {
return [
'dimensions' => [
'image_width' => '',
'image_height' => '',
],
] + parent::defaultSettings();
}
/**
* {@inheritdoc}
*/
public function settingsForm(array $form, FormStateInterface $form_state) {
$element = parent::settingsForm($form, $form_state);
if ($this->viewMode === '_entity_embed') {
$storage = $form_state
->getStorage();
/** @var \Drupal\media\Entity\Media $entity */
$entity = $storage['entity'];
$element['#attached']['library'][] = 'media_directories_editor/image-resize';
$element['image_link']['#access'] = FALSE;
$config = $this->configFactory
->get('media_directories_editor.settings');
$styles = $element['image_style']['#options'];
$selected_styles = $config
->get('embed_dialog.image_styles');
if (!empty($selected_styles)) {
$styles = array_intersect_key($styles, $selected_styles);
}
$image_style_options[(string) $this
->t('Pre-defined styles')] = $styles;
$element['image_style']['#options'] = $image_style_options;
$element['image_style']['#empty_option'] = $this
->t('Custom dimensions');
$element['image_style']['#description'] = $this
->t('Choose from pre-defined image styles or set custom dimensions.');
$element['dimensions'] = [
'#type' => 'details',
'#title' => $this
->t('Image size'),
'#description' => $this
->t('Original image size: @widthx@height', [
'@width' => $entity
->get('thumbnail')->width,
'@height' => $entity
->get('thumbnail')->height,
]),
'#open' => TRUE,
'#attributes' => [
'class' => [
'media-directories-editor--dimensions',
],
],
'#states' => [
'visible' => [
':input[name="attributes[data-entity-embed-display-settings][image_style]"]' => [
'value' => '',
],
],
],
];
$dimensions = $this
->getSetting('dimensions');
$img_width = empty($dimensions['image_width']) ? $entity
->get('thumbnail')->width : $dimensions['image_width'];
$img_height = empty($dimensions['image_height']) ? $entity
->get('thumbnail')->height : $dimensions['image_height'];
$element['dimensions']['image_width'] = [
'#title' => t('Width'),
'#type' => 'textfield',
'#size' => 4,
'#default_value' => $img_width,
'#attributes' => [
'class' => [
'media-directories-editor--image-width',
],
],
];
$element['dimensions']['image_height'] = [
'#title' => t('Height'),
'#type' => 'textfield',
'#size' => 4,
'#default_value' => $img_height,
'#attributes' => [
'class' => [
'media-directories-editor--image-height',
],
],
];
$element['dimensions']['controls'] = [
'#type' => 'container',
'#attributes' => [
'class' => [
'media-directories-editor--controls',
],
],
'reset' => [
'#type' => 'html_tag',
'#tag' => 'a',
'#attributes' => [
'class' => [
'media-directories-editor--reset',
'button',
],
'data-width' => $entity
->get('thumbnail')->width,
'data-height' => $entity
->get('thumbnail')->height,
],
'#value' => $this
->t('Reset'),
],
];
}
return $element;
}
/**
* {@inheritdoc}
*/
public function viewElements(FieldItemListInterface $items, $langcode) {
$elements = [];
$media_items = $this
->getEntitiesToView($items, $langcode);
// Early opt-out if the field is empty.
if (empty($media_items)) {
return $elements;
}
if ($this
->getSetting('image_style')) {
return parent::viewElements($items, $langcode);
}
/** @var \Drupal\media\MediaInterface[] $media_items */
foreach ($media_items as $delta => $media) {
/** @var \Drupal\file\Entity\File $file */
$file = $media
->get('thumbnail')->entity;
$elements[$delta] = [
'#theme' => 'image',
'#attributes' => [
'width' => $this
->getSetting('dimensions')['image_width'],
'height' => $this
->getSetting('dimensions')['image_height'],
'class' => [],
],
'#uri' => file_create_url($file
->getFileUri()),
];
// Add cacheability of each item in the field.
$this->renderer
->addCacheableDependency($elements[$delta], $media);
}
return $elements;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
public | function | 2 | |
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:: |
|
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. | |
ImageFormatter:: |
protected | property | The current user. | |
ImageFormatter:: |
protected | property | The file URL generator. | |
ImageFormatter:: |
protected | property | The image style entity storage. | |
ImageFormatter:: |
public | function |
Calculates dependencies for the configured plugin. Overrides PluginSettingsBase:: |
|
ImageFormatter:: |
public | function |
Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsBase:: |
|
ImageFormatterBase:: |
protected | function |
Returns the referenced entities for display. Overrides EntityReferenceFormatterBase:: |
|
MediaDirectoriesImageDimensionsFormatter:: |
protected | property | The configuration factory service. | |
MediaDirectoriesImageDimensionsFormatter:: |
public static | function |
Creates an instance of the plugin. Overrides MediaThumbnailFormatter:: |
|
MediaDirectoriesImageDimensionsFormatter:: |
public static | function |
Defines the default settings for this plugin. Overrides ImageFormatter:: |
|
MediaDirectoriesImageDimensionsFormatter:: |
public | function |
Returns a form to configure settings for the formatter. Overrides MediaThumbnailFormatter:: |
|
MediaDirectoriesImageDimensionsFormatter:: |
public | function |
Builds a renderable array for a field value. Overrides MediaThumbnailFormatter:: |
|
MediaDirectoriesImageDimensionsFormatter:: |
public | function |
Constructs an MediaThumbnailFormatter object. Overrides MediaThumbnailFormatter:: |
|
MediaThumbnailFormatter:: |
protected | property | The renderer service. | |
MediaThumbnailFormatter:: |
protected | function | Get the URL for the media thumbnail. | |
MediaThumbnailFormatter:: |
public static | function |
Returns if the formatter can be used for the provided field. Overrides FormatterBase:: |
|
MediaThumbnailFormatter:: |
protected | function |
This has to be overridden because FileFormatterBase expects $item to be
of type \Drupal\file\Plugin\Field\FieldType\FileItem and calls
isDisplayed() which is not in FieldItemInterface. Overrides FileFormatterBase:: |
|
MediaThumbnailFormatter:: |
public | function |
Returns a short summary for the current formatter settings. Overrides ImageFormatter:: |
|
MessengerTrait:: |
protected | property | The messenger. | 27 |
MessengerTrait:: |
public | function | Gets the messenger. | 27 |
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:: |
2 |
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 |
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 |
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. | 4 |
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. |