class UriDependentTestImageEffect in Drupal 9

Performs an image operation that depends on the URI of the original image.

Plugin annotation

@ImageEffect(
  id = "image_module_test_uri_dependent",
  label = @Translation("URI dependent test image effect")
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\image\ImageEffectBase implements ContainerFactoryPluginInterface, ImageEffectInterface
      • class \Drupal\image_module_test\Plugin\ImageEffect\UriDependentTestImageEffect

File

core/modules/image/tests/modules/image_module_test/src/Plugin/ImageEffect/UriDependentTestImageEffect.php, line 16

Namespace

Drupal\image_module_test\Plugin\ImageEffect

class UriDependentTestImageEffect extends ImageEffectBase {

  /**
   * {@inheritdoc}
   */
  public function transformDimensions(array &$dimensions, $uri) {
    $dimensions = $this
      ->getUriDependentDimensions($uri);
  }

  /**
   * {@inheritdoc}
   */
  public function applyEffect(ImageInterface $image) {
    $dimensions = $this
      ->getUriDependentDimensions($image
      ->getSource());
    return $image
      ->resize($dimensions['width'], $dimensions['height']);
  }

  /**
   * Make the image dimensions dependent on the image file extension.
   *
   * @param string $uri
   *   Original image file URI.
   *
   * @return array
   *   Associative array.
   *   - width: Integer with the derivative image width.
   *   - height: Integer with the derivative image height.
   */
  protected function getUriDependentDimensions($uri) {
    $dimensions = [];
    $extension = pathinfo($uri, PATHINFO_EXTENSION);
    switch (strtolower($extension)) {
      case 'png':
        $dimensions['width'] = $dimensions['height'] = 100;
        break;
      case 'gif':
        $dimensions['width'] = $dimensions['height'] = 50;
        break;
      default:
        $dimensions['width'] = $dimensions['height'] = 20;
        break;
    }
    return $dimensions;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
ImageEffectBase::$logger	protected	property	A logger instance.
ImageEffectBase::$uuid	protected	property	The image effect ID.
ImageEffectBase::$weight	protected	property	The weight of the image effect.
ImageEffectBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
ImageEffectBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
ImageEffectBase::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration	4
ImageEffectBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
ImageEffectBase::getDerivativeExtension	public	function	Returns the extension of the derivative after applying this image effect. Overrides ImageEffectInterface::getDerivativeExtension	1
ImageEffectBase::getSummary	public	function	Returns a render array summarizing the configuration of the image effect. Overrides ImageEffectInterface::getSummary	3
ImageEffectBase::getUuid	public	function	Returns the unique ID representing the image effect. Overrides ImageEffectInterface::getUuid
ImageEffectBase::getWeight	public	function	Returns the weight of the image effect. Overrides ImageEffectInterface::getWeight
ImageEffectBase::label	public	function	Returns the image effect label. Overrides ImageEffectInterface::label
ImageEffectBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
ImageEffectBase::setWeight	public	function	Sets the weight for this image effect. Overrides ImageEffectInterface::setWeight
ImageEffectBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct
MessengerTrait::$messenger	protected	property	The messenger.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	2
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	4
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.
UriDependentTestImageEffect::applyEffect	public	function	Applies an image effect to the image object. Overrides ImageEffectInterface::applyEffect
UriDependentTestImageEffect::getUriDependentDimensions	protected	function	Make the image dimensions dependent on the image file extension.
UriDependentTestImageEffect::transformDimensions	public	function	Determines the dimensions of the styled image. Overrides ImageEffectBase::transformDimensions