class ResponsiveBgImageFormatter in Background Images Formatter 8.2
Same name and namespace in other branches
- 8.3 modules/responsive_bg_image_formatter/src/Plugin/Field/FieldFormatter/ResponsiveBgImageFormatter.php \Drupal\responsive_bg_image_formatter\Plugin\Field\FieldFormatter\ResponsiveBgImageFormatter
- 8 modules/responsive_bg_image_formatter/src/Plugin/Field/FieldFormatter/ResponsiveBgImageFormatter.php \Drupal\responsive_bg_image_formatter\Plugin\Field\FieldFormatter\ResponsiveBgImageFormatter
Plugin annotation
@FieldFormatter(
id = "responsive_bg_image_formatter",
label = @Translation("Responsive Background Image"),
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\image\Plugin\Field\FieldFormatter\ImageFormatter implements ContainerFactoryPluginInterface
- class \Drupal\bg_image_formatter\Plugin\Field\FieldFormatter\BgImageFormatter
- class \Drupal\responsive_bg_image_formatter\Plugin\Field\FieldFormatter\ResponsiveBgImageFormatter
- class \Drupal\bg_image_formatter\Plugin\Field\FieldFormatter\BgImageFormatter
- class \Drupal\image\Plugin\Field\FieldFormatter\ImageFormatter 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 ResponsiveBgImageFormatter
File
- modules/
responsive_bg_image_formatter/ src/ Plugin/ Field/ FieldFormatter/ ResponsiveBgImageFormatter.php, line 18
Namespace
Drupal\responsive_bg_image_formatter\Plugin\Field\FieldFormatterView source
class ResponsiveBgImageFormatter extends BgImageFormatter {
/**
* Get the possible responsive image styles.
*/
protected function getResponsiveImageStyles($withNone = FALSE) {
$styles = ResponsiveImageStyle::loadMultiple();
$options = [];
if ($withNone && empty($styles)) {
$options[''] = t('- Defined None -');
}
foreach ($styles as $name => $style) {
$options[$name] = $style
->label();
}
return $options;
}
/**
* {@inheritdoc}
*/
public function settingsForm(array $form, FormStateInterface $form_state) {
$element = parent::settingsForm($form, $form_state);
$element['image_style']['#options'] = $this
->getResponsiveImageStyles(TRUE);
$element['image_style']['#description'] = $this
->t('Select <a href="@href_image_style">the responsive image style</a> to use.', [
'@href_image_style' => Url::fromRoute('entity.responsive_image_style.collection')
->toString(),
]);
unset($element['css_settings']['bg_image_media_query']);
return $element;
}
/**
* {@inheritdoc}
*/
public function settingsSummary() {
$summary = parent::settingsSummary();
$settings = $this
->getSettings();
$options = $this
->getResponsiveImageStyles();
if (isset($options[$settings['image_style']])) {
$summary[1] = $this
->t('URL for image style: @style', [
'@style' => $options[$settings['image_style']],
]);
}
else {
$summary[1] = $this
->t('Original image style');
}
return $summary;
}
/**
* {@inheritdoc}
*/
public function viewElements(FieldItemListInterface $items, $langcode) {
$elements = [];
$index = 0;
$settings = $this
->getSettings();
$css_settings = $settings['css_settings'];
$selectors = array_filter(preg_split('/$/', $css_settings['bg_image_selector']));
$files = $this
->getEntitiesToView($items, $langcode);
// Filter out empty selectors
$selectors = array_map(function ($value) {
return trim($value, ',');
}, $selectors);
// Early opt-out if the field is empty.
if (empty($files) || empty($settings['image_style'])) {
return $elements;
}
// Prepare token data in bg image css selector.
$token_data = [
'user' => \Drupal::currentUser(),
$items
->getEntity()
->getEntityTypeId() => $items
->getEntity(),
];
foreach ($selectors as &$selector) {
$selector = \Drupal::token()
->replace($selector, $token_data);
}
// Need an empty element so views renderer will see something to render.
$elements[0] = [];
foreach ($files as $delta => $file) {
// Use specified selectors in round-robin order.
$selector = $selectors[$index % count($selectors)];
$vars = [
'uri' => $file
->getFileUri(),
'responsive_image_style_id' => $settings['image_style'],
];
template_preprocess_responsive_image($vars);
// Split each source into multiple rules.
foreach (array_reverse($vars['sources']) as $source_i => $source) {
$attr = $source
->toArray();
$srcset = explode(', ', $attr['srcset']);
foreach ($srcset as $src_i => $src) {
list($src, $res) = explode(' ', $src);
$media = isset($attr['media']) ? $attr['media'] : '';
// Add "retina" to media query if this is a 2x image.
if ($res && $res === '2x') {
$media = "{$media} and (-webkit-min-device-pixel-ratio: 2), {$media} and (min-resolution: 192dpi)";
}
// Correct a bug in template_preprocess_responsive_image which
// generates an invalid media rule "screen (max-width)" when no
// min-width is specified. If this bug gets fixed, this replacement
// will deactivate.
$media = str_replace('screen (max-width', 'screen and (max-width', $media);
$css_settings['bg_image_selector'] = $selector;
$css = $this
->getBackgroundImageCss($src, $css_settings);
$css['media'] = $media;
// Define unique key to prevent collisions when displaying multiple
// background images on the same page.
$html_head_key = 'responsive_bg_image_formatter_css__' . sha1(implode('__', [
$items
->getEntity()
->uuid(),
$items
->getName(),
$settings['image_style'],
$delta,
$src_i,
$source_i,
]));
$elements['#attached']['html_head'][] = [
[
'#tag' => 'style',
'#attributes' => [
'media' => $css['media'],
],
'#value' => $css['style'],
],
$html_head_key,
];
}
}
$index++;
}
return $elements;
}
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
BgImageFormatter:: |
public static | function |
Defines the default settings for this plugin. Overrides ImageFormatter:: |
|
BgImageFormatter:: |
public | function | Function taken from the module 'bg_image'. | |
BgImageFormatter:: |
protected | function |
Merges default settings values into $settings. Overrides PluginSettingsBase:: |
|
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 |
ImageFormatter:: |
protected | property | The current user. | |
ImageFormatter:: |
protected | property | The image style entity storage. | |
ImageFormatter:: |
public | function |
Calculates dependencies for the configured plugin. Overrides PluginSettingsBase:: |
|
ImageFormatter:: |
public static | function |
Creates an instance of the plugin. Overrides FormatterBase:: |
1 |
ImageFormatter:: |
public | function |
Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsBase:: |
|
ImageFormatter:: |
public | function |
Constructs an ImageFormatter object. Overrides FormatterBase:: |
1 |
ImageFormatterBase:: |
protected | function |
Returns the referenced entities for display. Overrides EntityReferenceFormatterBase:: |
|
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 |
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:: |
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:: |
|
ResponsiveBgImageFormatter:: |
protected | function | Get the possible responsive image styles. | |
ResponsiveBgImageFormatter:: |
public | function |
Returns a form to configure settings for the formatter. Overrides BgImageFormatter:: |
|
ResponsiveBgImageFormatter:: |
public | function |
Returns a short summary for the current formatter settings. Overrides BgImageFormatter:: |
|
ResponsiveBgImageFormatter:: |
public | function |
Builds a renderable array for a field value. Overrides BgImageFormatter:: |
|
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. |