class ImageAPIOptimizePipeline in Image Optimize (or ImageAPI Optimize) 8.3
Same name and namespace in other branches
- 8.2 src/Entity/ImageAPIOptimizePipeline.php \Drupal\imageapi_optimize\Entity\ImageAPIOptimizePipeline
- 4.x src/Entity/ImageAPIOptimizePipeline.php \Drupal\imageapi_optimize\Entity\ImageAPIOptimizePipeline
Defines an image optimize pipeline configuration entity.
Plugin annotation
@ConfigEntityType(
id = "imageapi_optimize_pipeline",
label = @Translation("Image Optimize Pipeline"),
handlers = {
"form" = {
"add" = "Drupal\imageapi_optimize\Form\ImageAPIOptimizePipelineAddForm",
"edit" = "Drupal\imageapi_optimize\Form\ImageAPIOptimizePipelineEditForm",
"delete" = "Drupal\imageapi_optimize\Form\ImageAPIOptimizePipelineDeleteForm",
"flush" = "Drupal\imageapi_optimize\Form\ImageAPIOptimizePipelineFlushForm"
},
"list_builder" = "Drupal\imageapi_optimize\ImageAPIOptimizePipelineListBuilder",
"storage" = "Drupal\imageapi_optimize\ImageAPIOptimizePipelineStorage",
},
admin_permission = "administer imageapi optimize pipelines",
config_prefix = "pipeline",
entity_keys = {
"id" = "name",
"label" = "label"
},
links = {
"flush-form" = "/admin/config/media/imageapi-optimize-pipelines/manage/{imageapi_optimize_pipeline}/flush",
"edit-form" = "/admin/config/media/imageapi-optimize-pipelines/manage/{imageapi_optimize_pipeline}",
"delete-form" = "/admin/config/media/imageapi-optimize-pipelines/manage/{imageapi_optimize_pipeline}/delete",
"collection" = "/admin/config/media/imageapi-optimize-pipelines",
},
config_export = {
"name",
"label",
"processors",
}
)
Hierarchy
- class \Drupal\Core\Entity\EntityBase implements EntityInterface uses RefinableCacheableDependencyTrait, DependencySerializationTrait
- class \Drupal\Core\Config\Entity\ConfigEntityBase implements ConfigEntityInterface uses SynchronizableEntityTrait, PluginDependencyTrait
- class \Drupal\imageapi_optimize\Entity\ImageAPIOptimizePipeline implements EntityWithPluginCollectionInterface, ImageAPIOptimizePipelineInterface
- class \Drupal\Core\Config\Entity\ConfigEntityBase implements ConfigEntityInterface uses SynchronizableEntityTrait, PluginDependencyTrait
Expanded class hierarchy of ImageAPIOptimizePipeline
2 files declare their use of ImageAPIOptimizePipeline
- imageapi_optimize.module in ./
imageapi_optimize.module - ImageOptimizePipelineTest.php in tests/
src/ Kernel/ ImageOptimizePipelineTest.php
File
- src/
Entity/ ImageAPIOptimizePipeline.php, line 50
Namespace
Drupal\imageapi_optimize\EntityView source
class ImageAPIOptimizePipeline extends ConfigEntityBase implements ImageAPIOptimizePipelineInterface, EntityWithPluginCollectionInterface {
/**
* The name of the image optimize pipeline.
*
* @var string
*/
protected $name;
/**
* The image optimize pipeline label.
*
* @var string
*/
protected $label;
/**
* The array of image optimize processors for this image optimize pipeline.
*
* @var array
*/
protected $processors = [];
/**
* Holds the collection of image optimize processors that are used by this image optimize pipeline.
*
* @var \Drupal\imageapi_optimize\ImageAPIOptimizeProcessorPluginCollection
*/
protected $processorsCollection;
/**
* An array of temporary files that can be deleted on destruction.
*/
protected $temporaryFiles = [];
/**
* {@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 optimize pipeline name needs flushing after a rename.
$this->original
->flush();
// Update field settings if necessary.
if (!$this
->isSyncing()) {
static::replaceImageAPIOptimizePipeline($this);
}
}
else {
// Flush pipeline when updating without changing the name.
$this
->flush();
}
}
}
/**
* {@inheritdoc}
*/
public static function postDelete(EntityStorageInterface $storage, array $entities) {
parent::postDelete($storage, $entities);
/** @var \Drupal\imageapi_optimize\ImageAPIOptimizePipelineInterface[] $entities */
foreach ($entities as $pipeline) {
// Flush cached media for the deleted pipeline.
$pipeline
->flush();
// Clear the replacement ID, if one has been previously stored.
/** @var \Drupal\imageapi_optimize\ImageAPIOptimizePipelineStorageInterface $storage */
$storage
->clearReplacementId($pipeline
->id());
}
}
/**
* Update field settings if the image optimize pipeline name is changed.
*
* @param \Drupal\imageapi_optimize\ImageAPIOptimizePipelineInterface $pipeline
* The image optimize pipeline.
*/
protected static function replaceImageAPIOptimizePipeline(ImageAPIOptimizePipelineInterface $pipeline) {
if ($pipeline
->id() != $pipeline
->getOriginalId()) {
// Loop through all image optimize pipelines looking for usages.
}
}
/**
* {@inheritdoc}
*/
public function flush() {
// Get all image optimize pipelines and if they use this pipeline, flush it.
$style_storage = $this
->entityTypeManager()
->getStorage('image_style');
foreach ($style_storage
->loadMultiple() as $style) {
/** @var ImageStyleWithPipeline $style */
if ($style
->hasPipeline() && $style
->getPipelineEntity()
->id() == $this
->id()) {
$style
->flush();
}
}
// Let other modules update as necessary on flush.
$module_handler = \Drupal::moduleHandler();
$module_handler
->invokeAll('imageapi_optimize_pipeline_flush', [
$this,
]);
Cache::invalidateTags($this
->getCacheTagsToInvalidate());
return $this;
}
/**
* {@inheritdoc}
*/
public function applyToImage($image_uri) {
// If the source file doesn't exist, return FALSE.
$image = \Drupal::service('image.factory')
->get($image_uri);
if (!$image
->isValid()) {
return FALSE;
}
/*
Copy image to optimize to a temp location so that:
1. It's always a local image.
2. The filename is only ascii characters.
*/
$file_extension = strtolower(substr(strrchr($image_uri, '.'), 1));
$temp_image_uri = 'temporary://image_api_optimize_' . Crypt::randomBytesBase64(8) . '.' . $file_extension;
foreach ($this
->getProcessors() as $processor) {
// Create a copy of this image for the processor to work on.
$temp_image_uri = \Drupal::service('file_system')
->copy($image_uri, $temp_image_uri, FileSystemInterface::EXISTS_RENAME);
if ($temp_image_uri === FALSE) {
return FALSE;
}
// Add the temporary file to be cleaned up later.
$this->temporaryFiles[] = $temp_image_uri;
// Apply the actual processor.
$image_changed = $processor
->applyToImage($temp_image_uri);
// The file may have changed on disk after each processor has been
// applied, and PHP has a cache of file size information etc. so clear
// it here so that later calls to filesize() etc. get the correct
// information.
clearstatcache();
if ($image_changed) {
// Copy the temporary file back over the original image.
\Drupal::service('file_system')
->move($temp_image_uri, $image_uri, FileSystemInterface::EXISTS_REPLACE);
}
}
return TRUE;
}
/**
* {@inheritdoc}
*/
public function deleteProcessor(ImageAPIOptimizeProcessorInterface $processor) {
$this
->getProcessors()
->removeInstanceId($processor
->getUuid());
$this
->save();
return $this;
}
/**
* {@inheritdoc}
*/
public function getProcessor($processor) {
return $this
->getProcessors()
->get($processor);
}
/**
* {@inheritdoc}
*/
public function getProcessors() {
if (!$this->processorsCollection) {
$this->processorsCollection = $this
->getProcessorsCollection();
$this->processorsCollection
->sort();
}
return $this->processorsCollection;
}
/**
* {@inheritdoc}
*/
public function getProcessorsCollection() {
return new ImageAPIOptimizeProcessorPluginCollection($this
->getImageAPIOptimizeProcessorPluginManager(), $this->processors);
}
/**
* {@inheritdoc}
*/
public function getPluginCollections() {
return [
'processors' => $this
->getProcessors(),
];
}
/**
* {@inheritdoc}
*/
public function addProcessor(array $configuration) {
$configuration['uuid'] = $this
->uuidGenerator()
->generate();
$this
->getProcessors()
->addInstanceId($configuration['uuid'], $configuration);
return $configuration['uuid'];
}
/**
* {@inheritdoc}
*/
public function getReplacementID() {
/** @var \Drupal\imageapi_optimize\ImageAPIOptimizePipelineStorageInterface $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 optimize processor plugin manager.
*
* @return \Drupal\Component\Plugin\PluginManagerInterface
* The image optimize processor plugin manager.
*/
protected function getImageAPIOptimizeProcessorPluginManager() {
return \Drupal::service('plugin.manager.imageapi_optimize.processor');
}
/**
* Clean up any temporary files created in optimization.
*/
public function __destruct() {
foreach ($this->temporaryFiles as $file) {
if (file_exists($file)) {
\Drupal::service('file_system')
->delete($file);
}
}
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
CacheableDependencyTrait:: |
protected | property | Cache contexts. | |
CacheableDependencyTrait:: |
protected | property | Cache max-age. | |
CacheableDependencyTrait:: |
protected | property | Cache tags. | |
CacheableDependencyTrait:: |
protected | function | Sets cacheability; useful for value object constructors. | |
ConfigEntityBase:: |
private | property | Whether the config is being deleted by the uninstall process. | |
ConfigEntityBase:: |
protected | property | The language code of the entity's default language. | |
ConfigEntityBase:: |
protected | property | The original ID of the configuration entity. | |
ConfigEntityBase:: |
protected | property | The enabled/disabled status of the configuration entity. | 4 |
ConfigEntityBase:: |
protected | property | Third party entity settings. | |
ConfigEntityBase:: |
protected | property | Trust supplied data and not use configuration schema on save. | |
ConfigEntityBase:: |
protected | property | The UUID for this entity. | |
ConfigEntityBase:: |
protected | property | Information maintained by Drupal core about configuration. | |
ConfigEntityBase:: |
protected | function | Overrides \Drupal\Core\Entity\DependencyTrait:addDependency(). | |
ConfigEntityBase:: |
public | function |
Calculates dependencies and stores them in the dependency property. Overrides ConfigEntityInterface:: |
13 |
ConfigEntityBase:: |
public | function |
Creates a duplicate of the entity. Overrides EntityBase:: |
1 |
ConfigEntityBase:: |
public | function |
Disables the configuration entity. Overrides ConfigEntityInterface:: |
1 |
ConfigEntityBase:: |
public | function |
Enables the configuration entity. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Returns the value of a property. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Returns the cache tags that should be used to invalidate caches. Overrides EntityBase:: |
1 |
ConfigEntityBase:: |
public | function |
Gets the configuration dependency name. Overrides EntityBase:: |
|
ConfigEntityBase:: |
protected static | function | Gets the configuration manager. | |
ConfigEntityBase:: |
public | function |
Gets the configuration target identifier for the entity. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Gets the configuration dependencies. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Gets the original ID. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function |
Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function |
Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
protected | function | Gets the typed config manager. | |
ConfigEntityBase:: |
public | function |
Gets whether on not the data is trusted. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
protected static | function |
Override to never invalidate the individual entities' cache tags; the
config system already invalidates them. Overrides EntityBase:: |
|
ConfigEntityBase:: |
protected | function |
Override to never invalidate the entity's cache tag; the config system
already invalidates it. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Checks whether this entity is installable. Overrides ConfigEntityInterface:: |
2 |
ConfigEntityBase:: |
public | function |
Overrides Entity::isNew(). Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Returns whether this entity is being changed during the uninstall process. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Deprecated way of generating a link to the entity. See toLink(). Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityInterface:: |
7 |
ConfigEntityBase:: |
public static | function |
Acts on entities before they are deleted and before hooks are invoked. Overrides EntityBase:: |
8 |
ConfigEntityBase:: |
public | function |
Acts on an entity before the presave hook is invoked. Overrides EntityBase:: |
13 |
ConfigEntityBase:: |
public | function |
Saves an entity permanently. Overrides EntityBase:: |
1 |
ConfigEntityBase:: |
public | function |
Sets the value of a property. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Sets the original ID. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Sets the status of the configuration entity. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function | ||
ConfigEntityBase:: |
public static | function | Helper callback for uasort() to sort configuration entities by weight and label. | 6 |
ConfigEntityBase:: |
public | function |
Returns whether the configuration entity is enabled. Overrides ConfigEntityInterface:: |
4 |
ConfigEntityBase:: |
public | function |
Gets an array of all property values. Overrides EntityBase:: |
2 |
ConfigEntityBase:: |
public | function |
Gets the URL object for the entity. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Sets that the data should be trusted. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Unsets a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function |
Gets the public URL for this entity. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Gets the URL object for the entity. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Constructs an Entity object. Overrides EntityBase:: |
10 |
ConfigEntityBase:: |
public | function |
Overrides EntityBase:: |
4 |
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | Aliased as: traitSleep | 1 |
DependencySerializationTrait:: |
public | function | 2 | |
DependencyTrait:: |
protected | property | The object's dependencies. | |
DependencyTrait:: |
protected | function | Adds multiple dependencies. | |
DependencyTrait:: |
protected | function | Adds a dependency. Aliased as: addDependencyTrait | |
EntityBase:: |
protected | property | Boolean indicating whether the entity should be forced to be new. | |
EntityBase:: |
protected | property | The entity type. | |
EntityBase:: |
protected | property | A typed data object wrapping this entity. | |
EntityBase:: |
public | function |
Checks data value access. Overrides AccessibleInterface:: |
1 |
EntityBase:: |
public | function |
Gets the bundle of the entity. Overrides EntityInterface:: |
1 |
EntityBase:: |
public static | function |
Constructs a new entity object, without permanently saving it. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Deletes an entity permanently. Overrides EntityInterface:: |
2 |
EntityBase:: |
public | function |
Enforces an entity to be new. Overrides EntityInterface:: |
|
EntityBase:: |
protected | function | Gets the entity manager. | |
EntityBase:: |
protected | function | Gets the entity type bundle info service. | |
EntityBase:: |
protected | function | Gets the entity type manager. | |
EntityBase:: |
public | function |
The cache contexts associated with this object. Overrides CacheableDependencyTrait:: |
|
EntityBase:: |
public | function |
The maximum age for which this object may be cached. Overrides CacheableDependencyTrait:: |
|
EntityBase:: |
public | function |
The cache tags associated with this object. Overrides CacheableDependencyTrait:: |
|
EntityBase:: |
public | function |
Gets the key that is used to store configuration dependencies. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Gets the entity type definition. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Gets the ID of the type of the entity. Overrides EntityInterface:: |
|
EntityBase:: |
protected | function | The list cache tags to invalidate for this entity. | |
EntityBase:: |
public | function |
Gets a typed data object for this entity object. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Indicates if a link template exists for a given key. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Gets the label of the entity. Overrides EntityInterface:: |
6 |
EntityBase:: |
public | function |
Gets the language of the entity. Overrides EntityInterface:: |
1 |
EntityBase:: |
protected | function | Gets the language manager. | |
EntityBase:: |
protected | function | Gets an array link templates. | 1 |
EntityBase:: |
public static | function |
Loads an entity. Overrides EntityInterface:: |
|
EntityBase:: |
public static | function |
Loads one or more entities. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Acts on a created entity before hooks are invoked. Overrides EntityInterface:: |
4 |
EntityBase:: |
public static | function |
Acts on loaded entities. Overrides EntityInterface:: |
2 |
EntityBase:: |
public static | function |
Changes the values of an entity before it is created. Overrides EntityInterface:: |
5 |
EntityBase:: |
public | function |
Gets a list of entities referenced by this entity. Overrides EntityInterface:: |
1 |
EntityBase:: |
public | function |
Generates the HTML for a link to this entity. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Gets a list of URI relationships supported by this entity. Overrides EntityInterface:: |
|
EntityBase:: |
protected | function | Gets an array of placeholders for this entity. | 2 |
EntityBase:: |
public | function |
Gets the entity UUID (Universally Unique Identifier). Overrides EntityInterface:: |
1 |
EntityBase:: |
protected | function | Gets the UUID generator. | |
ImageAPIOptimizePipeline:: |
protected | property | The image optimize pipeline label. | |
ImageAPIOptimizePipeline:: |
protected | property | The name of the image optimize pipeline. | |
ImageAPIOptimizePipeline:: |
protected | property | The array of image optimize processors for this image optimize pipeline. | |
ImageAPIOptimizePipeline:: |
protected | property | Holds the collection of image optimize processors that are used by this image optimize pipeline. | |
ImageAPIOptimizePipeline:: |
protected | property | An array of temporary files that can be deleted on destruction. | |
ImageAPIOptimizePipeline:: |
public | function |
Saves an image optimize processor for this pipeline. Overrides ImageAPIOptimizePipelineInterface:: |
|
ImageAPIOptimizePipeline:: |
public | function |
Creates a new image derivative based on this image optimize pipeline. Overrides ImageAPIOptimizePipelineInterface:: |
|
ImageAPIOptimizePipeline:: |
public | function |
Deletes an image optimize processor from this pipeline. Overrides ImageAPIOptimizePipelineInterface:: |
|
ImageAPIOptimizePipeline:: |
public | function |
Flushes cached media for this pipeline. Overrides ImageAPIOptimizePipelineInterface:: |
|
ImageAPIOptimizePipeline:: |
protected | function | Returns the image optimize processor plugin manager. | |
ImageAPIOptimizePipeline:: |
public | function |
Returns the image optimize pipeline. Overrides ImageAPIOptimizePipelineInterface:: |
|
ImageAPIOptimizePipeline:: |
public | function |
Gets the plugin collections used by this object. Overrides ObjectWithPluginCollectionInterface:: |
|
ImageAPIOptimizePipeline:: |
public | function |
Returns a specific image optimize processor. Overrides ImageAPIOptimizePipelineInterface:: |
|
ImageAPIOptimizePipeline:: |
public | function |
Returns the image optimize processors for this pipeline. Overrides ImageAPIOptimizePipelineInterface:: |
|
ImageAPIOptimizePipeline:: |
public | function |
Returns an image optimize processors collection. Overrides ImageAPIOptimizePipelineInterface:: |
|
ImageAPIOptimizePipeline:: |
public | function |
Returns the replacement ID. Overrides ImageAPIOptimizePipelineInterface:: |
|
ImageAPIOptimizePipeline:: |
public | function |
Gets the identifier. Overrides EntityBase:: |
|
ImageAPIOptimizePipeline:: |
public static | function |
Acts on deleted entities before the delete hook is invoked. Overrides EntityBase:: |
|
ImageAPIOptimizePipeline:: |
public | function |
Acts on a saved entity before the insert or update hook is invoked. Overrides EntityBase:: |
|
ImageAPIOptimizePipeline:: |
protected static | function | Update field settings if the image optimize pipeline name is changed. | |
ImageAPIOptimizePipeline:: |
public | function |
Sets the name of the image optimize pipeline. Overrides ImageAPIOptimizePipelineInterface:: |
|
ImageAPIOptimizePipeline:: |
public | function | Clean up any temporary files created in optimization. | |
PluginDependencyTrait:: |
protected | function | Calculates and adds dependencies of a specific plugin instance. | 1 |
PluginDependencyTrait:: |
protected | function | Calculates and returns dependencies of a specific plugin instance. | |
PluginDependencyTrait:: |
protected | function | Wraps the module handler. | 1 |
PluginDependencyTrait:: |
protected | function | Wraps the theme handler. | 1 |
RefinableCacheableDependencyTrait:: |
public | function | 1 | |
RefinableCacheableDependencyTrait:: |
public | function | ||
RefinableCacheableDependencyTrait:: |
public | function | ||
RefinableCacheableDependencyTrait:: |
public | function | ||
SynchronizableEntityTrait:: |
protected | property | Whether this entity is being created, updated or deleted through a synchronization process. | |
SynchronizableEntityTrait:: |
public | function | ||
SynchronizableEntityTrait:: |
public | function |