Inheritance diagram for ilGlobalPageTemplate:

Collaboration diagram for ilGlobalPageTemplate:

Public Member Functions
	__construct (Services $gs, UIServices $ui, HTTPServices $http)
	@inheritDoc More...

	printToStdout ($part="DEFAULT", $a_fill_tabs=true, $a_skip_main_menu=false)
	@inheritDoc More...

	printToString ()
	@inheritDoc More...

	addJavaScript ($a_js_file, $a_add_version_parameter=true, $a_batch=2)
	@inheritDoc More...

	addCss ($a_css_file, $media="screen")
	@inheritDoc More...

	addOnLoadCode ($a_code, $a_batch=2)
	@inheritDoc More...

	addInlineCss ($a_css, $media="screen")
	@inheritDoc More...

	setContent ($a_html)
	@inheritDoc More...

	setLeftContent ($a_html)
	@inheritDoc More...

	setRightContent ($a_html)
	@inheritDoc More...

	setFilter (string $filter)

	setTitle ($a_title, $hidden=false)
	@inheritDoc More...

	setDescription ($a_descr)
	@inheritDoc More...

	setTitleIcon ($a_icon_path, $a_icon_desc="")
	@inheritDoc More...

	setBanner (string $img_src)

	setAlertProperties (array $a_props)
	@inheritDoc More...

	setOnScreenMessage ($a_type, $a_txt, $a_keep=false)
	@inheritDoc More...

	enableDragDropFileUpload ($a_ref_id)
	@inheritDoc More...

	setHeaderActionMenu ($a_header)
	@inheritDoc More...

	setHeaderPageTitle ($a_title)
	@inheritDoc More...

	addLightbox ($a_html, $a_id)
	@inheritDoc More...

	setPageFormAction ($a_action)

	addAdminPanelToolbar (ilToolbarGUI $toolb, $a_bottom_panel=true, $a_arrow=false)
	@inheritDoc More...

	setVariable ($variable, $value='')

	resetJavascript ()
	@inheritDoc More...

	get ($part="DEFAULT")
	@inheritDoc More...

	setCurrentBlock ($blockname="DEFAULT")
	@inheritDoc More...

	touchBlock ($blockname)
	@inheritDoc More...

	parseCurrentBlock ($blockname="DEFAULT")
	@inheritDoc More...

	addBlockFile ($var, $block, $tplname, $in_module=false)
	@inheritDoc More...

	blockExists ($blockname)
	@inheritDoc More...

	loadStandardTemplate ()
	@inheritDoc More...

	setLocator ()
	@inheritDoc More...

	setPermanentLink ($a_type, $a_id, $a_append="", $a_target="", $a_title="")
	@inheritDoc More...

	setTreeFlatIcon ($a_link, $a_mode)
	@inheritDoc More...

	hideFooter ()
	@inheritDoc More...

	setLeftNavContent ($a_content)
	@inheritDoc More...

	resetHeaderBlock ($a_reset_header_action=true)
	@inheritDoc More...

	setLoginTargetPar ($a_val)
	@inheritDoc More...

	getOnLoadCodeForAsynch ()
	@inheritDoc More...

	fillJavaScriptFiles ($a_force=false)

	setBodyClass ($a_class="")
	@inheritDoc More...

	clearHeader ()
	@inheritDoc More...

	setTabs ($a_tabs_html)
	@inheritDoc More...

	setSubTabs ($a_tabs_html)
	@inheritDoc More...

	getSpecial ($part="DEFAULT", $add_error_mess=false, $handle_referer=false, $add_ilias_footer=false, $add_standard_elements=false, $a_main_menu=true, $a_tabs=true)
	@inheritDoc More...

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

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

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

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

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

	resetJavascript ()
	Reset javascript files. More...

	fillJavaScriptFiles ($a_force=false)

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

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

	setBodyClass ($a_class="")

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

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

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

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

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

	clearHeader ()
	Clear header. More...

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

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

	setLocator ()
	Insert locator. More...

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

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

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

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

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

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

	setPageFormAction ($a_action)

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

	getSpecial ($part="DEFAULT", $add_error_mess=false, $handle_referer=false, $add_ilias_footer=false, $add_standard_elements=false, $a_main_menu=true, $a_tabs=true)

	printToStdout ($part="DEFAULT", $a_fill_tabs=true, $a_skip_main_menu=false)

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

	setTreeFlatIcon ($a_link, $a_mode)
	set tree/flat icon More...

	addLightbox ($a_html, $a_id)
	Add lightbox html. More...

	addAdminPanelToolbar (ilToolbarGUI $toolb, $a_bottom_panel=true, $a_arrow=false)
	Add admin panel commands as toolbar. More...

	setPermanentLink ($a_type, $a_id, $a_append="", $a_target="", $a_title="")

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

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

	get ($part="DEFAULT")

	setVariable ($variable, $value='')

	setCurrentBlock ($part="DEFAULT")
	@access public More...

	touchBlock ($block)
	overwrites ITX::touchBlock. More...

	parseCurrentBlock ($part="DEFAULT")
	Überladene Funktion, die auf den aktuelle Block vorher noch ein replace ausführt. More...

	addBlockFile ($var, $block, $tplname, $in_module=false)
	overwrites ITX::addBlockFile More...

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

Private Member Functions
	prepareOutputHeaders ()

	prepareBasicJS ()

	prepareBasicCSS ()

	handleReferer ()
	Old method from global template fixing #26968. More...

Private Attributes
	$http

	$gs

	$ui

	$legacy_content_template

	$lng

	$il_settings

Static Private Attributes
static	$ignored_blocks = ['ContentStyle', "DEFAULT", "SyntaxStyle", ""]

Detailed Description

Class ilGlobalPageTemplate.

Author: Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

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

Constructor & Destructor Documentation

◆ __construct()

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

@inheritDoc

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

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

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

Here is the call graph for this function:

Member Function Documentation

◆ addAdminPanelToolbar()

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

@inheritDoc

Implements ilGlobalTemplateInterface.

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

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

◆ addBlockFile()

ilGlobalPageTemplate::addBlockFile	(	$var,
		$block,
		$tplname,
		$in_module = `false`
	)

@inheritDoc

Implements ilGlobalTemplateInterface.

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

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

References blockExists().

Here is the call graph for this function:

◆ addCss()

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

@inheritDoc

Implements ilGlobalTemplateInterface.

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

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

Referenced by setVariable().

Here is the caller graph for this function:

◆ addInlineCss()

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

@inheritDoc

Implements ilGlobalTemplateInterface.

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

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

◆ addJavaScript()

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

@inheritDoc

Implements ilGlobalTemplateInterface.

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

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

Referenced by ilTermsOfServiceAcceptanceHistoryTableGUI\__construct(), and ILIAS\COPage\Editor\UI\Init\initUI().

Here is the caller graph for this function:

◆ addLightbox()

ilGlobalPageTemplate::addLightbox	(	$a_html,
		$a_id
	)

@inheritDoc

Implements ilGlobalTemplateInterface.

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

    { //
        $this->legacy_content_template->addLightbox($a_html, $a_id);
    }

◆ addOnLoadCode()

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

@inheritDoc

Implements ilGlobalTemplateInterface.

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

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

◆ blockExists()

ilGlobalPageTemplate::blockExists ( $blockname )

@inheritDoc

Implements ilGlobalTemplateInterface.

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

    {
        if (in_array($blockname, self::$ignored_blocks)) {
            return false; // TODO why is this needed?
        }
 
        return $this->legacy_content_template->blockExists($blockname);
    }

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

Here is the caller graph for this function:

◆ clearHeader()

ilGlobalPageTemplate::clearHeader ( )

@inheritDoc

Implements ilGlobalTemplateInterface.

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

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

◆ enableDragDropFileUpload()

ilGlobalPageTemplate::enableDragDropFileUpload ( $a_ref_id )

@inheritDoc

Implements ilGlobalTemplateInterface.

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

    {
        $this->legacy_content_template->setEnableFileupload((int) $a_ref_id);
    }

◆ fillJavaScriptFiles()

ilGlobalPageTemplate::fillJavaScriptFiles ( $a_force = false )

Parameters

bool $a_force

Implements ilGlobalTemplateInterface.

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

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

◆ get()

ilGlobalPageTemplate::get ( $part = "DEFAULT" )

@inheritDoc

Implements ilGlobalTemplateInterface.

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

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

◆ getOnLoadCodeForAsynch()

ilGlobalPageTemplate::getOnLoadCodeForAsynch ( )

@inheritDoc

Implements ilGlobalTemplateInterface.

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

    {
        // 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 "";
    }

◆ getSpecial()

ilGlobalPageTemplate::getSpecial	(	$part = `"DEFAULT"`,
		$add_error_mess = `false`,
		$handle_referer = `false`,
		$add_ilias_footer = `false`,
		$add_standard_elements = `false`,
		$a_main_menu = `true`,
		$a_tabs = `true`
	)

@inheritDoc

Implements ilGlobalTemplateInterface.

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

    { //
        throw new NotImplementedException();
    }

◆ handleReferer()

ilGlobalPageTemplate::handleReferer ( )

private

Old method from global template fixing #26968.

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

    {
        if (((substr(strrchr($_SERVER["PHP_SELF"], "/"), 1) != "error.php")
            && (substr(strrchr($_SERVER["PHP_SELF"], "/"), 1) != "adm_menu.php")
            && (substr(strrchr($_SERVER["PHP_SELF"], "/"), 1) != "chat.php"))) {
            // referer is modified if query string contains cmd=gateway and $_POST is not empty.
            // this is a workaround to display formular again in case of error and if the referer points to another page
            $url_parts = @parse_url($_SERVER["REQUEST_URI"]);
            if (!$url_parts) {
                $protocol = (isset($_SERVER['HTTPS']) ? 'https' : 'http') . '://';
                $host = $_SERVER['HTTP_HOST'];
                $path = $_SERVER['REQUEST_URI'];
                $url_parts = @parse_url($protocol . $host . $path);
            }
 
            if (isset($url_parts["query"]) && preg_match("/cmd=gateway/", $url_parts["query"]) && (isset($_POST["cmd"]["create"]))) {
                foreach ($_POST as $key => $val) {
                    if (is_array($val)) {
                        $val = key($val);
                    }
 
                    $str .= "&" . $key . "=" . $val;
                }
 
                $_SESSION["referer"] = preg_replace("/cmd=gateway/", substr($str, 1), $_SERVER["REQUEST_URI"]);
                $_SESSION['referer_ref_id'] = (int) $_GET['ref_id'];
            } elseif (isset($url_parts["query"]) && preg_match("/cmd=post/", $url_parts["query"]) && (isset($_POST["cmd"]["create"]))) {
                foreach ($_POST as $key => $val) {
                    if (is_array($val)) {
                        $val = key($val);
                    }
 
                    $str .= "&" . $key . "=" . $val;
                }
 
                $_SESSION["referer"] = preg_replace("/cmd=post/", substr($str, 1), $_SERVER["REQUEST_URI"]);
                if (isset($_GET['ref_id'])) {
                    $_SESSION['referer_ref_id'] = (int) $_GET['ref_id'];
                } else {
                    $_SESSION['referer_ref_id'] = 0;
                }
            } else {
                $_SESSION["referer"] = $_SERVER["REQUEST_URI"];
                if (isset($_GET['ref_id'])) {
                    $_SESSION['referer_ref_id'] = (int) $_GET['ref_id'];
                } else {
                    $_SESSION['referer_ref_id'] = 0;
                }
            }
 
            unset($_SESSION["error_post_vars"]);
        }
    }

References $_GET, $_POST, $_SERVER, and $_SESSION.

Referenced by printToStdout().

Here is the caller graph for this function:

◆ hideFooter()

ilGlobalPageTemplate::hideFooter ( )

@inheritDoc

Implements ilGlobalTemplateInterface.

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

    {
        // Nothing to do
    }

◆ loadStandardTemplate()

ilGlobalPageTemplate::loadStandardTemplate ( )

@inheritDoc

Implements ilGlobalTemplateInterface.

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

    {
        // Nothing to do
    }

◆ parseCurrentBlock()

ilGlobalPageTemplate::parseCurrentBlock ( $blockname = "DEFAULT" )

@inheritDoc

Implements ilGlobalTemplateInterface.

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

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

References blockExists().

Here is the call graph for this function:

◆ prepareBasicCSS()

ilGlobalPageTemplate::prepareBasicCSS ( )

private

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

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

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

Referenced by printToStdout(), and printToString().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ prepareBasicJS()

ilGlobalPageTemplate::prepareBasicJS ( )

private

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

    {
        \iljQueryUtil::initjQuery($this);
        \iljQueryUtil::initjQueryUI($this);
        $this->gs->layout()->meta()->addJs("./Services/JavaScript/js/Basic.js", true, 1);
        ilYuiUtil::initConnection();
        \ilUIFramework::init($this);
        \ilBuddySystemGUI::initializeFrontend($this);
        \ilOnScreenChatGUI::initializeFrontend($this);
        \ILIAS\Accessibility\GlobalPageHandler::initPage($this);
 
        $sessionReminder = new ilSessionReminderGUI(
            ilSessionReminder::createInstanceWithCurrentUserSession(),
            $this,
            $this->lng
        );
        $sessionReminder->populatePage();
 
        $onScreenNotifier = new ilNotificationOSDGUI($this, $this->lng);
        $onScreenNotifier->populatePage();
    }

References ilSessionReminder\createInstanceWithCurrentUserSession(), ilUIFramework\init(), ilYuiUtil\initConnection(), ilBuddySystemGUI\initializeFrontend(), ilOnScreenChatGUI\initializeFrontend(), iljQueryUtil\initjQuery(), iljQueryUtil\initjQueryUI(), and ILIAS\Accessibility\GlobalPageHandler\initPage().

Referenced by printToStdout(), and printToString().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ prepareOutputHeaders()

ilGlobalPageTemplate::prepareOutputHeaders ( )

private

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

    {
        $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());
    }

References ILIAS\FileDelivery\http().

Referenced by printToStdout(), and printToString().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ printToStdout()

ilGlobalPageTemplate::printToStdout	(	$part = `"DEFAULT"`,
		$a_fill_tabs = `true`,
		$a_skip_main_menu = `false`
	)

@inheritDoc

Implements ilGlobalTemplateInterface.

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

    {
        $this->prepareOutputHeaders();
        $this->prepareBasicJS();
        $this->prepareBasicCSS();
 
        $this->http->sendResponse();
 
        PageContentProvider::setContent($this->legacy_content_template->renderPage("DEFAULT", true, false));
        print $this->ui->renderer()->render($this->gs->collector()->layout()->getFinalPage());
 
        // save language usages as late as possible
        \ilObjLanguageAccess::_saveUsages();
 
        // see #26968
        $this->handleReferer();
    }

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

Here is the call graph for this function:

◆ printToString()

ilGlobalPageTemplate::printToString ( )

@inheritDoc

Implements ilGlobalTemplateInterface.

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

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

References prepareBasicCSS(), prepareBasicJS(), prepareOutputHeaders(), and ui().

Referenced by ILIAS\Blog\Export\BlogHtmlExport\writeExportFile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ resetHeaderBlock()

ilGlobalPageTemplate::resetHeaderBlock ( $a_reset_header_action = true )

@inheritDoc

Implements ilGlobalTemplateInterface.

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

    {
        // Nothing to do
    }

◆ resetJavascript()

ilGlobalPageTemplate::resetJavascript ( )

@inheritDoc

Implements ilGlobalTemplateInterface.

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

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

◆ setAlertProperties()

ilGlobalPageTemplate::setAlertProperties ( array $a_props )

@inheritDoc

Implements ilGlobalTemplateInterface.

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

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

◆ setBanner()

ilGlobalPageTemplate::setBanner ( string $img_src )

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

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

◆ setBodyClass()

ilGlobalPageTemplate::setBodyClass ( $a_class = "" )

@inheritDoc

Implements ilGlobalTemplateInterface.

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

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

◆ setContent()

ilGlobalPageTemplate::setContent ( $a_html )

@inheritDoc

Implements ilGlobalTemplateInterface.

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

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

Referenced by ILIAS\Blog\Export\BlogHtmlExport\writeExportFile().

Here is the caller graph for this function:

◆ setCurrentBlock()

ilGlobalPageTemplate::setCurrentBlock ( $blockname = "DEFAULT" )

@inheritDoc

Implements ilGlobalTemplateInterface.

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

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

References blockExists().

Here is the call graph for this function:

◆ setDescription()

ilGlobalPageTemplate::setDescription ( $a_descr )

@inheritDoc

Implements ilGlobalTemplateInterface.

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

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

◆ setFilter()

ilGlobalPageTemplate::setFilter ( string $filter )

Parameters

string $filter

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

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

◆ setHeaderActionMenu()

ilGlobalPageTemplate::setHeaderActionMenu ( $a_header )

@inheritDoc

Implements ilGlobalTemplateInterface.

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

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

◆ setHeaderPageTitle()

ilGlobalPageTemplate::setHeaderPageTitle ( $a_title )

@inheritDoc

Implements ilGlobalTemplateInterface.

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

    {
        PageContentProvider::setViewTitle($a_title);
    }

◆ setLeftContent()

ilGlobalPageTemplate::setLeftContent ( $a_html )

@inheritDoc

Implements ilGlobalTemplateInterface.

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

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

◆ setLeftNavContent()

ilGlobalPageTemplate::setLeftNavContent ( $a_content )

@inheritDoc

Implements ilGlobalTemplateInterface.

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

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

◆ setLocator()

ilGlobalPageTemplate::setLocator ( )

@inheritDoc

Implements ilGlobalTemplateInterface.

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

    {
        // Nothing to do
    }

◆ setLoginTargetPar()

ilGlobalPageTemplate::setLoginTargetPar ( $a_val )

@inheritDoc

Implements ilGlobalTemplateInterface.

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

    {
        // Nothing to do
    }

◆ setOnScreenMessage()

ilGlobalPageTemplate::setOnScreenMessage	(	$a_type,
		$a_txt,
		$a_keep = `false`
	)

@inheritDoc

Implements ilGlobalTemplateInterface.

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

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

◆ setPageFormAction()

ilGlobalPageTemplate::setPageFormAction ( $a_action )

Parameters

$a_action

Implements ilGlobalTemplateInterface.

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

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

◆ setPermanentLink()

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

@inheritDoc

Implements ilGlobalTemplateInterface.

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

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

References ilLink\_getStaticLink().

Here is the call graph for this function:

◆ setRightContent()

ilGlobalPageTemplate::setRightContent ( $a_html )

@inheritDoc

Implements ilGlobalTemplateInterface.

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

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

Referenced by ILIAS\Blog\Export\BlogHtmlExport\writeExportFile().

Here is the caller graph for this function:

◆ setSubTabs()

ilGlobalPageTemplate::setSubTabs ( $a_tabs_html )

@inheritDoc

Implements ilGlobalTemplateInterface.

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

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

◆ setTabs()

ilGlobalPageTemplate::setTabs ( $a_tabs_html )

@inheritDoc

Implements ilGlobalTemplateInterface.

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

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

◆ setTitle()

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

@inheritDoc

Implements ilGlobalTemplateInterface.

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

    {
        $this->legacy_content_template->setTitle((string) $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((string) $a_title);
        $header_title = ilObjSystemFolder::_getHeaderTitle();
        PageContentProvider::setTitle($header_title);
    }

◆ setTitleIcon()

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

@inheritDoc

Implements ilGlobalTemplateInterface.

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

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

◆ setTreeFlatIcon()

ilGlobalPageTemplate::setTreeFlatIcon	(	$a_link,
		$a_mode
	)

@inheritDoc

Implements ilGlobalTemplateInterface.

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

    {
        // Nothing to do
    }

◆ setVariable()

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

Parameters

	$variable
string	$value

Implements ilGlobalTemplateInterface.

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

    {
        if ($variable === "LOCATION_CONTENT_STYLESHEET" || $variable === "LOCATION_SYNTAX_STYLESHEET") {
            $this->addCss($value);
 
            return;
        }
        $this->legacy_content_template->setVariable($variable, $value);
    }

References addCss().

Here is the call graph for this function:

◆ touchBlock()

ilGlobalPageTemplate::touchBlock ( $blockname )

@inheritDoc

Implements ilGlobalTemplateInterface.

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

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

References blockExists().

Here is the call graph for this function:

Field Documentation

◆ $gs

ilGlobalPageTemplate::$gs

private

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

Referenced by __construct().

◆ $http

ilGlobalPageTemplate::$http

private

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

Referenced by __construct().

◆ $ignored_blocks

ilGlobalPageTemplate::$ignored_blocks = ['ContentStyle', "DEFAULT", "SyntaxStyle", ""]

staticprivate

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

◆ $il_settings

ilGlobalPageTemplate::$il_settings

private

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

◆ $legacy_content_template

ilGlobalPageTemplate::$legacy_content_template

private

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

◆ $lng

ilGlobalPageTemplate::$lng

private

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

◆ $ui

ilGlobalPageTemplate::$ui

private

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

Referenced by __construct().

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

Services/UICore/classes/class.ilGlobalPageTemplate.php

Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addAdminPanelToolbar()

◆ addBlockFile()

◆ addCss()

◆ addInlineCss()

◆ addJavaScript()

◆ addLightbox()

◆ addOnLoadCode()

◆ blockExists()

◆ clearHeader()

◆ enableDragDropFileUpload()

◆ fillJavaScriptFiles()

◆ get()

◆ getOnLoadCodeForAsynch()

◆ getSpecial()

◆ handleReferer()

◆ hideFooter()

◆ loadStandardTemplate()

◆ parseCurrentBlock()

◆ prepareBasicCSS()

◆ prepareBasicJS()

◆ prepareOutputHeaders()

◆ printToStdout()

◆ printToString()

◆ resetHeaderBlock()

◆ resetJavascript()

◆ setAlertProperties()

◆ setBanner()

◆ setBodyClass()

◆ setContent()

◆ setCurrentBlock()

◆ setDescription()

◆ 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

◆ $ui