Collaboration diagram for ilPreviewSettings:

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

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

static	setMaximumPreviews ($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 ($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 ($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

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 Member Functions
	__construct ()
	Private constructor. More...

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

static	adjustNumeric ($value, $min, $max, $default)
	Adjusts the numeric value to fit between the specified minimum and maximum. More...

Private Attributes
	$settings = null

	$preview_enabled = true

	$max_previews = self::MAX_PREVIEWS_DEFAULT

	$image_size = self::IMAGE_SIZE_DEFAULT

	$image_quality = self::IMAGE_QUALITY_DEFAULT

Static Private Attributes
static	$instance = null

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilPreviewSettings::__construct ( )

private

Private constructor.

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

References settings().

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

Here is the call graph for this function:

Member Function Documentation

◆ adjustNumeric()

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

staticprivate

Adjusts the numeric value to fit between the specified minimum and maximum.

If the value is not numeric the default value is returned.

Parameters

object	$value	The value to adjust.
int	$min	The allowed minimum (inclusive).
int	$max	The allowed maximum (inclusive).
int	$default	The default value if the specified value is not numeric.

Returns: The adjusted value.

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

References $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;
     }

◆ getImageQuality()

static ilPreviewSettings::getImageQuality ( )

static

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

Returns: int The current value

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

Referenced by ilPreviewRenderer\getImageQuality().

     {
         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 134 of file class.ilPreviewSettings.php.

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

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

Here is the caller graph for this function:

◆ getInstance()

static ilPreviewSettings::getInstance ( )

staticprivate

Gets the instance of the ilPreviewSettings.

Returns: ilPreviewSettings

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

     {
         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 112 of file class.ilPreviewSettings.php.

Referenced by ilObjFileAccessSettingsGUI\editPreviewSettings(), ilPreviewRenderer\getMaximumNumberOfPreviews(), and ilObjFileAccessSettingsGUI\initPreviewSettingsForm().

     {
         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 90 of file class.ilPreviewSettings.php.

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

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

Here is the caller graph for this function:

◆ setImageQuality()

static ilPreviewSettings::setImageQuality ( $a_value )

static

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

Parameters

int $a_value The new value

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

References $instance.

     {
         $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 ( $a_value )

static

Sets the size of the preview images in pixels.

Parameters

int $a_value The new value

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

References $instance.

     {
         $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 ( $a_value )

static

Sets the maximum number of preview pictures per object.

Parameters

int $a_value The new value

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

References $instance.

Referenced by ilObjFileAccessSettingsGUI\savePreviewSettings().

     {
         $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 ( $a_value )

static

Sets whether the preview functionality is enabled.

Parameters

bool $a_value The new value

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

References $instance.

Referenced by ilObjFileAccessSettingsGUI\savePreviewSettings().

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