ILIAS\Filesystem\Util\Convert\ImageConverter Class Reference

Collaboration diagram for ILIAS\Filesystem\Util\Convert\ImageConverter:

Public Member Functions
	__construct (protected ImageConversionOptions $conversion_options, protected ImageOutputOptions $output_options, protected FileStream $stream)
	isOK ()
	getThrowableIfAny ()
	getStream ()

Protected Member Functions
	handleImageDimension ()
	buildOutputStream ()
	handleFormatAndQuality ()
	handleBackgroundColor ()
	readInputStream ()
	doCrop (int $width, int $height)
	doResize (int $width, int $height)
	doThumbnail (int $width, int $height)

Protected Attributes
const	STATUS_OK = 1
const	STATUS_FAILED = 2
const	STATUS_UNKNOWN = 4
const	RESOLUTION = 72
const	RESOLUTION_FACTOR = self::RESOLUTION / 72
int	$status = self::STATUS_UNKNOWN
FileStream	$output_stream = null
Throwable	$throwable = null
string	$requested_background = null
Imagick	$image

Private Member Functions
	convert ()
	factoredResolution (int $initial)

Detailed Description

Author

Fabian Schmid fabia.nosp@m.n@sr.nosp@m..solu.nosp@m.tion.nosp@m.s

Definition at line 31 of file ImageConverter.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Filesystem\Util\Convert\ImageConverter::__construct	(	protected ImageConversionOptions	$conversion_options,
		protected ImageOutputOptions	$output_options,
		protected FileStream	$stream
	)

Definition at line 48 of file ImageConverter.php.

      {
        $this->image = new \Imagick();
        $this->convert();
    }

References ILIAS\Filesystem\Util\Convert\ImageConverter\convert().

Here is the call graph for this function:

Member Function Documentation

buildOutputStream()

ILIAS\Filesystem\Util\Convert\ImageConverter::buildOutputStream ( )

protected

Definition at line 156 of file ImageConverter.php.

                                          : void
    {
        if ($this->conversion_options->getOutputPath() === null) {
            $this->output_stream = Streams::ofString($this->image->getImageBlob());
        } else {
            $this->image->writeImage($this->conversion_options->getOutputPath());
            $this->output_stream = Streams::ofResource(fopen($this->conversion_options->getOutputPath(), 'rb'));
        }
 
        $this->output_stream->rewind();
 
        $this->status = self::STATUS_OK;
    }

References ILIAS\Filesystem\Stream\Streams\ofResource(), ILIAS\Filesystem\Stream\Streams\ofString(), and ILIAS\Filesystem\Util\Convert\ImageConverter\STATUS_OK.

Referenced by ILIAS\Filesystem\Util\Convert\ImageConverter\convert().

Here is the call graph for this function:

Here is the caller graph for this function:

convert()

ILIAS\Filesystem\Util\Convert\ImageConverter::convert ( )

private

Definition at line 57 of file ImageConverter.php.

                              : void
    {
        try {
            $this->handleBackgroundColor();
            $this->readInputStream();
            $this->handleFormatAndQuality();
            $this->handleImageDimension();
            $this->buildOutputStream();
        } catch (\Throwable $t) {
            $this->status = self::STATUS_FAILED;
            $this->throwable = $t;
            if ($this->conversion_options->throwOnError()) {
                throw $t;
            }
        }
    }

References ILIAS\Filesystem\Util\Convert\ImageConverter\buildOutputStream(), ILIAS\Filesystem\Util\Convert\ImageConverter\handleBackgroundColor(), ILIAS\Filesystem\Util\Convert\ImageConverter\handleFormatAndQuality(), ILIAS\Filesystem\Util\Convert\ImageConverter\handleImageDimension(), ILIAS\Filesystem\Util\Convert\ImageConverter\readInputStream(), and ILIAS\Filesystem\Util\Convert\ImageConverter\STATUS_FAILED.

Referenced by ILIAS\Filesystem\Util\Convert\ImageConverter\__construct().

Here is the call graph for this function:

Here is the caller graph for this function:

doCrop()

ILIAS\Filesystem\Util\Convert\ImageConverter::doCrop ( int  $width, int  $height  )

protected

Definition at line 273 of file ImageConverter.php.

                                                      : void
    {
        $this->image->setGravity(\Imagick::GRAVITY_CENTER);
        $this->image->cropThumbnailImage(
            $this->factoredResolution($width),
            $this->factoredResolution($height)
        );
    }

References ILIAS\Filesystem\Util\Convert\ImageConverter\factoredResolution().

Referenced by ILIAS\Filesystem\Util\Convert\ImageConverter\handleImageDimension().

Here is the call graph for this function:

Here is the caller graph for this function:

doResize()

ILIAS\Filesystem\Util\Convert\ImageConverter::doResize ( int  $width, int  $height  )

protected

Definition at line 282 of file ImageConverter.php.

                                                        : void
    {
        $this->image->resizeImage(
            $this->factoredResolution($width),
            $this->factoredResolution($height),
            \Imagick::FILTER_LANCZOS,
            1
        );
    }

References ILIAS\Filesystem\Util\Convert\ImageConverter\factoredResolution().

Referenced by ILIAS\Filesystem\Util\Convert\ImageConverter\handleImageDimension().

Here is the call graph for this function:

Here is the caller graph for this function:

doThumbnail()

ILIAS\Filesystem\Util\Convert\ImageConverter::doThumbnail ( int  $width, int  $height  )

protected

Definition at line 292 of file ImageConverter.php.

                                                           : void
    {
        $this->image->thumbnailImage(
            $this->factoredResolution($width),
            $this->factoredResolution($height),
            true,
            !$this->conversion_options->keepAspectRatio(),
        );
    }

References ILIAS\Filesystem\Util\Convert\ImageConverter\factoredResolution().

Referenced by ILIAS\Filesystem\Util\Convert\ImageConverter\handleImageDimension().

Here is the call graph for this function:

Here is the caller graph for this function:

factoredResolution()

ILIAS\Filesystem\Util\Convert\ImageConverter::factoredResolution ( int  $initial )

private

Definition at line 268 of file ImageConverter.php.

                                                     : int
    {
        return intval(round($initial * self::RESOLUTION_FACTOR, 0));
    }

Referenced by ILIAS\Filesystem\Util\Convert\ImageConverter\doCrop(), ILIAS\Filesystem\Util\Convert\ImageConverter\doResize(), and ILIAS\Filesystem\Util\Convert\ImageConverter\doThumbnail().

Here is the caller graph for this function:

getStream()

ILIAS\Filesystem\Util\Convert\ImageConverter::getStream

(

)

Definition at line 263 of file ImageConverter.php.

                               : FileStream
    {
        return $this->output_stream;
    }

References ILIAS\Filesystem\Util\Convert\ImageConverter\$output_stream.

Referenced by ILIAS\Filesystem\Util\Convert\LegacyImages\storeStream().

Here is the caller graph for this function:

getThrowableIfAny()

ILIAS\Filesystem\Util\Convert\ImageConverter::getThrowableIfAny

(

)

Definition at line 257 of file ImageConverter.php.

                                       : ?\Throwable
    {
        return $this->throwable;
    }

References ILIAS\Filesystem\Util\Convert\ImageConverter\$throwable.

Referenced by ILIAS\Filesystem\Util\Convert\LegacyImages\storeStream().

Here is the caller graph for this function:

handleBackgroundColor()

ILIAS\Filesystem\Util\Convert\ImageConverter::handleBackgroundColor ( )

protected

Definition at line 226 of file ImageConverter.php.

                                              : void
    {
        $this->requested_background = $this->conversion_options->getBackgroundColor();
        if ($this->output_options->getFormat(
        ) === ImageOutputOptions::FORMAT_JPG && $this->requested_background === null) {
            $this->requested_background = '#FFFFFF';
        }
        if ($this->output_options->getFormat(
        ) === ImageOutputOptions::FORMAT_PNG && $this->requested_background === null) {
            $this->requested_background = 'transparent';
        }
        if ($this->requested_background !== null) {
            $this->image->setBackgroundColor(new \ImagickPixel($this->requested_background));
        }
    }

References ILIAS\Filesystem\Util\Convert\ImageOutputOptions\FORMAT_JPG, and ILIAS\Filesystem\Util\Convert\ImageOutputOptions\FORMAT_PNG.

Referenced by ILIAS\Filesystem\Util\Convert\ImageConverter\convert().

Here is the caller graph for this function:

handleFormatAndQuality()

ILIAS\Filesystem\Util\Convert\ImageConverter::handleFormatAndQuality ( )

protected

Definition at line 170 of file ImageConverter.php.

                                               : void
    {
        $this->image->setImageResolution(
            self::RESOLUTION,
            self::RESOLUTION
        );
        // High density images do not support Resampling, cache to small. we deactivate this
        /*$this->image->resampleImage(
            self::RESOLUTION,
            self::RESOLUTION,
            \Imagick::FILTER_LANCZOS,
            1
        );*/
        $quality = $this->output_options->getQuality();
 
        // if $this->output_options->getFormat() is 'keep', we map it to the original format
        if ($this->output_options->getFormat() === ImageOutputOptions::FORMAT_KEEP) {
            try {
                $this->output_options = $this->output_options->withFormat(strtolower($this->image->getImageFormat()));
            } catch (\InvalidArgumentException) {
            }
        }
 
        switch ($this->output_options->getFormat()) {
            case ImageOutputOptions::FORMAT_WEBP:
                $this->image->setImageFormat('webp');
                $this->image->setImageAlphaChannel(\Imagick::ALPHACHANNEL_REMOVE);
                $this->image = $this->image->mergeImageLayers(\Imagick::LAYERMETHOD_FLATTEN);
                if ($quality === 0) {
                    $this->image->setOption('webp:lossless', 'false');
                }
                if ($quality === 100) {
                    $this->image->setOption('webp:lossless', 'true');
                }
                break;
            case ImageOutputOptions::FORMAT_JPG:
                $this->image->setImageFormat('jpeg');
                $this->image->setImageAlphaChannel(\Imagick::ALPHACHANNEL_REMOVE);
                $this->image = $this->image->mergeImageLayers(\Imagick::LAYERMETHOD_FLATTEN);
                $this->image->setImageCompression(\Imagick::COMPRESSION_JPEG);
                $this->image->setImageCompressionQuality($quality);
                break;
            case ImageOutputOptions::FORMAT_PNG:
                $png_compression_level = round($quality / 100 * 9, 0);
                if ($this->requested_background !== null && $this->requested_background !== 'transparent') {
                    $this->image->setImageAlphaChannel(\Imagick::ALPHACHANNEL_REMOVE);
                } else {
                    $this->image->setImageAlphaChannel(\Imagick::ALPHACHANNEL_ACTIVATE);
                }
                $this->image->setImageFormat('png');
                $this->image->setOption('png:compression-level', (string) $png_compression_level);
                break;
        }
        $this->image->stripImage();
    }

References ILIAS\Filesystem\Util\Convert\ImageOutputOptions\FORMAT_JPG, ILIAS\Filesystem\Util\Convert\ImageOutputOptions\FORMAT_KEEP, ILIAS\Filesystem\Util\Convert\ImageOutputOptions\FORMAT_PNG, and ILIAS\Filesystem\Util\Convert\ImageOutputOptions\FORMAT_WEBP.

Referenced by ILIAS\Filesystem\Util\Convert\ImageConverter\convert().

Here is the caller graph for this function:

handleImageDimension()

ILIAS\Filesystem\Util\Convert\ImageConverter::handleImageDimension ( )

protected

Definition at line 75 of file ImageConverter.php.

                                             : void
    {
        $requested_width = $this->conversion_options->getWidth();
        $requested_height = $this->conversion_options->getHeight();
        $original_image_width = $this->image->getImageWidth();
        $original_image_height = $this->image->getImageHeight();
 
        switch ($this->conversion_options->getDimensionMode()) {
            default:
            case ImageConversionOptions::DIMENSION_MODE_NONE:
                // no resizing
                return;
            case ImageConversionOptions::DIMENSION_MODE_FIT:
                if ($this->conversion_options->hasCrop()) {
                    $final_height = $requested_height;
                    $final_width = $requested_width;
                } else {
                    // this is a special case, where we want to fit the image into the given dimensions and
                    // Imagick knows the thumbnail method for that
                    $this->doThumbnail(
                        $requested_width,
                        $requested_height
                    );
                    return;
                }
                break;
            case ImageConversionOptions::DIMENSTION_MODE_RESIZE_TO_FIXED:
                // by width and height
                if ($requested_width > 0 && $requested_height > 0) {
                    $final_width = $requested_width;
                    $final_height = $requested_height;
                } else {
                    throw new \InvalidArgumentException('Dimension Mode does not match the given width/height');
                }
                break;
            case ImageConversionOptions::DIMENSTION_MODE_RESIZE_BY_HEIGHT:
                // by height
                if ($requested_width === null && $requested_height > 0) {
                    $ratio = $original_image_height / $requested_height;
                    $final_width = intval($original_image_width / $ratio);
                    $final_height = $requested_height;
                    $l = 1;
                } else {
                    throw new \InvalidArgumentException('Dimension Mode does not match the given width/height');
                }
                break;
            case ImageConversionOptions::DIMENSTION_MODE_RESIZE_BY_WIDTH:
                // by width
                if ($requested_width > 0 && $requested_height === null) {
                    $ratio = $original_image_width / $requested_width;
                    $final_width = $requested_width;
                    $final_height = intval($original_image_height / $ratio);
                } else {
                    throw new \InvalidArgumentException('Dimension Mode does not match the given width/height');
                }
                break;
            case ImageConversionOptions::DIMENSION_MODE_KEEP:
                // by none of them
                if ($requested_width === null && $requested_height === null) {
                    $final_width = $original_image_width;
                    $final_height = $original_image_height;
                } else {
                    throw new \InvalidArgumentException('Dimension Mode does not match the given width/height');
                }
                break;
        }
 
        if ($this->conversion_options->hasCrop()) {
            $this->doCrop(
                $final_width,
                $final_height
            );
        } else {
            $this->doResize(
                $final_width,
                $final_height
            );
        }
    }

References ILIAS\Filesystem\Util\Convert\ImageConversionOptions\DIMENSION_MODE_FIT, ILIAS\Filesystem\Util\Convert\ImageConversionOptions\DIMENSION_MODE_KEEP, ILIAS\Filesystem\Util\Convert\ImageConversionOptions\DIMENSION_MODE_NONE, ILIAS\Filesystem\Util\Convert\ImageConversionOptions\DIMENSTION_MODE_RESIZE_BY_HEIGHT, ILIAS\Filesystem\Util\Convert\ImageConversionOptions\DIMENSTION_MODE_RESIZE_BY_WIDTH, ILIAS\Filesystem\Util\Convert\ImageConversionOptions\DIMENSTION_MODE_RESIZE_TO_FIXED, ILIAS\Filesystem\Util\Convert\ImageConverter\doCrop(), ILIAS\Filesystem\Util\Convert\ImageConverter\doResize(), and ILIAS\Filesystem\Util\Convert\ImageConverter\doThumbnail().

Referenced by ILIAS\Filesystem\Util\Convert\ImageConverter\convert().

Here is the call graph for this function:

Here is the caller graph for this function:

isOK()

ILIAS\Filesystem\Util\Convert\ImageConverter::isOK

(

)

Definition at line 252 of file ImageConverter.php.

                          : bool
    {
        return $this->status === self::STATUS_OK;
    }

References ILIAS\Filesystem\Util\Convert\ImageConverter\STATUS_OK.

Referenced by ILIAS\Filesystem\Util\Convert\LegacyImages\storeStream().

Here is the caller graph for this function:

readInputStream()

ILIAS\Filesystem\Util\Convert\ImageConverter::readInputStream ( )

protected

Definition at line 242 of file ImageConverter.php.

                                        : void
    {
        if ($this->conversion_options->makeTemporaryFiles()) {
            $this->stream = $this->maybeSafeToTempStream($this->stream);
        }
        $this->stream->rewind();
        $this->image->readImageFile($this->stream->detach());
    }

Referenced by ILIAS\Filesystem\Util\Convert\ImageConverter\convert().

Here is the caller graph for this function:

Field Documentation

$image

Imagick ILIAS\Filesystem\Util\Convert\ImageConverter::$image

protected

Definition at line 46 of file ImageConverter.php.

$output_stream

FileStream ILIAS\Filesystem\Util\Convert\ImageConverter::$output_stream = null

protected

Definition at line 43 of file ImageConverter.php.

Referenced by ILIAS\Filesystem\Util\Convert\ImageConverter\getStream().

$requested_background

string ILIAS\Filesystem\Util\Convert\ImageConverter::$requested_background = null

protected

Definition at line 45 of file ImageConverter.php.

$status

int ILIAS\Filesystem\Util\Convert\ImageConverter::$status = self::STATUS_UNKNOWN

protected

Definition at line 42 of file ImageConverter.php.

$throwable

Throwable ILIAS\Filesystem\Util\Convert\ImageConverter::$throwable = null

protected

Definition at line 44 of file ImageConverter.php.

Referenced by ILIAS\Filesystem\Util\Convert\ImageConverter\getThrowableIfAny().

RESOLUTION

const ILIAS\Filesystem\Util\Convert\ImageConverter::RESOLUTION = 72

protected

Definition at line 39 of file ImageConverter.php.

RESOLUTION_FACTOR

const ILIAS\Filesystem\Util\Convert\ImageConverter::RESOLUTION_FACTOR = self::RESOLUTION / 72

protected

Definition at line 40 of file ImageConverter.php.

STATUS_FAILED

const ILIAS\Filesystem\Util\Convert\ImageConverter::STATUS_FAILED = 2

protected

Definition at line 36 of file ImageConverter.php.

Referenced by ILIAS\Filesystem\Util\Convert\ImageConverter\convert().

STATUS_OK

const ILIAS\Filesystem\Util\Convert\ImageConverter::STATUS_OK = 1

protected

Definition at line 35 of file ImageConverter.php.

Referenced by ILIAS\Filesystem\Util\Convert\ImageConverter\buildOutputStream(), and ILIAS\Filesystem\Util\Convert\ImageConverter\isOK().

STATUS_UNKNOWN

const ILIAS\Filesystem\Util\Convert\ImageConverter::STATUS_UNKNOWN = 4

protected

Definition at line 37 of file ImageConverter.php.

---

The documentation for this class was generated from the following file:

• components/ILIAS/Filesystem/src/Util/Convert/ImageConverter.php