ILIAS\Filesystem\Util\Convert\ImageOutputOptions Class Reference

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

Public Member Functions
	withFormat (string $format)
	set the desired output format. More...
	withJpgOutput ()
	set the output format to JPG More...
	withPngOutput ()
	set the output format to PNG More...
	withWebPOutput ()
	set the output format to WEBP More...
	withQuality (int $image_quality)
	set the image compression quality. More...
	getFormat ()
	getQuality ()

Data Fields
const	FORMAT_JPG = 'jpg'
const	FORMAT_PNG = 'png'
const	FORMAT_WEBP = 'webp'
const	FORMAT_KEEP = 'keep'

Protected Member Functions
	checkImageQuality (int $image_quality)

Private Member Functions
	checkFormat (string $format)

Private Attributes
int	$quality = 75
string	$format = self::FORMAT_JPG
array	$allowed_formats

Detailed Description

Author

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

Definition at line 26 of file ImageOutputOptions.php.

Member Function Documentation

checkFormat()

ILIAS\Filesystem\Util\Convert\ImageOutputOptions::checkFormat ( string  $format )

private

Definition at line 101 of file ImageOutputOptions.php.

References ILIAS\Filesystem\Util\Convert\ImageOutputOptions\$format.

Referenced by ILIAS\Filesystem\Util\Convert\ImageOutputOptions\withFormat().

                                                : string
    {
        $format = strtolower($format);
        if ($format === 'jpeg') {
            $format = self::FORMAT_JPG;
        }

        if (!in_array($format, $this->allowed_formats, true)) {
            throw new \InvalidArgumentException('Format must be either jpg or png, ' . $format . ' given.');
        }
        return $format;
    }

Here is the caller graph for this function:

checkImageQuality()

ILIAS\Filesystem\Util\Convert\ImageOutputOptions::checkImageQuality ( int  $image_quality )

protected

Definition at line 114 of file ImageOutputOptions.php.

Referenced by ILIAS\Filesystem\Util\Convert\ImageOutputOptions\withQuality().

                                                            : void
    {
        if ($this->format === self::FORMAT_WEBP) {
            if ($image_quality !== 0 && $image_quality !== 100) {
                throw new \InvalidArgumentException('WebP only supports quality 0 (loss) or 100 (losless)');
            }
        } elseif ($image_quality < 0 || $image_quality > 100) {
            throw new \InvalidArgumentException('Quality must be between 0 and 100');
        }
    }

Here is the caller graph for this function:

getFormat()

ILIAS\Filesystem\Util\Convert\ImageOutputOptions::getFormat

(

)

Definition at line 91 of file ImageOutputOptions.php.

References ILIAS\Filesystem\Util\Convert\ImageOutputOptions\$format.

Referenced by ILIAS\Filesystem\Util\Convert\Images\merge().

                               : string
    {
        return $this->format;
    }

Here is the caller graph for this function:

getQuality()

ILIAS\Filesystem\Util\Convert\ImageOutputOptions::getQuality

(

)

Definition at line 96 of file ImageOutputOptions.php.

References ILIAS\Filesystem\Util\Convert\ImageOutputOptions\$quality.

Referenced by ILIAS\Filesystem\Util\Convert\Images\merge().

                                : int
    {
        return $this->quality;
    }

Here is the caller graph for this function:

withFormat()

ILIAS\Filesystem\Util\Convert\ImageOutputOptions::withFormat

(

string

$format

)

set the desired output format.

Exceptions

Definition at line 45 of file ImageOutputOptions.php.

References ILIAS\Filesystem\Util\Convert\ImageOutputOptions\$format, and ILIAS\Filesystem\Util\Convert\ImageOutputOptions\checkFormat().

Referenced by ILIAS\Filesystem\Util\Convert\ImageOutputOptions\withJpgOutput(), ILIAS\Filesystem\Util\Convert\ImageOutputOptions\withPngOutput(), and ILIAS\Filesystem\Util\Convert\ImageOutputOptions\withWebPOutput().

                                              : ImageOutputOptions
    {
        $format = $this->checkFormat($format);
        $clone = clone $this;
        $clone->format = $format;
        return $clone;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

withJpgOutput()

ILIAS\Filesystem\Util\Convert\ImageOutputOptions::withJpgOutput

(

)

set the output format to JPG

Definition at line 56 of file ImageOutputOptions.php.

References ILIAS\Filesystem\Util\Convert\ImageOutputOptions\withFormat().

                                   : ImageOutputOptions
    {
        return $this->withFormat(self::FORMAT_JPG);
    }

Here is the call graph for this function:

withPngOutput()

ILIAS\Filesystem\Util\Convert\ImageOutputOptions::withPngOutput

(

)

set the output format to PNG

Definition at line 64 of file ImageOutputOptions.php.

References ILIAS\Filesystem\Util\Convert\ImageOutputOptions\withFormat().

                                   : ImageOutputOptions
    {
        return $this->withFormat(self::FORMAT_PNG);
    }

Here is the call graph for this function:

withQuality()

ILIAS\Filesystem\Util\Convert\ImageOutputOptions::withQuality

(

int

$image_quality

)

set the image compression quality.

Depending on the format, this will be ignored or other values are needed. JPG: 0-100 WEBP: 0 (loss) or 100 (lossless) PNG: 0-100 (which will be converted to 0-9 internally)

Definition at line 83 of file ImageOutputOptions.php.

References ILIAS\Filesystem\Util\Convert\ImageOutputOptions\checkImageQuality().

Referenced by ILIAS\Filesystem\Util\Convert\Images\merge().

                                                   : ImageOutputOptions
    {
        $this->checkImageQuality($image_quality);
        $clone = clone $this;
        $clone->quality = $image_quality;
        return $clone;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

withWebPOutput()

ILIAS\Filesystem\Util\Convert\ImageOutputOptions::withWebPOutput

(

)

set the output format to WEBP

Definition at line 72 of file ImageOutputOptions.php.

References ILIAS\Filesystem\Util\Convert\ImageOutputOptions\withFormat().

                                    : ImageOutputOptions
    {
        return $this->withFormat(self::FORMAT_WEBP);
    }

Here is the call graph for this function:

Field Documentation

$allowed_formats

array ILIAS\Filesystem\Util\Convert\ImageOutputOptions::$allowed_formats

private

Initial value:

= [
        self::FORMAT_JPG,
        self::FORMAT_PNG,
        self::FORMAT_WEBP,
        self::FORMAT_KEEP,
    ]

Definition at line 34 of file ImageOutputOptions.php.

$format

string ILIAS\Filesystem\Util\Convert\ImageOutputOptions::$format = self::FORMAT_JPG

private

Definition at line 33 of file ImageOutputOptions.php.

Referenced by ILIAS\Filesystem\Util\Convert\ImageOutputOptions\checkFormat(), ILIAS\Filesystem\Util\Convert\ImageOutputOptions\getFormat(), and ILIAS\Filesystem\Util\Convert\ImageOutputOptions\withFormat().

$quality

int ILIAS\Filesystem\Util\Convert\ImageOutputOptions::$quality = 75

private

Definition at line 32 of file ImageOutputOptions.php.

Referenced by ILIAS\Filesystem\Util\Convert\ImageOutputOptions\getQuality().

FORMAT_JPG

const ILIAS\Filesystem\Util\Convert\ImageOutputOptions::FORMAT_JPG = 'jpg'

Definition at line 28 of file ImageOutputOptions.php.

Referenced by ILIAS\Filesystem\Util\Convert\ImageConverter\handleBackgroundColor(), and ILIAS\Filesystem\Util\Convert\ImageConverter\handleFormatAndQuality().

FORMAT_KEEP

const ILIAS\Filesystem\Util\Convert\ImageOutputOptions::FORMAT_KEEP = 'keep'

Definition at line 31 of file ImageOutputOptions.php.

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

FORMAT_PNG

const ILIAS\Filesystem\Util\Convert\ImageOutputOptions::FORMAT_PNG = 'png'

Definition at line 29 of file ImageOutputOptions.php.

Referenced by ILIAS\MediaObjects\Thumbs\ThumbsManager\createThumb(), ILIAS\MediaObjects\MediaObjectManager\generatePreview(), ILIAS\Filesystem\Util\Convert\ImageConverter\handleBackgroundColor(), and ILIAS\Filesystem\Util\Convert\ImageConverter\handleFormatAndQuality().

FORMAT_WEBP

const ILIAS\Filesystem\Util\Convert\ImageOutputOptions::FORMAT_WEBP = 'webp'

Definition at line 30 of file ImageOutputOptions.php.

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

---

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

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