function ResponsiveImageStyleInterface::getKeyedImageStyleMappings

Same name in other branches
  1. 9 core/modules/responsive_image/src/ResponsiveImageStyleInterface.php \Drupal\responsive_image\ResponsiveImageStyleInterface::getKeyedImageStyleMappings()
  2. 8.9.x core/modules/responsive_image/src/ResponsiveImageStyleInterface.php \Drupal\responsive_image\ResponsiveImageStyleInterface::getKeyedImageStyleMappings()
  3. 10 core/modules/responsive_image/src/ResponsiveImageStyleInterface.php \Drupal\responsive_image\ResponsiveImageStyleInterface::getKeyedImageStyleMappings()

Returns the mappings of breakpoint ID and multiplier to image style.

Return value

array[] The image style mappings. Keyed by breakpoint ID then multiplier. The value is the image style mapping array with following keys:

  • image_mapping_type: Either 'image_style' or 'sizes'.
  • image_mapping:
    • If image_mapping_type is 'image_style', the image style ID.
    • If image_mapping_type is 'sizes', an array with following keys:
      • sizes: The value for the 'sizes' attribute.
      • sizes_image_styles: The image styles to use for the 'srcset' attribute.
  • breakpoint_id: The breakpoint ID for this mapping.
  • multiplier: The multiplier for this mapping.
1 method overrides ResponsiveImageStyleInterface::getKeyedImageStyleMappings()
ResponsiveImageStyle::getKeyedImageStyleMappings in core/modules/responsive_image/src/Entity/ResponsiveImageStyle.php
Returns the mappings of breakpoint ID and multiplier to image style.

File

core/modules/responsive_image/src/ResponsiveImageStyleInterface.php, line 46

Class

ResponsiveImageStyleInterface
Provides an interface defining a responsive_image mapping entity.

Namespace

Drupal\responsive_image

Code

public function getKeyedImageStyleMappings();

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