Stores all mediacast relevant settings. More...

Collaboration diagram for ilMediaCastSettings:

Public Member Functions
	setPurposeSuffixes (array $purpose_filetypes)

	getPurposeSuffixes ()

	getDefaultAccess ()

	setDefaultAccess (string $value)

	getMimeTypes ()

	setMimeTypes (array $mimeTypes)

	setVideoCompletionThreshold (int $a_val)

	getVideoCompletionThreshold ()

	save ()

Static Public Member Functions
static	_getInstance ()

Data Fields
array video	webm

Protected Attributes
ilSetting	$storage

int	$video_threshold = 0

Private Member Functions
	__construct ()

	read ()

	initStorage ()

Private Attributes
array	$supported_suffixes = ["mp4", "mp3", "webm", "jpg", "jpeg", "png", "gif", "svg"]

array	$supported_mime_types

string	$defaultAccess = "users"

array	$purposeSuffixes = array()

array	$mimeTypes = array()

Static Private Attributes
static self	$instance = null

Detailed Description

Stores all mediacast relevant settings.

Author: Roland Küstermann rkues.nosp@m.term.nosp@m.ann@m.nosp@m.ps.d.nosp@m.e

Definition at line 25 of file class.ilMediaCastSettings.php.

Constructor & Destructor Documentation

◆ __construct()

ilMediaCastSettings::__construct ( )

private

Definition at line 46 of file class.ilMediaCastSettings.php.

References initStorage(), and read().

     {
         $this->initStorage();
         $this->read();
     }

Here is the call graph for this function:

Member Function Documentation

◆ _getInstance()

static ilMediaCastSettings::_getInstance ( )

static

Definition at line 52 of file class.ilMediaCastSettings.php.

Referenced by ilObjMediaCastSettingsGUI\__construct(), ilObjMediaCastGUI\__construct(), ilMediaObjectsPlayerWrapperGUI\audio(), ilObjMediaCastSettingsGUI\initMediaCastSettings(), ILIAS\MediaCast\Presentation\VideoViewGUI\renderSideColumn(), and ILIAS\MediaCast\Presentation\VideoViewGUI\renderToolbar().

                                          : self
     {
         if (self::$instance) {
             return self::$instance;
         }
         return self::$instance = new ilMediaCastSettings();
     }

Here is the caller graph for this function:

◆ getDefaultAccess()

ilMediaCastSettings::getDefaultAccess ( )

Definition at line 70 of file class.ilMediaCastSettings.php.

References $defaultAccess.

                                       : string
     {
         return $this->defaultAccess;
     }

◆ getMimeTypes()

ilMediaCastSettings::getMimeTypes ( )

Definition at line 80 of file class.ilMediaCastSettings.php.

References $mimeTypes.

Referenced by save().

                                   : array
     {
         return $this->mimeTypes;
     }

Here is the caller graph for this function:

◆ getPurposeSuffixes()

ilMediaCastSettings::getPurposeSuffixes ( )

Definition at line 65 of file class.ilMediaCastSettings.php.

References $purposeSuffixes.

                                         : array
     {
         return $this->purposeSuffixes;
     }

◆ getVideoCompletionThreshold()

ilMediaCastSettings::getVideoCompletionThreshold ( )

Definition at line 95 of file class.ilMediaCastSettings.php.

References $video_threshold.

                                                  : int
     {
         return $this->video_threshold;
     }

◆ initStorage()

ilMediaCastSettings::initStorage ( )

private

Definition at line 133 of file class.ilMediaCastSettings.php.

References ilObjMediaCast\$purposes, $supported_suffixes, setDefaultAccess(), and setMimeTypes().

Referenced by __construct().

                                   : void
     {
         $this->storage = new ilSetting('mcst');
         $this->purposeSuffixes = array_flip(ilObjMediaCast::$purposes);
 
         $this->purposeSuffixes["Standard"] = $this->supported_suffixes;
         $this->setDefaultAccess("users");
         $mimeTypes = array_unique(array_values(MimeType::getExt2MimeMap()));
         sort($mimeTypes);
         $this->setMimeTypes($this->supported_mime_types);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ read()

ilMediaCastSettings::read ( )

private

Definition at line 110 of file class.ilMediaCastSettings.php.

References Vendor\Package\$c, setDefaultAccess(), setMimeTypes(), and setVideoCompletionThreshold().

Referenced by __construct().

                            : void
     {
         foreach ($this->purposeSuffixes as $purpose => $filetypes) {
             if ($this->storage->get($purpose . "_types") != false) {
                 $sf = explode(",", $this->storage->get($purpose . "_types"));
                 $sf = array_filter($sf, function ($c) {
                     return in_array($c, $this->supported_suffixes);
                 });
                 $this->purposeSuffixes[$purpose] = $sf;
             }
         }
         $this->setDefaultAccess((string) $this->storage->get("defaultaccess"));
         $this->setVideoCompletionThreshold((int) $this->storage->get("video_threshold"));
         if ($this->storage->get("mimetypes")) {
             $mt = explode(",", $this->storage->get("mimetypes"));
             $mt = array_filter($mt, function ($c) {
                 return in_array($c, $this->supported_mime_types);
             });
 
             $this->setMimeTypes($mt);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ save()

ilMediaCastSettings::save ( )

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

References getMimeTypes().

                           : void
     {
         foreach ($this->purposeSuffixes as $purpose => $filetypes) {
             $this->storage->set($purpose . "_types", implode(",", $filetypes));
         }
         $this->storage->set("defaultaccess", $this->defaultAccess);
         $this->storage->set("video_threshold", $this->video_threshold);
         $this->storage->set("mimetypes", implode(",", $this->getMimeTypes()));
     }

Here is the call graph for this function:

◆ setDefaultAccess()

ilMediaCastSettings::setDefaultAccess ( string $value )

Definition at line 75 of file class.ilMediaCastSettings.php.

Referenced by initStorage(), and read().

                                                    : void
     {
         $this->defaultAccess = $value === "users" ? "users" : "public";
     }

Here is the caller graph for this function:

◆ setMimeTypes()

ilMediaCastSettings::setMimeTypes ( array $mimeTypes )

Definition at line 85 of file class.ilMediaCastSettings.php.

References $mimeTypes.

Referenced by initStorage(), and read().

                                                   : void
     {
         $this->mimeTypes = $mimeTypes;
     }

Here is the caller graph for this function:

◆ setPurposeSuffixes()

ilMediaCastSettings::setPurposeSuffixes ( array $purpose_filetypes )

Definition at line 60 of file class.ilMediaCastSettings.php.

                                                                 : void
     {
         $this->purposeSuffixes = $purpose_filetypes;
     }

◆ setVideoCompletionThreshold()

ilMediaCastSettings::setVideoCompletionThreshold ( int $a_val )

Definition at line 90 of file class.ilMediaCastSettings.php.

Referenced by read().

                                                            : void
     {
         $this->video_threshold = $a_val;
     }

Here is the caller graph for this function:

Field Documentation

◆ $defaultAccess

string ilMediaCastSettings::$defaultAccess = "users"

private

Definition at line 40 of file class.ilMediaCastSettings.php.

Referenced by getDefaultAccess().

◆ $instance

self ilMediaCastSettings::$instance = null

staticprivate

Definition at line 39 of file class.ilMediaCastSettings.php.

◆ $mimeTypes

array ilMediaCastSettings::$mimeTypes = array()

private

Definition at line 42 of file class.ilMediaCastSettings.php.

Referenced by getMimeTypes(), and setMimeTypes().

◆ $purposeSuffixes

array ilMediaCastSettings::$purposeSuffixes = array()

private

Definition at line 41 of file class.ilMediaCastSettings.php.

Referenced by getPurposeSuffixes().

◆ $storage

ilSetting ilMediaCastSettings::$storage

protected

Definition at line 43 of file class.ilMediaCastSettings.php.

◆ $supported_mime_types

array ilMediaCastSettings::$supported_mime_types

private

Initial value:

= [

"video/mp4" => "video/mp4"

Definition at line 28 of file class.ilMediaCastSettings.php.

◆ $supported_suffixes

array ilMediaCastSettings::$supported_suffixes = ["mp4", "mp3", "webm", "jpg", "jpeg", "png", "gif", "svg"]

private

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

Referenced by initStorage().

◆ $video_threshold

int ilMediaCastSettings::$video_threshold = 0

protected

Definition at line 44 of file class.ilMediaCastSettings.php.

Referenced by getVideoCompletionThreshold().

◆ webm

array video ilMediaCastSettings::webm

Initial value:

=> "video/webm",
        "audio/mpeg" => "audio/mpeg",
        "image/jpeg" => "image/jpeg",
        "image/png" => "image/png",
        "image/gif" => "image/gif",
        "image/svg+xml" => "image/svg+xml"
    ]

Definition at line 30 of file class.ilMediaCastSettings.php.

The documentation for this class was generated from the following file:

Modules/MediaCast/classes/class.ilMediaCastSettings.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _getInstance()

◆ getDefaultAccess()

◆ getMimeTypes()

◆ getPurposeSuffixes()

◆ getVideoCompletionThreshold()

◆ initStorage()

◆ read()

◆ save()

◆ setDefaultAccess()

◆ setMimeTypes()

◆ setPurposeSuffixes()

◆ setVideoCompletionThreshold()

Field Documentation

◆ $defaultAccess

◆ $instance

◆ $mimeTypes

◆ $purposeSuffixes

◆ $storage

◆ $supported_mime_types

◆ $supported_suffixes

◆ $video_threshold

◆ webm