Inheritance diagram for ilPreviewGUI:

Collaboration diagram for ilPreviewGUI:

Public Member Functions
	__construct (?int $a_node_id=null, ?int $a_context=self::CONTEXT_REPOSITORY, ?int $a_obj_id=null, ?object $a_access_handler=null)
	Creates a new preview GUI. More...

	executeCommand ()
	execute command More...

	getJSCall (string $a_html_id)
	Gets the JavaScript code to show the preview. More...

	getPreviewHTML ()
	Gets the HTML that displays the preview. More...

	getInlineHTML ()
	Gets the HTML that is used for displaying the preview inline. More...

	renderPreview ()
	Renders the preview and returns the HTML code that displays the preview. More...

	deletePreview ()
	Deletes the preview and returns the HTML code that displays the preview. More...

Static Public Member Functions
static	initPreview ()
	Initializes the preview and loads the needed javascripts and styles. More...

Data Fields
const	CONTEXT_REPOSITORY = 1

const	CONTEXT_WORKSPACE = 2

Private Member Functions
	renderCommand (ilTemplate $tmpl, string $a_cmd, string $btn_topic, string $loading_topic, array $a_display_status)
	Renders a command to the specified template. More...

	getHtmlId ()
	Gets the HTML id for the preview. More...

	buildUrl (string $a_cmd="", bool $a_async=true)
	Builds the URL to call the preview GUI. More...

Static Private Member Functions
static	jsonSafeString (string $text)
	Makes the specified string safe for JSON. More...

Private Attributes
int	$node_id = null

int	$obj_id = null

ilPreview	$preview = null

object	$access_handler = null

int	$context = null

ilCtrl	$ctrl = null

ilLanguage	$lng = null

Static Private Attributes
static bool	$initialized = false

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilPreviewGUI::__construct	(	?int	$a_node_id = `null`,
		?int	$a_context = `self::CONTEXT_REPOSITORY`,
		?int	$a_obj_id = `null`,
		?object	$a_access_handler = `null`
	)

Creates a new preview GUI.

Parameters

int	$a_node_id	The node id.
int	$a_context	The context of the preview.
int	$a_obj_id	The object id.
ilWorkspaceAccessHandler \| ilAccessHandler \| null	$a_access_handler	The access handler to use.

Definition at line 50 of file class.ilPreviewGUI.php.

References $DIC, $query, ilObject\_lookupObjId(), ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

       {
         global $DIC;
         // assign values
         $this->ctrl = $DIC->ctrl();
         $this->lng = $DIC->language();
         $ilAccess = $DIC['ilAccess'];
 
         $query = $DIC->http()->wrapper()->query();
         $base_class = $query->has('baseClass')
             ? $query->retrieve('baseClass', $DIC->refinery()->to()->string())
             : null;
 
         // if we are the base class, get the id's from the query string
         if (strtolower($base_class) === strtolower(__CLASS__)) {
             $this->node_id = $query->has('node_id')
                 ? $query->retrieve('node_id', $DIC->refinery()->kindlyTo()->int())
                 : 0;
             $this->context = $query->has('context')
                 ? $query->retrieve('context', $DIC->refinery()->kindlyTo()->int())
                 : self::CONTEXT_REPOSITORY;
             $a_obj_id = $query->has('obj_id')
                 ? $query->retrieve('obj_id', $DIC->refinery()->kindlyTo()->int())
                 : null;
         } else {
             $this->node_id = $a_node_id;
             $this->context = $a_context;
         }
 
 
 
         // access handler NOT provided?
         if ($a_access_handler === null) {
             if ($this->context === self::CONTEXT_WORKSPACE) {
                 $a_access_handler = new ilWorkspaceAccessHandler();
             } else {
                 $a_access_handler = $ilAccess;
             }
         }
         $this->access_handler = $a_access_handler;
 
         // object id NOT provided?
         if ($a_obj_id === null) {
             if ($this->context === self::CONTEXT_WORKSPACE) {
                 $a_obj_id = $this->access_handler->getTree()->lookupObjectId($this->node_id);
             } else {
                 $a_obj_id = ilObject::_lookupObjId($this->node_id);
             }
         }
         $this->obj_id = $a_obj_id;
 
         // create preview object
         $this->preview = new ilPreview($this->obj_id);
 
         // if the call is NOT async initialize our stuff
         if (!$this->ctrl->isAsynch()) {
             self::initPreview();
         }
     }

Here is the call graph for this function:

Member Function Documentation

◆ buildUrl()

ilPreviewGUI::buildUrl	(	string	$a_cmd = `""`,
		bool	$a_async = `true`
	)

private

Builds the URL to call the preview GUI.

Parameters

$a_cmd	string The command to call.
$a_async	bool true, to create a URL to call asynchronous; otherwise, false.

Returns: string The created URL.

Definition at line 331 of file class.ilPreviewGUI.php.

Referenced by getJSCall(), and renderCommand().

                                                                        : string
     {
         $link = "ilias.php?baseClass=ilPreviewGUI&node_id={$this->node_id}&context={$this->context}&obj_id={$this->obj_id}";
 
         if ($a_async) {
             $link .= "&cmdMode=asynch";
         }
 
         if (!empty($a_cmd)) {
             $link .= "&cmd=$a_cmd";
         }
 
         return $link;
     }

Here is the caller graph for this function:

◆ deletePreview()

ilPreviewGUI::deletePreview ( )

Deletes the preview and returns the HTML code that displays the preview.

Returns: string The HTML code that displays the preview.

Definition at line 306 of file class.ilPreviewGUI.php.

References getPreviewHTML().

                                    : string
     {
         // has read access?
         if ($this->access_handler->checkAccess("write", "", $this->node_id)) {
             $this->preview->delete();
         }
 
         return $this->getPreviewHTML();
     }

Here is the call graph for this function:

◆ executeCommand()

ilPreviewGUI::executeCommand ( )

execute command

Definition at line 118 of file class.ilPreviewGUI.php.

References ILIAS\Repository\ctrl().

     {
         $cmd = $this->ctrl->getCmd("getPreviewHTML");
         $next_class = $this->ctrl->getNextClass($this);
 
         switch ($next_class) {
             default:
                 return $this->$cmd();
                 break;
         }
     }

Here is the call graph for this function:

◆ getHtmlId()

ilPreviewGUI::getHtmlId ( )

private

Gets the HTML id for the preview.

Returns: string The HTML id to use for the preview.

Definition at line 320 of file class.ilPreviewGUI.php.

References $node_id.

Referenced by getPreviewHTML(), and renderCommand().

                                 : string
     {
         return "preview_" . $this->node_id;
     }

Here is the caller graph for this function:

◆ getInlineHTML()

ilPreviewGUI::getInlineHTML ( )

Gets the HTML that is used for displaying the preview inline.

Returns: string The HTML that is used for displaying the preview inline.

Definition at line 226 of file class.ilPreviewGUI.php.

References getPreviewHTML(), ilPreview\RENDER_STATUS_CREATED, ilPreview\RENDER_STATUS_FAILED, ilPreview\RENDER_STATUS_NONE, and renderCommand().

                                    : string
     {
         $tmpl = new ilTemplate("tpl.preview_inline.html", true, true, "Services/Preview");
         $tmpl->setVariable("PREVIEW", $this->getPreviewHTML());
 
         // rendering allowed?
         if ($this->access_handler->checkAccess("read", "", $this->node_id)) {
             $this->renderCommand(
                 $tmpl,
                 "render",
                 "preview_create",
                 "preview_status_creating",
                 array(ilPreview::RENDER_STATUS_NONE, ilPreview::RENDER_STATUS_FAILED)
             );
         }
 
         // delete allowed?
         if ($this->access_handler->checkAccess("write", "", $this->node_id)) {
             $this->renderCommand(
                 $tmpl,
                 "delete",
                 "preview_delete",
                 "preview_status_deleting",
                 array(ilPreview::RENDER_STATUS_CREATED)
             );
         }
 
         return $tmpl->get();
     }

Here is the call graph for this function:

◆ getJSCall()

ilPreviewGUI::getJSCall ( string $a_html_id )

Gets the JavaScript code to show the preview.

Parameters

$a_html_id string The id of the HTML element that contains the preview.

Returns: string The JavaScript code to show the preview.

Definition at line 135 of file class.ilPreviewGUI.php.

References buildUrl(), ILIAS\Repository\lng(), and ilPreview\RENDER_STATUS_NONE.

                                                 : string
     {
         $status = $this->preview->getRenderStatus();
         $command = $status === ilPreview::RENDER_STATUS_NONE ? "renderPreview" : "";
         $loading_text = self::jsonSafeString(
             $this->lng->txt($status === ilPreview::RENDER_STATUS_NONE ? "preview_status_creating" : "preview_loading")
         );
 
         // build the url
         $link = $this->buildUrl($command);
         return "il.Preview.toggle(event, { id: '{$this->node_id}', htmlId: '{$a_html_id}', url: '$link', status: '$status', loadingText: '$loading_text' });";
     }

Here is the call graph for this function:

◆ getPreviewHTML()

ilPreviewGUI::getPreviewHTML ( )

Gets the HTML that displays the preview.

Returns: string The HTML that displays the preview.

Definition at line 152 of file class.ilPreviewGUI.php.

References $index, $response, ilObject\_lookupTitle(), ILIAS\Repository\ctrl(), exit, getHtmlId(), ILIAS\Repository\lng(), ilPreview\RENDER_STATUS_FAILED, ilPreview\RENDER_STATUS_PENDING, and ilWACSignedPath\signFile().

Referenced by deletePreview(), getInlineHTML(), and renderPreview().

                                     : string
     {
         // load the template
         $tmpl = new ilTemplate("tpl.preview.html", true, true, "Services/Preview");
         $tmpl->setVariable("PREVIEW_ID", $this->getHtmlId());
 
         // check for read access and get object id
         $preview_status = $this->preview->getRenderStatus();
 
         // has read access?
         if ($this->access_handler->checkAccess("read", "", $this->node_id)) {
             // preview images available?
             $images = $this->preview->getImages();
             if (count($images) > 0) {
                 $title = ilObject2::_lookupTitle($this->obj_id);
                 $index = 1;
                 foreach ($images as $image) {
                     $tmpl->setCurrentBlock("preview_item");
                     $tmpl->setVariable("IMG_URL", ilWACSignedPath::signFile($image["url"]));
                     $tmpl->setVariable("WIDTH", $image["width"]);
                     $tmpl->setVariable("HEIGHT", $image["height"]);
                     $tmpl->setVariable("ALT_TEXT", sprintf(
                         $this->lng->txt('preview_caption'),
                         (string) $index . ' ',
                         $title
                     ));
                     $tmpl->parseCurrentBlock();
                     $index++;
                 }
             } else {
                 // set text depending on the status
                 $tmpl->setCurrentBlock("no_preview");
                 switch ($preview_status) {
                     case ilPreview::RENDER_STATUS_PENDING:
                         $tmpl->setVariable("TXT_NO_PREVIEW", $this->lng->txt("preview_status_pending"));
                         break;
 
                     case ilPreview::RENDER_STATUS_FAILED:
                         $tmpl->setVariable("TXT_NO_PREVIEW", $this->lng->txt("preview_status_failed"));
                         break;
 
                     default:
                         $tmpl->setVariable("TXT_NO_PREVIEW", $this->lng->txt("preview_status_missing"));
                         break;
                 }
                 $tmpl->parseCurrentBlock();
             }
         } else {
             // display error message
             $tmpl->setVariable("TXT_NO_PREVIEW", $this->lng->txt("no_access_item"));
         }
 
         // output
         if ($this->ctrl->isAsynch()) {
             $response = new stdClass();
             $response->html = $tmpl->get();
             $response->status = $preview_status;
 
             // send response object (don't use 'application/json' as IE wants to download it!)
             header('Vary: Accept');
             header('Content-type: text/plain');
             echo json_encode($response, JSON_THROW_ON_ERROR);
 
             // no further processing!
             exit;
         }
 
         return $tmpl->get();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initPreview()

static ilPreviewGUI::initPreview ( )

static

Initializes the preview and loads the needed javascripts and styles.

Definition at line 350 of file class.ilPreviewGUI.php.

References $DIC, $i, ilPreviewSettings\getImageSize(), ilTooltipGUI\init(), iljQueryUtil\initjQuery(), and ilLegacyFormElementsUtil\prepareFormOutput().

Referenced by ilObjCategoryGUI\addHeaderAction().

                                         : void
     {
         if (self::$initialized) {
             return;
         }
 
         global $DIC;
         // jquery
         iljQueryUtil::initjQuery();
 
         // load qtip
         ilTooltipGUI::init();
 
         // needed scripts & styles
         $DIC->ui()->mainTemplate()->addJavaScript("./libs/bower/bower_components/jquery-mousewheel/jquery.mousewheel.js");
         $DIC->ui()->mainTemplate()->addJavaScript("./Services/Preview/js/ilPreview.js");
 
         // create loading template
         $tmpl = new ilTemplate("tpl.preview.html", true, true, "Services/Preview");
         $tmpl->setCurrentBlock("no_preview");
         $tmpl->setVariable("TXT_NO_PREVIEW", "%%0%%");
         $tmpl->parseCurrentBlock();
 
         $initialHtml = str_replace(array("\r\n", "\r"), "\n", $tmpl->get());
         $lines = explode("\n", $initialHtml);
         $new_lines = array();
         foreach ($lines as $i => $line) {
             if (!empty($line)) {
                 $new_lines[] = trim($line);
             }
         }
         $initialHtml = implode($new_lines);
 
         // add default texts and values
         $DIC->ui()->mainTemplate()->addOnLoadCode("il.Preview.texts.preview = \"" . self::jsonSafeString($DIC->language()->txt("preview")) . "\";");
         $DIC->ui()->mainTemplate()->addOnLoadCode("il.Preview.texts.showPreview = \"" . self::jsonSafeString($DIC->language()->txt("preview_show"))
                                                   . "\";");
         $DIC->ui()->mainTemplate()->addOnLoadCode("il.Preview.texts.close = \"" . ilLegacyFormElementsUtil::prepareFormOutput(
             $DIC->language()->txt("close")
         ) . "\";");
         $DIC->ui()->mainTemplate()->addOnLoadCode("il.Preview.previewSize = " . ilPreviewSettings::getImageSize() . ";");
         $DIC->ui()->mainTemplate()->addOnLoadCode(
             "il.Preview.initialHtml = " . json_encode($initialHtml, JSON_THROW_ON_ERROR) . ";"
         );
         $DIC->ui()->mainTemplate()->addOnLoadCode("il.Preview.highlightClass = \"ilContainerListItemOuterHighlight\";");
         $DIC->ui()->mainTemplate()->addOnLoadCode("il.Preview.init();");
 
         self::$initialized = true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ jsonSafeString()

static ilPreviewGUI::jsonSafeString ( string $text )

staticprivate

Makes the specified string safe for JSON.

Parameters

string $text The text to make JSON safe.

Returns: string The JSON safe text.

Definition at line 406 of file class.ilPreviewGUI.php.

                                                         : string
     {
         if (!is_string($text)) {
             return $text;
         }
 
         $text = htmlentities($text, ENT_COMPAT | ENT_HTML401, "UTF-8");
         $text = str_replace("'", "&#039;", $text);
         return $text;
     }

◆ renderCommand()

ilPreviewGUI::renderCommand	(	ilTemplate	$tmpl,
		string	$a_cmd,
		string	$btn_topic,
		string	$loading_topic,
		array	$a_display_status
	)

private

Renders a command to the specified template.

Parameters

$tmpl	object The template.
$a_cmd	string The command to create.
$btn_topic	string The topic to get the button text.
$loading_topic	string The topic to get the loading text.
$a_display_status	string[] An array containing the statuses when the command should be visible.

Definition at line 264 of file class.ilPreviewGUI.php.

References buildUrl(), getHtmlId(), ILIAS\Repository\lng(), ilTemplate\parseCurrentBlock(), ilTemplate\setCurrentBlock(), and HTML_Template_IT\setVariable().

Referenced by getInlineHTML().

                                                                                                                                       : void
     {
         $preview_html_id = $this->getHtmlId();
         $preview_status = $this->preview->getRenderStatus();
         $loading_text = self::jsonSafeString($this->lng->txt($loading_topic));
 
         $link = $this->buildUrl($a_cmd . "Preview");
         $script_args = "event, { id: '{$this->node_id}', htmlId: '$preview_html_id', url: '$link', loadingText: '$loading_text' }";
 
         $action_class = "";
         if (!in_array($preview_status, $a_display_status, true)) {
             $action_class = "ilPreviewActionHidden";
         }
 
         $tmpl->setCurrentBlock("preview_action");
         $tmpl->setVariable("CLICK_ACTION", "il.Preview.$a_cmd($script_args);");
         $tmpl->setVariable("ACTION_CLASS", $action_class);
         $tmpl->setVariable("ACTION_ID", "preview_{$a_cmd}_" . $preview_html_id);
         $tmpl->setVariable("TXT_ACTION", $this->lng->txt($btn_topic));
         $tmpl->parseCurrentBlock();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ renderPreview()

ilPreviewGUI::renderPreview ( )

Renders the preview and returns the HTML code that displays the preview.

Returns: string The HTML code that displays the preview.

Definition at line 290 of file class.ilPreviewGUI.php.

References ilObjectFactory\getInstanceByObjId(), and getPreviewHTML().

                                    : string
     {
         // has read access?
         if ($this->access_handler->checkAccess("read", "", $this->node_id)) {
             // get the object
             $obj = ilObjectFactory::getInstanceByObjId($this->obj_id);
             $this->preview->create($obj);
         }
 
         return $this->getPreviewHTML();
     }

Here is the call graph for this function:

Field Documentation

◆ $access_handler

object ilPreviewGUI::$access_handler = null

private

Definition at line 34 of file class.ilPreviewGUI.php.

◆ $context

int ilPreviewGUI::$context = null

private

Definition at line 35 of file class.ilPreviewGUI.php.

◆ $ctrl

ilCtrl ilPreviewGUI::$ctrl = null

private

Definition at line 36 of file class.ilPreviewGUI.php.

◆ $initialized

bool ilPreviewGUI::$initialized = false

staticprivate

Definition at line 38 of file class.ilPreviewGUI.php.

◆ $lng

ilLanguage ilPreviewGUI::$lng = null

private

Definition at line 37 of file class.ilPreviewGUI.php.

◆ $node_id

int ilPreviewGUI::$node_id = null

private

Definition at line 28 of file class.ilPreviewGUI.php.

Referenced by getHtmlId().

◆ $obj_id

int ilPreviewGUI::$obj_id = null

private

Definition at line 29 of file class.ilPreviewGUI.php.

◆ $preview

ilPreview ilPreviewGUI::$preview = null

private

Definition at line 30 of file class.ilPreviewGUI.php.

◆ CONTEXT_REPOSITORY

const ilPreviewGUI::CONTEXT_REPOSITORY = 1

Definition at line 40 of file class.ilPreviewGUI.php.

Referenced by ilDclFileuploadRecordRepresentation\getHTML(), ilObjFileGUI\infoScreenForward(), and ilObjectListGUI\insertTitle().

◆ CONTEXT_WORKSPACE

const ilPreviewGUI::CONTEXT_WORKSPACE = 2

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

Referenced by ilObjFileGUI\infoScreenForward(), and ilObjectListGUI\insertTitle().

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

Services/Preview/classes/class.ilPreviewGUI.php

Public Member Functions

Static Public Member Functions

Data Fields

Private Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ buildUrl()

◆ deletePreview()

◆ executeCommand()

◆ getHtmlId()

◆ getInlineHTML()

◆ getJSCall()

◆ getPreviewHTML()

◆ initPreview()

◆ jsonSafeString()

◆ renderCommand()

◆ renderPreview()

Field Documentation

◆ $access_handler

◆ $context

◆ $ctrl

◆ $initialized

◆ $lng

◆ $node_id

◆ $obj_id

◆ $preview

◆ CONTEXT_REPOSITORY

◆ CONTEXT_WORKSPACE