interface ResponsiveImageStyleInterface
Same name in other branches
- 8.9.x core/modules/responsive_image/src/ResponsiveImageStyleInterface.php \Drupal\responsive_image\ResponsiveImageStyleInterface
- 10 core/modules/responsive_image/src/ResponsiveImageStyleInterface.php \Drupal\responsive_image\ResponsiveImageStyleInterface
- 11.x core/modules/responsive_image/src/ResponsiveImageStyleInterface.php \Drupal\responsive_image\ResponsiveImageStyleInterface
Provides an interface defining a responsive_image mapping entity.
Hierarchy
- interface \Drupal\Core\Config\Entity\ThirdPartySettingsInterface; interface \Drupal\Core\Entity\EntityInterface extends \Drupal\Core\Access\AccessibleInterface \Drupal\Core\Cache\CacheableDependencyInterface \Drupal\Core\Cache\RefinableCacheableDependencyInterface; interface \Drupal\Core\Entity\SynchronizableInterface extends \Drupal\Core\Entity\EntityInterface
- interface \Drupal\Core\Config\Entity\ConfigEntityInterface extends \Drupal\Core\Entity\EntityInterface \Drupal\Core\Config\Entity\ThirdPartySettingsInterface \Drupal\Core\Entity\SynchronizableInterface
- interface \Drupal\responsive_image\ResponsiveImageStyleInterface extends \Drupal\Core\Config\Entity\ConfigEntityInterface
- interface \Drupal\Core\Config\Entity\ConfigEntityInterface extends \Drupal\Core\Entity\EntityInterface \Drupal\Core\Config\Entity\ThirdPartySettingsInterface \Drupal\Core\Entity\SynchronizableInterface
Expanded class hierarchy of ResponsiveImageStyleInterface
All classes that implement ResponsiveImageStyleInterface
4 files declare their use of ResponsiveImageStyleInterface
- ResponsiveImageAdminUITest.php in core/
modules/ responsive_image/ tests/ src/ Functional/ ResponsiveImageAdminUITest.php - ResponsiveImageFieldDisplayTest.php in core/
modules/ responsive_image/ tests/ src/ Functional/ ResponsiveImageFieldDisplayTest.php - 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.
File
-
core/
modules/ responsive_image/ src/ ResponsiveImageStyleInterface.php, line 10
Namespace
Drupal\responsive_imageView source
interface ResponsiveImageStyleInterface extends ConfigEntityInterface {
/**
* The machine name for the empty image breakpoint image style option.
*/
const EMPTY_IMAGE = '_empty image_';
/**
* The machine name for the original image breakpoint image style option.
*/
const ORIGINAL_IMAGE = '_original image_';
/**
* Checks if there is at least one mapping defined.
*
* @return bool
* Whether the entity has any image style mappings.
*/
public function hasImageStyleMappings();
/**
* Returns the mappings of breakpoint ID and multiplier to image style.
*
* @return 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.
*/
public function getKeyedImageStyleMappings();
/**
* Returns the image style mappings for the responsive image style.
*
* @return array[]
* An array of image style mappings. Each image style mapping array
* contains the following keys:
* - breakpoint_id
* - multiplier
* - image_mapping_type
* - image_mapping
*/
public function getImageStyleMappings();
/**
* Sets the breakpoint group for the responsive image style.
*
* @param string $breakpoint_group
* The responsive image style breakpoint group.
*
* @return $this
*/
public function setBreakpointGroup($breakpoint_group);
/**
* Returns the breakpoint group for the responsive image style.
*
* @return string
* The breakpoint group.
*/
public function getBreakpointGroup();
/**
* Sets the fallback image style for the responsive image style.
*
* @param string $fallback_image_style
* The fallback image style ID.
*
* @return $this
*/
public function setFallbackImageStyle($fallback_image_style);
/**
* Returns the fallback image style ID for the responsive image style.
*
* @return string
* The fallback image style ID.
*/
public function getFallbackImageStyle();
/**
* Gets the image style mapping for a breakpoint ID and multiplier.
*
* @param string $breakpoint_id
* The breakpoint ID.
* @param string $multiplier
* The multiplier.
*
* @return array|null
* The image style mapping. NULL if the mapping does not exist.
* The image style mapping has 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 image style mapping.
* - multiplier: The multiplier for this image style mapping.
*/
public function getImageStyleMapping($breakpoint_id, $multiplier);
/**
* Checks if there is at least one image style mapping defined.
*
* @param array $image_style_mapping
* The image style mapping.
*
* @return bool
* Whether the image style mapping is empty.
*/
public static function isEmptyImageStyleMapping(array $image_style_mapping);
/**
* Adds an image style mapping to the responsive image configuration entity.
*
* @param string $breakpoint_id
* The breakpoint ID.
* @param string $multiplier
* The multiplier.
* @param array $image_style_mapping
* The mapping image style mapping.
*
* @return $this
*/
public function addImageStyleMapping($breakpoint_id, $multiplier, array $image_style_mapping);
/**
* Removes all image style mappings from the responsive image style.
*
* @return $this
*/
public function removeImageStyleMappings();
/**
* Gets all the image styles IDs involved in the responsive image mapping.
*
* @return string[]
*/
public function getImageStyleIds();
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overrides |
---|---|---|---|---|
AccessibleInterface::access | public | function | Checks data value access. | 9 |
CacheableDependencyInterface::getCacheContexts | public | function | The cache contexts associated with this object. | 34 |
CacheableDependencyInterface::getCacheMaxAge | public | function | The maximum age for which this object may be cached. | 34 |
CacheableDependencyInterface::getCacheTags | public | function | The cache tags associated with this object. | 27 |
ConfigEntityInterface::calculateDependencies | public | function | Calculates dependencies and stores them in the dependency property. | 2 |
ConfigEntityInterface::disable | public | function | Disables the configuration entity. | 2 |
ConfigEntityInterface::enable | public | function | Enables the configuration entity. | 2 |
ConfigEntityInterface::get | public | function | Returns the value of a property. | 2 |
ConfigEntityInterface::getDependencies | public | function | Gets the configuration dependencies. | 2 |
ConfigEntityInterface::hasTrustedData | public | function | Gets whether on not the data is trusted. | 2 |
ConfigEntityInterface::isInstallable | public | function | Checks whether this entity is installable. | 2 |
ConfigEntityInterface::isUninstalling | public | function | Returns whether this entity is being changed during the uninstall process. | 2 |
ConfigEntityInterface::onDependencyRemoval | public | function | Informs the entity that entities it depends on will be deleted. | 2 |
ConfigEntityInterface::set | public | function | Sets the value of a property. | 2 |
ConfigEntityInterface::setStatus | public | function | Sets the status of the configuration entity. | 2 |
ConfigEntityInterface::status | public | function | Returns whether the configuration entity is enabled. | 2 |
ConfigEntityInterface::trustData | public | function | Sets that the data should be trusted. | 2 |
EntityInterface::bundle | public | function | Gets the bundle of the entity. | 2 |
EntityInterface::create | public static | function | Constructs a new entity object, without permanently saving it. | 2 |
EntityInterface::createDuplicate | public | function | Creates a duplicate of the entity. | 2 |
EntityInterface::delete | public | function | Deletes an entity permanently. | 2 |
EntityInterface::enforceIsNew | public | function | Enforces an entity to be new. | 2 |
EntityInterface::getCacheTagsToInvalidate | public | function | Returns the cache tags that should be used to invalidate caches. | 2 |
EntityInterface::getConfigDependencyKey | public | function | Gets the key that is used to store configuration dependencies. | 2 |
EntityInterface::getConfigDependencyName | public | function | Gets the configuration dependency name. | 2 |
EntityInterface::getConfigTarget | public | function | Gets the configuration target identifier for the entity. | 2 |
EntityInterface::getEntityType | public | function | Gets the entity type definition. | 2 |
EntityInterface::getEntityTypeId | public | function | Gets the ID of the type of the entity. | 2 |
EntityInterface::getOriginalId | public | function | Gets the original ID. | 2 |
EntityInterface::getTypedData | public | function | Gets a typed data object for this entity object. | 2 |
EntityInterface::hasLinkTemplate | public | function | Indicates if a link template exists for a given key. | 2 |
EntityInterface::id | public | function | Gets the identifier. | 2 |
EntityInterface::isNew | public | function | Determines whether the entity is new. | 2 |
EntityInterface::label | public | function | Gets the label of the entity. | 2 |
EntityInterface::language | public | function | Gets the language of the entity. | 2 |
EntityInterface::load | public static | function | Loads an entity. | 2 |
EntityInterface::loadMultiple | public static | function | Loads one or more entities. | 2 |
EntityInterface::postCreate | public | function | Acts on a created entity before hooks are invoked. | 2 |
EntityInterface::postDelete | public static | function | Acts on deleted entities before the delete hook is invoked. | 2 |
EntityInterface::postLoad | public static | function | Acts on loaded entities. | 3 |
EntityInterface::postSave | public | function | Acts on a saved entity before the insert or update hook is invoked. | 2 |
EntityInterface::preCreate | public static | function | Changes the values of an entity before it is created. | 2 |
EntityInterface::preDelete | public static | function | Acts on entities before they are deleted and before hooks are invoked. | 2 |
EntityInterface::preSave | public | function | Acts on an entity before the presave hook is invoked. | 2 |
EntityInterface::referencedEntities | public | function | Gets a list of entities referenced by this entity. | 2 |
EntityInterface::save | public | function | Saves an entity permanently. | 2 |
EntityInterface::setOriginalId | public | function | Sets the original ID. | 2 |
EntityInterface::toArray | public | function | Gets an array of all property values. | 3 |
EntityInterface::toLink | public | function | Generates the HTML for a link to this entity. | 2 |
EntityInterface::toUrl | public | function | Gets the URL object for the entity. | 2 |
EntityInterface::uriRelationships | public | function | Gets a list of URI relationships supported by this entity. | 2 |
EntityInterface::uuid | public | function | Gets the entity UUID (Universally Unique Identifier). | 2 |
RefinableCacheableDependencyInterface::addCacheableDependency | public | function | Adds a dependency on an object: merges its cacheability metadata. | 1 |
RefinableCacheableDependencyInterface::addCacheContexts | public | function | Adds cache contexts. | 1 |
RefinableCacheableDependencyInterface::addCacheTags | public | function | Adds cache tags. | 1 |
RefinableCacheableDependencyInterface::mergeCacheMaxAge | public | function | Merges the maximum age (in seconds) with the existing maximum age. | 1 |
ResponsiveImageStyleInterface::addImageStyleMapping | public | function | Adds an image style mapping to the responsive image configuration entity. | 1 |
ResponsiveImageStyleInterface::EMPTY_IMAGE | constant | The machine name for the empty image breakpoint image style option. | ||
ResponsiveImageStyleInterface::getBreakpointGroup | public | function | Returns the breakpoint group for the responsive image style. | 1 |
ResponsiveImageStyleInterface::getFallbackImageStyle | public | function | Returns the fallback image style ID for the responsive image style. | 1 |
ResponsiveImageStyleInterface::getImageStyleIds | public | function | Gets all the image styles IDs involved in the responsive image mapping. | 1 |
ResponsiveImageStyleInterface::getImageStyleMapping | public | function | Gets the image style mapping for a breakpoint ID and multiplier. | 1 |
ResponsiveImageStyleInterface::getImageStyleMappings | public | function | Returns the image style mappings for the responsive image style. | 1 |
ResponsiveImageStyleInterface::getKeyedImageStyleMappings | public | function | Returns the mappings of breakpoint ID and multiplier to image style. | 1 |
ResponsiveImageStyleInterface::hasImageStyleMappings | public | function | Checks if there is at least one mapping defined. | 1 |
ResponsiveImageStyleInterface::isEmptyImageStyleMapping | public static | function | Checks if there is at least one image style mapping defined. | 1 |
ResponsiveImageStyleInterface::ORIGINAL_IMAGE | constant | The machine name for the original image breakpoint image style option. | ||
ResponsiveImageStyleInterface::removeImageStyleMappings | public | function | Removes all image style mappings from the responsive image style. | 1 |
ResponsiveImageStyleInterface::setBreakpointGroup | public | function | Sets the breakpoint group for the responsive image style. | 1 |
ResponsiveImageStyleInterface::setFallbackImageStyle | public | function | Sets the fallback image style for the responsive image style. | 1 |
SynchronizableInterface::isSyncing | public | function | Returns whether this entity is being changed as part of a synchronization. | 1 |
SynchronizableInterface::setSyncing | public | function | Sets the status of the synchronization flag. | 1 |
ThirdPartySettingsInterface::getThirdPartyProviders | public | function | Gets the list of third parties that store information. | 5 |
ThirdPartySettingsInterface::getThirdPartySetting | public | function | Gets the value of a third-party setting. | 5 |
ThirdPartySettingsInterface::getThirdPartySettings | public | function | Gets all third-party settings of a given module. | 5 |
ThirdPartySettingsInterface::setThirdPartySetting | public | function | Sets the value of a third-party setting. | 5 |
ThirdPartySettingsInterface::unsetThirdPartySetting | public | function | Unsets a third-party setting. | 5 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.