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

Public Member Functions
	__construct (bool $throw_on_error=false)

	thumbnail (FileStream $stream, int $fit_into_size, ?ImageOutputOptions $image_output_options=null)
	@description Creates an image from the given stream which fits into the given size and keeps the aspect ratio. More...

	croppedSquare (FileStream $stream, int $square_size, ?ImageOutputOptions $image_output_options=null)
	@description Creates an image from the given stream which fits into the given size, but is cropped to fill the whole square. More...

	resizeByWidth (FileStream $stream, int $width, ?ImageOutputOptions $image_output_options=null)
	@description Resizes an image to an image with the given width. More...

	resizeByHeight (FileStream $stream, int $height, ?ImageOutputOptions $image_output_options=null)
	@description Resizes an image to an image with the given height. More...

	resizeToFixedSize (FileStream $stream, int $width, int $height, bool $crop_or_otherwise_squeeze=true, ?ImageOutputOptions $image_output_options=null)
	@description Creates an image from the given stream, resized to width and height given. More...

	convertToFormat (FileStream $stream, string $to_format, ?int $width=null, ?int $height=null, ?ImageOutputOptions $image_output_options=null)
	@description Creates an image from the given stream, converted to the desired format. More...

Protected Attributes
ImageConversionOptions	$conversion_options

ImageOutputOptions	$image_output_options

Private Member Functions
	merge (?ImageOutputOptions $image_output_options)

Detailed Description

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

Definition at line 29 of file Images.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Filesystem\Util\Convert\Images::__construct ( bool $throw_on_error = false )

Parameters

bool $throw_on_error if there is any error, throw an exception, otherwise one must check with isOK()

Definition at line 37 of file Images.php.

      {
        // Defaults
        $this->conversion_options = (new ImageConversionOptions())
            ->withMakeTemporaryFiles(false)
            ->withThrowOnError($throw_on_error);
        $this->image_output_options = (new ImageOutputOptions())
            ->withJpgOutput()
            ->withQuality(75);
    }

Member Function Documentation

◆ convertToFormat()

ILIAS\Filesystem\Util\Convert\Images::convertToFormat	(	FileStream	$stream,
		string	$to_format,
		?int	$width = `null`,
		?int	$height = `null`,
		?ImageOutputOptions	$image_output_options = `null`
	)

@description Creates an image from the given stream, converted to the desired format.

Currently supported target formats are:

ImageOutputOptions::FORMAT_JPG
ImageOutputOptions::FORMAT_PNG
ImageOutputOptions::FORMAT_KEEP (will keep the original format), but makes no sense here

Definition at line 158 of file Images.php.

     : ImageConverter {
        $conversion_options = $this->conversion_options
            ->withKeepAspectRatio(true)
            ->withCrop(true);
 
        if ($height !== null) {
            $conversion_options = $conversion_options->withHeight($height);
        }
        if ($width !== null) {
            $conversion_options = $conversion_options->withWidth($width);
        }
        if ($width === null && $height === null) {
            $conversion_options = $conversion_options->withKeepDimensions(true);
        }
        return new ImageConverter(
            $conversion_options,
            $this->merge($image_output_options)->withFormat($to_format),
            $stream
        );
    }

References ILIAS\Filesystem\Util\Convert\ImageConversionOptions\withHeight().

Here is the call graph for this function:

◆ croppedSquare()

ILIAS\Filesystem\Util\Convert\Images::croppedSquare	(	FileStream	$stream,
		int	$square_size,
		?ImageOutputOptions	$image_output_options = `null`
	)

@description Creates an image from the given stream which fits into the given size, but is cropped to fill the whole square.

Use getStream() to get final image.

Definition at line 72 of file Images.php.

     : ImageConverter {
        return new ImageConverter(
            $this->conversion_options
                ->withFitIn($square_size)
                ->withKeepAspectRatio(true)
                ->withCrop(true),
            $this->merge($image_output_options),
            $stream
        );
    }

◆ merge()

ILIAS\Filesystem\Util\Convert\Images::merge ( ?ImageOutputOptions $image_output_options )

private

Definition at line 185 of file Images.php.

                                                                     : ImageOutputOptions
    {
        if ($image_output_options !== null) {
            return $this->image_output_options
                ->withQuality($image_output_options->getQuality())
                ->withFormat($image_output_options->getFormat());
        }
        return $this->image_output_options;
    }

References ILIAS\Filesystem\Util\Convert\ImageOutputOptions\getFormat(), ILIAS\Filesystem\Util\Convert\ImageOutputOptions\getQuality(), and ILIAS\Filesystem\Util\Convert\ImageOutputOptions\withQuality().

Here is the call graph for this function:

◆ resizeByHeight()

ILIAS\Filesystem\Util\Convert\Images::resizeByHeight	(	FileStream	$stream,
		int	$height,
		?ImageOutputOptions	$image_output_options = `null`
	)

@description Resizes an image to an image with the given height.

The width is calculated to keep the aspect ratio. Use getStream() to get final image.

Definition at line 113 of file Images.php.

     : ImageConverter {
        return new ImageConverter(
            $this->conversion_options
                ->withHeight($height)
                ->withKeepAspectRatio(true),
            $this->merge($image_output_options),
            $stream
        );
    }

◆ resizeByWidth()

ILIAS\Filesystem\Util\Convert\Images::resizeByWidth	(	FileStream	$stream,
		int	$width,
		?ImageOutputOptions	$image_output_options = `null`
	)

@description Resizes an image to an image with the given width.

The height is calculated to keep the aspect ratio. Use getStream() to get final image.

Definition at line 93 of file Images.php.

     : ImageConverter {
        return new ImageConverter(
            $this->conversion_options
                ->withWidth($width)
                ->withKeepAspectRatio(true),
            $this->merge($image_output_options),
            $stream
        );
    }

◆ resizeToFixedSize()

ILIAS\Filesystem\Util\Convert\Images::resizeToFixedSize	(	FileStream	$stream,
		int	$width,
		int	$height,
		bool	$crop_or_otherwise_squeeze = `true`,
		?ImageOutputOptions	$image_output_options = `null`
	)

@description Creates an image from the given stream, resized to width and height given.

The original image can be cropped (to keep aspect ratio) or not (which squeezes the original to fit). Use getStream() to get final image.

Definition at line 133 of file Images.php.

     : ImageConverter {
        return new ImageConverter(
            $this->conversion_options
                ->withWidth($width)
                ->withHeight($height)
                ->withCrop($crop_or_otherwise_squeeze)
                ->withKeepAspectRatio(true),
            $this->merge($image_output_options),
            $stream
        );
    }

Referenced by ILIAS\Filesystem\Util\ImageConversionTest\testFailed().

Here is the caller graph for this function:

◆ thumbnail()

ILIAS\Filesystem\Util\Convert\Images::thumbnail	(	FileStream	$stream,
		int	$fit_into_size,
		?ImageOutputOptions	$image_output_options = `null`
	)

@description Creates an image from the given stream which fits into the given size and keeps the aspect ratio.

Use getStream() to get final image.

Definition at line 53 of file Images.php.

     : ImageConverter {
        return new ImageConverter(
            $this->conversion_options
                ->withFitIn($fit_into_size)
                ->withCrop(false)
                ->withKeepAspectRatio(true),
            $this->merge($image_output_options),
            $stream
        );
    }

Field Documentation

◆ $conversion_options

ImageConversionOptions ILIAS\Filesystem\Util\Convert\Images::$conversion_options

protected

Definition at line 31 of file Images.php.

◆ $image_output_options

ImageOutputOptions ILIAS\Filesystem\Util\Convert\Images::$image_output_options