class UriDependentTestImageEffect

Same name and namespace in other branches

9 core/modules/image/tests/modules/image_module_test/src/Plugin/ImageEffect/UriDependentTestImageEffect.php \Drupal\image_module_test\Plugin\ImageEffect\UriDependentTestImageEffect
8.9.x core/modules/image/tests/modules/image_module_test/src/Plugin/ImageEffect/UriDependentTestImageEffect.php \Drupal\image_module_test\Plugin\ImageEffect\UriDependentTestImageEffect
11.x core/modules/image/tests/modules/image_module_test/src/Plugin/ImageEffect/UriDependentTestImageEffect.php \Drupal\image_module_test\Plugin\ImageEffect\UriDependentTestImageEffect

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

Attributes

#[ImageEffect(id: "image_module_test_uri_dependent", label: new TranslatableMarkup("URI dependent test image effect"))]

Hierarchy

class \Drupal\Component\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait implements \Drupal\Component\Plugin\PluginBase
  - class \Drupal\image\ImageEffectBase extends \Drupal\image\ImageEffectInterface, \Drupal\Core\Plugin\ContainerFactoryPluginInterface implements \Drupal\Core\Plugin\PluginBase
    - class \Drupal\image_module_test\Plugin\ImageEffect\UriDependentTestImageEffect implements \Drupal\image\ImageEffectBase

Expanded class hierarchy of UriDependentTestImageEffect

File

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

Namespace

Drupal\image_module_test\Plugin\ImageEffect

View on git.drupalcode.org

View source

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

Title Sort descending	Modifiers	Object type	Summary	Overriden Title	Overrides
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		Overrides DependentPluginInterface::calculateDependencies
ImageEffectBase::create	public static	function		Overrides ContainerFactoryPluginInterface::create
ImageEffectBase::defaultConfiguration	public	function		Overrides ConfigurableInterface::defaultConfiguration	4
ImageEffectBase::getConfiguration	public	function		Overrides ConfigurableInterface::getConfiguration
ImageEffectBase::getDerivativeExtension	public	function		Overrides ImageEffectInterface::getDerivativeExtension	1
ImageEffectBase::getSummary	public	function		Overrides ImageEffectInterface::getSummary	3
ImageEffectBase::getUuid	public	function		Overrides ImageEffectInterface::getUuid
ImageEffectBase::getWeight	public	function		Overrides ImageEffectInterface::getWeight
ImageEffectBase::label	public	function		Overrides ImageEffectInterface::label
ImageEffectBase::setConfiguration	public	function		Overrides ConfigurableInterface::setConfiguration
ImageEffectBase::setWeight	public	function		Overrides ImageEffectInterface::setWeight
ImageEffectBase::__construct	public	function
PluginInspectionInterface::getPluginDefinition	public	function	Gets the definition of the plugin implementation.		6
PluginInspectionInterface::getPluginId	public	function	Gets the plugin ID of the plugin instance.		2
UriDependentTestImageEffect::applyEffect	public	function		Overrides ImageEffectInterface::applyEffect
UriDependentTestImageEffect::getUriDependentDimensions	protected	function	Make the image dimensions dependent on the image file extension.
UriDependentTestImageEffect::transformDimensions	public	function		Overrides ImageEffectBase::transformDimensions

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.

Breadcrumb