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

Public Member Functions
	withThrowOnError (bool $throw_on_error)
	@description If there is any throwable during convertion, this will be thworn again. More...

	withMakeTemporaryFiles (bool $make_temporary_files)
	@description if passing a stream from memory, make a temporary file for this. More...

	withFitIn (int $max_size)
	@description Fit the image into the given size. More...

	withKeepAspectRatio (bool $keep_aspect_ratio)
	@description Keep the aspect ratio while resizing the image. More...

	withCrop (bool $crop)
	@description Crops the final image if needed. More...

	withKeepDimensions (bool $keep)
	@description No resizing, the original image dimension will be used. More...

	withWidth (int $width)
	@description Resize the image to the given width. More...

	withHeight (int $height)
	@description Resize the image to the given height. More...

	withFixedDimensions (int $width, int $height)
	@description Resizes the Image to a fixed size. More...

	withOutputPath (string $output_path)

	withBackgroundColor (string $background_color)
	@description Set a background color for the image. More...

	getBackgroundColor ()

	getOutputPath ()

	getDimensionMode ()

	getHeight ()

	getWidth ()

	keepAspectRatio ()

	hasCrop ()

	throwOnError ()

	makeTemporaryFiles ()

Data Fields
const	DIMENSION_MODE_NONE = 0

const	DIMENSION_MODE_FIT = 1

const	DIMENSTION_MODE_RESIZE_TO_FIXED = 2

const	DIMENSTION_MODE_RESIZE_BY_HEIGHT = 3

const	DIMENSTION_MODE_RESIZE_BY_WIDTH = 4

const	DIMENSION_MODE_KEEP = 5

Protected Member Functions
	checkBackgroundColor (string $background_color)

Private Attributes
int	$dimension_mode = self::DIMENSION_MODE_NONE

int	$height = null

int	$width = null

bool	$keep_aspect_ratio = true

string	$background_color = null

string	$output_path = null

bool	$crop = true

bool	$throw_on_error = false

bool	$make_temporary_files = false

Detailed Description

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

Definition at line 27 of file ImageConversionOptions.php.

Member Function Documentation

◆ checkBackgroundColor()

ILIAS\Filesystem\Util\Convert\ImageConversionOptions::checkBackgroundColor ( string $background_color )

protected

Definition at line 214 of file ImageConversionOptions.php.

                                                                     : void
    {
        if (!preg_match('/^#?([a-f0-9]{6})$/i', $background_color)) {
            throw new \InvalidArgumentException('Invalid background color');
        }
    }

References ILIAS\Filesystem\Util\Convert\ImageConversionOptions\$background_color.

Referenced by ILIAS\Filesystem\Util\Convert\ImageConversionOptions\withBackgroundColor().

Here is the caller graph for this function:

◆ getBackgroundColor()

ILIAS\Filesystem\Util\Convert\ImageConversionOptions::getBackgroundColor ( )

Definition at line 166 of file ImageConversionOptions.php.

                                        : ?string
    {
        return $this->background_color;
    }

References ILIAS\Filesystem\Util\Convert\ImageConversionOptions\$background_color.

◆ getDimensionMode()

ILIAS\Filesystem\Util\Convert\ImageConversionOptions::getDimensionMode ( )

Definition at line 177 of file ImageConversionOptions.php.

                                      : int
    {
        return $this->dimension_mode;
    }

References ILIAS\Filesystem\Util\Convert\ImageConversionOptions\$dimension_mode.

◆ getHeight()

ILIAS\Filesystem\Util\Convert\ImageConversionOptions::getHeight ( )

Definition at line 182 of file ImageConversionOptions.php.

                               : ?int
    {
        return $this->height;
    }

References ILIAS\Filesystem\Util\Convert\ImageConversionOptions\$height.

◆ getOutputPath()

ILIAS\Filesystem\Util\Convert\ImageConversionOptions::getOutputPath ( )

Definition at line 171 of file ImageConversionOptions.php.

                                   : ?string
    {
        return $this->output_path;
    }

References ILIAS\Filesystem\Util\Convert\ImageConversionOptions\$output_path.

◆ getWidth()

ILIAS\Filesystem\Util\Convert\ImageConversionOptions::getWidth ( )

Definition at line 187 of file ImageConversionOptions.php.

                              : ?int
    {
        return $this->width;
    }

References ILIAS\Filesystem\Util\Convert\ImageConversionOptions\$width.

◆ hasCrop()

ILIAS\Filesystem\Util\Convert\ImageConversionOptions::hasCrop ( )

Definition at line 199 of file ImageConversionOptions.php.

                             : bool
    {
        return $this->crop;
    }

References ILIAS\Filesystem\Util\Convert\ImageConversionOptions\$crop.

◆ keepAspectRatio()

ILIAS\Filesystem\Util\Convert\ImageConversionOptions::keepAspectRatio ( )

Definition at line 193 of file ImageConversionOptions.php.

                                     : bool
    {
        return $this->keep_aspect_ratio;
    }

References ILIAS\Filesystem\Util\Convert\ImageConversionOptions\$keep_aspect_ratio.

◆ makeTemporaryFiles()

ILIAS\Filesystem\Util\Convert\ImageConversionOptions::makeTemporaryFiles ( )

Definition at line 209 of file ImageConversionOptions.php.

                                        : bool
    {
        return $this->make_temporary_files;
    }

References ILIAS\Filesystem\Util\Convert\ImageConversionOptions\$make_temporary_files.

◆ throwOnError()

ILIAS\Filesystem\Util\Convert\ImageConversionOptions::throwOnError ( )

Definition at line 204 of file ImageConversionOptions.php.

                                  : bool
    {
        return $this->throw_on_error;
    }

References ILIAS\Filesystem\Util\Convert\ImageConversionOptions\$throw_on_error.

◆ withBackgroundColor()

ILIAS\Filesystem\Util\Convert\ImageConversionOptions::withBackgroundColor ( string $background_color )

@description Set a background color for the image.

This is used e.g. while converting transparent pngs to jpgs.

Definition at line 157 of file ImageConversionOptions.php.

                                                                 : ImageConversionOptions
    {
        $this->checkBackgroundColor($background_color);
 
        $clone = clone $this;
        $clone->background_color = $background_color;
        return $clone;
    }

References ILIAS\Filesystem\Util\Convert\ImageConversionOptions\$background_color, and ILIAS\Filesystem\Util\Convert\ImageConversionOptions\checkBackgroundColor().

Here is the call graph for this function:

◆ withCrop()

ILIAS\Filesystem\Util\Convert\ImageConversionOptions::withCrop ( bool $crop )

@description Crops the final image if needed.

Definition at line 94 of file ImageConversionOptions.php.

                                        : ImageConversionOptions
    {
        $clone = clone $this;
        $clone->crop = $crop;
        return $clone;
    }

References ILIAS\Filesystem\Util\Convert\ImageConversionOptions\$crop.

◆ withFitIn()

ILIAS\Filesystem\Util\Convert\ImageConversionOptions::withFitIn ( int $max_size )

@description Fit the image into the given size.

Depending on the withCrop option, the image will be cropped or not.

Definition at line 73 of file ImageConversionOptions.php.

                                            : ImageConversionOptions
    {
        $clone = clone $this;
        $clone->dimension_mode = self::DIMENSION_MODE_FIT;
        $clone->width = $clone->height = $max_size;
        return $clone;
    }

References ILIAS\Filesystem\Util\Convert\ImageConversionOptions\DIMENSION_MODE_FIT.

◆ withFixedDimensions()

ILIAS\Filesystem\Util\Convert\ImageConversionOptions::withFixedDimensions	(	int	$width,
		int	$height
	)

@description Resizes the Image to a fixed size.

Use withCrop() and withKeepAspectRatio() if needed.

Definition at line 137 of file ImageConversionOptions.php.

                                                                : ImageConversionOptions
    {
        return $this->withHeight($height)->withWidth($width);
    }

References ILIAS\Filesystem\Util\Convert\ImageConversionOptions\$width, and ILIAS\Filesystem\Util\Convert\ImageConversionOptions\withHeight().

Here is the call graph for this function:

◆ withHeight()

ILIAS\Filesystem\Util\Convert\ImageConversionOptions::withHeight ( int $height )

@description Resize the image to the given height.

Depends on withWidth() if the image will be resized to a fixed size or depending on the height.

Definition at line 126 of file ImageConversionOptions.php.

                                           : ImageConversionOptions
    {
        $clone = clone $this;
        $clone->dimension_mode = ($this->width === null) ? self::DIMENSTION_MODE_RESIZE_BY_HEIGHT : self::DIMENSTION_MODE_RESIZE_TO_FIXED;
        $clone->height = $height;
        return $clone;
    }

References ILIAS\Filesystem\Util\Convert\ImageConversionOptions\$height.

Referenced by ILIAS\Filesystem\Util\Convert\Images\convertToFormat(), and ILIAS\Filesystem\Util\Convert\ImageConversionOptions\withFixedDimensions().

Here is the caller graph for this function:

◆ withKeepAspectRatio()

ILIAS\Filesystem\Util\Convert\ImageConversionOptions::withKeepAspectRatio ( bool $keep_aspect_ratio )

@description Keep the aspect ratio while resizing the image.

If used with withCrop, the image will be cropped as well to fit the size.

Definition at line 84 of file ImageConversionOptions.php.

                                                                : ImageConversionOptions
    {
        $clone = clone $this;
        $clone->keep_aspect_ratio = $keep_aspect_ratio;
        return $clone;
    }

References ILIAS\Filesystem\Util\Convert\ImageConversionOptions\$keep_aspect_ratio.

◆ withKeepDimensions()

ILIAS\Filesystem\Util\Convert\ImageConversionOptions::withKeepDimensions ( bool $keep )

@description No resizing, the original image dimension will be used.

Definition at line 104 of file ImageConversionOptions.php.

                                                  : ImageConversionOptions
    {
        $clone = clone $this;
        $clone->dimension_mode = self::DIMENSION_MODE_KEEP;
        $this->width = $this->height = null;
        return $clone;
    }

References ILIAS\Filesystem\Util\Convert\ImageConversionOptions\DIMENSION_MODE_KEEP.

◆ withMakeTemporaryFiles()

ILIAS\Filesystem\Util\Convert\ImageConversionOptions::withMakeTemporaryFiles ( bool $make_temporary_files )

@description if passing a stream from memory, make a temporary file for this.

otherwise, the php://memory stream will be used which can cause problems with imagick in some circumstances, but is faster.

Definition at line 63 of file ImageConversionOptions.php.

                                                                      : self
    {
        $clone = clone $this;
        $clone->make_temporary_files = $make_temporary_files;
        return $clone;
    }

References ILIAS\Filesystem\Util\Convert\ImageConversionOptions\$make_temporary_files.

◆ withOutputPath()

ILIAS\Filesystem\Util\Convert\ImageConversionOptions::withOutputPath ( string $output_path )

Deprecated:: @description Set an write path for the converted image. If not set, the image will be converted in memory.

Definition at line 146 of file ImageConversionOptions.php.

                                                       : ImageConversionOptions
    {
        $clone = clone $this;
        $clone->output_path = $output_path;
        return $clone;
    }

References ILIAS\Filesystem\Util\Convert\ImageConversionOptions\$output_path.

◆ withThrowOnError()

ILIAS\Filesystem\Util\Convert\ImageConversionOptions::withThrowOnError ( bool $throw_on_error )

@description If there is any throwable during convertion, this will be thworn again.

otherwise one must check with isOK()

Definition at line 50 of file ImageConversionOptions.php.

                                                          : self
    {
        $clone = clone $this;
        $clone->throw_on_error = $throw_on_error;
        return $clone;
    }

References ILIAS\Filesystem\Util\Convert\ImageConversionOptions\$throw_on_error.

◆ withWidth()

ILIAS\Filesystem\Util\Convert\ImageConversionOptions::withWidth ( int $width )

@description Resize the image to the given width.

Depends on withHeight() if the image will be resized to a fixed size or depending on the width.

Definition at line 115 of file ImageConversionOptions.php.

                                         : ImageConversionOptions
    {
        $clone = clone $this;
        $clone->dimension_mode = ($this->height === null) ? self::DIMENSTION_MODE_RESIZE_BY_WIDTH : self::DIMENSTION_MODE_RESIZE_TO_FIXED;
        $clone->width = $width;
        return $clone;
    }

References ILIAS\Filesystem\Util\Convert\ImageConversionOptions\$width.

Field Documentation

◆ $background_color

string ILIAS\Filesystem\Util\Convert\ImageConversionOptions::$background_color = null

private

Definition at line 40 of file ImageConversionOptions.php.

Referenced by ILIAS\Filesystem\Util\Convert\ImageConversionOptions\checkBackgroundColor(), ILIAS\Filesystem\Util\Convert\ImageConversionOptions\getBackgroundColor(), and ILIAS\Filesystem\Util\Convert\ImageConversionOptions\withBackgroundColor().

◆ $crop

bool ILIAS\Filesystem\Util\Convert\ImageConversionOptions::$crop = true

private

Definition at line 42 of file ImageConversionOptions.php.

Referenced by ILIAS\Filesystem\Util\Convert\ImageConversionOptions\hasCrop(), and ILIAS\Filesystem\Util\Convert\ImageConversionOptions\withCrop().

◆ $dimension_mode

int ILIAS\Filesystem\Util\Convert\ImageConversionOptions::$dimension_mode = self::DIMENSION_MODE_NONE

private

Definition at line 36 of file ImageConversionOptions.php.

Referenced by ILIAS\Filesystem\Util\Convert\ImageConversionOptions\getDimensionMode().

◆ $height

int ILIAS\Filesystem\Util\Convert\ImageConversionOptions::$height = null

private

Definition at line 37 of file ImageConversionOptions.php.

Referenced by ILIAS\Filesystem\Util\Convert\ImageConversionOptions\getHeight(), and ILIAS\Filesystem\Util\Convert\ImageConversionOptions\withHeight().

◆ $keep_aspect_ratio

bool ILIAS\Filesystem\Util\Convert\ImageConversionOptions::$keep_aspect_ratio = true

private

Definition at line 39 of file ImageConversionOptions.php.

Referenced by ILIAS\Filesystem\Util\Convert\ImageConversionOptions\keepAspectRatio(), and ILIAS\Filesystem\Util\Convert\ImageConversionOptions\withKeepAspectRatio().

◆ $make_temporary_files

bool ILIAS\Filesystem\Util\Convert\ImageConversionOptions::$make_temporary_files = false

private

Definition at line 44 of file ImageConversionOptions.php.

Referenced by ILIAS\Filesystem\Util\Convert\ImageConversionOptions\makeTemporaryFiles(), and ILIAS\Filesystem\Util\Convert\ImageConversionOptions\withMakeTemporaryFiles().

◆ $output_path

string ILIAS\Filesystem\Util\Convert\ImageConversionOptions::$output_path = null

private

Definition at line 41 of file ImageConversionOptions.php.

Referenced by ILIAS\Filesystem\Util\Convert\ImageConversionOptions\getOutputPath(), and ILIAS\Filesystem\Util\Convert\ImageConversionOptions\withOutputPath().

◆ $throw_on_error

bool ILIAS\Filesystem\Util\Convert\ImageConversionOptions::$throw_on_error = false

private

Definition at line 43 of file ImageConversionOptions.php.

Referenced by ILIAS\Filesystem\Util\Convert\ImageConversionOptions\throwOnError(), and ILIAS\Filesystem\Util\Convert\ImageConversionOptions\withThrowOnError().

◆ $width

int ILIAS\Filesystem\Util\Convert\ImageConversionOptions::$width = null

private

Definition at line 38 of file ImageConversionOptions.php.

Referenced by ILIAS\Filesystem\Util\Convert\ImageConversionOptions\getWidth(), ILIAS\Filesystem\Util\Convert\ImageConversionOptions\withFixedDimensions(), and ILIAS\Filesystem\Util\Convert\ImageConversionOptions\withWidth().

◆ DIMENSION_MODE_FIT

const ILIAS\Filesystem\Util\Convert\ImageConversionOptions::DIMENSION_MODE_FIT = 1

Definition at line 30 of file ImageConversionOptions.php.

Referenced by ILIAS\Filesystem\Util\Convert\ImageConverter\handleImageDimension(), and ILIAS\Filesystem\Util\Convert\ImageConversionOptions\withFitIn().

◆ DIMENSION_MODE_KEEP

const ILIAS\Filesystem\Util\Convert\ImageConversionOptions::DIMENSION_MODE_KEEP = 5

Definition at line 34 of file ImageConversionOptions.php.

Referenced by ILIAS\Filesystem\Util\Convert\ImageConverter\handleImageDimension(), and ILIAS\Filesystem\Util\Convert\ImageConversionOptions\withKeepDimensions().

◆ DIMENSION_MODE_NONE

const ILIAS\Filesystem\Util\Convert\ImageConversionOptions::DIMENSION_MODE_NONE = 0

Definition at line 29 of file ImageConversionOptions.php.

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

◆ DIMENSTION_MODE_RESIZE_BY_HEIGHT

const ILIAS\Filesystem\Util\Convert\ImageConversionOptions::DIMENSTION_MODE_RESIZE_BY_HEIGHT = 3

Definition at line 32 of file ImageConversionOptions.php.

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

◆ DIMENSTION_MODE_RESIZE_BY_WIDTH

const ILIAS\Filesystem\Util\Convert\ImageConversionOptions::DIMENSTION_MODE_RESIZE_BY_WIDTH = 4

Definition at line 33 of file ImageConversionOptions.php.

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

◆ DIMENSTION_MODE_RESIZE_TO_FIXED

const ILIAS\Filesystem\Util\Convert\ImageConversionOptions::DIMENSTION_MODE_RESIZE_TO_FIXED = 2

Definition at line 31 of file ImageConversionOptions.php.

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

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

components/ILIAS/Filesystem/src/Util/Convert/ImageConversionOptions.php

Public Member Functions

Data Fields

Protected Member Functions

Private Attributes

Detailed Description

Member Function Documentation

◆ checkBackgroundColor()

◆ getBackgroundColor()

◆ getDimensionMode()

◆ getHeight()

◆ getOutputPath()

◆ getWidth()

◆ hasCrop()

◆ keepAspectRatio()

◆ makeTemporaryFiles()

◆ throwOnError()

◆ withBackgroundColor()

◆ withCrop()

◆ withFitIn()

◆ withFixedDimensions()

◆ withHeight()

◆ withKeepAspectRatio()

◆ withKeepDimensions()

◆ withMakeTemporaryFiles()

◆ withOutputPath()

◆ withThrowOnError()

◆ withWidth()

Field Documentation

◆ $background_color

◆ $crop

◆ $dimension_mode

◆ $height

◆ $keep_aspect_ratio

◆ $make_temporary_files

◆ $output_path

◆ $throw_on_error

◆ $width

◆ DIMENSION_MODE_FIT

◆ DIMENSION_MODE_KEEP

◆ DIMENSION_MODE_NONE

◆ DIMENSTION_MODE_RESIZE_BY_HEIGHT

◆ DIMENSTION_MODE_RESIZE_BY_WIDTH

◆ DIMENSTION_MODE_RESIZE_TO_FIXED