class ImageStyle
Same name in other branches
- 8.9.x core/modules/image/src/Entity/ImageStyle.php \Drupal\image\Entity\ImageStyle
- 10 core/modules/image/src/Entity/ImageStyle.php \Drupal\image\Entity\ImageStyle
- 11.x core/modules/image/src/Entity/ImageStyle.php \Drupal\image\Entity\ImageStyle
Defines an image style configuration entity.
Plugin annotation
@ConfigEntityType(
id = "image_style",
label = @Translation("Image style"),
label_collection = @Translation("Image styles"),
label_singular = @Translation("image style"),
label_plural = @Translation("image styles"),
label_count = @PluralTranslation(
singular = "@count image style",
plural = "@count image styles",
),
handlers = {
"form" = {
"add" = "Drupal\image\Form\ImageStyleAddForm",
"edit" = "Drupal\image\Form\ImageStyleEditForm",
"delete" = "Drupal\image\Form\ImageStyleDeleteForm",
"flush" = "Drupal\image\Form\ImageStyleFlushForm"
},
"list_builder" = "Drupal\image\ImageStyleListBuilder",
"storage" = "Drupal\image\ImageStyleStorage",
},
admin_permission = "administer image styles",
config_prefix = "style",
entity_keys = {
"id" = "name",
"label" = "label"
},
links = {
"flush-form" = "/admin/config/media/image-styles/manage/{image_style}/flush",
"edit-form" = "/admin/config/media/image-styles/manage/{image_style}",
"delete-form" = "/admin/config/media/image-styles/manage/{image_style}/delete",
"collection" = "/admin/config/media/image-styles",
},
config_export = {
"name",
"label",
"effects",
}
)
Hierarchy
- class \Drupal\Core\Entity\EntityBase implements \Drupal\Core\Entity\EntityInterface uses \Drupal\Core\Cache\RefinableCacheableDependencyTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait
- class \Drupal\Core\Config\Entity\ConfigEntityBase extends \Drupal\Core\Entity\EntityBase implements \Drupal\Core\Config\Entity\ConfigEntityInterface uses \Drupal\Core\Plugin\PluginDependencyTrait, \Drupal\Core\Entity\SynchronizableEntityTrait
- class \Drupal\image\Entity\ImageStyle extends \Drupal\Core\Config\Entity\ConfigEntityBase implements \Drupal\image\ImageStyleInterface, \Drupal\Core\Entity\EntityWithPluginCollectionInterface
- class \Drupal\Core\Config\Entity\ConfigEntityBase extends \Drupal\Core\Entity\EntityBase implements \Drupal\Core\Config\Entity\ConfigEntityInterface uses \Drupal\Core\Plugin\PluginDependencyTrait, \Drupal\Core\Entity\SynchronizableEntityTrait
Expanded class hierarchy of ImageStyle
33 files declare their use of ImageStyle
- ConfigEntityImportTest.php in core/
modules/ system/ tests/ src/ Kernel/ Entity/ ConfigEntityImportTest.php - ConvertTest.php in core/
modules/ image/ tests/ src/ Functional/ ImageEffect/ ConvertTest.php - FileMoveTest.php in core/
modules/ image/ tests/ src/ Functional/ FileMoveTest.php - image.module in core/
modules/ image/ image.module - Exposes global functionality for creating image styles.
- ImageAdminStylesTest.php in core/
modules/ image/ tests/ src/ Functional/ ImageAdminStylesTest.php
File
-
core/
modules/ image/ src/ Entity/ ImageStyle.php, line 67
Namespace
Drupal\image\EntityView source
class ImageStyle extends ConfigEntityBase implements ImageStyleInterface, EntityWithPluginCollectionInterface {
/**
* The name of the image style.
*
* @var string
*/
protected $name;
/**
* The image style label.
*
* @var string
*/
protected $label;
/**
* The array of image effects for this image style.
*
* @var array
*/
protected $effects = [];
/**
* Holds the collection of image effects that are used by this image style.
*
* @var \Drupal\image\ImageEffectPluginCollection
*/
protected $effectsCollection;
/**
* {@inheritdoc}
*/
public function id() {
return $this->name;
}
/**
* {@inheritdoc}
*/
public function postSave(EntityStorageInterface $storage, $update = TRUE) {
parent::postSave($storage, $update);
if ($update) {
if (!empty($this->original) && $this->id() !== $this->original
->id()) {
// The old image style name needs flushing after a rename.
$this->original
->flush();
// Update field settings if necessary.
if (!$this->isSyncing()) {
static::replaceImageStyle($this);
}
}
else {
// Flush image style when updating without changing the name.
$this->flush();
}
}
}
/**
* {@inheritdoc}
*/
public static function postDelete(EntityStorageInterface $storage, array $entities) {
parent::postDelete($storage, $entities);
/** @var \Drupal\image\ImageStyleInterface[] $entities */
foreach ($entities as $style) {
// Flush cached media for the deleted style.
$style->flush();
// Clear the replacement ID, if one has been previously stored.
/** @var \Drupal\image\ImageStyleStorageInterface $storage */
$storage->clearReplacementId($style->id());
}
}
/**
* Update field settings if the image style name is changed.
*
* @param \Drupal\image\ImageStyleInterface $style
* The image style.
*/
protected static function replaceImageStyle(ImageStyleInterface $style) {
if ($style->id() != $style->getOriginalId()) {
// Loop through all entity displays looking for formatters / widgets using
// the image style.
foreach (EntityViewDisplay::loadMultiple() as $display) {
foreach ($display->getComponents() as $name => $options) {
if (isset($options['type']) && $options['type'] == 'image' && $options['settings']['image_style'] == $style->getOriginalId()) {
$options['settings']['image_style'] = $style->id();
$display->setComponent($name, $options)
->save();
}
}
}
foreach (EntityFormDisplay::loadMultiple() as $display) {
foreach ($display->getComponents() as $name => $options) {
if (isset($options['type']) && $options['type'] == 'image_image' && $options['settings']['preview_image_style'] == $style->getOriginalId()) {
$options['settings']['preview_image_style'] = $style->id();
$display->setComponent($name, $options)
->save();
}
}
}
}
}
/**
* {@inheritdoc}
*/
public function buildUri($uri) {
$source_scheme = $scheme = StreamWrapperManager::getScheme($uri);
$default_scheme = $this->fileDefaultScheme();
if ($source_scheme) {
$path = StreamWrapperManager::getTarget($uri);
// The scheme of derivative image files only needs to be computed for
// source files not stored in the default scheme.
if ($source_scheme != $default_scheme) {
$class = $this->getStreamWrapperManager()
->getClass($source_scheme);
$is_writable = NULL;
if ($class) {
$is_writable = $class::getType() & StreamWrapperInterface::WRITE;
}
// Compute the derivative URI scheme. Derivatives created from writable
// source stream wrappers will inherit the scheme. Derivatives created
// from read-only stream wrappers will fall-back to the default scheme.
$scheme = $is_writable ? $source_scheme : $default_scheme;
}
}
else {
$path = $uri;
$source_scheme = $scheme = $default_scheme;
}
return "{$scheme}://styles/{$this->id()}/{$source_scheme}/{$this->addExtension($path)}";
}
/**
* {@inheritdoc}
*/
public function buildUrl($path, $clean_urls = NULL) {
/** @var \Drupal\Core\StreamWrapper\StreamWrapperManagerInterface $stream_wrapper_manager */
$stream_wrapper_manager = \Drupal::service('stream_wrapper_manager');
$uri = $stream_wrapper_manager->normalizeUri($this->buildUri($path));
// The token query is added even if the
// 'image.settings:allow_insecure_derivatives' configuration is TRUE, so
// that the emitted links remain valid if it is changed back to the default
// FALSE. However, sites which need to prevent the token query from being
// emitted at all can additionally set the
// 'image.settings:suppress_itok_output' configuration to TRUE to achieve
// that (if both are set, the security token will neither be emitted in the
// image derivative URL nor checked for in
// \Drupal\image\ImageStyleInterface::deliver()).
$token_query = [];
if (!\Drupal::config('image.settings')->get('suppress_itok_output')) {
// The passed $path variable can be either a relative path or a full URI.
if (!$stream_wrapper_manager::getScheme($path)) {
$path = \Drupal::config('system.file')->get('default_scheme') . '://' . $path;
}
$original_uri = $stream_wrapper_manager->normalizeUri($path);
$token_query = [
IMAGE_DERIVATIVE_TOKEN => $this->getPathToken($original_uri),
];
}
if ($clean_urls === NULL) {
// Assume clean URLs unless the request tells us otherwise.
$clean_urls = TRUE;
try {
$request = \Drupal::request();
$clean_urls = RequestHelper::isCleanUrl($request);
} catch (ServiceNotFoundException $e) {
}
}
// If not using clean URLs, the image derivative callback is only available
// with the script path. If the file does not exist, use Url::fromUri() to
// ensure that it is included. Once the file exists it's fine to fall back
// to the actual file path, this avoids bootstrapping PHP once the files are
// built.
if ($clean_urls === FALSE && $stream_wrapper_manager::getScheme($uri) == 'public' && !file_exists($uri)) {
$directory_path = $stream_wrapper_manager->getViaUri($uri)
->getDirectoryPath();
return Url::fromUri('base:' . $directory_path . '/' . $stream_wrapper_manager::getTarget($uri), [
'absolute' => TRUE,
'query' => $token_query,
])->toString();
}
/** @var \Drupal\Core\File\FileUrlGeneratorInterface $file_url_generator */
$file_url_generator = \Drupal::service('file_url_generator');
$file_url = $file_url_generator->generateAbsoluteString($uri);
// Append the query string with the token, if necessary.
if ($token_query) {
$file_url .= (strpos($file_url, '?') !== FALSE ? '&' : '?') . UrlHelper::buildQuery($token_query);
}
return $file_url;
}
/**
* {@inheritdoc}
*/
public function flush($path = NULL) {
// A specific image path has been provided. Flush only that derivative.
/** @var \Drupal\Core\File\FileSystemInterface $file_system */
$file_system = \Drupal::service('file_system');
if (isset($path)) {
$derivative_uri = $this->buildUri($path);
if (file_exists($derivative_uri)) {
try {
$file_system->delete($derivative_uri);
} catch (FileException $e) {
// Ignore failed deletes.
}
}
return $this;
}
// Delete the style directory in each registered wrapper.
$wrappers = $this->getStreamWrapperManager()
->getWrappers(StreamWrapperInterface::WRITE_VISIBLE);
foreach ($wrappers as $wrapper => $wrapper_data) {
if (file_exists($directory = $wrapper . '://styles/' . $this->id())) {
try {
$file_system->deleteRecursive($directory);
} catch (FileException $e) {
// Ignore failed deletes.
}
}
}
// Let other modules update as necessary on flush.
$module_handler = \Drupal::moduleHandler();
$module_handler->invokeAll('image_style_flush', [
$this,
]);
// Clear caches so that formatters may be added for this style.
drupal_theme_rebuild();
Cache::invalidateTags($this->getCacheTagsToInvalidate());
return $this;
}
/**
* {@inheritdoc}
*/
public function createDerivative($original_uri, $derivative_uri) {
// If the source file doesn't exist, return FALSE without creating folders.
$image = $this->getImageFactory()
->get($original_uri);
if (!$image->isValid()) {
return FALSE;
}
// Get the folder for the final location of this style.
$directory = \Drupal::service('file_system')->dirname($derivative_uri);
// Build the destination folder tree if it doesn't already exist.
if (!\Drupal::service('file_system')->prepareDirectory($directory, FileSystemInterface::CREATE_DIRECTORY | FileSystemInterface::MODIFY_PERMISSIONS)) {
\Drupal::logger('image')->error('Failed to create style directory: %directory', [
'%directory' => $directory,
]);
return FALSE;
}
foreach ($this->getEffects() as $effect) {
$effect->applyEffect($image);
}
if (!$image->save($derivative_uri)) {
if (file_exists($derivative_uri)) {
\Drupal::logger('image')->error('Cached image file %destination already exists. There may be an issue with your rewrite configuration.', [
'%destination' => $derivative_uri,
]);
}
return FALSE;
}
return TRUE;
}
/**
* {@inheritdoc}
*/
public function transformDimensions(array &$dimensions, $uri) {
foreach ($this->getEffects() as $effect) {
$effect->transformDimensions($dimensions, $uri);
}
}
/**
* {@inheritdoc}
*/
public function getDerivativeExtension($extension) {
foreach ($this->getEffects() as $effect) {
$extension = $effect->getDerivativeExtension($extension);
}
return $extension;
}
/**
* {@inheritdoc}
*/
public function getPathToken($uri) {
// Return the first 8 characters.
return substr(Crypt::hmacBase64($this->id() . ':' . $this->addExtension($uri), $this->getPrivateKey() . $this->getHashSalt()), 0, 8);
}
/**
* {@inheritdoc}
*/
public function deleteImageEffect(ImageEffectInterface $effect) {
$this->getEffects()
->removeInstanceId($effect->getUuid());
$this->save();
return $this;
}
/**
* {@inheritdoc}
*/
public function supportsUri($uri) {
// Only support the URI if its extension is supported by the current image
// toolkit.
return in_array(mb_strtolower(pathinfo($uri, PATHINFO_EXTENSION)), $this->getImageFactory()
->getSupportedExtensions());
}
/**
* {@inheritdoc}
*/
public function getEffect($effect) {
return $this->getEffects()
->get($effect);
}
/**
* {@inheritdoc}
*/
public function getEffects() {
if (!$this->effectsCollection) {
$this->effectsCollection = new ImageEffectPluginCollection($this->getImageEffectPluginManager(), $this->effects);
$this->effectsCollection
->sort();
}
return $this->effectsCollection;
}
/**
* {@inheritdoc}
*/
public function getPluginCollections() {
return [
'effects' => $this->getEffects(),
];
}
/**
* {@inheritdoc}
*/
public function addImageEffect(array $configuration) {
$configuration['uuid'] = $this->uuidGenerator()
->generate();
$this->getEffects()
->addInstanceId($configuration['uuid'], $configuration);
return $configuration['uuid'];
}
/**
* {@inheritdoc}
*/
public function getReplacementID() {
/** @var \Drupal\image\ImageStyleStorageInterface $storage */
$storage = $this->entityTypeManager()
->getStorage($this->getEntityTypeId());
return $storage->getReplacementId($this->id());
}
/**
* {@inheritdoc}
*/
public function getName() {
return $this->get('name');
}
/**
* {@inheritdoc}
*/
public function setName($name) {
$this->set('name', $name);
return $this;
}
/**
* Returns the image effect plugin manager.
*
* @return \Drupal\Component\Plugin\PluginManagerInterface
* The image effect plugin manager.
*/
protected function getImageEffectPluginManager() {
return \Drupal::service('plugin.manager.image.effect');
}
/**
* Returns the image factory.
*
* @return \Drupal\Core\Image\ImageFactory
* The image factory.
*/
protected function getImageFactory() {
return \Drupal::service('image.factory');
}
/**
* Gets the Drupal private key.
*
* @return string
* The Drupal private key.
*/
protected function getPrivateKey() {
return \Drupal::service('private_key')->get();
}
/**
* Gets a salt useful for hardening against SQL injection.
*
* @return string
* A salt based on information in settings.php, not in the database.
*
* @throws \RuntimeException
*/
protected function getHashSalt() {
return Settings::getHashSalt();
}
/**
* Adds an extension to a path.
*
* If this image style changes the extension of the derivative, this method
* adds the new extension to the given path. This way we avoid filename
* clashes while still allowing us to find the source image.
*
* @param string $path
* The path to add the extension to.
*
* @return string
* The given path if this image style doesn't change its extension, or the
* path with the added extension if it does.
*/
protected function addExtension($path) {
$original_extension = pathinfo($path, PATHINFO_EXTENSION);
$extension = $this->getDerivativeExtension($original_extension);
if ($original_extension !== $extension) {
$path .= '.' . $extension;
}
return $path;
}
/**
* Provides a wrapper to allow unit testing.
*
* Gets the default file stream implementation.
*
* @return string
* 'public', 'private' or any other file scheme defined as the default.
*/
protected function fileDefaultScheme() {
return \Drupal::config('system.file')->get('default_scheme');
}
/**
* Gets the stream wrapper manager service.
*
* @return \Drupal\Core\StreamWrapper\StreamWrapperManagerInterface
* The stream wrapper manager service
*
* @todo Properly inject this service in Drupal 9.0.x.
*/
protected function getStreamWrapperManager() {
return \Drupal::service('stream_wrapper_manager');
}
}
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'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 | Third party entity settings. | |||
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::calculateDependencies | public | function | Calculates dependencies and stores them in the dependency property. | Overrides ConfigEntityInterface::calculateDependencies | 14 | |
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' cache tags; the config system already invalidates them. |
Overrides EntityBase::invalidateTagsOnDelete | ||
ConfigEntityBase::invalidateTagsOnSave | protected | function | Override to never invalidate the entity'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::preSave | public | function | Acts on an entity before the presave hook is invoked. | Overrides EntityBase::preSave | 13 | |
ConfigEntityBase::save | public | function | Saves an entity permanently. | Overrides EntityBase::save | 1 | |
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 | 2 | |
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::__construct | public | function | Constructs an Entity object. | Overrides EntityBase::__construct | 10 | |
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'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 | 1 | |
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::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 | 4 | |
EntityBase::postLoad | public static | function | Acts on loaded entities. | Overrides EntityInterface::postLoad | 3 | |
EntityBase::preCreate | public static | function | Changes the values of an entity before it is created. | Overrides EntityInterface::preCreate | 7 | |
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. | |||
ImageStyle::$effects | protected | property | The array of image effects for this image style. | |||
ImageStyle::$effectsCollection | protected | property | Holds the collection of image effects that are used by this image style. | |||
ImageStyle::$label | protected | property | The image style label. | |||
ImageStyle::$name | protected | property | The name of the image style. | |||
ImageStyle::addExtension | protected | function | Adds an extension to a path. | |||
ImageStyle::addImageEffect | public | function | Saves an image effect for this style. | Overrides ImageStyleInterface::addImageEffect | ||
ImageStyle::buildUri | public | function | Returns the URI of this image when using this style. | Overrides ImageStyleInterface::buildUri | ||
ImageStyle::buildUrl | public | function | Returns the URL of this image derivative for an original image path or URI. | Overrides ImageStyleInterface::buildUrl | ||
ImageStyle::createDerivative | public | function | Creates a new image derivative based on this image style. | Overrides ImageStyleInterface::createDerivative | ||
ImageStyle::deleteImageEffect | public | function | Deletes an image effect from this style. | Overrides ImageStyleInterface::deleteImageEffect | ||
ImageStyle::fileDefaultScheme | protected | function | Provides a wrapper to allow unit testing. | |||
ImageStyle::flush | public | function | Flushes cached media for this style. | Overrides ImageStyleInterface::flush | ||
ImageStyle::getDerivativeExtension | public | function | Determines the extension of the derivative without generating it. | Overrides ImageStyleInterface::getDerivativeExtension | ||
ImageStyle::getEffect | public | function | Returns a specific image effect. | Overrides ImageStyleInterface::getEffect | ||
ImageStyle::getEffects | public | function | Returns the image effects for this style. | Overrides ImageStyleInterface::getEffects | ||
ImageStyle::getHashSalt | protected | function | Gets a salt useful for hardening against SQL injection. | |||
ImageStyle::getImageEffectPluginManager | protected | function | Returns the image effect plugin manager. | |||
ImageStyle::getImageFactory | protected | function | Returns the image factory. | |||
ImageStyle::getName | public | function | Returns the image style. | Overrides ImageStyleInterface::getName | ||
ImageStyle::getPathToken | public | function | Generates a token to protect an image style derivative. | Overrides ImageStyleInterface::getPathToken | ||
ImageStyle::getPluginCollections | public | function | ||||
ImageStyle::getPrivateKey | protected | function | Gets the Drupal private key. | |||
ImageStyle::getReplacementID | public | function | ||||
ImageStyle::getStreamWrapperManager | protected | function | Gets the stream wrapper manager service. | |||
ImageStyle::id | public | function | Gets the identifier. | Overrides EntityBase::id | ||
ImageStyle::postDelete | public static | function | Acts on deleted entities before the delete hook is invoked. | Overrides EntityBase::postDelete | ||
ImageStyle::postSave | public | function | Acts on a saved entity before the insert or update hook is invoked. | Overrides EntityBase::postSave | ||
ImageStyle::replaceImageStyle | protected static | function | Update field settings if the image style name is changed. | |||
ImageStyle::setName | public | function | Sets the name of the image style. | Overrides ImageStyleInterface::setName | ||
ImageStyle::supportsUri | public | function | Determines if this style can be applied to a given image. | Overrides ImageStyleInterface::supportsUri | ||
ImageStyle::transformDimensions | public | function | Determines the dimensions of this image style. | Overrides ImageStyleInterface::transformDimensions | ||
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 | ||||
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.