Collaboration diagram for ILIAS\MediaObjects\MediaObjectManager:

Public Member Functions
	__construct (protected InternalDataService $data, InternalRepoService $repo, protected InternalDomainService $domain, protected \ilMobStakeholder $stakeholder)

	create (int $id, string $title, int $from_mob_id=0)

	addLocalDirectory (int $mob_id, string $dir)

	addFileFromLegacyUpload (int $mob_id, string $tmp_name, string $target_path="")

	addFileFromUpload (int $mob_id, UploadResult $result, string $path="/")

	addFileFromLocal (int $mob_id, string $tmp_name, string $path)

	removeLocation (int $mob_id, string $location)

	getLocationStream (int $mob_id, string $location)

	addStream (int $mob_id, string $location, FileStream $stream)

	getLocalSrc (int $mob_id, string $location)

	hasLocalFile (int $mob_id, string $location)

	getContainerResource (int $mob_id)

	getContainerResourceId (int $mob_id)

	getFilesOfPath (int $mob_id, string $dir_path)

	getInfoOfEntry (int $mob_id, string $path)

	deliverEntry (int $mob_id, string $path)

	generatePreview (int $mob_id, string $location, bool $local, string $format, int $sec=1, string $target_location="mob_vpreview.png")

	addPreviewFromUrl (int $mob_id, string $url, string $target_location)

	getSrtFiles (int $mob_id, bool $vtt_only=false)

	generateMissingVTT (int $mob_id)

	srtToVtt (string $srt_text)

Protected Attributes
ImageOutputOptions	$output_options

Images	$image_converters

MediaObjectRepository	$repo

Detailed Description

Definition at line 33 of file MediaObjectManager.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\MediaObjects\MediaObjectManager::__construct	(	protected InternalDataService	$data,
		InternalRepoService	$repo,
		protected InternalDomainService	$domain,
		protected \ilMobStakeholder	$stakeholder
	)

Definition at line 39 of file MediaObjectManager.php.

       {
         $this->repo = $repo->mediaObject();
         $this->image_converters = new Images(true);
         $this->output_options = new ImageOutputOptions();
     }

Member Function Documentation

◆ addFileFromLegacyUpload()

ILIAS\MediaObjects\MediaObjectManager::addFileFromLegacyUpload	(	int	$mob_id,
		string	$tmp_name,
		string	$target_path = `""`
	)

Definition at line 68 of file MediaObjectManager.php.

                                                                                                     : void
     {
         $this->repo->addFileFromLegacyUpload($mob_id, $tmp_name, $target_path);
     }

◆ addFileFromLocal()

ILIAS\MediaObjects\MediaObjectManager::addFileFromLocal	(	int	$mob_id,
		string	$tmp_name,
		string	$path
	)

Definition at line 81 of file MediaObjectManager.php.

                                                                                  : void
     {
         $this->repo->addFileFromLocal($mob_id, $tmp_name, $path);
     }

◆ addFileFromUpload()

ILIAS\MediaObjects\MediaObjectManager::addFileFromUpload	(	int	$mob_id,
		UploadResult	$result,
		string	$path = `"/"`
	)

Definition at line 73 of file MediaObjectManager.php.

References $path.

      : void {
         $this->repo->addFileFromUpload($mob_id, $result, $path);
     }

◆ addLocalDirectory()

ILIAS\MediaObjects\MediaObjectManager::addLocalDirectory	(	int	$mob_id,
		string	$dir
	)

Definition at line 63 of file MediaObjectManager.php.

                                                                : void
     {
         $this->repo->addLocalDirectory($mob_id, $dir);
     }

◆ addPreviewFromUrl()

ILIAS\MediaObjects\MediaObjectManager::addPreviewFromUrl	(	int	$mob_id,
		string	$url,
		string	$target_location
	)

Definition at line 226 of file MediaObjectManager.php.

References $res.

      : void {
         $str = file_get_contents($url);
         $res = fopen('php://memory', 'r+');
         fwrite($res, $str);
         rewind($res);
         $stream = new Stream($res);
         $this->repo->addStream(
             $mob_id,
             $target_location,
             $stream
         );
     }

◆ addStream()

ILIAS\MediaObjects\MediaObjectManager::addStream	(	int	$mob_id,
		string	$location,
		FileStream	$stream
	)

Definition at line 100 of file MediaObjectManager.php.

      : void {
         $this->repo->addStream($mob_id, $location, $stream);
     }

◆ create()

ILIAS\MediaObjects\MediaObjectManager::create	(	int	$id,
		string	$title,
		int	$from_mob_id = `0`
	)

Definition at line 50 of file MediaObjectManager.php.

      : void {
         $this->repo->create(
             $id,
             $title,
             $this->stakeholder,
             $from_mob_id
         );
     }

◆ deliverEntry()

ILIAS\MediaObjects\MediaObjectManager::deliverEntry	(	int	$mob_id,
		string	$path
	)

Definition at line 158 of file MediaObjectManager.php.

      : void {
         $this->repo->deliverEntry($mob_id, $path);
     }

◆ generateMissingVTT()

ILIAS\MediaObjects\MediaObjectManager::generateMissingVTT ( int $mob_id )

Definition at line 263 of file MediaObjectManager.php.

References ILIAS\MediaObjects\MediaObjectManager\getSrtFiles(), and ILIAS\MediaObjects\MediaObjectManager\srtToVtt().

                                                    : void
     {
         $names = array_map(static function (array $i) {
             return $i["file"];
         }, $this->getSrtFiles($mob_id));
         $missing_vtt = [];
         foreach ($names as $name) {
             if (str_ends_with($name, ".srt")) {
                 $vtt = str_replace(".srt", ".vtt", $name);
                 if (!in_array($vtt, $names) && !in_array($vtt, $missing_vtt)) {
                     $missing_vtt[] = $vtt;
                 }
             }
         }
         foreach ($missing_vtt as $vtt_name) {
             $srt_name = str_replace(".vtt", ".srt", $vtt_name);
             $srt_content = stream_get_contents($this->repo->getLocationStream($mob_id, "srt/" . $srt_name)->detach());
             $vtt_content = $this->srtToVtt($srt_content);
             $this->repo->addString($mob_id, "/srt/" . $vtt_name, $vtt_content);
         }
     }

Here is the call graph for this function:

◆ generatePreview()

ILIAS\MediaObjects\MediaObjectManager::generatePreview	(	int	$mob_id,
		string	$location,
		bool	$local,
		string	$format,
		int	$sec = `1`,
		string	$target_location = `"mob_vpreview.png"`
	)

Definition at line 166 of file MediaObjectManager.php.

References ilObjMediaObject\DEFAULT_PREVIEW_SIZE, ilFFmpeg\extractPNGFromVideoInZip(), and ILIAS\Filesystem\Util\Convert\ImageOutputOptions\FORMAT_PNG.

      : void {
 
         $is_image = is_int(strpos($format, "image/"));
         $is_video = in_array($format, ["video/mp4", "video/webm"]);
 
         if ($local) {
             if ($is_image) {
                 $width = $height = \ilObjMediaObject::DEFAULT_PREVIEW_SIZE;
                 $image_quality = 60;
 
                 // the zip stream is not seekable, which is needed by Imagick
                 // so we create a seekable stream first
                 $tempStream = fopen('php://temp', 'w+');
                 stream_copy_to_stream($this->repo->getLocationStream($mob_id, $location)->detach(), $tempStream);
                 rewind($tempStream);
                 $stream = new Stream($tempStream);
 
                 $converter = $this->image_converters->resizeToFixedSize(
                     $stream,
                     $width,
                     $height,
                     true,
                     $this->output_options
                         ->withQuality($image_quality)
                         ->withFormat(ImageOutputOptions::FORMAT_PNG)
                 );
                 $this->repo->addStream(
                     $mob_id,
                     $target_location,
                     $converter->getStream()
                 );
                 fclose($tempStream);
             }
             if ($is_video) {
                 $zip_uri = $this->repo->getContainerPath($mob_id);
                 $image_str = \ilFFmpeg::extractPNGFromVideoInZip(
                     $zip_uri,
                     $location,
                     $sec
                 );
                 $png_res = fopen('php://memory', 'r+');
                 fwrite($png_res, $image_str);
                 rewind($png_res);
                 $png_stream = new Stream($png_res);
                 $this->repo->addStream(
                     $mob_id,
                     $target_location,
                     $png_stream
                 );
             }
         }
     }

Here is the call graph for this function:

◆ getContainerResource()

ILIAS\MediaObjects\MediaObjectManager::getContainerResource ( int $mob_id )

Definition at line 129 of file MediaObjectManager.php.

      : ?StorableResource {
         return $this->repo->getContainerResource($mob_id);
     }

◆ getContainerResourceId()

ILIAS\MediaObjects\MediaObjectManager::getContainerResourceId ( int $mob_id )

Definition at line 135 of file MediaObjectManager.php.

      : ?ResourceIdentification {
         return $this->repo->getContainerResourceId($mob_id);
     }

◆ getFilesOfPath()

ILIAS\MediaObjects\MediaObjectManager::getFilesOfPath	(	int	$mob_id,
		string	$dir_path
	)

Definition at line 141 of file MediaObjectManager.php.

Referenced by ILIAS\MediaObjects\MediaObjectManager\getSrtFiles().

      : array {
         return $this->repo->getFilesOfPath($mob_id, $dir_path);
     }

Here is the caller graph for this function:

◆ getInfoOfEntry()

ILIAS\MediaObjects\MediaObjectManager::getInfoOfEntry	(	int	$mob_id,
		string	$path
	)

Definition at line 148 of file MediaObjectManager.php.

      : array {
         return $this->repo->getInfoOfEntry(
             $mob_id,
             $path
         );
     }

◆ getLocalSrc()

ILIAS\MediaObjects\MediaObjectManager::getLocalSrc	(	int	$mob_id,
		string	$location
	)

Definition at line 108 of file MediaObjectManager.php.

References Vendor\Package\$e, $location, ilObjMediaObject\_getURL(), and ilWACSignedPath\signFile().

Referenced by ILIAS\MediaObjects\MediaObjectManager\getSrtFiles().

                                                               : string
     {
         $src = $this->repo->getLocalSrc(
             $mob_id,
             $location
         );
         if ($src === "") {  // fallback: old source
             $path_to_file = \ilObjMediaObject::_getURL($mob_id) . "/" . $location;
             try {
                 $src = \ilWACSignedPath::signFile($path_to_file);
             } catch (Exception $e) {
             }
         }
         return $src;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLocationStream()

ILIAS\MediaObjects\MediaObjectManager::getLocationStream	(	int	$mob_id,
		string	$location
	)

Definition at line 93 of file MediaObjectManager.php.

      : ZIPStream {
         return $this->repo->getLocationStream($mob_id, $location);
     }

◆ getSrtFiles()

ILIAS\MediaObjects\MediaObjectManager::getSrtFiles	(	int	$mob_id,
		bool	$vtt_only = `false`
	)

Definition at line 243 of file MediaObjectManager.php.

References ILIAS\MediaObjects\MediaObjectManager\getFilesOfPath(), and ILIAS\MediaObjects\MediaObjectManager\getLocalSrc().

Referenced by ILIAS\MediaObjects\MediaObjectManager\generateMissingVTT().

                                                                     : array
     {
         $srt_files = [];
         $valid_suffixes = $vtt_only
             ? ["vtt"]
             : ["srt", "vtt"];
         foreach ($this->getFilesOfPath($mob_id, "/srt") as $i) {
             $name = explode(".", $i["basename"]);
             if (in_array($name[1], $valid_suffixes) && substr($name[0], 0, 9) == "subtitle_") {
                 $srt_files[] = [
                     "file" => $i["basename"],
                     "full_path" => $i["path"],
                     "src" => $this->getLocalSrc($mob_id, $i["path"]),
                     "language" => substr($name[0], 9, 2)
                 ];
             }
         }
         return $srt_files;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasLocalFile()

ILIAS\MediaObjects\MediaObjectManager::hasLocalFile	(	int	$mob_id,
		string	$location
	)

Definition at line 124 of file MediaObjectManager.php.

                                                                : bool
     {
         return $this->repo->hasLocalFile($mob_id, $location);
     }

◆ removeLocation()

ILIAS\MediaObjects\MediaObjectManager::removeLocation	(	int	$mob_id,
		string	$location
	)

Definition at line 86 of file MediaObjectManager.php.

      : void {
         $this->repo->removeLocation($mob_id, $location);
     }

◆ srtToVtt()

ILIAS\MediaObjects\MediaObjectManager::srtToVtt ( string $srt_text )

Definition at line 285 of file MediaObjectManager.php.

Referenced by ILIAS\MediaObjects\MediaObjectManager\generateMissingVTT().

                                               : string
     {
         // Remove UTF-8 BOM if present
         $srt_text = preg_replace('/^\xEF\xBB\xBF/', '', $srt_text);
 
         // Normalise line-endings and split cues
         $srt_text = preg_replace('~\r\n?~', "\n", $srt_text);
         $blocks = preg_split("/\n{2,}/", trim($srt_text));
 
         $vttLines = ['WEBVTT', ''];          // header + blank line
 
         foreach ($blocks as $block) {
             $lines = explode("\n", $block);
 
             if (count($lines) < 2) {
                 continue;                    // malformed cue
             }
 
             /* cue number? allow BOM or spaces either side */
             if (preg_match('/^\s*\d+\s*$/u', $lines[0])) {
                 array_shift($lines);         // drop it
             }
 
             /* now $lines[0] *is* the time-code line → , → . */
             $lines[0] = preg_replace(
                 '/(\d{2}:\d{2}:\d{2}),(\d{3})/',
                 '$1.$2',
                 $lines[0]
             );
 
             $vttLines = array_merge($vttLines, $lines, ['']);
         }
 
         return implode("\n", $vttLines);
     }

Here is the caller graph for this function:

Field Documentation

◆ $image_converters

Images ILIAS\MediaObjects\MediaObjectManager::$image_converters

protected

Definition at line 36 of file MediaObjectManager.php.

◆ $output_options

ImageOutputOptions ILIAS\MediaObjects\MediaObjectManager::$output_options

protected

Definition at line 35 of file MediaObjectManager.php.

◆ $repo

MediaObjectRepository ILIAS\MediaObjects\MediaObjectManager::$repo

protected

Definition at line 37 of file MediaObjectManager.php.

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

components/ILIAS/MediaObjects/MediaObject/MediaObjectManager.php

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addFileFromLegacyUpload()

◆ addFileFromLocal()

◆ addFileFromUpload()

◆ addLocalDirectory()

◆ addPreviewFromUrl()

◆ addStream()

◆ create()

◆ deliverEntry()

◆ generateMissingVTT()

◆ generatePreview()

◆ getContainerResource()

◆ getContainerResourceId()

◆ getFilesOfPath()

◆ getInfoOfEntry()

◆ getLocalSrc()

◆ getLocationStream()

◆ getSrtFiles()

◆ hasLocalFile()

◆ removeLocation()

◆ srtToVtt()

Field Documentation

◆ $image_converters

◆ $output_options

◆ $repo