ILIAS\Filesystem\Util\Convert\LegacyImages Class Reference

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

Public Member Functions
	__construct ()
	thumbnail (string $path_to_original, string $path_to_output, int $fit_into_size, string $output_format=ImageOutputOptions::FORMAT_KEEP, int $image_quality=75)
	croppedSquare (string $path_to_original, string $path_to_output, int $square_size, string $output_format=ImageOutputOptions::FORMAT_KEEP, int $image_quality=75)
	resizeByWidth (string $path_to_original, string $path_to_output, int $width, string $output_format=ImageOutputOptions::FORMAT_KEEP, int $image_quality=60)
	resizeByHeight (string $path_to_original, string $path_to_output, int $height, string $output_format=ImageOutputOptions::FORMAT_KEEP, int $image_quality=60)
	resizeToFixedSize (string $path_to_original, string $path_to_output, int $width, int $height, bool $crop_if_true_and_resize_if_false=true, string $output_format=ImageOutputOptions::FORMAT_KEEP, int $image_quality=60)
	convertToFormat (string $path_to_original, string $path_to_output, string $output_format, ?int $width=null, ?int $height=null)

Private Member Functions
	storeStream (ImageConverter $converter, string $path)
	buildStream (string $path_to_original)

Private Attributes
Images	$image_converters
ImageOutputOptions	$output_options

Detailed Description

Author

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

Deprecated:

ise instead

Definition at line 31 of file LegacyImages.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Filesystem\Util\Convert\LegacyImages::__construct

(

)

Definition at line 36 of file LegacyImages.php.

    {
        $this->image_converters = new Images(false);
        $this->output_options = new ImageOutputOptions();
    }

Member Function Documentation

buildStream()

ILIAS\Filesystem\Util\Convert\LegacyImages::buildStream ( string  $path_to_original )

private

Definition at line 196 of file LegacyImages.php.

Referenced by ILIAS\Filesystem\Util\Convert\LegacyImages\convertToFormat(), ILIAS\Filesystem\Util\Convert\LegacyImages\croppedSquare(), ILIAS\Filesystem\Util\Convert\LegacyImages\resizeByHeight(), ILIAS\Filesystem\Util\Convert\LegacyImages\resizeByWidth(), ILIAS\Filesystem\Util\Convert\LegacyImages\resizeToFixedSize(), and ILIAS\Filesystem\Util\Convert\LegacyImages\thumbnail().

                                                          : Stream|FileStream
    {
        return Streams::ofResource(fopen($path_to_original, 'rb'));
    }

Here is the caller graph for this function:

convertToFormat()

ILIAS\Filesystem\Util\Convert\LegacyImages::convertToFormat	(	string	$path_to_original,
		string	$path_to_output,
		string	$output_format,
		?int	$width = null,
		?int	$height = null
	)

Definition at line 165 of file LegacyImages.php.

References ILIAS\Filesystem\Util\Convert\LegacyImages\buildStream(), and ILIAS\Filesystem\Util\Convert\LegacyImages\storeStream().

     : string {
        $converter = $this->image_converters->convertToFormat(
            $this->buildStream($path_to_original),
            $output_format,
            $width,
            $height
        );
        return $this->storeStream($converter, $path_to_output);
    }

Here is the call graph for this function:

croppedSquare()

ILIAS\Filesystem\Util\Convert\LegacyImages::croppedSquare	(	string	$path_to_original,
		string	$path_to_output,
		int	$square_size,
		string	$output_format = ImageOutputOptions::FORMAT_KEEP,
		int	$image_quality = 75
	)

Returns

string path to the thumbnail

Deprecated:

Use ::croppedSquare() instead.

Definition at line 74 of file LegacyImages.php.

References ILIAS\Filesystem\Util\Convert\LegacyImages\buildStream(), and ILIAS\Filesystem\Util\Convert\LegacyImages\storeStream().

     : string {
        $converter = $this->image_converters->croppedSquare(
            $this->buildStream($path_to_original),
            $square_size,
            $this->output_options
                ->withQuality($image_quality)
                ->withFormat($output_format)
        );

        return $this->storeStream($converter, $path_to_output);
    }

Here is the call graph for this function:

resizeByHeight()

ILIAS\Filesystem\Util\Convert\LegacyImages::resizeByHeight	(	string	$path_to_original,
		string	$path_to_output,
		int	$height,
		string	$output_format = ImageOutputOptions::FORMAT_KEEP,
		int	$image_quality = 60
	)

Deprecated:

Use ::resizeByHeight() instead.

Returns

string path to the resized image

Definition at line 122 of file LegacyImages.php.

References ILIAS\Filesystem\Util\Convert\LegacyImages\buildStream(), and ILIAS\Filesystem\Util\Convert\LegacyImages\storeStream().

     : string {
        $converter = $this->image_converters->resizeByHeight(
            $this->buildStream($path_to_original),
            $height,
            $this->output_options
                ->withQuality($image_quality)
                ->withFormat($output_format)
        );
        return $this->storeStream($converter, $path_to_output);
    }

Here is the call graph for this function:

resizeByWidth()

ILIAS\Filesystem\Util\Convert\LegacyImages::resizeByWidth	(	string	$path_to_original,
		string	$path_to_output,
		int	$width,
		string	$output_format = ImageOutputOptions::FORMAT_KEEP,
		int	$image_quality = 60
	)

Returns

string path to the thumbnail

Deprecated:

Use ::resizeByWidth() instead.

Definition at line 100 of file LegacyImages.php.

References ILIAS\Filesystem\Util\Convert\LegacyImages\buildStream(), and ILIAS\Filesystem\Util\Convert\LegacyImages\storeStream().

     : string {
        $converter = $this->image_converters->resizeByWidth(
            $this->buildStream($path_to_original),
            $width,
            $this->output_options
                ->withQuality($image_quality)
                ->withFormat($output_format)
        );
        return $this->storeStream($converter, $path_to_output);
    }

Here is the call graph for this function:

resizeToFixedSize()

ILIAS\Filesystem\Util\Convert\LegacyImages::resizeToFixedSize	(	string	$path_to_original,
		string	$path_to_output,
		int	$width,
		int	$height,
		bool	$crop_if_true_and_resize_if_false = true,
		string	$output_format = ImageOutputOptions::FORMAT_KEEP,
		int	$image_quality = 60
	)

Returns

string path to the thumbnail

Deprecated:

Use ::resizeToFixedSize() instead.

Definition at line 144 of file LegacyImages.php.

References ILIAS\Filesystem\Util\Convert\LegacyImages\buildStream(), and ILIAS\Filesystem\Util\Convert\LegacyImages\storeStream().

     : string {
        $converter = $this->image_converters->resizeToFixedSize(
            $this->buildStream($path_to_original),
            $width,
            $height,
            $crop_if_true_and_resize_if_false,
            $this->output_options
                ->withQuality($image_quality)
                ->withFormat($output_format)
        );
        return $this->storeStream($converter, $path_to_output);
    }

Here is the call graph for this function:

storeStream()

ILIAS\Filesystem\Util\Convert\LegacyImages::storeStream ( ImageConverter  $converter, string  $path  )

private

Definition at line 181 of file LegacyImages.php.

References $path, ILIAS\Filesystem\Util\Convert\ImageConverter\getStream(), ILIAS\Filesystem\Util\Convert\ImageConverter\getThrowableIfAny(), and ILIAS\Filesystem\Util\Convert\ImageConverter\isOK().

Referenced by ILIAS\Filesystem\Util\Convert\LegacyImages\convertToFormat(), ILIAS\Filesystem\Util\Convert\LegacyImages\croppedSquare(), ILIAS\Filesystem\Util\Convert\LegacyImages\resizeByHeight(), ILIAS\Filesystem\Util\Convert\LegacyImages\resizeByWidth(), ILIAS\Filesystem\Util\Convert\LegacyImages\resizeToFixedSize(), and ILIAS\Filesystem\Util\Convert\LegacyImages\thumbnail().

                                                                         : string
    {
        if (!$converter->isOK()) {
            throw $converter->getThrowableIfAny() ?? new \RuntimeException('Could not create requested image');
        }

        $stream = $converter->getStream();

        $stream->rewind();
        if (file_put_contents($path, $stream->getContents()) === false) {
            throw new \RuntimeException('Could not store image');
        }
        return $path;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

thumbnail()

ILIAS\Filesystem\Util\Convert\LegacyImages::thumbnail	(	string	$path_to_original,
		string	$path_to_output,
		int	$fit_into_size,
		string	$output_format = ImageOutputOptions::FORMAT_KEEP,
		int	$image_quality = 75
	)

Returns

string path to the thumbnail

Deprecated:

Use ::thumbnail() instead.

Definition at line 49 of file LegacyImages.php.

References ILIAS\Filesystem\Util\Convert\LegacyImages\buildStream(), and ILIAS\Filesystem\Util\Convert\LegacyImages\storeStream().

     : string {
        $converter = $this->image_converters->thumbnail(
            $this->buildStream($path_to_original),
            $fit_into_size,
            $this->output_options
                ->withQuality($image_quality)
                ->withFormat($output_format)
        );
        return $this->storeStream($converter, $path_to_output);
    }

Here is the call graph for this function:

Field Documentation

$image_converters

Images ILIAS\Filesystem\Util\Convert\LegacyImages::$image_converters

private

Definition at line 33 of file LegacyImages.php.

$output_options

ImageOutputOptions ILIAS\Filesystem\Util\Convert\LegacyImages::$output_options

private

Definition at line 34 of file LegacyImages.php.

---

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

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