Inheritance diagram for ilGlobalPageTemplate:

Collaboration diagram for ilGlobalPageTemplate:

Public Member Functions
	__construct (Services $gs, UIServices $ui, HTTPServices $http)

	printToStdout (string $part=self::DEFAULT_BLOCK, bool $a_fill_tabs=true, bool $a_skip_main_menu=false)

	printToString ()
	Use this method to get the finally rendered page as string. More...

	addJavaScript (string $a_js_file, bool $a_add_version_parameter=true, int $a_batch=2)
	Add a javascript file that should be included in the header. More...

	addCss (string $a_css_file, string $media="screen")
	Add a css file that should be included in the header. More...

	addOnLoadCode (string $a_code, int $a_batch=2)
	Add on load code. More...

	addInlineCss (string $a_css, string $media="screen")
	Add a css file that should be included in the header. More...

	setContent (string $a_html)
	Sets content for standard template. More...

	setLeftContent (string $a_html)
	Sets content of left column. More...

	setRightContent (string $a_html)
	Sets content of right column. More...

	setFilter (string $filter)

	setTitle (string $a_title, bool $hidden=false)
	Sets title in standard template. More...

	setDescription (string $a_descr)
	Sets description below title in standard template. More...

	setTitleIcon (string $a_icon_path, string $a_icon_desc="")
	set title icon More...

	setBanner (string $img_src)

	setAlertProperties (array $a_props)
	Set alert properties. More...

	setOnScreenMessage (string $a_type, string $a_txt, bool $a_keep=false)
	Set a message to be displayed to the user. More...

	setFileUploadRefId (int $a_ref_id)
	Enables the file upload into this object by dropping a file. More...

	setHeaderActionMenu (string $a_header)
	Set header action menu. More...

	setHeaderPageTitle (string $a_title)
	Sets the title of the page (for browser window). More...

	setPageFormAction (string $a_action)
	Sets the pages form action. More...

	addAdminPanelToolbar (ilToolbarGUI $toolb, bool $a_bottom_panel=true, bool $a_arrow=false)

	setVariable (string $variable, $value='')
	Sets the given variable to the given value. More...

	resetJavascript ()
	Reset javascript files. More...

	get (string $part=self::DEFAULT_BLOCK)
	Renders the given block and returns the html string. More...

	setCurrentBlock (string $blockname=self::DEFAULT_BLOCK)
	Sets the template to the given block. More...

	touchBlock (string $blockname)
	overwrites ITX::touchBlock. More...

	parseCurrentBlock (string $blockname=self::DEFAULT_BLOCK)
	Parses the given block. More...

	addBlockFile (string $var, string $block, string $template_name, ?string $in_module=null)
	overwrites ITX::addBlockFile More...

	blockExists (string $blockname)
	check if block exists in actual template More...

	loadStandardTemplate ()
	This loads the standard template "tpl.adm_content.html" and "tpl.statusline.html" the CONTENT and STATUSLINE placeholders if they are not already loaded. More...

	setLocator ()
	Insert locator. More...

	setPermanentLink (string $a_type, ?int $a_id, string $a_append="", string $a_target="", string $a_title="")
	Generates and sets a permanent ilias link. More...

	setTreeFlatIcon (string $a_link, string $a_mode)
	Sets a tree or flat icon. More...

	hideFooter ()
	Make the template hide the footer. More...

	setLeftNavContent (string $a_content)
	Sets content of left navigation column. More...

	resetHeaderBlock (bool $a_reset_header_action=true)
	Reset all header properties: title, icon, description, alerts, action menu. More...

	setLoginTargetPar (string $a_val)
	Set target parameter for login (public sector). More...

	getOnLoadCodeForAsynch ()
	Get js onload code for ajax calls. More...

	fillJavaScriptFiles (bool $a_force=false)
	Probably adds javascript files. More...

	setBodyClass (string $a_class="")
	Sets the body-tags class. More...

	clearHeader ()
	Clear header. More...

	setTabs (string $a_tabs_html)
	sets tabs in standard template More...

	setSubTabs (string $a_tabs_html)
	sets subtabs in standard template More...

	getSpecial (string $part=self::DEFAULT_BLOCK, bool $add_error_mess=false, bool $handle_referer=false, bool $add_ilias_footer=false, bool $add_standard_elements=false, bool $a_main_menu=true, bool $a_tabs=true)
	Renders the page with specific elements enabled. More...

Public Member Functions inherited from ILIAS\UICore\GlobalTemplate
	addAdminPanelToolbar (\ilToolbarGUI $toolbar, bool $is_bottom_panel=true, bool $has_arrow=false)
	Add admin panel commands as toolbar. More...

Protected Member Functions
	prepareOutputHeaders ()

	prepareBasicJS ()

	prepareBasicCSS ()

Protected Attributes
HTTPServices	$http

Services	$gs

ilLoggerFactory	$logger_factory

UIServices	$ui

PageContentGUI	$legacy_content_template

ilLanguage	$lng

ilSetting	$il_settings

Refinery	$refinery

Static Protected Attributes
static array	$ignored_blocks

Additional Inherited Members
Data Fields inherited from ILIAS\UICore\GlobalTemplate
const	MESSAGE_TYPE_FAILURE = 'failure'

const	MESSAGE_TYPE_SUCCESS = "success"

const	MESSAGE_TYPE_QUESTION = "question"

const	MESSAGE_TYPE_INFO = "info"

const	MESSAGE_TYPES

const	DEFAULT_BLOCK = 'DEFAULT'

Detailed Description

Author: Fabian Schmid fabia.nosp@m.n@sr.nosp@m..solu.nosp@m.tion.nosp@m.s; Thibeau Fuhrer thibe.nosp@m.au@s.nosp@m.r.sol.nosp@m.utio.nosp@m.ns

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

Constructor & Destructor Documentation

◆ __construct()

ilGlobalPageTemplate::__construct	(	Services	$gs,
		UIServices	$ui,
		HTTPServices	$http
	)

Definition at line 60 of file class.ilGlobalPageTemplate.php.

References $DIC, $gs, $http, $ui, ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), and ILIAS\Repository\ui().

     {
         global $DIC;
         $this->lng = $DIC->language();
         $this->ui = $ui;
         $this->gs = $gs;
         $this->logger_factory = $DIC['ilLoggerFactory'];
         $this->http = $http;
         $this->legacy_content_template = new PageContentGUI("tpl.page_content.html", true, true);
         $this->il_settings = $DIC->settings();
         $this->refinery = $DIC->refinery();
     }

Here is the call graph for this function:

Member Function Documentation

◆ addAdminPanelToolbar()

ilGlobalPageTemplate::addAdminPanelToolbar	(	ilToolbarGUI	$toolb,
		bool	$a_bottom_panel = `true`,
		bool	$a_arrow = `false`
	)

Definition at line 255 of file class.ilGlobalPageTemplate.php.

                                                                                                                  : void
     {
         $this->legacy_content_template->setAdminPanelCommandsToolbar($toolb);
         $this->legacy_content_template->setAdminPanelArrow($a_arrow);
         $this->legacy_content_template->setAdminPanelBottom($a_bottom_panel);
     }

◆ addBlockFile()

ilGlobalPageTemplate::addBlockFile	(	string	$var,
		string	$block,
		string	$template_name,
		?string	$in_module = `null`
	)

overwrites ITX::addBlockFile

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 324 of file class.ilGlobalPageTemplate.php.

References blockExists().

Referenced by ilInfoScreenGUI\getHTML().

                                                                                                               : bool
     {
         if ($this->blockExists($block)) {
             $this->legacy_content_template->removeBlockData($block);
         }
 
         return $this->legacy_content_template->addBlockFile($var, $block, $template_name, $in_module);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addCss()

ilGlobalPageTemplate::addCss	(	string	$a_css_file,
		string	$media = `"screen"`
	)

Add a css file that should be included in the header.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 159 of file class.ilGlobalPageTemplate.php.

Referenced by setVariable().

                                                                         : void
     {
         $this->gs->layout()->meta()->addCss($a_css_file, $media);
     }

Here is the caller graph for this function:

◆ addInlineCss()

ilGlobalPageTemplate::addInlineCss	(	string	$a_css,
		string	$media = `"screen"`
	)

Add a css file that should be included in the header.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 169 of file class.ilGlobalPageTemplate.php.

                                                                          : void
     {
         $this->gs->layout()->meta()->addInlineCss($a_css, $media);
     }

◆ addJavaScript()

ilGlobalPageTemplate::addJavaScript	(	string	$a_js_file,
		bool	$a_add_version_parameter = `true`,
		int	$a_batch = `2`
	)

Add a javascript file that should be included in the header.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 154 of file class.ilGlobalPageTemplate.php.

                                                                                                             : void
     {
         $this->gs->layout()->meta()->addJs($a_js_file, $a_add_version_parameter, $a_batch);
     }

◆ addOnLoadCode()

ilGlobalPageTemplate::addOnLoadCode	(	string	$a_code,
		int	$a_batch = `2`
	)

Add on load code.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 164 of file class.ilGlobalPageTemplate.php.

                                                                    : void
     {
         $this->gs->layout()->meta()->addOnloadCode($a_code, $a_batch);
     }

◆ blockExists()

ilGlobalPageTemplate::blockExists ( string $block_name )

check if block exists in actual template

Parameters

string $block_name

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 333 of file class.ilGlobalPageTemplate.php.

Referenced by addBlockFile(), parseCurrentBlock(), setCurrentBlock(), and touchBlock().

                                                   : bool
     {
         if (in_array($blockname, self::$ignored_blocks)) {
             return false;
         }
 
         return $this->legacy_content_template->blockExists($blockname);
     }

Here is the caller graph for this function:

◆ clearHeader()

ilGlobalPageTemplate::clearHeader ( )

Clear header.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 413 of file class.ilGlobalPageTemplate.php.

                                  : void
     {
         throw new NotImplementedException("This Method is no longer available in GlobalTemplate");
     }

◆ fillJavaScriptFiles()

ilGlobalPageTemplate::fillJavaScriptFiles ( bool $a_force = false )

Probably adds javascript files.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 403 of file class.ilGlobalPageTemplate.php.

                                                               : void
     {
         throw new NotImplementedException("This Method is no longer available in GlobalTemplate");
     }

◆ get()

ilGlobalPageTemplate::get ( string $part = self::DEFAULT_BLOCK )

Renders the given block and returns the html string.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 281 of file class.ilGlobalPageTemplate.php.

Referenced by assTextQuestionGUI\getBestAnswer(), ilInfoScreenGUI\getHTML(), assTextQuestionGUI\getJsCode(), assQuestionGUI\getPreviousSolutionConfirmationCheckboxHtml(), assImagemapQuestionGUI\getPreviousSolutionConfirmationCheckboxHtml(), assLongMenuGUI\getSelectGapTemplate(), ilExPeerReviewGUI\getSubPanel(), assLongMenuGUI\getTextGapTemplate(), assMultipleChoiceGUI\getUseUnchangedAnswerCheckboxHtml(), assQuestionGUI\getUseUnchangedAnswerCheckboxHtml(), assLongMenuGUI\populateQuestionSpecificFormPart(), assClozeTestGUI\populateQuestionSpecificFormPart(), and ilDclRecordEditGUI\searchObjects().

                                                          : string
     {
         return $this->legacy_content_template->get($part);
     }

Here is the caller graph for this function:

◆ getOnLoadCodeForAsynch()

ilGlobalPageTemplate::getOnLoadCodeForAsynch ( )

Get js onload code for ajax calls.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 388 of file class.ilGlobalPageTemplate.php.

Referenced by ilExPeerReviewGUI\updateCritAjaxObject().

                                             : string
     {
         // see e.g. bug #26413
         $js = "";
         foreach ($this->gs->layout()->meta()->getOnLoadCode()->getItemsInOrderOfDelivery() as $code) {
             $js .= $code->getContent() . "\n";
         }
         if ($js) {
             return '<script type="text/javascript">' . "\n" .
                 $js .
                 '</script>' . "\n";
         }
         return "";
     }

Here is the caller graph for this function:

◆ getSpecial()

ilGlobalPageTemplate::getSpecial	(	string	$part = `self::DEFAULT_BLOCK`,
		bool	$add_error_mess = `false`,
		bool	$handle_referer = `false`,
		bool	$add_ilias_footer = `false`,
		bool	$add_standard_elements = `false`,
		bool	$a_main_menu = `true`,
		bool	$a_tabs = `true`
	)

Renders the page with specific elements enabled.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 428 of file class.ilGlobalPageTemplate.php.

      : string {
         throw new NotImplementedException();
     }

◆ hideFooter()

ilGlobalPageTemplate::hideFooter ( )

Make the template hide the footer.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 368 of file class.ilGlobalPageTemplate.php.

                                 : void
     {
         // Nothing to do
     }

◆ loadStandardTemplate()

ilGlobalPageTemplate::loadStandardTemplate ( )

This loads the standard template "tpl.adm_content.html" and "tpl.statusline.html" the CONTENT and STATUSLINE placeholders if they are not already loaded.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 342 of file class.ilGlobalPageTemplate.php.

                                           : void
     {
         // Nothing to do
     }

◆ parseCurrentBlock()

ilGlobalPageTemplate::parseCurrentBlock ( string $block_name = self::DEFAULT_BLOCK )

Parses the given block.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 312 of file class.ilGlobalPageTemplate.php.

References blockExists().

Referenced by assTextQuestionGUI\getBestAnswer(), ilInfoScreenGUI\getHTML(), assTextQuestionGUI\getJsCode(), assLongMenuGUI\getSelectGapTemplate(), ilExPeerReviewGUI\getSubPanel(), assMultipleChoiceGUI\getUseUnchangedAnswerCheckboxHtml(), assLongMenuGUI\populateQuestionSpecificFormPart(), assClozeTestGUI\populateQuestionSpecificFormPart(), assSingleChoiceGUI\renderAggregateView(), and ilDclRecordEditGUI\searchObjects().

                                                                             : bool
     {
         if (in_array($blockname, self::$ignored_blocks)) {
             return false; // TODO why is this needed?
         }
         if ($this->blockExists($blockname)) {
             return $this->legacy_content_template->parseCurrentBlock($blockname);
         }
 
         throw new ilTemplateException("block " . var_export($blockname, true) . " not found");
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ prepareBasicCSS()

ilGlobalPageTemplate::prepareBasicCSS ( )

protected

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

References ilUtil\getNewContentStyleSheetLocation(), and ilUtil\getStyleSheetLocation().

Referenced by printToStdout(), and printToString().

                                         : void
     {
         $this->gs->layout()->meta()->addCss(ilUtil::getStyleSheetLocation());
         $this->gs->layout()->meta()->addCss(ilUtil::getNewContentStyleSheetLocation());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ prepareBasicJS()

ilGlobalPageTemplate::prepareBasicJS ( )

protected

Exceptions

JsonException

Definition at line 98 of file class.ilGlobalPageTemplate.php.

References ilSessionReminder\byLoggedInUser(), ilBuddySystemGUI\initializeFrontend(), ilOnScreenChatGUI\initializeFrontend(), iljQueryUtil\initjQuery(), iljQueryUtil\initjQueryUI(), and ILIAS\Repository\lng().

Referenced by printToStdout(), and printToString().

                                        : void
     {
         iljQueryUtil::initjQuery($this);
         iljQueryUtil::initjQueryUI($this);
         $this->gs->layout()->meta()->addJs("assets/js/Basic.js", true, 1);
         ilBuddySystemGUI::initializeFrontend($this);
         ilOnScreenChatGUI::initializeFrontend($this);
         GlobalPageHandler::initPage($this);
 
         $sessionReminder = new ilSessionReminderGUI(
             ilSessionReminder::byLoggedInUser(),
             $this,
             $this->lng,
             $this->logger_factory
         );
 
         $sessionReminder->populatePage();
         $onScreenNotifier = new ilNotificationOSDGUI($this, $this->lng);
         $onScreenNotifier->populatePage();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ prepareOutputHeaders()

ilGlobalPageTemplate::prepareOutputHeaders ( )

protected

Definition at line 73 of file class.ilGlobalPageTemplate.php.

References ILIAS\FileDelivery\http(), and ILIAS\Repository\lng().

Referenced by printToStdout(), and printToString().

                                              : void
     {
         $this->http->saveResponse(
             $this->http->response()->withAddedHeader(
                 'P3P',
                 'CP="CURa ADMa DEVa TAIa PSAa PSDa IVAa IVDa OUR BUS IND UNI COM NAV INT CNT STA PRE"'
             )
         );
 
         $this->http->saveResponse(
             $this->http->response()->withAddedHeader('Content-type', 'text/html; charset=UTF-8')
         );
 
         if (defined("ILIAS_HTTP_PATH")) {
             $this->gs->layout()->meta()->setBaseURL(
                 (substr(ILIAS_HTTP_PATH, -1) === '/' ? ILIAS_HTTP_PATH : ILIAS_HTTP_PATH . '/')
             );
         }
 
         $this->gs->layout()->meta()->setTextDirection($this->lng->getTextDirection());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ printToStdout()

ilGlobalPageTemplate::printToStdout	(	string	$part = `self::DEFAULT_BLOCK`,
		bool	$has_tabs = `true`,
		bool	$skip_main_menu = `false`
	)

Parameters

bool	$has_tabs	if template variable {TABS} should be filled with content of ilTabs
bool	$skip_main_menu	if the main menu should be rendered.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 125 of file class.ilGlobalPageTemplate.php.

References ilObjLanguageAccess\_saveUsages(), ILIAS\FileDelivery\http(), prepareBasicCSS(), prepareBasicJS(), prepareOutputHeaders(), and ILIAS\Repository\ui().

      : void {
         $this->prepareOutputHeaders();
         $this->prepareBasicJS();
         $this->prepareBasicCSS();
 
         PageContentProvider::setContent($this->legacy_content_template->renderPage(self::DEFAULT_BLOCK, true));
         $this->http->sendResponse();
 
         print $this->ui->renderer()->render($this->gs->collector()->layout()->getFinalPage());
 
         // save language usages as late as possible
         ilObjLanguageAccess::_saveUsages();
     }

Here is the call graph for this function:

◆ printToString()

ilGlobalPageTemplate::printToString ( )

Use this method to get the finally rendered page as string.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 143 of file class.ilGlobalPageTemplate.php.

References prepareBasicCSS(), prepareBasicJS(), prepareOutputHeaders(), and ILIAS\Repository\ui().

Referenced by ILIAS\Wiki\Export\WikiHtmlExport\exportPageHTML(), ILIAS\Notes\Export\NotesHtmlExport\writeExportFile(), and ILIAS\Wiki\Export\BlogHtmlExport\writeExportFile().

                                    : string
     {
         $this->prepareOutputHeaders();
         $this->prepareBasicJS();
         $this->prepareBasicCSS();
 
         PageContentProvider::setContent($this->legacy_content_template->renderPage(self::DEFAULT_BLOCK, true));
 
         return $this->ui->renderer()->render($this->gs->collector()->layout()->getFinalPage());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ resetHeaderBlock()

ilGlobalPageTemplate::resetHeaderBlock ( bool $a_reset_header_action = true )

Reset all header properties: title, icon, description, alerts, action menu.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 378 of file class.ilGlobalPageTemplate.php.

                                                                         : void
     {
         // Nothing to do
     }

◆ resetJavascript()

ilGlobalPageTemplate::resetJavascript ( )

Reset javascript files.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 276 of file class.ilGlobalPageTemplate.php.

                                      : void
     {
         $this->gs->layout()->meta()->getJs()->clear();
     }

◆ setAlertProperties()

ilGlobalPageTemplate::setAlertProperties ( array $alerts )

Set alert properties.

Parameters

array<int,array> $alerts

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 225 of file class.ilGlobalPageTemplate.php.

                                                       : void
     {
         $this->legacy_content_template->setTitleAlerts($a_props);
     }

◆ setBanner()

ilGlobalPageTemplate::setBanner ( string $img_src )

Definition at line 220 of file class.ilGlobalPageTemplate.php.

                                               : void
     {
         $this->legacy_content_template->setBanner($img_src);
     }

◆ setBodyClass()

ilGlobalPageTemplate::setBodyClass ( string $a_class = "" )

Sets the body-tags class.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 408 of file class.ilGlobalPageTemplate.php.

                                                       : void
     {
         throw new NotImplementedException("This Method is no longer available in GlobalTemplate");
     }

◆ setContent()

ilGlobalPageTemplate::setContent ( string $a_html )

Sets content for standard template.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 174 of file class.ilGlobalPageTemplate.php.

Referenced by ilExAssignmentEditorGUI\addAssignmentObject(), ilSurveySkillGUI\assignSkillToQuestion(), ilExAssignmentEditorGUI\confirmAssignmentsDeletionObject(), ilExPeerReviewGUI\confirmResetPeerReviewObject(), ilExAssignmentEditorGUI\editAssignmentObject(), ilExPeerReviewGUI\editPeerReviewItemObject(), ilExPeerReviewGUI\editPeerReviewObject(), ilExAssignmentEditorGUI\editPeerReviewObject(), ilInfoScreenGUI\executeCommand(), ILIAS\Wiki\Export\WikiHtmlExport\exportPageHTML(), ilExAssignmentEditorGUI\listAssignmentsObject(), ilSurveySkillGUI\listQuestionAssignment(), ilExAssignmentEditorGUI\saveAssignmentObject(), ilExPeerReviewGUI\showGivenPeerReviewObject(), ilExPeerReviewGUI\showPeerReviewOverviewObject(), ilExPeerReviewGUI\showReceivedPeerReviewObject(), ilInfoScreenGUI\showSummary(), ilExAssignmentEditorGUI\updateAssignmentObject(), ilExAssignmentEditorGUI\updatePeerReviewObject(), ILIAS\Notes\Export\NotesHtmlExport\writeExportFile(), and ILIAS\Wiki\Export\BlogHtmlExport\writeExportFile().

                                               : void
     {
         $this->legacy_content_template->setMainContent($a_html);
     }

Here is the caller graph for this function:

◆ setCurrentBlock()

ilGlobalPageTemplate::setCurrentBlock ( string $part = self::DEFAULT_BLOCK )

Sets the template to the given block.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 286 of file class.ilGlobalPageTemplate.php.

References blockExists().

Referenced by assTextQuestionGUI\getBestAnswer(), ilInfoScreenGUI\getHTML(), assTextQuestionGUI\getJsCode(), assLongMenuGUI\getSelectGapTemplate(), ilExPeerReviewGUI\getSubPanel(), assMultipleChoiceGUI\getUseUnchangedAnswerCheckboxHtml(), assSingleChoiceGUI\renderAggregateView(), and ilDclRecordEditGUI\searchObjects().

                                                                           : bool
     {
         if (in_array($blockname, self::$ignored_blocks)) {
             return false;
         }
 
         if ($this->blockExists($blockname)) {
             return $this->legacy_content_template->setCurrentBlock($blockname);
         }
         throw new ilTemplateException("block " . var_export($blockname, true) . " not found");
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setDescription()

ilGlobalPageTemplate::setDescription ( string $a_descr )

Sets description below title in standard template.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 209 of file class.ilGlobalPageTemplate.php.

Referenced by ilExAssignmentEditorGUI\setAssignmentHeader().

                                                    : void
     {
         $this->legacy_content_template->setTitleDesc($a_descr);
     }

Here is the caller graph for this function:

◆ setFileUploadRefId()

ilGlobalPageTemplate::setFileUploadRefId ( int $a_ref_id )

Enables the file upload into this object by dropping a file.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 235 of file class.ilGlobalPageTemplate.php.

                                                      : void
     {
         $this->legacy_content_template->setFileUploadRefId($a_ref_id);
     }

◆ setFilter()

ilGlobalPageTemplate::setFilter ( string $filter )

Definition at line 189 of file class.ilGlobalPageTemplate.php.

                                              : void
     {
         $this->legacy_content_template->setFilter($filter);
     }

◆ setHeaderActionMenu()

ilGlobalPageTemplate::setHeaderActionMenu ( string $a_header )

Set header action menu.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 240 of file class.ilGlobalPageTemplate.php.

                                                          : void
     {
         $this->legacy_content_template->setHeaderAction($a_header);
     }

◆ setHeaderPageTitle()

ilGlobalPageTemplate::setHeaderPageTitle ( string $a_title )

Sets the title of the page (for browser window).

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 245 of file class.ilGlobalPageTemplate.php.

                                                        : void
     {
         PageContentProvider::setViewTitle($a_title);
     }

◆ setLeftContent()

ilGlobalPageTemplate::setLeftContent ( string $a_html )

Sets content of left column.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 179 of file class.ilGlobalPageTemplate.php.

                                                   : void
     {
         $this->legacy_content_template->setLeftContent($a_html);
     }

◆ setLeftNavContent()

ilGlobalPageTemplate::setLeftNavContent ( string $a_content )

Sets content of left navigation column.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 373 of file class.ilGlobalPageTemplate.php.

                                                         : void
     {
         // Nothing to do, this should be handled in Slates later
     }

◆ setLocator()

ilGlobalPageTemplate::setLocator ( )

Insert locator.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 347 of file class.ilGlobalPageTemplate.php.

                                 : void
     {
         // Nothing to do
     }

◆ setLoginTargetPar()

ilGlobalPageTemplate::setLoginTargetPar ( string $a_val )

Set target parameter for login (public sector).

This is used by the main menu

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 383 of file class.ilGlobalPageTemplate.php.

                                                     : void
     {
         // Nothing to do
     }

◆ setOnScreenMessage()

ilGlobalPageTemplate::setOnScreenMessage	(	string	$type,
		string	$a_txt,
		bool	$a_keep = `false`
	)

Set a message to be displayed to the user.

Please use instead of ilUtil::sendInfo(), ilUtil::sendSuccess() and ilUtil::sendFailure().

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 230 of file class.ilGlobalPageTemplate.php.

                                                                                            : void
     {
         $this->legacy_content_template->setOnScreenMessage($a_type, $a_txt, $a_keep);
     }

◆ setPageFormAction()

ilGlobalPageTemplate::setPageFormAction ( string $a_action )

Sets the pages form action.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 250 of file class.ilGlobalPageTemplate.php.

                                                        : void
     {
         $this->legacy_content_template->setPageFormAction($a_action);
     }

◆ setPermanentLink()

ilGlobalPageTemplate::setPermanentLink	(	string	$a_type,
		?int	$a_id,
		string	$a_append = `""`,
		string	$a_target = `""`,
		string	$a_title = `""`
	)

Generates and sets a permanent ilias link.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 352 of file class.ilGlobalPageTemplate.php.

References ilLink\_getStaticLink().

      : void {
         $href = ilLink::_getStaticLink($a_id, $a_type, true, $a_append);
         PageContentProvider::setPermaLink($href);
     }

Here is the call graph for this function:

◆ setRightContent()

ilGlobalPageTemplate::setRightContent ( string $a_html )

Sets content of right column.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 184 of file class.ilGlobalPageTemplate.php.

Referenced by ILIAS\Wiki\Export\WikiHtmlExport\exportPageHTML(), ilInfoScreenGUI\showSummary(), and ILIAS\Wiki\Export\BlogHtmlExport\writeExportFile().

                                                    : void
     {
         $this->legacy_content_template->setRightContent($a_html);
     }

Here is the caller graph for this function:

◆ setSubTabs()

ilGlobalPageTemplate::setSubTabs ( string $a_tabs_html )

sets subtabs in standard template

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 423 of file class.ilGlobalPageTemplate.php.

                                                    : void
     {
         throw new NotImplementedException("This Method is no longer available in GlobalTemplate");
     }

◆ setTabs()

ilGlobalPageTemplate::setTabs ( string $a_tabs_html )

sets tabs in standard template

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 418 of file class.ilGlobalPageTemplate.php.

                                                 : void
     {
         throw new NotImplementedException("This Method is no longer available in GlobalTemplate");
     }

◆ setTitle()

ilGlobalPageTemplate::setTitle	(	string	$a_title,
		bool	$hidden = `false`
	)

Sets title in standard template.

Will override the header_page_title.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 194 of file class.ilGlobalPageTemplate.php.

Referenced by ILIAS\Wiki\Export\WikiHtmlExport\exportPageHTML(), ilExAssignmentEditorGUI\setAssignmentHeader(), ilExPeerReviewGUI\showGivenPeerReviewObject(), and ilExPeerReviewGUI\showReceivedPeerReviewObject().

                                                                    : void
     {
         $this->legacy_content_template->setTitle($a_title, $hidden);
 
         $short_title = (string) $this->il_settings->get('short_inst_name');
         if (trim($short_title) === "") {
             $short_title = 'ILIAS';
         }
 
         PageContentProvider::setShortTitle($short_title);
         PageContentProvider::setViewTitle($a_title);
         $header_title = ilObjSystemFolder::_getHeaderTitle();
         PageContentProvider::setTitle($header_title);
     }

Here is the caller graph for this function:

◆ setTitleIcon()

ilGlobalPageTemplate::setTitleIcon	(	string	$a_icon_path,
		string	$a_icon_desc = `""`
	)

set title icon

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 214 of file class.ilGlobalPageTemplate.php.

Referenced by ILIAS\Wiki\Export\WikiHtmlExport\exportPageHTML().

                                                                                : void
     {
         $this->legacy_content_template->setIconPath($a_icon_path);
         $this->legacy_content_template->setIconDesc($a_icon_desc);
     }

Here is the caller graph for this function:

◆ setTreeFlatIcon()

ilGlobalPageTemplate::setTreeFlatIcon	(	string	$a_link,
		string	$a_mode
	)

Sets a tree or flat icon.

Parameters

string $a_mode ("tree" | "flat")

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 363 of file class.ilGlobalPageTemplate.php.

                                                                    : void
     {
         // Nothing to do
     }

◆ setVariable()

ilGlobalPageTemplate::setVariable	(	string	$variable,
			$value = `''`
	)

Sets the given variable to the given value.

Parameters

mixed $value

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 262 of file class.ilGlobalPageTemplate.php.

References addCss(), and ILIAS\Repository\refinery().

Referenced by assTextQuestionGUI\getBestAnswer(), ilInfoScreenGUI\getHTML(), assTextQuestionGUI\getJsCode(), assQuestionGUI\getPreviousSolutionConfirmationCheckboxHtml(), assImagemapQuestionGUI\getPreviousSolutionConfirmationCheckboxHtml(), assLongMenuGUI\getSelectGapTemplate(), ilExPeerReviewGUI\getSubPanel(), assLongMenuGUI\getTextGapTemplate(), assMultipleChoiceGUI\getUseUnchangedAnswerCheckboxHtml(), assQuestionGUI\getUseUnchangedAnswerCheckboxHtml(), assLongMenuGUI\populateQuestionSpecificFormPart(), assClozeTestGUI\populateQuestionSpecificFormPart(), assSingleChoiceGUI\renderAggregateView(), and ilDclRecordEditGUI\searchObjects().

                                                               : void
     {
         if ($variable === "LOCATION_CONTENT_STYLESHEET" || $variable === "LOCATION_SYNTAX_STYLESHEET") {
             $this->addCss($value);
 
             return;
         }
 
         $this->legacy_content_template->setVariable(
             $variable,
             $this->refinery->kindlyTo()->string()->transform($value)
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ touchBlock()

ilGlobalPageTemplate::touchBlock ( string $block )

overwrites ITX::touchBlock.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 298 of file class.ilGlobalPageTemplate.php.

References blockExists().

Referenced by ilInfoScreenGUI\getHTML(), assTextQuestionGUI\getJsCode(), and assMultipleChoiceGUI\getUseUnchangedAnswerCheckboxHtml().

                                                  : bool
     {
         if (in_array($blockname, self::$ignored_blocks)) {
             return false;
         }
 
         if ($this->blockExists($blockname)) {
             $this->legacy_content_template->touchBlock($blockname);
             return true;
         }
 
         throw new ilTemplateException("block " . var_export($blockname, true) . " not found");
     }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $gs

Services ilGlobalPageTemplate::$gs

protected

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

Referenced by __construct().

◆ $http

HTTPServices ilGlobalPageTemplate::$http

protected

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

Referenced by __construct().

◆ $ignored_blocks

array ilGlobalPageTemplate::$ignored_blocks

staticprotected

Initial value:

= [
        self::DEFAULT_BLOCK,
        'ContentStyle',
        "SyntaxStyle",
        "",
    ]

Definition at line 49 of file class.ilGlobalPageTemplate.php.

◆ $il_settings

ilSetting ilGlobalPageTemplate::$il_settings

protected

Definition at line 43 of file class.ilGlobalPageTemplate.php.

◆ $legacy_content_template

PageContentGUI ilGlobalPageTemplate::$legacy_content_template

protected

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

◆ $lng

ilLanguage ilGlobalPageTemplate::$lng

protected

Definition at line 42 of file class.ilGlobalPageTemplate.php.

◆ $logger_factory

ilLoggerFactory ilGlobalPageTemplate::$logger_factory

protected

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

◆ $refinery

Refinery ilGlobalPageTemplate::$refinery

protected

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

◆ $ui

UIServices ilGlobalPageTemplate::$ui

protected

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

Referenced by __construct().

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

components/ILIAS/UICore/classes/class.ilGlobalPageTemplate.php

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addAdminPanelToolbar()

◆ addBlockFile()

◆ addCss()

◆ addInlineCss()

◆ addJavaScript()

◆ addOnLoadCode()

◆ blockExists()

◆ clearHeader()

◆ fillJavaScriptFiles()

◆ get()

◆ getOnLoadCodeForAsynch()

◆ getSpecial()

◆ hideFooter()

◆ loadStandardTemplate()

◆ parseCurrentBlock()

◆ prepareBasicCSS()

◆ prepareBasicJS()

◆ prepareOutputHeaders()

◆ printToStdout()

◆ printToString()

◆ resetHeaderBlock()

◆ resetJavascript()

◆ setAlertProperties()

◆ setBanner()

◆ setBodyClass()

◆ setContent()

◆ setCurrentBlock()

◆ setDescription()

◆ setFileUploadRefId()

◆ setFilter()

◆ setHeaderActionMenu()

◆ setHeaderPageTitle()

◆ setLeftContent()

◆ setLeftNavContent()

◆ setLocator()

◆ setLoginTargetPar()

◆ setOnScreenMessage()

◆ setPageFormAction()

◆ setPermanentLink()

◆ setRightContent()

◆ setSubTabs()

◆ setTabs()

◆ setTitle()

◆ setTitleIcon()

◆ setTreeFlatIcon()

◆ setVariable()

◆ touchBlock()

Field Documentation

◆ $gs

◆ $http

◆ $ignored_blocks

◆ $il_settings

◆ $legacy_content_template

◆ $lng

◆ $logger_factory

◆ $refinery

◆ $ui