interface ImageAPIOptimizePipelineInterface in Image Optimize (or ImageAPI Optimize) 4.x

Provides an interface defining an image optimize pipeline entity.

Hierarchy

• interface \Drupal\Core\Entity\EntityInterface; interface \Drupal\Core\Config\Entity\ThirdPartySettingsInterface; interface \Drupal\Core\Entity\SynchronizableInterface
  • interface \Drupal\Core\Config\Entity\ConfigEntityInterface
    • interface \Drupal\imageapi_optimize\ImageAPIOptimizePipelineInterface

5 files declare their use of ImageAPIOptimizePipelineInterface

ImageAPIOptimizePipeline.php in src/Entity/ImageAPIOptimizePipeline.php

ImageAPIOptimizeProcessorAddForm.php in src/Form/ImageAPIOptimizeProcessorAddForm.php

ImageAPIOptimizeProcessorDeleteForm.php in src/Form/ImageAPIOptimizeProcessorDeleteForm.php

ImageAPIOptimizeProcessorEditForm.php in src/Form/ImageAPIOptimizeProcessorEditForm.php

ImageAPIOptimizeProcessorFormBase.php in src/Form/ImageAPIOptimizeProcessorFormBase.php

File

src/ImageAPIOptimizePipelineInterface.php, line 10

Namespace

Drupal\imageapi_optimize

interface ImageAPIOptimizePipelineInterface extends ConfigEntityInterface {

  /**
   * Returns the replacement ID.
   *
   * @return string|null
   *   The replacement image optimize pipeline ID or NULL if no replacement has been
   *   selected.
   *
   * @deprecated in Drupal 8.0.x, will be removed before Drupal 9.0.x. Use
   *   \Drupal\imageapi_optimize\ImageAPIOptimizePipelineStorageInterface::getReplacementId() instead.
   *
   * @see \Drupal\imageapi_optimize\ImageAPIOptimizePipelineStorageInterface::getReplacementId()
   */
  public function getReplacementID();

  /**
   * Returns the image optimize pipeline.
   *
   * @return string
   *   The name of the image optimize pipeline.
   */
  public function getName();

  /**
   * Sets the name of the image optimize pipeline.
   *
   * @param string $name
   *   The name of the image optimize pipeline.
   *
   * @return \Drupal\imageapi_optimize\ImageAPIOptimizePipelineInterface
   *   The class instance this method is called on.
   */
  public function setName($name);

  /**
   * Returns a specific image optimize processor.
   *
   * @param string $processor
   *   The image optimize processor ID.
   *
   * @return \Drupal\imageapi_optimize\ImageAPIOptimizeProcessorInterface
   *   The image optimize processor object.
   */
  public function getProcessor($processor);

  /**
   * Returns the image optimize processors for this pipeline.
   *
   * The processors should be sorted, and will have been instantiated.
   *
   * @return \Drupal\imageapi_optimize\ImageAPIOptimizeProcessorPluginCollection|\Drupal\imageapi_optimize\ImageAPIOptimizeProcessorInterface[]
   *   The image optimize processor plugin collection.
   */
  public function getProcessors();

  /**
   * Returns an image optimize processors collection.
   *
   * @return \Drupal\imageapi_optimize\ImageAPIOptimizeProcessorPluginCollection|\Drupal\imageapi_optimize\ImageAPIOptimizeProcessorInterface[]
   *   The image optimize processor plugin collection.
   */
  public function getProcessorsCollection();

  /**
   * Saves an image optimize processor for this pipeline.
   *
   * @param array $configuration
   *   An array of image optimize processor configuration.
   *
   * @return string
   *   The image optimize processor ID.
   */
  public function addProcessor(array $configuration);

  /**
   * Deletes an image optimize processor from this pipeline.
   *
   * @param \Drupal\imageapi_optimize\ImageAPIOptimizeProcessorInterface $processor
   *   The image optimize processor object.
   *
   * @return $this
   */
  public function deleteProcessor(ImageAPIOptimizeProcessorInterface $processor);

  /**
   * Flushes cached media for this pipeline.
   *
   * @return $this
   */
  public function flush();

  /**
   * Creates a new image derivative based on this image optimize pipeline.
   *
   * Generates an image derivative applying all image optimize processors and saving the
   * resulting image.
   *
   * @param string $image_uri
   *   Original image file URI.
   *
   * @return bool
   *   TRUE if an image derivative was generated, or FALSE if the image
   *   derivative could not be generated.
   */
  public function applyToImage($image_uri);

}

Members

Name	Modifiers	Type	Description	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
ImageAPIOptimizePipelineInterface::addProcessor	public	function	Saves an image optimize processor for this pipeline.	1
ImageAPIOptimizePipelineInterface::applyToImage	public	function	Creates a new image derivative based on this image optimize pipeline.	1
ImageAPIOptimizePipelineInterface::deleteProcessor	public	function	Deletes an image optimize processor from this pipeline.	1
ImageAPIOptimizePipelineInterface::flush	public	function	Flushes cached media for this pipeline.	1
ImageAPIOptimizePipelineInterface::getName	public	function	Returns the image optimize pipeline.	1
ImageAPIOptimizePipelineInterface::getProcessor	public	function	Returns a specific image optimize processor.	1
ImageAPIOptimizePipelineInterface::getProcessors	public	function	Returns the image optimize processors for this pipeline.	1
ImageAPIOptimizePipelineInterface::getProcessorsCollection	public	function	Returns an image optimize processors collection.	1
ImageAPIOptimizePipelineInterface::getReplacementID Deprecated	public	function	Returns the replacement ID.	1
ImageAPIOptimizePipelineInterface::setName	public	function	Sets the name of the image optimize pipeline.	1
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
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