ILIAS\MediaObjects\Thumbs\ThumbsManager Class Reference

Collaboration diagram for ILIAS\MediaObjects\Thumbs\ThumbsManager:

Public Member Functions
	__construct (protected InternalDataService $data, InternalRepoService $repo, protected InternalDomainService $domain)
	getThumbSrc (int $mob_id)
	For use in browser src of images. More...
	createPreview (int $mob_id, string $location, bool $local, string $format, int $sec=1, string $target_location="mob_vpreview.png")
	getPreviewSrc (int $mob_id)
	For use in browser src of images. More...

Protected Member Functions
	getThumbPath ()
	createThumb (int $mob_id, string $location, string $format, string $target_location,)
	resizeToFixedSize (Stream $stream, int $width, int $height, bool $crop_if_true_and_resize_if_false, ImageOutputOptions $output_options)

Protected Attributes
ILIAS MediaObjects MediaObjectRepository	$repo
ILIAS MediaObjects MediaObjectManager	$media_manager
ImageOutputOptions	$output_options
Images	$image_converters

Detailed Description

Definition at line 33 of file ThumbsManager.php.

Constructor & Destructor Documentation

__construct()

ILIAS\MediaObjects\Thumbs\ThumbsManager::__construct	(	protected InternalDataService	$data,
		InternalRepoService	$repo,
		protected InternalDomainService	$domain
	)

Definition at line 40 of file ThumbsManager.php.

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

References ILIAS\MediaObjects\Thumbs\ThumbsManager\$repo.

Member Function Documentation

createPreview()

ILIAS\MediaObjects\Thumbs\ThumbsManager::createPreview	(	int	$mob_id,
		string	$location,
		bool	$local,
		string	$format,
		int	$sec = 1,
		string	$target_location = "mob_vpreview.png"
	)

Definition at line 143 of file ThumbsManager.php.

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

createThumb()

ILIAS\MediaObjects\Thumbs\ThumbsManager::createThumb ( int  $mob_id, string  $location, string  $format, string  $target_location  )

protected

Definition at line 104 of file ThumbsManager.php.

     : void {
        $is_image = is_int(strpos($format, "image/"));
        if ($is_image) {
            if (!$this->media_manager->hasLocalFile($mob_id, $location)) {
                return;
            }
            $width = $height = \ilObjMediaObject::DEFAULT_THUMB_SIZE;
            $image_quality = 90;
 
            // 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->media_manager->getLocationStream($mob_id, $location)->detach(), $tempStream);
            rewind($tempStream);
            $stream = new Stream($tempStream);
 
            $converter = $this->resizeToFixedSize(
                $stream,
                $width,
                $height,
                true,
                $this->output_options
                    ->withQuality($image_quality)
                    ->withFormat(ImageOutputOptions::FORMAT_PNG)
            );
            $this->media_manager->addStream(
                $mob_id,
                $target_location,
                $converter->getStream()
            );
            fclose($tempStream);
        }
    }

References $location, ilObjMediaObject\DEFAULT_THUMB_SIZE, ILIAS\Filesystem\Util\Convert\ImageOutputOptions\FORMAT_PNG, and ILIAS\MediaObjects\Thumbs\ThumbsManager\resizeToFixedSize().

Referenced by ILIAS\MediaObjects\Thumbs\ThumbsManager\getThumbSrc().

Here is the call graph for this function:

Here is the caller graph for this function:

getPreviewSrc()

ILIAS\MediaObjects\Thumbs\ThumbsManager::getPreviewSrc

(

int

$mob_id

)

For use in browser src of images.

Definition at line 231 of file ThumbsManager.php.

                                              : string
    {
        $ppics = array(
            "mob_vpreview.png",
            "mob_vpreview.jpg",
            "mob_vpreview.jpeg");
        foreach ($ppics as $pic) {
            if ($this->media_manager->hasLocalFile($mob_id, $pic)) {
                return $this->media_manager->getLocalSrc($mob_id, $pic);
            }
        }
        return "";
    }

Referenced by ILIAS\MediaObjects\Thumbs\ThumbsManager\getThumbSrc().

Here is the caller graph for this function:

getThumbPath()

ILIAS\MediaObjects\Thumbs\ThumbsManager::getThumbPath ( )

protected

Definition at line 51 of file ThumbsManager.php.

                                     : string
    {
        return "thumbs/Standard.png";
    }

Referenced by ILIAS\MediaObjects\Thumbs\ThumbsManager\getThumbSrc().

Here is the caller graph for this function:

getThumbSrc()

ILIAS\MediaObjects\Thumbs\ThumbsManager::getThumbSrc

(

int

$mob_id

)

For use in browser src of images.

Definition at line 59 of file ThumbsManager.php.

                                            : string
    {
        $mob = new \ilObjMediaObject($mob_id);
        $item = $mob->getMediaItem("Standard");
        // for svg return standard src
        if ($item?->getFormat() === "image/svg+xml") {
            return $mob->getStandardSrc();
        }
 
        // if thumb exists -> return
        $thumb_path = $this->getThumbPath();
        if ($this->media_manager->hasLocalFile($mob_id, $thumb_path)) {
            return $this->media_manager->getLocalSrc($mob_id, $thumb_path);
        }
 
        // if preview exists -> return
        $preview_src = $this->getPreviewSrc($mob_id);
        if ($preview_src !== "") {
            return $preview_src;
        }
 
        // if not tried already, create thumb and return
        if ($item?->getLocationType() === "LocalFile") {
            if ($item?->getThumbTried() !== "y") {
                $this->createThumb(
                    $mob_id,
                    $item?->getLocation(),
                    $item?->getFormat(),
                    $thumb_path
                );
                $item?->writeThumbTried("y");
                if ($this->media_manager->hasLocalFile($mob_id, $thumb_path)) {
                    return $this->media_manager->getLocalSrc($mob_id, $thumb_path);
                }
            }
        } else {
            if (str_starts_with($item?->getFormat(), "image/")) {
                return $item?->getLocation();
            }
        }
 
        // send generic thumb src
        return \ilUtil::getImagePath("standard/icon_mob.svg");
    }

References ILIAS\MediaObjects\Thumbs\ThumbsManager\createThumb(), ILIAS\MediaObjects\Thumbs\ThumbsManager\getPreviewSrc(), and ILIAS\MediaObjects\Thumbs\ThumbsManager\getThumbPath().

Here is the call graph for this function:

resizeToFixedSize()

ILIAS\MediaObjects\Thumbs\ThumbsManager::resizeToFixedSize ( Stream  $stream, int  $width, int  $height, bool  $crop_if_true_and_resize_if_false, ImageOutputOptions  $output_options  )

protected

Definition at line 204 of file ThumbsManager.php.

     : ImageConverter {
        $conversion_options = (new ImageConversionOptions())
            ->withMakeTemporaryFiles(false)
            ->withThrowOnError(false)
            ->withBackgroundColor('#FFFFFF');
 
        return new ImageConverter(
            $conversion_options
                ->withWidth($width)
                ->withHeight($height)
                ->withCrop($crop_if_true_and_resize_if_false)
                ->withKeepAspectRatio(true),
            $output_options,
            $stream
        );
    }

Referenced by ILIAS\MediaObjects\Thumbs\ThumbsManager\createThumb().

Here is the caller graph for this function:

Field Documentation

$image_converters

Images ILIAS\MediaObjects\Thumbs\ThumbsManager::$image_converters

protected

Definition at line 38 of file ThumbsManager.php.

$media_manager

ILIAS MediaObjects MediaObjectManager ILIAS\MediaObjects\Thumbs\ThumbsManager::$media_manager

protected

Definition at line 36 of file ThumbsManager.php.

$output_options

ImageOutputOptions ILIAS\MediaObjects\Thumbs\ThumbsManager::$output_options

protected

Definition at line 37 of file ThumbsManager.php.

$repo

ILIAS MediaObjects MediaObjectRepository ILIAS\MediaObjects\Thumbs\ThumbsManager::$repo

protected

Definition at line 35 of file ThumbsManager.php.

Referenced by ILIAS\MediaObjects\Thumbs\ThumbsManager\__construct().

---

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

• components/ILIAS/MediaObjects/Thumbs/ThumbsManager.php