Settings.php

Go to the documentation of this file.

<?php

namespace ILIAS\Modules\File\Preview;

use ILIAS\Administration\Setting;
use ILIAS\ResourceStorage\Flavour\Engine\ImagickEngine;
use ilSetting;

class Settings extends ilSetting implements Setting
{
    public const V_MAX_PREVIEWS_DEFAULT = 5;
    public const V_MAX_PREVIEWS_MIN = 1;
    public const V_MAX_PREVIEWS_MAX = 100;

    public const V_IMAGE_SIZE_DEFAULT = 868;
    public const V_IMAGE_SIZE_MIN = 50;
    public const V_IMAGE_SIZE_MAX = 1000;

    private const V_IMAGE_QUALITY_DEFAULT = 85;
    private const V_IMAGE_QUALITY_MIN = 1;
    private const V_IMAGE_QUALITY_MAX = 100;

    public const MODULE_NAME = 'preview';

    private const F_PREVIEW_ENABLED = 'preview_enabled';
    private const F_MAX_PREVIEWS_PER_OBJECT = 'max_previews_per_object';
    private const F_PREVIEW_IMAGE_SIZE = 'preview_image_size';
    private const F_PREVIEW_PERSISTING = 'preview_persisting';
    private const F_PREVIEW_IMAGE_QUALITY = 'preview_image_quality';
    private const F_TILE_PREVIEWS = 'tile_previews';
    private ImagickEngine $imagick;

    public function __construct()
    {
        parent::__construct(self::MODULE_NAME, false);
        $this->imagick = new ImagickEngine();
    }

    public function setPersisting(bool $a_value): void
    {
        $this->set(self::F_PREVIEW_PERSISTING, $this->boolToStr($a_value));
    }

    public function isPersisting(): bool
    {
        return $this->strToBool($this->get(self::F_PREVIEW_PERSISTING, '1'));
    }

    public function setTilePreviews(bool $a_value): void
    {
        $this->set(self::F_TILE_PREVIEWS, $this->boolToStr($a_value));
    }

    public function hasTilePreviews(): bool
    {
        return $this->strToBool($this->get(self::F_TILE_PREVIEWS, '1'));
    }

    public function isPreviewPossible(): bool
    {
        return $this->imagick->isRunning(); // &&(new GDEngine())->isRunning();
    }

    public function setPreviewEnabled(bool $a_value): void
    {
        $this->set(self::F_PREVIEW_ENABLED, $this->boolToStr($a_value));
    }

    public function isPreviewEnabled(): bool
    {
        if (!$this->isPreviewPossible()) {
            return false;
        }
        return $this->strToBool($this->get(self::F_PREVIEW_ENABLED, '1'));
    }

    public function setMaximumPreviews(int $max_previews): void
    {
        $max_previews = $this->adjustNumeric(
            $max_previews,
            self::V_MAX_PREVIEWS_MIN,
            self::V_MAX_PREVIEWS_MAX,
            self::V_MAX_PREVIEWS_DEFAULT
        );
        $this->set(self::F_MAX_PREVIEWS_PER_OBJECT, $this->intToStr($max_previews));
    }

    public function getMaximumPreviews(): int
    {
        return $this->strToInt($this->get(self::F_MAX_PREVIEWS_PER_OBJECT, (string) self::V_MAX_PREVIEWS_DEFAULT));
    }

    public function setImageSize(int $image_size): void
    {
        $image_size = $this->adjustNumeric(
            $image_size,
            self::V_IMAGE_SIZE_MIN,
            self::V_IMAGE_SIZE_MAX,
            self::V_IMAGE_SIZE_DEFAULT
        );
        $this->set(self::F_PREVIEW_IMAGE_SIZE, $this->intToStr($image_size));
    }

    public function getImageSize(): int
    {
        return $this->strToInt($this->get(self::F_PREVIEW_IMAGE_SIZE, (string) self::V_IMAGE_SIZE_DEFAULT));
    }

    public function setImageQuality(int $quality): void
    {
        $quality = $this->adjustNumeric(
            $quality,
            self::V_IMAGE_QUALITY_MIN,
            self::V_IMAGE_QUALITY_MAX,
            self::V_IMAGE_QUALITY_DEFAULT
        );
        $this->set(self::F_PREVIEW_IMAGE_QUALITY, $this->intToStr($quality));
    }

    public function getImageQuality(): int
    {
        return $this->strToInt($this->get(self::F_PREVIEW_IMAGE_QUALITY, (string) self::V_IMAGE_QUALITY_DEFAULT));
    }

    private function adjustNumeric(int $value, int $min, int $max, int $default): int
    {
        // is number?
        if (is_numeric($value)) {
            // don't allow to large numbers
            $value = (int) $value;
            if ($value < $min) {
                $value = $min;
            } elseif ($value > $max) {
                $value = $max;
            }
        } else {
            $value = $default;
        }

        return $value;
    }

    // HELPERS

    private function strToBool(string $value): bool
    {
        return $value === '1';
    }

    private function boolToStr(bool $value): string
    {
        return $value ? '1' : '0';
    }

    private function intToStr(int $int): string
    {
        return (string) $int;
    }

    private function strToInt(string $str): int
    {
        return (int) $str;
    }
}