Factory that provides access to all available preview renderers. More...

Collaboration diagram for ilRendererFactory:

Static Public Member Functions
static	getRenderers ()
	Gets an array containing all available preview renderers. More...

static	getRenderer ($preview)
	Gets the renderer that is able to create a preview for the specified preview object. More...

Static Private Member Functions
static	loadAvailableRenderers ()
	Loads the available preview renderers. More...

Static Private Attributes
static	$renderers = null

Detailed Description

Factory that provides access to all available preview renderers.

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

Member Function Documentation

◆ getRenderer()

static ilRendererFactory::getRenderer ( $preview )

static

Gets the renderer that is able to create a preview for the specified preview object.

Parameters

ilPReview $preview The preview to get the renderer for.

Returns: ilPreviewRenderer A renderer or null if no renderer matches the preview object.

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

References $preview, and $renderers.

Referenced by ilPreview\create(), and ilPreview\hasPreview().

         {
                 $renderers = self::getRenderers();
                 
                 // check each renderer if it supports that preview object
                 foreach ($renderers as $renderer)
                 {
                         if ($renderer->supports($preview))      
                         {
                                 return $renderer;
                         }                       
                 }
                 
                 // no matching renderer was found
                 return null;
         }

Here is the caller graph for this function:

◆ getRenderers()

static ilRendererFactory::getRenderers ( )

static

Gets an array containing all available preview renderers.

Returns: array All available preview renderers.

Definition at line 27 of file class.ilRendererFactory.php.

Referenced by ilObjFileAccessSettingsGUI\editPreviewSettings().

         {
                 self::loadAvailableRenderers();
                 return self::$renderers;
         }

Here is the caller graph for this function:

◆ loadAvailableRenderers()

static ilRendererFactory::loadAvailableRenderers ( )

staticprivate

Loads the available preview renderers.

That is built in renderers and plugins.

Returns: array The available renderers.

Definition at line 61 of file class.ilRendererFactory.php.

References $r, ilPluginAdmin\getPluginObject(), IL_COMP_SERVICE, and ilGhostscriptRenderer\isGhostscriptInstalled().

         {
                 // already loaded?
                 if (self::$renderers != null)
                         return;
                 
                 $r = array();
                 
                 // get registered and active plugins
                 global $ilPluginAdmin;
                 $pl_names = $ilPluginAdmin->getActivePluginsForSlot(IL_COMP_SERVICE, "Preview", "pvre");
                 foreach ($pl_names as $pl)
                 {
                         $plugin = ilPluginAdmin::getPluginObject(IL_COMP_SERVICE, "Preview", "pvre", $pl);
                         $r[] = $plugin->getRendererClassInstance();     
                 }
                 
                 // add default renderers
                 include_once("./Services/Preview/classes/class.ilImageMagickRenderer.php");
                 $r[] = new ilImageMagickRenderer();
                 
                 include_once("./Services/Preview/classes/class.ilGhostscriptRenderer.php");
                 if (ilGhostscriptRenderer::isGhostscriptInstalled())
                         $r[] = new ilGhostscriptRenderer();
                 
                 self::$renderers = $r;
         }