class.ilPreviewSettings.php

Go to the documentation of this file.

<?php
class ilPreviewSettings
{
    public const MAX_PREVIEWS_DEFAULT = 5;
    public const MAX_PREVIEWS_MIN = 1;
    public const MAX_PREVIEWS_MAX = 20;
 
    private const IMAGE_SIZE_DEFAULT = 280;
    private const IMAGE_SIZE_MIN = 50;
    private const IMAGE_SIZE_MAX = 600;
 
    private const IMAGE_QUALITY_DEFAULT = 85;
    private const IMAGE_QUALITY_MIN = 20;
    private const IMAGE_QUALITY_MAX = 100;
 
    private static ?\ilPreviewSettings $instance = null;
 
    private ?\ilSetting $settings = null;
 
    private bool $preview_enabled = true;
 
    private int $max_previews = self::MAX_PREVIEWS_DEFAULT;
 
    private int $image_size = self::IMAGE_SIZE_DEFAULT;
 
    private int $image_quality = self::IMAGE_QUALITY_DEFAULT;
 
    private function __construct()
    {
        $this->settings = new ilSetting("preview");
        $this->preview_enabled = (bool) $this->settings->get('preview_enabled', '0') === true;
        $this->max_previews = $this->settings->get('max_previews_per_object', self::MAX_PREVIEWS_DEFAULT);
    }
 
    public static function setPreviewEnabled(bool $a_value): void
    {
        $instance = self::getInstance();
        $instance->preview_enabled = $a_value === true;
        $instance->settings->set('preview_enabled', $instance->preview_enabled);
    }
 
    public static function isPreviewEnabled(): bool
    {
        return self::getInstance()->preview_enabled;
    }
 
    public static function setMaximumPreviews(int $a_value): void
    {
        $instance = self::getInstance();
        $instance->max_previews = self::adjustNumeric($a_value, self::MAX_PREVIEWS_MIN, self::MAX_PREVIEWS_MAX, self::MAX_PREVIEWS_DEFAULT);
        $instance->settings->set('max_previews_per_object', $instance->max_previews);
    }
 
    public static function getMaximumPreviews(): int
    {
        return self::getInstance()->max_previews;
    }
 
    public static function setImageSize(int $a_value): void
    {
        $instance = self::getInstance();
        $instance->image_size = self::adjustNumeric($a_value, self::IMAGE_SIZE_MIN, self::IMAGE_SIZE_MAX, self::IMAGE_SIZE_DEFAULT);
        $instance->settings->set('preview_image_size', $instance->image_size);
    }
 
    public static function getImageSize(): int
    {
        return self::getInstance()->image_size;
    }
 
    public static function setImageQuality(int $a_value): void
    {
        $instance = self::getInstance();
        $instance->image_quality = self::adjustNumeric($a_value, self::IMAGE_QUALITY_MIN, self::IMAGE_QUALITY_MAX, self::IMAGE_QUALITY_DEFAULT);
        $instance->settings->set('preview_image_quality', $instance->image_quality);
    }
 
    public static function getImageQuality(): int
    {
        return self::getInstance()->image_quality;
    }
 
    private static function getInstance(): \ilPreviewSettings
    {
        if (self::$instance === null) {
            self::$instance = new ilPreviewSettings();
        }
 
        return self::$instance;
    }
 
    private static function adjustNumeric($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;
    }
}