class ResponsiveImageStyle

Same name in other branches
  1. 9 core/modules/responsive_image/src/Entity/ResponsiveImageStyle.php \Drupal\responsive_image\Entity\ResponsiveImageStyle
  2. 8.9.x core/modules/responsive_image/src/Entity/ResponsiveImageStyle.php \Drupal\responsive_image\Entity\ResponsiveImageStyle
  3. 11.x core/modules/responsive_image/src/Entity/ResponsiveImageStyle.php \Drupal\responsive_image\Entity\ResponsiveImageStyle

Defines the responsive image style entity.

Plugin annotation


@ConfigEntityType(
  id = "responsive_image_style",
  label = @Translation("Responsive image style"),
  label_collection = @Translation("Responsive image styles"),
  label_singular = @Translation("responsive image style"),
  label_plural = @Translation("responsive image styles"),
  label_count = @PluralTranslation(
    singular = "@count responsive image style",
    plural = "@count responsive image styles",
  ),
  handlers = {
    "list_builder" = "Drupal\responsive_image\ResponsiveImageStyleListBuilder",
    "form" = {
      "edit" = "Drupal\responsive_image\ResponsiveImageStyleForm",
      "add" = "Drupal\responsive_image\ResponsiveImageStyleForm",
      "delete" = "Drupal\Core\Entity\EntityDeleteForm",
      "duplicate" = "Drupal\responsive_image\ResponsiveImageStyleForm"
    }
  },
  admin_permission = "administer responsive images",
  config_prefix = "styles",
  entity_keys = {
    "id" = "id",
    "label" = "label"
  },
  config_export = {
    "id",
    "label",
    "image_style_mappings",
    "breakpoint_group",
    "fallback_image_style",
  },
  links = {
    "edit-form" = "/admin/config/media/responsive-image-style/{responsive_image_style}",
    "duplicate-form" = "/admin/config/media/responsive-image-style/{responsive_image_style}/duplicate",
    "delete-form" = "/admin/config/media/responsive-image-style/{responsive_image_style}/delete",
    "collection" = "/admin/config/media/responsive-image-style",
  }
)

Hierarchy

Expanded class hierarchy of ResponsiveImageStyle

13 files declare their use of ResponsiveImageStyle
MigrateResponsiveImageStylesTest.php in core/modules/responsive_image/tests/src/Kernel/Migrate/d7/MigrateResponsiveImageStylesTest.php
ResponsiveImageFieldDisplayTest.php in core/modules/responsive_image/tests/src/Functional/ResponsiveImageFieldDisplayTest.php
ResponsiveImageFieldUiTest.php in core/modules/responsive_image/tests/src/FunctionalJavascript/ResponsiveImageFieldUiTest.php
ResponsiveImageFormatter.php in core/modules/responsive_image/src/Plugin/Field/FieldFormatter/ResponsiveImageFormatter.php
ResponsiveImageIntegrationTest.php in core/modules/responsive_image/tests/src/Kernel/ResponsiveImageIntegrationTest.php

... See full list

File

core/modules/responsive_image/src/Entity/ResponsiveImageStyle.php, line 54

Namespace

Drupal\responsive_image\Entity
View source
class ResponsiveImageStyle extends ConfigEntityBase implements ResponsiveImageStyleInterface {
    
    /**
     * The responsive image ID (machine name).
     *
     * @var string
     */
    protected $id;
    
    /**
     * The responsive image label.
     *
     * @var string
     */
    protected $label;
    
    /**
     * The image style mappings.
     *
     * Each image style mapping array contains the following keys:
     *   - image_mapping_type: Either 'image_style' or 'sizes'.
     *   - image_mapping:
     *     - If image_mapping_type is 'image_style', the image style ID (a
     *       string).
     *     - 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 image style mapping.
     *   - multiplier: The multiplier for this image style mapping.
     *
     * @var array
     */
    protected $image_style_mappings = [];
    
    /**
     * @var array
     */
    protected $keyedImageStyleMappings;
    
    /**
     * The responsive image breakpoint group.
     *
     * @var string
     */
    protected $breakpoint_group = '';
    
    /**
     * The fallback image style.
     *
     * @var string
     */
    protected $fallback_image_style = '';
    
    /**
     * {@inheritdoc}
     */
    public function __construct(array $values, $entity_type_id = 'responsive_image_style') {
        parent::__construct($values, $entity_type_id);
    }
    
    /**
     * {@inheritdoc}
     */
    public function preSave(EntityStorageInterface $storage) {
        parent::preSave($storage);
        $config_updater = \Drupal::classResolver(ResponsiveImageConfigUpdater::class);
        $config_updater->orderMultipliersNumerically($this);
    }
    
    /**
     * {@inheritdoc}
     */
    public function addImageStyleMapping($breakpoint_id, $multiplier, array $image_style_mapping) {
        // If there is an existing mapping, overwrite it.
        foreach ($this->image_style_mappings as &$mapping) {
            if ($mapping['breakpoint_id'] === $breakpoint_id && $mapping['multiplier'] === $multiplier) {
                $mapping = $image_style_mapping + [
                    'breakpoint_id' => $breakpoint_id,
                    'multiplier' => $multiplier,
                ];
                $this->sortMappings();
                return $this;
            }
        }
        $this->image_style_mappings[] = $image_style_mapping + [
            'breakpoint_id' => $breakpoint_id,
            'multiplier' => $multiplier,
        ];
        $this->sortMappings();
        return $this;
    }
    
    /**
     * Sort mappings by breakpoint ID and multiplier.
     */
    protected function sortMappings() : void {
        $this->keyedImageStyleMappings = NULL;
        $breakpoints = \Drupal::service('breakpoint.manager')->getBreakpointsByGroup($this->getBreakpointGroup());
        if (empty($breakpoints)) {
            return;
        }
        usort($this->image_style_mappings, static function (array $a, array $b) use ($breakpoints) : int {
            $breakpoint_a = $breakpoints[$a['breakpoint_id']] ?? NULL;
            $breakpoint_b = $breakpoints[$b['breakpoint_id']] ?? NULL;
            $first = (double) mb_substr($a['multiplier'], 0, -1) * 100;
            $second = (double) mb_substr($b['multiplier'], 0, -1) * 100;
            return [
                $breakpoint_b ? $breakpoint_b->getWeight() : 0,
                $first,
            ] <=> [
                $breakpoint_a ? $breakpoint_a->getWeight() : 0,
                $second,
            ];
        });
    }
    
    /**
     * {@inheritdoc}
     */
    public function hasImageStyleMappings() {
        $mappings = $this->getKeyedImageStyleMappings();
        return !empty($mappings);
    }
    
    /**
     * {@inheritdoc}
     */
    public function getKeyedImageStyleMappings() {
        if (!$this->keyedImageStyleMappings) {
            $this->keyedImageStyleMappings = [];
            foreach ($this->image_style_mappings as $mapping) {
                if (!static::isEmptyImageStyleMapping($mapping)) {
                    $this->keyedImageStyleMappings[$mapping['breakpoint_id']][$mapping['multiplier']] = $mapping;
                }
            }
        }
        return $this->keyedImageStyleMappings;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getImageStyleMappings() {
        return $this->image_style_mappings;
    }
    
    /**
     * {@inheritdoc}
     */
    public function setBreakpointGroup($breakpoint_group) {
        // If the breakpoint group is changed then the image style mappings are
        // invalid.
        if ($breakpoint_group !== $this->breakpoint_group) {
            $this->removeImageStyleMappings();
        }
        $this->breakpoint_group = $breakpoint_group;
        return $this;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getBreakpointGroup() {
        return $this->breakpoint_group;
    }
    
    /**
     * {@inheritdoc}
     */
    public function setFallbackImageStyle($fallback_image_style) {
        $this->fallback_image_style = $fallback_image_style;
        return $this;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getFallbackImageStyle() {
        return $this->fallback_image_style;
    }
    
    /**
     * {@inheritdoc}
     */
    public function removeImageStyleMappings() {
        $this->image_style_mappings = [];
        $this->keyedImageStyleMappings = NULL;
        return $this;
    }
    
    /**
     * {@inheritdoc}
     */
    public function calculateDependencies() {
        parent::calculateDependencies();
        $providers = \Drupal::service('breakpoint.manager')->getGroupProviders($this->breakpoint_group);
        foreach ($providers as $provider => $type) {
            $this->addDependency($type, $provider);
        }
        // Extract all the styles from the image style mappings.
        $styles = ImageStyle::loadMultiple($this->getImageStyleIds());
        array_walk($styles, function ($style) {
            $this->addDependency('config', $style->getConfigDependencyName());
        });
        return $this;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function isEmptyImageStyleMapping(array $image_style_mapping) {
        if (!empty($image_style_mapping)) {
            switch ($image_style_mapping['image_mapping_type']) {
                case 'sizes':
                    // The image style mapping must have a sizes attribute defined and one
                    // or more image styles selected.
                    if ($image_style_mapping['image_mapping']['sizes'] && $image_style_mapping['image_mapping']['sizes_image_styles']) {
                        return FALSE;
                    }
                    break;
                case 'image_style':
                    // The image style mapping must have an image style selected.
                    if ($image_style_mapping['image_mapping']) {
                        return FALSE;
                    }
                    break;
            }
        }
        return TRUE;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getImageStyleMapping($breakpoint_id, $multiplier) {
        $map = $this->getKeyedImageStyleMappings();
        if (isset($map[$breakpoint_id][$multiplier])) {
            return $map[$breakpoint_id][$multiplier];
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function getImageStyleIds() {
        $image_styles = [
            $this->getFallbackImageStyle(),
        ];
        foreach ($this->getImageStyleMappings() as $image_style_mapping) {
            // Only image styles of non-empty mappings should be loaded.
            if (!$this::isEmptyImageStyleMapping($image_style_mapping)) {
                switch ($image_style_mapping['image_mapping_type']) {
                    case 'image_style':
                        $image_styles[] = $image_style_mapping['image_mapping'];
                        break;
                    case 'sizes':
                        $image_styles = array_merge($image_styles, $image_style_mapping['image_mapping']['sizes_image_styles']);
                        break;
                }
            }
        }
        return array_values(array_filter(array_unique($image_styles)));
    }

}

Members

Title Sort descending Modifiers Object type Summary Member alias Overriden Title Overrides
CacheableDependencyTrait::$cacheContexts protected property Cache contexts.
CacheableDependencyTrait::$cacheMaxAge protected property Cache max-age.
CacheableDependencyTrait::$cacheTags protected property Cache tags.
CacheableDependencyTrait::setCacheability protected function Sets cacheability; useful for value object constructors.
ConfigEntityBase::$isUninstalling private property Whether the config is being deleted by the uninstall process.
ConfigEntityBase::$langcode protected property The language code of the entity&#039;s default language.
ConfigEntityBase::$originalId protected property The original ID of the configuration entity.
ConfigEntityBase::$status protected property The enabled/disabled status of the configuration entity. 4
ConfigEntityBase::$third_party_settings protected property
ConfigEntityBase::$trustedData protected property Trust supplied data and not use configuration schema on save.
ConfigEntityBase::$uuid protected property The UUID for this entity.
ConfigEntityBase::$_core protected property
ConfigEntityBase::addDependency protected function Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
ConfigEntityBase::createDuplicate public function Creates a duplicate of the entity. Overrides EntityBase::createDuplicate 1
ConfigEntityBase::disable public function Disables the configuration entity. Overrides ConfigEntityInterface::disable 1
ConfigEntityBase::enable public function Enables the configuration entity. Overrides ConfigEntityInterface::enable
ConfigEntityBase::get public function Returns the value of a property. Overrides ConfigEntityInterface::get
ConfigEntityBase::getCacheTagsToInvalidate public function Returns the cache tags that should be used to invalidate caches. Overrides EntityBase::getCacheTagsToInvalidate 1
ConfigEntityBase::getConfigDependencyName public function Gets the configuration dependency name. Overrides EntityBase::getConfigDependencyName
ConfigEntityBase::getConfigManager protected static function Gets the configuration manager.
ConfigEntityBase::getConfigTarget public function Gets the configuration target identifier for the entity. Overrides EntityBase::getConfigTarget
ConfigEntityBase::getDependencies public function Gets the configuration dependencies. Overrides ConfigEntityInterface::getDependencies
ConfigEntityBase::getOriginalId public function Gets the original ID. Overrides EntityBase::getOriginalId
ConfigEntityBase::getThirdPartyProviders public function Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
ConfigEntityBase::getThirdPartySetting public function Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
ConfigEntityBase::getThirdPartySettings public function Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
ConfigEntityBase::getTypedConfig protected function Gets the typed config manager.
ConfigEntityBase::hasTrustedData public function Gets whether on not the data is trusted. Overrides ConfigEntityInterface::hasTrustedData
ConfigEntityBase::invalidateTagsOnDelete protected static function Override to never invalidate the individual entities&#039; cache tags; the
config system already invalidates them.
Overrides EntityBase::invalidateTagsOnDelete
ConfigEntityBase::invalidateTagsOnSave protected function Override to never invalidate the entity&#039;s cache tag; the config system
already invalidates it.
Overrides EntityBase::invalidateTagsOnSave
ConfigEntityBase::isInstallable public function Checks whether this entity is installable. Overrides ConfigEntityInterface::isInstallable 2
ConfigEntityBase::isNew public function Overrides Entity::isNew(). Overrides EntityBase::isNew
ConfigEntityBase::isUninstalling public function Returns whether this entity is being changed during the uninstall process. Overrides ConfigEntityInterface::isUninstalling
ConfigEntityBase::onDependencyRemoval public function Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityInterface::onDependencyRemoval 8
ConfigEntityBase::preDelete public static function Acts on entities before they are deleted and before hooks are invoked. Overrides EntityBase::preDelete 8
ConfigEntityBase::save public function Saves an entity permanently. Overrides EntityBase::save 2
ConfigEntityBase::set public function Sets the value of a property. Overrides ConfigEntityInterface::set
ConfigEntityBase::setOriginalId public function Sets the original ID. Overrides EntityBase::setOriginalId
ConfigEntityBase::setStatus public function Sets the status of the configuration entity. Overrides ConfigEntityInterface::setStatus
ConfigEntityBase::setThirdPartySetting public function Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
ConfigEntityBase::setUninstalling public function
ConfigEntityBase::sort public static function Helper callback for uasort() to sort configuration entities by weight and label. 6
ConfigEntityBase::status public function Returns whether the configuration entity is enabled. Overrides ConfigEntityInterface::status 4
ConfigEntityBase::toArray public function Gets an array of all property values. Overrides EntityBase::toArray 3
ConfigEntityBase::toUrl public function Gets the URL object for the entity. Overrides EntityBase::toUrl
ConfigEntityBase::trustData public function Sets that the data should be trusted. Overrides ConfigEntityInterface::trustData
ConfigEntityBase::unsetThirdPartySetting public function Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
ConfigEntityBase::__sleep public function Overrides EntityBase::__sleep 4
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function Aliased as: traitSleep 1
DependencySerializationTrait::__wakeup public function 2
DependencyTrait::$dependencies protected property The object&#039;s dependencies.
DependencyTrait::addDependencies protected function Adds multiple dependencies.
DependencyTrait::addDependency protected function Adds a dependency. Aliased as: addDependencyTrait
EntityBase::$enforceIsNew protected property Boolean indicating whether the entity should be forced to be new.
EntityBase::$entityTypeId protected property The entity type.
EntityBase::$typedData protected property A typed data object wrapping this entity.
EntityBase::access public function Checks data value access. Overrides AccessibleInterface::access 1
EntityBase::bundle public function Gets the bundle of the entity. Overrides EntityInterface::bundle 1
EntityBase::create public static function Constructs a new entity object, without permanently saving it. Overrides EntityInterface::create 2
EntityBase::delete public function Deletes an entity permanently. Overrides EntityInterface::delete 1
EntityBase::enforceIsNew public function Enforces an entity to be new. Overrides EntityInterface::enforceIsNew
EntityBase::entityTypeBundleInfo protected function Gets the entity type bundle info service.
EntityBase::entityTypeManager protected function Gets the entity type manager.
EntityBase::getCacheContexts public function The cache contexts associated with this object. Overrides CacheableDependencyTrait::getCacheContexts
EntityBase::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides CacheableDependencyTrait::getCacheMaxAge
EntityBase::getCacheTags public function The cache tags associated with this object. Overrides CacheableDependencyTrait::getCacheTags
EntityBase::getConfigDependencyKey public function Gets the key that is used to store configuration dependencies. Overrides EntityInterface::getConfigDependencyKey
EntityBase::getEntityType public function Gets the entity type definition. Overrides EntityInterface::getEntityType
EntityBase::getEntityTypeId public function Gets the ID of the type of the entity. Overrides EntityInterface::getEntityTypeId
EntityBase::getListCacheTagsToInvalidate protected function The list cache tags to invalidate for this entity.
EntityBase::getTypedData public function Gets a typed data object for this entity object. Overrides EntityInterface::getTypedData
EntityBase::getTypedDataClass private function Returns the typed data class name for this entity.
EntityBase::hasLinkTemplate public function Indicates if a link template exists for a given key. Overrides EntityInterface::hasLinkTemplate
EntityBase::id public function Gets the identifier. Overrides EntityInterface::id 10
EntityBase::label public function Gets the label of the entity. Overrides EntityInterface::label 6
EntityBase::language public function Gets the language of the entity. Overrides EntityInterface::language 1
EntityBase::languageManager protected function Gets the language manager.
EntityBase::linkTemplates protected function Gets an array link templates. 1
EntityBase::load public static function Loads an entity. Overrides EntityInterface::load
EntityBase::loadMultiple public static function Loads one or more entities. Overrides EntityInterface::loadMultiple
EntityBase::postCreate public function Acts on a created entity before hooks are invoked. Overrides EntityInterface::postCreate 5
EntityBase::postDelete public static function Acts on deleted entities before the delete hook is invoked. Overrides EntityInterface::postDelete 17
EntityBase::postLoad public static function Acts on loaded entities. Overrides EntityInterface::postLoad 3
EntityBase::postSave public function Acts on a saved entity before the insert or update hook is invoked. Overrides EntityInterface::postSave 13
EntityBase::preCreate public static function Changes the values of an entity before it is created. Overrides EntityInterface::preCreate 6
EntityBase::referencedEntities public function Gets a list of entities referenced by this entity. Overrides EntityInterface::referencedEntities 1
EntityBase::toLink public function Generates the HTML for a link to this entity. Overrides EntityInterface::toLink
EntityBase::uriRelationships public function Gets a list of URI relationships supported by this entity. Overrides EntityInterface::uriRelationships
EntityBase::urlRouteParameters protected function Gets an array of placeholders for this entity. 2
EntityBase::uuid public function Gets the entity UUID (Universally Unique Identifier). Overrides EntityInterface::uuid 1
EntityBase::uuidGenerator protected function Gets the UUID generator.
PluginDependencyTrait::calculatePluginDependencies protected function Calculates and adds dependencies of a specific plugin instance. 1
PluginDependencyTrait::getPluginDependencies protected function Calculates and returns dependencies of a specific plugin instance.
PluginDependencyTrait::moduleHandler protected function Wraps the module handler. 1
PluginDependencyTrait::themeHandler protected function Wraps the theme handler. 1
RefinableCacheableDependencyTrait::addCacheableDependency public function 1
RefinableCacheableDependencyTrait::addCacheContexts public function
RefinableCacheableDependencyTrait::addCacheTags public function
RefinableCacheableDependencyTrait::mergeCacheMaxAge public function
ResponsiveImageStyle::$breakpoint_group protected property The responsive image breakpoint group.
ResponsiveImageStyle::$fallback_image_style protected property The fallback image style.
ResponsiveImageStyle::$id protected property The responsive image ID (machine name).
ResponsiveImageStyle::$image_style_mappings protected property The image style mappings.
ResponsiveImageStyle::$keyedImageStyleMappings protected property
ResponsiveImageStyle::$label protected property The responsive image label.
ResponsiveImageStyle::addImageStyleMapping public function Adds an image style mapping to the responsive image configuration entity. Overrides ResponsiveImageStyleInterface::addImageStyleMapping
ResponsiveImageStyle::calculateDependencies public function Calculates dependencies and stores them in the dependency property. Overrides ConfigEntityBase::calculateDependencies
ResponsiveImageStyle::getBreakpointGroup public function Returns the breakpoint group for the responsive image style. Overrides ResponsiveImageStyleInterface::getBreakpointGroup
ResponsiveImageStyle::getFallbackImageStyle public function Returns the fallback image style ID for the responsive image style. Overrides ResponsiveImageStyleInterface::getFallbackImageStyle
ResponsiveImageStyle::getImageStyleIds public function Gets all the image styles IDs involved in the responsive image mapping. Overrides ResponsiveImageStyleInterface::getImageStyleIds
ResponsiveImageStyle::getImageStyleMapping public function Gets the image style mapping for a breakpoint ID and multiplier. Overrides ResponsiveImageStyleInterface::getImageStyleMapping
ResponsiveImageStyle::getImageStyleMappings public function Returns the image style mappings for the responsive image style. Overrides ResponsiveImageStyleInterface::getImageStyleMappings
ResponsiveImageStyle::getKeyedImageStyleMappings public function Returns the mappings of breakpoint ID and multiplier to image style. Overrides ResponsiveImageStyleInterface::getKeyedImageStyleMappings
ResponsiveImageStyle::hasImageStyleMappings public function Checks if there is at least one mapping defined. Overrides ResponsiveImageStyleInterface::hasImageStyleMappings
ResponsiveImageStyle::isEmptyImageStyleMapping public static function Checks if there is at least one image style mapping defined. Overrides ResponsiveImageStyleInterface::isEmptyImageStyleMapping
ResponsiveImageStyle::preSave public function Acts on an entity before the presave hook is invoked. Overrides ConfigEntityBase::preSave
ResponsiveImageStyle::removeImageStyleMappings public function Removes all image style mappings from the responsive image style. Overrides ResponsiveImageStyleInterface::removeImageStyleMappings
ResponsiveImageStyle::setBreakpointGroup public function Sets the breakpoint group for the responsive image style. Overrides ResponsiveImageStyleInterface::setBreakpointGroup
ResponsiveImageStyle::setFallbackImageStyle public function Sets the fallback image style for the responsive image style. Overrides ResponsiveImageStyleInterface::setFallbackImageStyle
ResponsiveImageStyle::sortMappings protected function Sort mappings by breakpoint ID and multiplier.
ResponsiveImageStyle::__construct public function Constructs an Entity object. Overrides ConfigEntityBase::__construct
ResponsiveImageStyleInterface::EMPTY_IMAGE constant The machine name for the empty image breakpoint image style option.
ResponsiveImageStyleInterface::ORIGINAL_IMAGE constant The machine name for the original image breakpoint image style option.
SynchronizableEntityTrait::$isSyncing protected property Is entity being created updated or deleted through synchronization process.
SynchronizableEntityTrait::isSyncing public function
SynchronizableEntityTrait::setSyncing public function

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