interface ImageStyleStorageInterface
Same name in other branches
- 9 core/modules/image/src/ImageStyleStorageInterface.php \Drupal\image\ImageStyleStorageInterface
- 10 core/modules/image/src/ImageStyleStorageInterface.php \Drupal\image\ImageStyleStorageInterface
- 11.x core/modules/image/src/ImageStyleStorageInterface.php \Drupal\image\ImageStyleStorageInterface
Interface for storage controller for "image style" configuration entities.
Hierarchy
- interface \Drupal\image\ImageStyleStorageInterface
Expanded class hierarchy of ImageStyleStorageInterface
All classes that implement ImageStyleStorageInterface
1 file declares its use of ImageStyleStorageInterface
- MediaThumbnailFormatter.php in core/
modules/ media/ src/ Plugin/ Field/ FieldFormatter/ MediaThumbnailFormatter.php
File
-
core/
modules/ image/ src/ ImageStyleStorageInterface.php, line 8
Namespace
Drupal\imageView source
interface ImageStyleStorageInterface {
/**
* Stores a replacement ID for an image style being deleted.
*
* The method stores a replacement style to be used by the configuration
* dependency system when a image style is deleted. The replacement style is
* replacing the deleted style in other configuration entities that are
* depending on the image style being deleted.
*
* @param string $name
* The ID of the image style to be deleted.
* @param string $replacement
* The ID of the image style used as replacement.
*/
public function setReplacementId($name, $replacement);
/**
* Retrieves the replacement ID of a deleted image style.
*
* The method is retrieving the value stored by ::setReplacementId().
*
* @param string $name
* The ID of the image style to be replaced.
*
* @return string|null
* The ID of the image style used as replacement, if there's any, or NULL.
*
* @see \Drupal\image\ImageStyleStorageInterface::setReplacementId()
*/
public function getReplacementId($name);
/**
* Clears a replacement ID from the storage.
*
* The method clears the value previously stored with ::setReplacementId().
*
* @param string $name
* The ID of the image style to be replaced.
*
* @see \Drupal\image\ImageStyleStorageInterface::setReplacementId()
*/
public function clearReplacementId($name);
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overrides |
---|---|---|---|---|
ImageStyleStorageInterface::clearReplacementId | public | function | Clears a replacement ID from the storage. | 1 |
ImageStyleStorageInterface::getReplacementId | public | function | Retrieves the replacement ID of a deleted image style. | 1 |
ImageStyleStorageInterface::setReplacementId | public | function | Stores a replacement ID for an image style being deleted. | 1 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.