tag. Requesting the URL will cause the image to be created. * * @see \Drupal\image\Controller\ImageStyleDownloadController::deliver() */ public function buildUrl($path, $clean_urls = NULL); /** * Generates a token to protect an image style derivative. * * This prevents unauthorized generation of an image style derivative, * which can be costly both in CPU time and disk space. * * @param string $uri * The URI of the original image of this style. * * @return string * An eight-character token which can be used to protect image style * derivatives against denial-of-service attacks. */ public function getPathToken($uri); /** * Flushes cached media for this style. * * @param string $path * (optional) The original image path or URI. If it's supplied, only this * image derivative will be flushed. * * @return $this */ public function flush($path = NULL); /** * Creates a new image derivative based on this image style. * * Generates an image derivative applying all image effects and saving the * resulting image. * * @param string $original_uri * Original image file URI. * @param string $derivative_uri * Derivative image file URI. * * @return bool * TRUE if an image derivative was generated, or FALSE if the image * derivative could not be generated. */ public function createDerivative($original_uri, $derivative_uri); /** * Determines the dimensions of this image style. * * Stores the dimensions of this image style into $dimensions associative * array. Implementations have to provide at least values to next keys: * - width: Integer with the derivative image width. * - height: Integer with the derivative image height. * * @param array $dimensions * Associative array passed by reference. Implementations have to store the * resulting width and height, in pixels. * @param string $uri * Original image file URI. It is passed in to allow effects to * optionally use this information to retrieve additional image metadata * to determine dimensions of the styled image. * ImageStyleInterface::transformDimensions key objective is to calculate * styled image dimensions without performing actual image operations, so * be aware that performing IO on the URI may lead to decrease in * performance. * * @see ImageEffectInterface::transformDimensions */ public function transformDimensions(array &$dimensions, $uri); /** * Determines the extension of the derivative without generating it. * * @param string $extension * The file extension of the original image. * * @return string * The extension the derivative image will have, given the extension of the * original. */ public function getDerivativeExtension($extension); /** * Returns a specific image effect. * * @param string $effect * The image effect ID. * * @return \Drupal\image\ImageEffectInterface * The image effect object. */ public function getEffect($effect); /** * Returns the image effects for this style. * * @return \Drupal\image\ImageEffectPluginCollection|\Drupal\image\ImageEffectInterface[] * The image effect plugin collection. */ public function getEffects(); /** * Saves an image effect for this style. * * @param array $configuration * An array of image effect configuration. * * @return string * The image effect ID. */ public function addImageEffect(array $configuration); /** * Deletes an image effect from this style. * * @param \Drupal\image\ImageEffectInterface $effect * The image effect object. * * @return $this */ public function deleteImageEffect(ImageEffectInterface $effect); }