class ResponsiveImageConfigUpdater
Same name in other branches
- 11.x core/modules/responsive_image/src/ResponsiveImageConfigUpdater.php \Drupal\responsive_image\ResponsiveImageConfigUpdater
Provides a BC layer for modules providing old configurations.
@internal This class is only meant to fix outdated responsive image configuration and its methods should not be invoked directly.
Hierarchy
- class \Drupal\responsive_image\ResponsiveImageConfigUpdater
Expanded class hierarchy of ResponsiveImageConfigUpdater
3 files declare their use of ResponsiveImageConfigUpdater
- ResponsiveImageStyle.php in core/
modules/ responsive_image/ src/ Entity/ ResponsiveImageStyle.php - responsive_image.module in core/
modules/ responsive_image/ responsive_image.module - Responsive image display formatter for image fields.
- responsive_image.post_update.php in core/
modules/ responsive_image/ responsive_image.post_update.php - Post update functions for Responsive Image.
File
-
core/
modules/ responsive_image/ src/ ResponsiveImageConfigUpdater.php, line 14
Namespace
Drupal\responsive_imageView source
final class ResponsiveImageConfigUpdater {
/**
* Flag determining whether deprecations should be triggered.
*
* @var bool
*/
private $deprecationsEnabled = TRUE;
/**
* Stores which deprecations were triggered.
*
* @var bool
*/
private $triggeredDeprecations = [];
/**
* Sets the deprecations enabling status.
*
* @param bool $enabled
* Whether deprecations should be enabled.
*/
public function setDeprecationsEnabled(bool $enabled) : void {
$this->deprecationsEnabled = $enabled;
}
/**
* Re-order mappings by breakpoint ID and descending numeric multiplier order.
*
* @param \Drupal\responsive_image\ResponsiveImageStyleInterface $responsive_image_style
* The responsive image style
*
* @return bool
* Whether the responsive image style was updated.
*
* @todo when removing this, evaluate if we need to keep it permanently
* to support an upgrade path (migration) from Drupal 7 picture module.
*/
public function orderMultipliersNumerically(ResponsiveImageStyleInterface $responsive_image_style) : bool {
$changed = FALSE;
$original_mapping_order = $responsive_image_style->getImageStyleMappings();
$responsive_image_style->removeImageStyleMappings();
foreach ($original_mapping_order as $mapping) {
$responsive_image_style->addImageStyleMapping($mapping['breakpoint_id'], $mapping['multiplier'], $mapping);
}
if ($responsive_image_style->getImageStyleMappings() !== $original_mapping_order) {
$changed = TRUE;
}
$deprecations_triggered =& $this->triggeredDeprecations['3267870'][$responsive_image_style->id()];
if ($this->deprecationsEnabled && $changed && !$deprecations_triggered) {
$deprecations_triggered = TRUE;
@trigger_error(sprintf('The responsive image style multiplier re-ordering update for "%s" is deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Profile, module and theme provided Responsive Image configuration should be updated. See https://www.drupal.org/node/3274803', $responsive_image_style->id()), E_USER_DEPRECATED);
}
return $changed;
}
/**
* Processes responsive image type fields.
*
* @param \Drupal\Core\Entity\Display\EntityViewDisplayInterface $view_display
* The view display.
*
* @return bool
* Whether the display was updated.
*/
public function processResponsiveImageField(EntityViewDisplayInterface $view_display) : bool {
$changed = FALSE;
foreach ($view_display->getComponents() as $field => $component) {
if (isset($component['type']) && $component['type'] === 'responsive_image' && !array_key_exists('image_loading', $component['settings'])) {
$component['settings']['image_loading']['attribute'] = 'eager';
$view_display->setComponent($field, $component);
$changed = TRUE;
}
}
$deprecations_triggered =& $this->triggeredDeprecations['3192234'][$view_display->id()];
if ($this->deprecationsEnabled && $changed && !$deprecations_triggered) {
$deprecations_triggered = TRUE;
@trigger_error(sprintf('The responsive image loading attribute update for "%s" is deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Configuration should be updated. See https://www.drupal.org/node/3279032', $view_display->id()), E_USER_DEPRECATED);
}
return $changed;
}
}
Members
Title Sort descending | Modifiers | Object type | Summary |
---|---|---|---|
ResponsiveImageConfigUpdater::$deprecationsEnabled | private | property | Flag determining whether deprecations should be triggered. |
ResponsiveImageConfigUpdater::$triggeredDeprecations | private | property | Stores which deprecations were triggered. |
ResponsiveImageConfigUpdater::orderMultipliersNumerically | public | function | Re-order mappings by breakpoint ID and descending numeric multiplier order. |
ResponsiveImageConfigUpdater::processResponsiveImageField | public | function | Processes responsive image type fields. |
ResponsiveImageConfigUpdater::setDeprecationsEnabled | public | function | Sets the deprecations enabling status. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.