class UriDependentTestImageEffect

Same name in other branches
  1. 8.9.x core/modules/image/tests/modules/image_module_test/src/Plugin/ImageEffect/UriDependentTestImageEffect.php \Drupal\image_module_test\Plugin\ImageEffect\UriDependentTestImageEffect
  2. 10 core/modules/image/tests/modules/image_module_test/src/Plugin/ImageEffect/UriDependentTestImageEffect.php \Drupal\image_module_test\Plugin\ImageEffect\UriDependentTestImageEffect
  3. 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.

Plugin annotation


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

Hierarchy

Expanded class hierarchy of UriDependentTestImageEffect

File

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

Namespace

Drupal\image_module_test\Plugin\ImageEffect
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 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 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
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 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

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