ImageConfigUpdater.php

Namespace

Drupal\image

File

core/modules/image/src/ImageConfigUpdater.php

View source
<?php

namespace Drupal\image;

use Drupal\Core\Entity\Display\EntityViewDisplayInterface;

/**
 * Provides a BC layer for modules providing old configurations.
 *
 * @internal
 *   This class is only meant to fix outdated image configuration and its
 *   methods should not be invoked directly. It will be removed once all the
 *   deprecated methods have been removed.
 */
final class ImageConfigUpdater {
  
  /**
   * Re-order mappings by breakpoint ID and descending numeric multiplier order.
   *
   * @param \Drupal\Core\Entity\Display\EntityViewDisplayInterface $view_display
   *   The view display.
   *
   * @return bool
   *   Whether the display was updated.
   */
  public function processImageLazyLoad(EntityViewDisplayInterface $view_display) : bool {
    $changed = FALSE;
    foreach ($view_display->getComponents() as $field => $component) {
      if (isset($component['type']) && $component['type'] === 'image' && !array_key_exists('image_loading', $component['settings'])) {
        $component['settings']['image_loading']['attribute'] = 'lazy';
        $view_display->setComponent($field, $component);
        $changed = TRUE;
      }
    }
    return $changed;
  }

}

Classes

Title Deprecated Summary
ImageConfigUpdater Provides a BC layer for modules providing old configurations.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.