ilFilePreviewRenderer Class Reference

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

Inheritance diagram for ilFilePreviewRenderer:

Collaboration diagram for ilFilePreviewRenderer:

Public Member Functions
	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...

Additional Inherited Members
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...

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 Abstract parent class for all file preview renderer classes.

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.ilFilePreviewRenderer.php.

Member Function Documentation

getSupportedFileFormats()

ilFilePreviewRenderer::getSupportedFileFormats ( )

abstract

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

Returns

array An array containing the supported file formats.

Referenced by prepareFileForExec(), ilObjFileAccessSettingsGUI\showPreviewRenderers(), and supports().

Here is the caller graph for this function:

getSupportedRepositoryTypes()

ilFilePreviewRenderer::getSupportedRepositoryTypes ( )

final

Gets an array containing the repository types (e.g.

'file' or 'crs') that are supported by the renderer.

Returns

array An array containing the supported repository types.

Definition at line 33 of file class.ilFilePreviewRenderer.php.

Referenced by ilObjFileAccessSettingsGUI\showPreviewRenderers().

                                                       : array
    {
        return ["file"];
    }

Here is the caller graph for this function:

prepareFileForExec()

ilFilePreviewRenderer::prepareFileForExec

(

string

$filepath

)

Checks whether the specified file path can be used with exec() commands.

If the file name is not conform with exec() commands, a temporary file is created and the path to that file is returned.

Parameters

string

$filepath

The path of the file to check.

Returns

string The specified file path if conform with exec(); otherwise, the path to a temporary copy of the file.

Definition at line 89 of file class.ilFilePreviewRenderer.php.

References $name, getSupportedFileFormats(), and ilFileUtils\getValidFilename().

Referenced by ilGhostscriptRenderer\renderImages(), and ilImageMagickRenderer\renderImages().

                                                        : string
    {
        $filepath = ilFileUtils::getValidFilename($filepath);

        $pos = strrpos($filepath, "/");
        $name = $pos !== false ? substr($filepath, $pos + 1) : $filepath;

        // if the file path contains any characters that could cause problems
        // we copy the file to a temporary file
        // $normName = preg_replace("/[^A-Za-z0-9.\- +_&]/", "", $name);
        // if ($normName != $name)
        // {
        //      $tempPath = ilUtil::ilTempnam();
        //      if (copy($filepath, $tempPath))
        //              return $tempPath;
        // }
        //
        return $filepath;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

supports()

ilFilePreviewRenderer::supports

(

\ilPreview

$preview

)

Determines whether the specified preview object is supported by the renderer.

Parameters

ilPreview

$preview

The preview object to check.

Returns

bool true, if the renderer supports the specified preview object; otherwise, false.

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

References Vendor\Package\$e, $filename, ilObjFileAccess\_getFileExtension(), ilPreview\getObjId(), and getSupportedFileFormats().

                                                 : bool
    {
        // let parent check first
        if (!parent::supports($preview)) {
            return false;
        }

        // legacy
        if (null === $preview->getObjId()) {
            // bugfix mantis 23293
            if (isset($_FILES['file']['name'])) {
                $filename = $_FILES['file']['name'];
            } elseif (isset($_FILES['upload_files']['name'])) {
                $filename = $_FILES['upload_files']['name'];
            }
            if (empty($filename)) {
                return false;
            }

            // contains that extension?
            $ext = ilObjFileAccess::_getFileExtension($filename);
            return in_array($ext, $this->getSupportedFileFormats(), true);
        }

        try {
            $obj = new ilObjFile($preview->getObjId(), false);
        } catch (Exception $e) {
            return false;
        }

        if (empty($obj->getResourceId())) {
            return false;
        }

        return in_array($obj->getFileExtension(), $this->getSupportedFileFormats(), true);
    }

Here is the call graph for this function:

---

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

• Services/Preview/classes/class.ilFilePreviewRenderer.php