Collaboration diagram for ilPreviewSettings:

Static Public Member Functions
static	setPreviewEnabled (bool $a_value)
	Sets whether the preview functionality is enabled. More...

static	isPreviewEnabled ()
	Gets whether the preview functionality is enabled. More...

static	setMaximumPreviews (int $a_value)
	Sets the maximum number of preview pictures per object. More...

static	getMaximumPreviews ()
	Gets the maximum number of preview pictures per object. More...

static	setImageSize (int $a_value)
	Sets the size of the preview images in pixels. More...

static	getImageSize ()
	Gets the size of the preview images in pixels. More...

static	setImageQuality (int $a_value)
	Sets the quality (compression) of the preview images (1-100). More...

static	getImageQuality ()
	Gets the quality (compression) of the preview images (1-100). More...

Data Fields
const	MAX_PREVIEWS_DEFAULT = 5

const	MAX_PREVIEWS_MIN = 1

const	MAX_PREVIEWS_MAX = 20

Private Member Functions
	__construct ()
	Private constructor. More...

Static Private Member Functions
static	getInstance ()
	Gets the instance of the ilPreviewSettings. More...

static	adjustNumeric ($value, int $min, int $max, int $default)

Private Attributes
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

ilSetting	$settings = null
	Settings object. More...

bool	$preview_enabled = true
	Indicates whether the preview functionality is enabled. More...

int	$max_previews = self::MAX_PREVIEWS_DEFAULT
	Defines the maximum number of previews pictures per object. More...

int	$image_size = self::IMAGE_SIZE_DEFAULT
	Defines the maximum width and height of the preview images. More...

int	$image_quality = self::IMAGE_QUALITY_DEFAULT
	Defines the quality (compression) of the preview images (1-100). More...

Static Private Attributes
static ilPreviewSettings	$instance = null
	The instance of the ilPreviewSettings. More...

Detailed Description

Definition at line 27 of file class.ilPreviewSettings.php.

Constructor & Destructor Documentation

◆ __construct()

ilPreviewSettings::__construct ( )

private

Private constructor.

Definition at line 74 of file class.ilPreviewSettings.php.

References ILIAS\Repository\settings().

     {
         $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);
     }

Here is the call graph for this function:

Member Function Documentation

◆ adjustNumeric()

static ilPreviewSettings::adjustNumeric	(		$value,
		int	$min,
		int	$max,
		int	$default
	)

staticprivate

Definition at line 181 of file class.ilPreviewSettings.php.

References ILIAS\Repository\int().

                                                                                    : 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;
     }

Here is the call graph for this function:

◆ getImageQuality()

static ilPreviewSettings::getImageQuality ( )

static

Gets the quality (compression) of the preview images (1-100).

Returns: int The current value

Definition at line 164 of file class.ilPreviewSettings.php.

Referenced by ilPreviewRenderer\getImageQuality().

                                             : int
     {
         return self::getInstance()->image_quality;
     }

Here is the caller graph for this function:

◆ getImageSize()

static ilPreviewSettings::getImageSize ( )

static

Gets the size of the preview images in pixels.

Returns: int The current value

Definition at line 142 of file class.ilPreviewSettings.php.

Referenced by ilPreviewRenderer\getImageSize(), and ilPreviewGUI\initPreview().

                                          : int
     {
         return self::getInstance()->image_size;
     }

Here is the caller graph for this function:

◆ getInstance()

static ilPreviewSettings::getInstance ( )

staticprivate

Gets the instance of the ilPreviewSettings.

Definition at line 172 of file class.ilPreviewSettings.php.

                                          : \ilPreviewSettings
     {
         if (self::$instance === null) {
             self::$instance = new ilPreviewSettings();
         }
 
         return self::$instance;
     }

◆ getMaximumPreviews()

static ilPreviewSettings::getMaximumPreviews ( )

static

Gets the maximum number of preview pictures per object.

Returns: int The current value

Definition at line 120 of file class.ilPreviewSettings.php.

Referenced by ilPreviewRenderer\getMaximumNumberOfPreviews(), and ilObjFileAccessSettingsGUI\initSettingsForm().

                                                : int
     {
         return self::getInstance()->max_previews;
     }

Here is the caller graph for this function:

◆ isPreviewEnabled()

static ilPreviewSettings::isPreviewEnabled ( )

static

Gets whether the preview functionality is enabled.

Returns: bool The current value

Definition at line 98 of file class.ilPreviewSettings.php.

Referenced by ilPreview\copyPreviews(), ilPreview\create(), ilPreview\hasPreview(), and ilObjFileAccessSettingsGUI\initSettingsForm().

                                              : bool
     {
         return self::getInstance()->preview_enabled;
     }

Here is the caller graph for this function:

◆ setImageQuality()

static ilPreviewSettings::setImageQuality ( int $a_value )

static

Sets the quality (compression) of the preview images (1-100).

Parameters

int $a_value The new value

Definition at line 152 of file class.ilPreviewSettings.php.

                                                         : 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);
     }

◆ setImageSize()

static ilPreviewSettings::setImageSize ( int $a_value )

static

Sets the size of the preview images in pixels.

Parameters

int $a_value The new value

Definition at line 130 of file class.ilPreviewSettings.php.

                                                      : 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);
     }

◆ setMaximumPreviews()

static ilPreviewSettings::setMaximumPreviews ( int $a_value )

static

Sets the maximum number of preview pictures per object.

Parameters

int $a_value The new value

Definition at line 108 of file class.ilPreviewSettings.php.

Referenced by ilObjFileAccessSettingsGUI\saveSettings().

                                                            : 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);
     }

Here is the caller graph for this function:

◆ setPreviewEnabled()

static ilPreviewSettings::setPreviewEnabled ( bool $a_value )

static

Sets whether the preview functionality is enabled.

Parameters

bool $a_value The new value

Definition at line 86 of file class.ilPreviewSettings.php.

Referenced by ilObjFileAccessSettingsGUI\saveSettings().

                                                            : void
     {
         $instance = self::getInstance();
         $instance->preview_enabled = $a_value === true;
         $instance->settings->set('preview_enabled', $instance->preview_enabled);
     }