class.ilPreviewSettings.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2013 ILIAS open source, Extended GPL, see docs/LICENSE */

class ilPreviewSettings
{
    const MAX_PREVIEWS_DEFAULT = 5;
    const MAX_PREVIEWS_MIN = 1;
    const MAX_PREVIEWS_MAX = 20;
    
    const IMAGE_SIZE_DEFAULT = 280;
    const IMAGE_SIZE_MIN = 50;
    const IMAGE_SIZE_MAX = 600;
    
    const IMAGE_QUALITY_DEFAULT = 85;
    const IMAGE_QUALITY_MIN = 20;
    const IMAGE_QUALITY_MAX = 100;
    
    private static $instance = null;
    
    private $settings = null;

    private $preview_enabled = true;

    private $max_previews = self::MAX_PREVIEWS_DEFAULT;
    
    private $image_size = self::IMAGE_SIZE_DEFAULT;

    private $image_quality = self::IMAGE_QUALITY_DEFAULT;

    private function __construct()
    {
        $this->settings = new ilSetting("preview");
        $this->preview_enabled = $this->settings->get('preview_enabled', false) == true;
        $this->max_previews = $this->settings->get('max_previews_per_object', self::MAX_PREVIEWS_DEFAULT);
    }

    public static function setPreviewEnabled($a_value)
    {
        $instance = self::getInstance();
        $instance->preview_enabled = $a_value == true;
        $instance->settings->set('preview_enabled', $instance->preview_enabled);
    }
    
    public static function isPreviewEnabled()
    {
        return self::getInstance()->preview_enabled;
    }
    
    public static function setMaximumPreviews($a_value)
    {
        $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()
    {
        return self::getInstance()->max_previews;
    }
    
    public static function setImageSize($a_value)
    {
        $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()
    {
        return self::getInstance()->image_size;
    }
    
    public static function setImageQuality($a_value)
    {
        $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()
    {
        return self::getInstance()->image_quality;
    }

    private static function getInstance()
    {
        if (self::$instance == null) {
            self::$instance = new ilPreviewSettings();
        }
        
        return self::$instance;
    }
    
    private static function adjustNumeric($value, $min, $max, $default)
    {
        // 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;
    }
}