This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilImageMagickRenderer:

Collaboration diagram for ilImageMagickRenderer:

Public Member Functions
	getSupportedFileFormats ()
	Gets an array containing the file formats that are supported by the renderer. More...

Public Member Functions inherited from ilFilePreviewRenderer
	getSupportedRepositoryTypes ()
	Gets an array containing the repository types (e.g. More...

	supports (\ilPreview $preview)
	Determines whether the specified preview object is supported by the renderer. More...

	prepareFileForExec (string $filepath)
	Checks whether the specified file path can be used with exec() commands. More...

	getSupportedFileFormats ()
	Gets an array containing the file formats that are supported by the renderer. More...

Public Member Functions inherited from ilPreviewRenderer
	getName ()
	Gets the name of the renderer. More...

	isPlugin ()
	Determines whether the renderer is a plugin or a built in one. More...

	getSupportedRepositoryTypes ()
	Gets an array containing the repository types (e.g. More...

	supports (\ilPreview $preview)
	Determines whether the specified preview object is supported by the renderer. More...

	render (\ilPreview $preview, \ilObject $obj, bool $async)
	Creates the preview of the specified preview object. More...

Static Public Member Functions
static	evaluateSupportedFileFormats ()
	Evaluates the supported file formats. More...

Protected Member Functions
	renderImages (\ilObject $obj)
	Renders the specified object into images. More...

Protected Member Functions inherited from ilPreviewRenderer
	renderImages (\ilObject $obj)
	Renders the specified object into images. More...

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

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

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

Private Attributes
const	SUPPORTED_FORMATS = "jpg,jpeg,jp2,png,gif,bmp,tif,tiff,cur,ico,pict,tga,psd"

Static Private Attributes
static array	$supported_formats = null

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Preview renderer class that is able to create previews from images by using ImageMagick.

Author: Stefan Born stefa.nosp@m.n.bo.nosp@m.rn@ph.nosp@m.zh.c.nosp@m.h

Version: $Id$

Definition at line 26 of file class.ilImageMagickRenderer.php.

Member Function Documentation

◆ evaluateSupportedFileFormats()

static ilImageMagickRenderer::evaluateSupportedFileFormats ( )

static

Evaluates the supported file formats.

Returns: array An array containing the supported file formats.

Definition at line 54 of file class.ilImageMagickRenderer.php.

                                                          : array
     {
         return explode(",", self::SUPPORTED_FORMATS) ?? [];
     }

◆ getSupportedFileFormats()

ilImageMagickRenderer::getSupportedFileFormats ( )

Gets an array containing the file formats that are supported by the renderer.

Returns: array An array containing the supported file formats.

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

                                              : array
     {
         // build formats only once
         if (!isset(self::$supported_formats)) {
             self::$supported_formats = self::evaluateSupportedFileFormats();
         }
 
         return self::$supported_formats;
     }

◆ renderImages()

ilImageMagickRenderer::renderImages ( \ilObject $obj )

protected

Renders the specified object into images.

The images do not need to be of the preview image size.

Parameters

ilObjFile $obj The object to create images from.

Returns: array An array of ilRenderedImage containing the absolute file paths to the images.

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

References ilFilePreviewRenderer\prepareFileForExec().

                                                    : array
     {
         $filepath = $obj->getFile();
         $tmpPath = $this->prepareFileForExec($filepath);
         $isTemporary = $tmpPath !== $filepath;
         return array(new ilRenderedImage($tmpPath, $isTemporary));
     }