interface ImageStyleStorageInterface
Same name in other branches
- 9 core/modules/image/src/ImageStyleStorageInterface.php \Drupal\image\ImageStyleStorageInterface
- 8.9.x 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\Core\Entity\EntityStorageInterface
- interface \Drupal\Core\Config\Entity\ConfigEntityStorageInterface extends \Drupal\Core\Entity\EntityStorageInterface
- interface \Drupal\image\ImageStyleStorageInterface extends \Drupal\Core\Config\Entity\ConfigEntityStorageInterface
- interface \Drupal\Core\Config\Entity\ConfigEntityStorageInterface extends \Drupal\Core\Entity\EntityStorageInterface
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 10
Namespace
Drupal\imageView source
interface ImageStyleStorageInterface extends ConfigEntityStorageInterface {
/**
* 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 an 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 | Deprecated | Modifiers | Object type | Summary | Overrides |
---|---|---|---|---|---|
ConfigEntityStorageInterface::createFromStorageRecord | public | function | Creates a configuration entity from storage values. | 1 | |
ConfigEntityStorageInterface::getIDFromConfigName | public static | function | Extracts the configuration entity ID from the full configuration name. | 1 | |
ConfigEntityStorageInterface::loadMultipleOverrideFree | public | function | Loads one or more entities in their original form without overrides. | 1 | |
ConfigEntityStorageInterface::loadOverrideFree | public | function | Loads one entity in their original form without overrides. | 1 | |
ConfigEntityStorageInterface::updateFromStorageRecord | public | function | Updates a configuration entity from storage values. | 1 | |
EntityStorageInterface::create | public | function | Constructs a new entity object, without permanently saving it. | 1 | |
EntityStorageInterface::delete | public | function | Deletes permanently saved entities. | 1 | |
EntityStorageInterface::deleteRevision | Deprecated | public | function | Delete a specific entity revision. | 4 |
EntityStorageInterface::FIELD_LOAD_CURRENT | constant | Load the most recent version of an entity's field data. | |||
EntityStorageInterface::FIELD_LOAD_REVISION | constant | Load the version of an entity's field data specified in the entity. | |||
EntityStorageInterface::getAggregateQuery | public | function | Gets an aggregated query instance. | 1 | |
EntityStorageInterface::getEntityClass | public | function | Retrieves the class name used to create the entity. | 1 | |
EntityStorageInterface::getEntityType | public | function | Gets the entity type definition. | 1 | |
EntityStorageInterface::getEntityTypeId | public | function | Gets the entity type ID. | 1 | |
EntityStorageInterface::getQuery | public | function | Gets an entity query instance. | 1 | |
EntityStorageInterface::hasData | public | function | Determines if the storage contains any data. | 1 | |
EntityStorageInterface::load | public | function | Loads one entity. | 1 | |
EntityStorageInterface::loadByProperties | public | function | Load entities by their property values without any access checks. | 1 | |
EntityStorageInterface::loadMultiple | public | function | Loads one or more entities. | 1 | |
EntityStorageInterface::loadRevision | Deprecated | public | function | Load a specific entity revision. | 4 |
EntityStorageInterface::loadUnchanged | public | function | Loads an unchanged entity from the database. | 1 | |
EntityStorageInterface::resetCache | public | function | Resets the internal entity cache. | 1 | |
EntityStorageInterface::restore | public | function | Restores a previously saved entity. | 1 | |
EntityStorageInterface::save | public | function | Saves the entity permanently. | 1 | |
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.