ilPreviewRenderer Class Reference

Abstract parent class for all preview renderer classes. More...

Inheritance diagram for ilPreviewRenderer:

Collaboration diagram for ilPreviewRenderer:

Public Member Functions
	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 ($preview)
	Determines whether the specified preview object is supported by the renderer. More...
	render ($preview, $obj, $async)
	Creates the preview of the specified preview object. More...

Protected Member Functions
	renderImages ($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 Member Functions
	createPreviewImage ($src_img_path, $dest_img_path)
	Creates a preview image path from the specified source image. More...

Detailed Description

Abstract parent class for all 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 14 of file class.ilPreviewRenderer.php.

Member Function Documentation

createPreviewImage()

ilPreviewRenderer::createPreviewImage (   $src_img_path,   $dest_img_path  )

private

Creates a preview image path from the specified source image.

Parameters

string	$src_img_path	The source image path.
string	$dest_img_path	The destination image path.

Returns

bool true, if the preview was created; otherwise, false.

Definition at line 119 of file class.ilPreviewRenderer.php.

References ilUtil\escapeShellArg(), ilUtil\execQuoted(), getImageQuality(), getImageSize(), ilUtil\isWindows(), and renderImages().

Referenced by render().

    {
        // create resize argument
        $imgSize = $this->getImageSize();
        $resizeArg = $imgSize . "x" . $imgSize . (ilUtil::isWindows() ? "^" : "\\") . ">";
        
        // cmd: convert $src_img_path -background white -flatten -resize 280x280 -quality 85 -sharpen 0x0.5 $dest_img_path
        $args = sprintf(
            "%s -background white -flatten -resize %s -quality %d -sharpen 0x0.5 %s",
            ilUtil::escapeShellArg($src_img_path),
            $resizeArg,
            $this->getImageQuality(),
            ilUtil::escapeShellArg($dest_img_path)
        );
    
        ilUtil::execQuoted(PATH_TO_CONVERT, $args);
        
        return is_file($dest_img_path);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getImageQuality()

ilPreviewRenderer::getImageQuality ( )

finalprotected

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

Returns

int The current value

Definition at line 163 of file class.ilPreviewRenderer.php.

References ilPreviewSettings\getImageQuality().

Referenced by createPreviewImage().

    {
        return ilPreviewSettings::getImageQuality();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getImageSize()

ilPreviewRenderer::getImageSize ( )

finalprotected

Gets the size of the preview images in pixels.

Returns

int The current value

Definition at line 153 of file class.ilPreviewRenderer.php.

References ilPreviewSettings\getImageSize().

Referenced by createPreviewImage().

    {
        return ilPreviewSettings::getImageSize();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getMaximumNumberOfPreviews()

ilPreviewRenderer::getMaximumNumberOfPreviews ( )

finalprotected

Gets the maximum number of preview pictures per object.

Returns

int The current value

Definition at line 173 of file class.ilPreviewRenderer.php.

References ilPreviewSettings\getMaximumPreviews().

Referenced by ilGhostscriptRenderer\renderImages().

    {
        return ilPreviewSettings::getMaximumPreviews();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getName()

ilPreviewRenderer::getName

(

)

Gets the name of the renderer.

Returns

string The name of the renderer.

Definition at line 21 of file class.ilPreviewRenderer.php.

References $name.

    {
        $name = get_class($this);
        
        if (strpos($name, "il") === 0) {
            $name = substr($name, 2);
        }
        
        if (strpos($name, "Renderer") === (strlen($name) - 8)) {
            $name = substr($name, 0, strlen($name) - 8) . " Renderer";
        }
        
        return $name;
    }

getSupportedRepositoryTypes()

ilPreviewRenderer::getSupportedRepositoryTypes ( )

abstract

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.

Referenced by isPlugin(), and supports().

Here is the caller graph for this function:

isPlugin()

ilPreviewRenderer::isPlugin ( )

final

Determines whether the renderer is a plugin or a built in one.

Returns

bool true, if the renderer is a plugin; otherwise, false.

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

References getSupportedRepositoryTypes().

    {
        $filepath = "./Services/Preview/classes/class." . get_class($this) . ".php";
        return !is_file($filepath);
    }

Here is the call graph for this function:

render()

ilPreviewRenderer::render (   $preview,   $obj,   $async  )

final

Creates the preview of the specified preview object.

Parameters

ilPreview	$preview	The preview object.
ilObject	$obj	The object to create a preview for.
bool	$async	true, if the rendering should be done asynchronously; otherwise, false.

Returns

bool true, if the preview was successfully rendered; otherwise, false.

Definition at line 74 of file class.ilPreviewRenderer.php.

References $preview, $success, createPreviewImage(), ilUtil\now(), ilPreview\RENDER_STATUS_CREATED, ilPreview\RENDER_STATUS_FAILED, ilPreview\RENDER_STATUS_PENDING, and renderImages().

    {
        $preview->setRenderDate(ilUtil::now());
        $preview->setRenderStatus(ilPreview::RENDER_STATUS_PENDING);
        $preview->save();
        
        // TODO: this should be done in background if $async is true
        
        // the deriving renderer should deliver images
        require_once("./Services/Preview/classes/class.ilRenderedImage.php");
        $images = $this->renderImages($obj);
        
        // process each image
        if (is_array($images) && count($images) > 0) {
            $success = false;
            foreach ($images as $idx => $image) {
                // create the ending preview image
                $success |= $this->createPreviewImage(
                    $image->getImagePath(),
                    sprintf($preview->getFilePathFormat(), $idx + 1)
                );

                // if the image is temporary we can delete it
                if ($image->isTemporary()) {
                    $image->delete();
                }
            }

            $preview->setRenderDate(ilUtil::now());
            $preview->setRenderStatus($success ? ilPreview::RENDER_STATUS_CREATED : ilPreview::RENDER_STATUS_FAILED);
            return $success;
        } else {
            $preview->setRenderDate(ilUtil::now());
            $preview->setRenderStatus(ilPreview::RENDER_STATUS_FAILED);
            return false;
        }
    }

Here is the call graph for this function:

renderImages()

ilPreviewRenderer::renderImages (   $obj )

abstractprotected

Renders the specified object into images.

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

Parameters

ilObject

$obj

The object to create images from.

Returns

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

Referenced by createPreviewImage(), and render().

Here is the caller graph for this function:

supports()

ilPreviewRenderer::supports

(

$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 60 of file class.ilPreviewRenderer.php.

References $preview, and getSupportedRepositoryTypes().

    {
        // contains type?
        return in_array($preview->getObjType(), $this->getSupportedRepositoryTypes());
    }

Here is the call graph for this function:

---

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

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