ilGlobalTemplate Class Reference

special template class to simplify handling of ITX/PEAR More...

Inheritance diagram for ilGlobalTemplate:

Collaboration diagram for ilGlobalTemplate:

Public Member Functions
	__construct (string $file, bool $flag1, bool $flag2, string $in_module='', string $vars=self::DEFAULT_BLOCK, bool $plugin=false, bool $a_use_cache=true)
	printToString (string $part=self::DEFAULT_BLOCK)
	hideFooter ()
	Make the template hide the footer. More...
	setOnScreenMessage (string $a_type, string $a_txt, bool $a_keep=false)
	Set a message to be displayed to the user. 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...
	addOnLoadCode (string $a_code, int $a_batch=2)
	Add on load code. More...
	getOnLoadCodeForAsynch ()
	Get js onload code for ajax calls. More...
	resetJavascript ()
	Reset javascript files. More...
	fillJavaScriptFiles (bool $a_force=false)
	Probably adds javascript files. More...
	fillOnLoadCode ()
	addCss (string $a_css_file, string $media="screen")
	Add a css file that should be included in the header. More...
	addInlineCss (string $a_css, string $media="screen")
	Add a css file that should be included in the header. More...
	fillCssFiles (bool $a_force=false)
	setBodyClass (string $a_class="")
	Sets the body-tags class. More...
	fillBodyClass ()
	renderPage (string $part, bool $a_fill_tabs, bool $a_skip_main_menu, Container $DIC)
	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 (string $a_title, bool $hidden=false)
	Sets title in standard template. More...
	setDescription (string $a_descr)
	Sets descripton below title in standard template. More...
	setTitleIcon (string $a_icon_path, string $a_icon_desc="")
	set title icon More...
	setAlertProperties (array $a_props)
	Set alert properties. More...
	clearHeader ()
	Clear header. More...
	setHeaderActionMenu (string $a_header)
	Set header action menu. More...
	setHeaderPageTitle (string $a_title)
	Sets the title of the page (for browser window). More...
	setLocator ()
	Insert locator. More...
	setTabs (string $a_tabs_html)
	setSubTabs (string $a_tabs_html)
	sets subtabs in standard template More...
	fillTabs ()
	setContent (string $a_html)
	Sets content for standard template. More...
	setLeftContent (string $a_html)
	Sets content of left column. More...
	setLeftNavContent (string $a_content)
	Sets content of left navigation column. More...
	setRightContent (string $a_html)
	Sets content of right column. More...
	fillContentLanguage ()
	fillWindowTitle ()
	setPageFormAction (string $a_action)
	Sets the pages form action. More...
	setLoginTargetPar (string $a_val)
	Set target parameter for login (public sector). 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)
	printToStdout (string $part=self::DEFAULT_BLOCK, bool $a_fill_tabs=true, bool $a_skip_main_menu=false)
	fillScreenReaderFocus ()
	setTreeFlatIcon (string $a_link, string $a_mode)
	Sets a tree or flat icon. More...
	addAdminPanelToolbar (ilToolbarGUI $toolb, bool $a_bottom_panel=true, bool $a_arrow=false)
	setPermanentLink (string $a_type, ?int $a_id, string $a_append="", string $a_target="", string $a_title="")
	Generates and sets a permanent ilias link. More...
	resetHeaderBlock (bool $a_reset_header_action=true)
	Reset all header properties: title, icon, description, alerts, action menu. More...
	setFileUploadRefId (int $a_ref_id)
	Enables the file upload into this object by dropping a file. More...
	get (string $part=self::DEFAULT_BLOCK)
	setVariable (string $variable, $value='')
	Sets the given variable to the given value. More...
	setCurrentBlock (string $part=self::DEFAULT_BLOCK)
	touchBlock (string $block)
	parseCurrentBlock (string $part=self::DEFAULT_BLOCK)
	addBlockFile (string $var, string $block, string $template_name, ?string $in_module=null)
	blockExists (string $a_blockname)
	check if block exists in actual template More...
	getJSFiles ()
	getCSSFiles ()
Public Member Functions inherited from ILIAS\UICore\GlobalTemplate
	printToString ()
	Use this method to get the finally rendered page as string. More...
	addAdminPanelToolbar (\ilToolbarGUI $toolbar, bool $is_bottom_panel=true, bool $has_arrow=false)
	Add admin panel commands as toolbar. More...

Protected Member Functions
	getMainMenu ()
	fillMainMenu ()
	initHelp ()
	fillMessage ()
	getMessageTextForType (string $type)
	fillJavascriptFile (string $file, string $vers)
	resetCss ()
	fillInlineCss ()
	fillNewContentStyle ()
	fillHeader ()
	getHeaderActionMenu ()
	getTabsHTML ()
	fillLeftNav ()
	setCenterColumnClass ()
	fillMainContent ()
	fillLeftContent ()
	fillRightContent ()
	fillToolbar ()
	fillPageFormAction ()
	getLoginTargetPar ()
	fillSideIcons ()
	fillAdminPanel ()
	fillPermanentLink ()
	variableExists (string $a_variablename)

Protected Attributes
ilTemplate	$template
ilToolbarGUI	$admin_panel_commands_toolbar = null
array	$js_files
array	$js_files_vp
array	$js_files_batch
array	$css_files = []
array	$inline_css = []
string	$in_module
string	$template_name
string	$body_class = ''
string	$tree_flat_link = ""
string	$page_form_action = ""
array	$permanent_link = []
string	$main_content = ""
array	$lightbox = []
bool	$standard_template_loaded = false
string	$main_menu = ''
string	$main_menu_spacer = ''
array	$messages = []
bool	$show_footer = true
array	$on_load_code = []
string	$left_nav_content = ''
string	$tree_flat_mode = ''
bool	$admin_panel_arrow = false
bool	$admin_panel_bottom = false
int	$enable_fileupload = null
string	$header_page_title = ""
string	$title = ""
string	$title_desc = ""
array	$title_alerts = []
string	$header_action = ''
string	$icon_desc = ''
string	$icon_path = ''
string	$tabs_html = ""
string	$sub_tabs_html = ""
string	$left_content = ''
string	$right_content = ''
string	$login_target_par = ''

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

special template class to simplify handling of ITX/PEAR

Author

Stefan Kesseler skess.nosp@m.eler.nosp@m.@data.nosp@m.bay..nosp@m.de

Sascha Hofmann shofm.nosp@m.ann@.nosp@m.datab.nosp@m.ay.d.nosp@m.e

Thibeau Fuhrer thibe.nosp@m.au@s.nosp@m.r.sol.nosp@m.utio.nosp@m.ns

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

Constructor & Destructor Documentation

__construct()

ilGlobalTemplate::__construct	(	string	$file,
		bool	$flag1,
		bool	$flag2,
		string	$in_module = '',
		string	$vars = self::DEFAULT_BLOCK,
		bool	$plugin = false,
		bool	$a_use_cache = true
	)

Exceptions

ilTemplateException|ilSystemStyleException

Definition at line 105 of file class.ilGlobalTemplate.php.

References $in_module, XapiProxy\$plugin, and setBodyClass().

      {
        $this->setBodyClass("std");
        $this->template_name = $file;
        $this->in_module = $in_module;
        $this->template = new ilTemplate(
            $file,
            $flag1,
            $flag2,
            $in_module,
            $vars,
            $plugin,
            $a_use_cache
        );
    }

Here is the call graph for this function:

Member Function Documentation

addAdminPanelToolbar()

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

Definition at line 1065 of file class.ilGlobalTemplate.php.

                                                                                                                 : void
    {
        $this->admin_panel_commands_toolbar = $toolb;
        $this->admin_panel_arrow = $a_arrow;
        $this->admin_panel_bottom = $a_bottom_panel;
    }

addBlockFile()

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

Exceptions

ilTemplateException

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 1208 of file class.ilGlobalTemplate.php.

Referenced by loadStandardTemplate().

                                                                                                              : bool
    {
        return $this->template->addBlockFile($var, $block, $template_name, $in_module);
    }

Here is the caller graph for this function:

addCss()

ilGlobalTemplate::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 319 of file class.ilGlobalTemplate.php.

                                                                        : void
    {
        if (!array_key_exists($a_css_file . $media, $this->css_files)) {
            $this->css_files[$a_css_file . $media] = [
                "file" => $a_css_file,
                "media" => $media,
            ];
        }
    }

addInlineCss()

ilGlobalTemplate::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 329 of file class.ilGlobalTemplate.php.

                                                                         : void
    {
        $this->inline_css[] = [
            "css" => $a_css,
            "media" => $media,
        ];
    }

addJavaScript()

ilGlobalTemplate::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 194 of file class.ilGlobalTemplate.php.

                                                                                                            : void
    {
        // three batches currently
        if ($a_batch < 1 || $a_batch > 3) {
            $a_batch = 2;
        }

        // ensure jquery files being loaded first
        if (is_int(strpos($a_js_file, "components/ILIAS/jQuery")) ||
            is_int(strpos($a_js_file, "/jquery.js")) ||
            is_int(strpos($a_js_file, "/jquery/")) ||
            is_int(strpos($a_js_file, "/jquery-ui/")) ||
            is_int(strpos($a_js_file, "/jquery-min.js"))
        ) {
            $a_batch = 0;
        }

        if (!in_array($a_js_file, $this->js_files, true)) {
            $this->js_files[] = $a_js_file;
            $this->js_files_vp[$a_js_file] = $a_add_version_parameter;
            $this->js_files_batch[$a_js_file] = $a_batch;
        }
    }

addOnLoadCode()

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

Add on load code.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 218 of file class.ilGlobalTemplate.php.

                                                                   : void
    {
        // three batches currently
        if ($a_batch < 1 || $a_batch > 3) {
            $a_batch = 2;
        }

        $this->on_load_code[$a_batch][] = $a_code;
    }

blockExists()

ilGlobalTemplate::blockExists

(

string

$block_name

)

check if block exists in actual template

Parameters

string

$block_name

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 1213 of file class.ilGlobalTemplate.php.

Referenced by fillBodyClass(), fillCssFiles(), fillInlineCss(), fillJavaScriptFiles(), fillTabs(), getSpecial(), getTabsHTML(), renderPage(), setCenterColumnClass(), and setTabs().

                                                    : bool
    {
        return $this->template->blockExists($a_blockname);
    }

Here is the caller graph for this function:

clearHeader()

ilGlobalTemplate::clearHeader

(

)

Clear header.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 566 of file class.ilGlobalTemplate.php.

References setAlertProperties(), setDescription(), setTitle(), and setTitleIcon().

                                 : void
    {
        $this->setTitle("");
        $this->setTitleIcon("");
        $this->setDescription("");
        $this->setAlertProperties([]);
    }

Here is the call graph for this function:

fillAdminPanel()

ilGlobalTemplate::fillAdminPanel ( )

protected

Exceptions

ilTemplateException

Definition at line 1075 of file class.ilGlobalTemplate.php.

References $admin_panel_commands_toolbar, $DIC, $lng, fillPageFormAction(), ilUtil\getImagePath(), null, parseCurrentBlock(), setCurrentBlock(), ilToolbarGUI\setLeadingImage(), and setVariable().

Referenced by getSpecial(), and renderPage().

                                       : void
    {
        global $DIC;
        $lng = $DIC->language();

        if ($this->admin_panel_commands_toolbar === null) {
            return;
        }

        $toolb = $this->admin_panel_commands_toolbar;

        // Add arrow if desired.
        if ($this->admin_panel_arrow) {
            $toolb->setLeadingImage(ilUtil::getImagePath("nav/arrow_upright.svg"), $lng->txt("actions"));
        }

        $this->fillPageFormAction();

        // Add top admin bar.
        $this->setCurrentBlock("adm_view_components");
        $this->setVariable("ADM_PANEL1", $toolb->getHTML());
        $this->parseCurrentBlock();

        // Add bottom admin bar if user wants one.
        if ($this->admin_panel_bottom) {
            $this->setCurrentBlock("adm_view_components2");

            // Replace previously set arrow image.
            if ($this->admin_panel_arrow) {
                $toolb->setLeadingImage(ilUtil::getImagePath("nav/arrow_downright.svg"), $lng->txt("actions"));
            }

            $this->setVariable("ADM_PANEL2", $toolb->getHTML());
            $this->parseCurrentBlock();
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

fillBodyClass()

ilGlobalTemplate::fillBodyClass

(

)

Exceptions

ilTemplateException

Definition at line 367 of file class.ilGlobalTemplate.php.

References blockExists(), parseCurrentBlock(), setCurrentBlock(), and setVariable().

Referenced by getSpecial(), and renderPage().

                                   : void
    {
        if ($this->body_class !== "" && $this->blockExists("body_class")) {
            $this->setCurrentBlock("body_class");
            $this->setVariable("BODY_CLASS", $this->body_class);
            $this->parseCurrentBlock();
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

fillContentLanguage()

ilGlobalTemplate::fillContentLanguage

(

)

Definition at line 854 of file class.ilGlobalTemplate.php.

References $DIC, $lng, and setVariable().

Referenced by getSpecial(), and renderPage().

                                         : void
    {
        global $DIC;
        $lng = $DIC->language();

        if (is_object($lng)) {
            $this->setVariable('META_CONTENT_LANGUAGE', $lng->getContentLanguage());
            $this->setVariable('LANGUAGE_DIRECTION', $lng->getTextDirection());
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

fillCssFiles()

ilGlobalTemplate::fillCssFiles

(

bool

$a_force = false

)

Exceptions

ilTemplateException

Definition at line 340 of file class.ilGlobalTemplate.php.

References $filename, blockExists(), parseCurrentBlock(), setCurrentBlock(), and setVariable().

Referenced by getSpecial(), and renderPage().

                                                       : void
    {
        if (!$this->blockExists("css_file")) {
            return;
        }
        foreach ($this->css_files as $css) {
            $filename = $css["file"];
            if (strpos($filename, "?") > 0) {
                $filename = substr($filename, 0, strpos($filename, "?"));
            }
            if ($a_force || is_file($filename)) {
                $this->setCurrentBlock("css_file");
                $this->setVariable("CSS_FILE", $css["file"]);
                $this->setVariable("CSS_MEDIA", $css["media"]);
                $this->parseCurrentBlock();
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

fillHeader()

ilGlobalTemplate::fillHeader ( )

protected

Exceptions

ilTemplateException

Definition at line 587 of file class.ilGlobalTemplate.php.

References $DIC, $lng, getHeaderActionMenu(), null, setVariable(), and ilUtil\stripScriptHTML().

Referenced by getSpecial(), and renderPage().

                                   : void
    {
        global $DIC;

        $lng = $DIC->language();
        $header = $this->getHeaderActionMenu();

        $header_tpl = new ilTemplate('tpl.il_header.html', true, true);

        if ($this->icon_path !== "") {
            $header_tpl->setCurrentBlock("header_image");
            $header_tpl->setVariable("IMG_HEADER", $this->icon_path);
            $header_tpl->parseCurrentBlock();
            $header = true;
        }

        if ($this->title !== "") {
            $title = ilUtil::stripScriptHTML($this->title);
            $header_tpl->setVariable("HEADER", $title);

            $header = true;
        }

        if ($header !== '') {
            $header_tpl->setCurrentBlock("header_image");
            $header_tpl->parseCurrentBlock();
        }

        if ($this->title_desc !== "") {
            $header_tpl->setCurrentBlock("header_desc");
            $header_tpl->setVariable("H_DESCRIPTION", $this->title_desc);
            $header_tpl->parseCurrentBlock();
        }

        if ($header !== '') {
            $header_tpl->setCurrentBlock("head_action_inner");
            $header_tpl->setVariable("HEAD_ACTION", $header);
            $header_tpl->parseCurrentBlock();
        }

        foreach ($this->title_alerts as $alert) {
            $header_tpl->setCurrentBlock('header_alert');
            if (!($alert['propertyNameVisible'] === false)) {
                $header_tpl->setVariable('H_PROP', $alert['property'] . ':');
            }
            $header_tpl->setVariable('H_VALUE', $alert['value']);
            $header_tpl->parseCurrentBlock();
        }

        // add file upload drop zone in header
        if ($this->enable_fileupload !== null) {
            $file_upload = new ilObjFileUploadDropzone(
                $this->enable_fileupload,
                $header_tpl->get()
            );

            $this->setVariable(
                "IL_DROPZONE_HEADER",
                $file_upload->getDropzoneHtml()
            );
        } else {
            $this->setVariable("IL_HEADER", $header_tpl->get());
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

fillInlineCss()

ilGlobalTemplate::fillInlineCss ( )

protected

Exceptions

ilTemplateException

Definition at line 490 of file class.ilGlobalTemplate.php.

References blockExists(), parseCurrentBlock(), setCurrentBlock(), and setVariable().

Referenced by getSpecial(), and renderPage().

                                      : void
    {
        if (!$this->blockExists("css_inline")) {
            return;
        }
        foreach ($this->inline_css as $css) {
            $this->setCurrentBlock("css_inline");
            $this->setVariable("CSS_INLINE", $css["css"]);
            $this->parseCurrentBlock();
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

fillJavascriptFile()

ilGlobalTemplate::fillJavascriptFile ( string  $file, string  $vers  )

protected

Definition at line 308 of file class.ilGlobalTemplate.php.

References ilUtil\appendUrlParameterString(), parseCurrentBlock(), setCurrentBlock(), and setVariable().

Referenced by fillJavaScriptFiles().

                                                                     : void
    {
        $this->setCurrentBlock("js_file");
        if ($this->js_files_vp[$file]) {
            $this->setVariable("JS_FILE", ilUtil::appendUrlParameterString($file, $vers));
        } else {
            $this->setVariable("JS_FILE", $file);
        }
        $this->parseCurrentBlock();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

fillJavaScriptFiles()

ilGlobalTemplate::fillJavaScriptFiles

(

bool

$a_force = false

)

Probably adds javascript files.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 254 of file class.ilGlobalTemplate.php.

References $DIC, $ilSetting, blockExists(), fillJavascriptFile(), and ILIAS_VERSION.

Referenced by getSpecial(), and renderPage().

                                                              : void
    {
        global $DIC;

        $ilSetting = $DIC->settings();

        $vers = '';
        if (is_object($ilSetting)) {        // maybe this one can be removed
            $vers = "vers=" . str_replace([".", " "], "-", ILIAS_VERSION);

            if (DEVMODE) {
                $vers .= '-' . time();
            }
        }
        if ($this->blockExists("js_file")) {
            // three batches
            for ($i = 0; $i <= 3; $i++) {
                reset($this->js_files);
                foreach ($this->js_files as $file) {
                    if ($this->js_files_batch[$file] === $i) {
                        if ($a_force ||
                            is_file($file) ||
                            strpos($file, "http") === 0 ||
                            strpos($file, "//") === 0
                        ) {
                            $this->fillJavascriptFile($file, $vers);
                        } elseif (strpos($file, './') === 0) { // #13962
                            $url_parts = parse_url($file);
                            if (is_file($url_parts['path'])) {
                                $this->fillJavascriptFile($file, $vers);
                            }
                        }
                    }
                }
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

fillLeftContent()

ilGlobalTemplate::fillLeftContent ( )

protected

Exceptions

ilTemplateException

Definition at line 812 of file class.ilGlobalTemplate.php.

References parseCurrentBlock(), setCurrentBlock(), and setVariable().

Referenced by getSpecial(), and renderPage().

                                        : void
    {
        if (trim($this->left_content) !== "") {
            $this->setCurrentBlock("left_column");
            $this->setVariable("LEFT_CONTENT", trim($this->left_content));
            $left_col_class = (trim($this->right_content) === "")
                ? "col-sm-3 col-sm-pull-9"
                : "col-sm-3 col-sm-pull-6";
            $this->setVariable("LEFT_COL_CLASS", $left_col_class);
            $this->parseCurrentBlock();
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

fillLeftNav()

ilGlobalTemplate::fillLeftNav ( )

protected

Exceptions

ilTemplateException

Definition at line 750 of file class.ilGlobalTemplate.php.

References parseCurrentBlock(), setCurrentBlock(), setVariable(), and touchBlock().

Referenced by getSpecial(), and renderPage().

                                    : void
    {
        if (trim($this->left_nav_content) !== "") {
            $this->setCurrentBlock("left_nav");
            $this->setVariable("LEFT_NAV_CONTENT", trim($this->left_nav_content));
            $this->parseCurrentBlock();
            $this->touchBlock("left_nav_space");
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

fillMainContent()

ilGlobalTemplate::fillMainContent ( )

protected

Definition at line 802 of file class.ilGlobalTemplate.php.

References setVariable().

Referenced by getSpecial(), and renderPage().

                                        : void
    {
        if (trim($this->main_content) !== "") {
            $this->setVariable("ADM_CONTENT", trim($this->main_content));
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

fillMainMenu()

ilGlobalTemplate::fillMainMenu ( )

protected

Definition at line 144 of file class.ilGlobalTemplate.php.

Referenced by getSpecial(), and renderPage().

                                     : void
    {
    }

Here is the caller graph for this function:

fillMessage()

ilGlobalTemplate::fillMessage ( )

protected

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

References $out, $txt, ilSession\clear(), getMessageTextForType(), ilUtil\getSystemMessageHTML(), null, and setVariable().

Referenced by getSpecial(), and renderPage().

                                    : void
    {
        $out = "";
        foreach (self::MESSAGE_TYPES as $type) {
            $txt = $this->getMessageTextForType($type);
            if (null !== $txt) {
                $out .= ilUtil::getSystemMessageHTML($txt, $type);
            }

            ilSession::clear($type);
        }

        if ($out !== "") {
            $this->setVariable("MESSAGE", $out);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

fillNewContentStyle()

ilGlobalTemplate::fillNewContentStyle ( )

protected

Definition at line 502 of file class.ilGlobalTemplate.php.

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

Referenced by getSpecial(), and renderPage().

                                            : void
    {
        $this->setVariable(
            "LOCATION_NEWCONTENT_STYLESHEET_TAG",
            '<link rel="stylesheet" type="text/css" href="' .
            ilUtil::getNewContentStyleSheetLocation()
            . '" />'
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

fillOnLoadCode()

ilGlobalTemplate::fillOnLoadCode

(

)

Definition at line 292 of file class.ilGlobalTemplate.php.

References parseCurrentBlock(), setCurrentBlock(), and setVariable().

Referenced by getSpecial(), and renderPage().

                                    : void
    {
        for ($i = 1; $i <= 3; $i++) {
            if (isset($this->on_load_code[$i])) {
                $this->setCurrentBlock("on_load_code");
                foreach ($this->on_load_code[$i] as $code) {
                    $this->setCurrentBlock("on_load_code_inner");
                    $this->setVariable("OLCODE", $code);
                    $this->parseCurrentBlock();
                }
                $this->setCurrentBlock("on_load_code");
                $this->parseCurrentBlock();
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

fillPageFormAction()

ilGlobalTemplate::fillPageFormAction ( )

protected

Exceptions

ilTemplateException

Definition at line 897 of file class.ilGlobalTemplate.php.

References parseCurrentBlock(), setCurrentBlock(), setVariable(), and touchBlock().

Referenced by fillAdminPanel().

                                           : void
    {
        if ($this->page_form_action !== "") {
            $this->setCurrentBlock("page_form_start");
            $this->setVariable("PAGE_FORM_ACTION", $this->page_form_action);
            $this->parseCurrentBlock();
            $this->touchBlock("page_form_end");
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

fillPermanentLink()

ilGlobalTemplate::fillPermanentLink ( )

protected

Definition at line 1128 of file class.ilGlobalTemplate.php.

References setVariable().

Referenced by getSpecial(), and renderPage().

                                          : void
    {
        if (!empty($this->permanent_link)) {
            $plinkgui = new ilPermanentLinkGUI(
                $this->permanent_link["type"],
                $this->permanent_link["id"],
                $this->permanent_link["append"],
                $this->permanent_link["target"]
            );
            if ($this->permanent_link["title"] !== "") {
                $plinkgui->setTitle($this->permanent_link["title"]);
            }
            $this->setVariable("PRMLINK", $plinkgui->getHTML());
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

fillRightContent()

ilGlobalTemplate::fillRightContent ( )

protected

Exceptions

ilTemplateException

Definition at line 828 of file class.ilGlobalTemplate.php.

References parseCurrentBlock(), setCurrentBlock(), and setVariable().

Referenced by getSpecial(), and renderPage().

                                         : void
    {
        if (trim($this->right_content) !== "") {
            $this->setCurrentBlock("right_column");
            $this->setVariable("RIGHT_CONTENT", trim($this->right_content));
            $this->parseCurrentBlock();
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

fillScreenReaderFocus()

ilGlobalTemplate::fillScreenReaderFocus

(

)

Definition at line 1024 of file class.ilGlobalTemplate.php.

Referenced by getSpecial(), and renderPage().

                                           : void
    {
        // abandoned
    }

Here is the caller graph for this function:

fillSideIcons()

ilGlobalTemplate::fillSideIcons ( )

protected

Exceptions

ilTemplateException

Definition at line 1032 of file class.ilGlobalTemplate.php.

References $DIC, $ilSetting, $lng, ilFrameTargetInfo\_getFrame(), ilUtil\getImagePath(), parseCurrentBlock(), setCurrentBlock(), setVariable(), and touchBlock().

Referenced by getSpecial(), and renderPage().

                                      : void
    {
        global $DIC;

        $ilSetting = $DIC->settings();
        $lng = $DIC->language();

        if ($this->tree_flat_link !== "") {
            if ($this->left_nav_content !== "") {
                $this->touchBlock("tree_lns");
            }

            $this->setCurrentBlock("tree_mode");
            $this->setVariable("LINK_MODE", $this->tree_flat_link);
            $this->setVariable("IMG_TREE", ilUtil::getImagePath("standard/icon_sidebar_on.svg"));
            if ($ilSetting->get("tree_frame") === "right") {
                $this->setVariable("RIGHT", "Right");
            }
            $this->setVariable("ALT_TREE", $lng->txt($this->tree_flat_mode . "view"));
            $this->setVariable("TARGET_TREE", ilFrameTargetInfo::_getFrame("MainContent"));
            $this->parseCurrentBlock();
        }

        $this->setCurrentBlock("tree_icons");
        $this->parseCurrentBlock();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

fillTabs()

ilGlobalTemplate::fillTabs

(

)

Exceptions

ilTemplateException

Definition at line 699 of file class.ilGlobalTemplate.php.

References blockExists(), setVariable(), and touchBlock().

Referenced by getSpecial(), and renderPage().

                              : void
    {
        if ($this->blockExists("tabs_outer_start")) {
            $this->touchBlock("tabs_outer_start");
            $this->touchBlock("tabs_outer_end");
            $this->touchBlock("tabs_inner_start");
            $this->touchBlock("tabs_inner_end");

            if ($this->tabs_html !== "") {
                $this->setVariable("TABS", $this->tabs_html);
            }
            $this->setVariable("SUB_TABS", $this->sub_tabs_html);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

fillToolbar()

ilGlobalTemplate::fillToolbar ( )

protected

Exceptions

ilTemplateException

Definition at line 840 of file class.ilGlobalTemplate.php.

References $DIC, parseCurrentBlock(), setCurrentBlock(), and setVariable().

Referenced by getSpecial(), and renderPage().

                                    : void
    {
        global $DIC;

        $ilToolbar = $DIC["ilToolbar"];
        $thtml = $ilToolbar->getHTML();

        if ($thtml !== "") {
            $this->setCurrentBlock("toolbar_buttons");
            $this->setVariable("BUTTONS", $thtml);
            $this->parseCurrentBlock();
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

fillWindowTitle()

ilGlobalTemplate::fillWindowTitle

(

)

Definition at line 865 of file class.ilGlobalTemplate.php.

References $DIC, $ilSetting, setVariable(), and ilUtil\stripScriptHTML().

Referenced by getSpecial(), and renderPage().

                                     : void
    {
        global $DIC;

        $ilSetting = $DIC->settings();

        if ($this->header_page_title !== "") {
            $title = ilUtil::stripScriptHTML($this->header_page_title);
            $this->setVariable("PAGETITLE", "- " . $title);
        }

        if ($ilSetting->get('short_inst_name') !== "") {
            $this->setVariable(
                "WINDOW_TITLE",
                $ilSetting->get('short_inst_name')
            );
        } else {
            $this->setVariable(
                "WINDOW_TITLE",
                "ILIAS"
            );
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

get()

ilGlobalTemplate::get

(

string

$part = self::DEFAULT_BLOCK

)

Exceptions

ilTemplateException

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 1166 of file class.ilGlobalTemplate.php.

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

getCSSFiles()

ilGlobalTemplate::getCSSFiles

(

)

Definition at line 1223 of file class.ilGlobalTemplate.php.

References $css_files.

                                 : array
    {
        return $this->css_files;
    }

getHeaderActionMenu()

ilGlobalTemplate::getHeaderActionMenu ( )

protected

Definition at line 652 of file class.ilGlobalTemplate.php.

References $header_action.

Referenced by fillHeader().

                                            : string
    {
        return $this->header_action;
    }

Here is the caller graph for this function:

getJSFiles()

ilGlobalTemplate::getJSFiles

(

)

Definition at line 1218 of file class.ilGlobalTemplate.php.

References $js_files_batch.

                                : array
    {
        return $this->js_files_batch;
    }

getLoginTargetPar()

ilGlobalTemplate::getLoginTargetPar ( )

protected

Definition at line 916 of file class.ilGlobalTemplate.php.

References $login_target_par.

                                          : string
    {
        return $this->login_target_par;
    }

getMainMenu()

ilGlobalTemplate::getMainMenu ( )

protected

Definition at line 140 of file class.ilGlobalTemplate.php.

Referenced by getSpecial(), and renderPage().

                                    : void
    {
    }

Here is the caller graph for this function:

getMessageTextForType()

ilGlobalTemplate::getMessageTextForType ( string  $type )

protected

Definition at line 185 of file class.ilGlobalTemplate.php.

References ilSession\get(), ilSession\has(), and null.

Referenced by fillMessage().

                                                          : ?string
    {
        if (ilSession::has($type)) {
            return (string) ilSession::get($type);
        }

        return $this->messages[$type] ?? null;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getOnLoadCodeForAsynch()

ilGlobalTemplate::getOnLoadCodeForAsynch

(

)

Get js onload code for ajax calls.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 228 of file class.ilGlobalTemplate.php.

                                            : string
    {
        $js = "";
        for ($i = 1; $i <= 3; $i++) {
            if (isset($this->on_load_code[$i])) {
                foreach ($this->on_load_code[$i] as $code) {
                    $js .= $code . "\n";
                }
            }
        }
        if ($js) {
            return '<script type="text/javascript">' . "\n" .
                $js .
                '</script>' . "\n";
        }

        return '';
    }

getSpecial()

ilGlobalTemplate::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
	)

Exceptions

ilTemplateException
ilCtrlException

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 925 of file class.ilGlobalTemplate.php.

References ilObjLanguageAccess\_saveUsages(), blockExists(), fillAdminPanel(), fillBodyClass(), fillContentLanguage(), fillCssFiles(), fillHeader(), fillInlineCss(), fillJavaScriptFiles(), fillLeftContent(), fillLeftNav(), fillMainContent(), fillMainMenu(), fillMessage(), fillNewContentStyle(), fillOnLoadCode(), fillPermanentLink(), fillRightContent(), fillScreenReaderFocus(), fillSideIcons(), fillTabs(), fillToolbar(), fillWindowTitle(), getMainMenu(), getTabsHTML(), initHelp(), parseCurrentBlock(), setCenterColumnClass(), and setCurrentBlock().

     : string {
        if ($add_error_mess) {
            $this->fillMessage();
        }

        // set standard parts (tabs and title icon)
        if ($add_standard_elements) {
            if ($a_tabs && $this->blockExists("content")) {
                // determine default screen id
                $this->getTabsHTML();
            }

            // to get also the js files for the main menu
            $this->getMainMenu();
            $this->initHelp();

            // these fill blocks in tpl.main.html
            $this->fillCssFiles();
            $this->fillInlineCss();
            $this->fillBodyClass();

            // these fill just plain placeholder variables in tpl.main.html
            $this->setCurrentBlock();
            $this->fillNewContentStyle();
            $this->fillContentLanguage();
            $this->fillWindowTitle();

            // these fill blocks in tpl.adm_content.html
            $this->fillHeader();
            $this->fillSideIcons();
            $this->fillScreenReaderFocus();
            $this->fillLeftContent();
            $this->fillLeftNav();
            $this->fillRightContent();
            $this->fillAdminPanel();
            $this->fillToolbar();
            $this->fillPermanentLink();

            $this->setCenterColumnClass();

            // late loading of javascipr files, since operations above may add files
            $this->fillJavaScriptFiles();
            $this->fillOnLoadCode();

            // these fill just plain placeholder variables in tpl.adm_content.html
            if ($this->blockExists("content")) {
                $this->setCurrentBlock("content");
                if ($a_tabs) {
                    $this->fillTabs();
                }
                $this->fillMainContent();
                if ($a_main_menu) {
                    $this->fillMainMenu();
                }
                $this->parseCurrentBlock();
            }
        }

        if ($part === self::DEFAULT_BLOCK) {
            $html = $this->template->get();
        } else {
            $html = $this->template->get($part);
        }

        // save language usages as late as possible
        \ilObjLanguageAccess::_saveUsages();

        return $html;
    }

Here is the call graph for this function:

getTabsHTML()

ilGlobalTemplate::getTabsHTML ( )

protected

Definition at line 714 of file class.ilGlobalTemplate.php.

References $DIC, and blockExists().

Referenced by getSpecial(), and renderPage().

                                    : void
    {
        global $DIC;

        $ilTabs = $DIC["ilTabs"];

        if ($this->blockExists("tabs_outer_start")) {
            $this->sub_tabs_html = $ilTabs->getSubTabHTML();
            $this->tabs_html = $ilTabs->getHTML(true);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

hideFooter()

ilGlobalTemplate::hideFooter

(

)

Make the template hide the footer.

Implements ILIAS\UICore\GlobalTemplate.

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

                                : void
    {
        $this->show_footer = false;
    }

initHelp()

ilGlobalTemplate::initHelp ( )

protected

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

Referenced by getSpecial(), and renderPage().

                                 : void
    {
        //ilHelpGUI::initHelp($this);
    }

Here is the caller graph for this function:

loadStandardTemplate()

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

Exceptions

ilTemplateException

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 518 of file class.ilGlobalTemplate.php.

References addBlockFile(), iljQueryUtil\initjQuery(), and iljQueryUtil\initjQueryUI().

                                          : void
    {
        if ($this->standard_template_loaded) {
            return;
        }

        // always load jQuery
        iljQueryUtil::initjQuery();
        iljQueryUtil::initjQueryUI();

        $this->addBlockFile("CONTENT", "content", "tpl.adm_content.html");
        $this->addBlockFile("STATUSLINE", "statusline", "tpl.statusline.html");

        $this->standard_template_loaded = true;
    }

Here is the call graph for this function:

parseCurrentBlock()

ilGlobalTemplate::parseCurrentBlock

(

string

$part = self::DEFAULT_BLOCK

)

Exceptions

ilTemplateException

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 1200 of file class.ilGlobalTemplate.php.

Referenced by fillAdminPanel(), fillBodyClass(), fillCssFiles(), fillInlineCss(), fillJavascriptFile(), fillLeftContent(), fillLeftNav(), fillOnLoadCode(), fillPageFormAction(), fillRightContent(), fillSideIcons(), fillToolbar(), getSpecial(), ilInternalLinkGUI\outputThumbnail(), ilInternalLinkGUI\renderLink(), renderPage(), and setCenterColumnClass().

                                                                       : bool
    {
        return $this->template->parseCurrentBlock($part);
    }

Here is the caller graph for this function:

printToStdout()

ilGlobalTemplate::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 1003 of file class.ilGlobalTemplate.php.

References $DIC, ILIAS\UI\examples\Symbol\Glyph\Header\header(), ilYuiUtil\initDom(), and renderPage().

     : void {
        global $DIC;

        // include yahoo dom per default
        ilYuiUtil::initDom();

        header('P3P: CP="CURa ADMa DEVa TAIa PSAa PSDa IVAa IVDa OUR BUS IND UNI COM NAV INT CNT STA PRE"');
        header("Content-type: text/html; charset=UTF-8");

        print $this->renderPage(
            $part,
            $a_fill_tabs,
            $a_skip_main_menu,
            $DIC
        );
    }

Here is the call graph for this function:

printToString()

ilGlobalTemplate::printToString

(

string

$part = self::DEFAULT_BLOCK

)

Definition at line 128 of file class.ilGlobalTemplate.php.

References $DIC, ilYuiUtil\initDom(), and renderPage().

                                                                   : string
    {
        global $DIC;
        ilYuiUtil::initDom();
        return $this->renderPage($part, true, false, $DIC);
    }

Here is the call graph for this function:

renderPage()

ilGlobalTemplate::renderPage	(	string	$part,
		bool	$a_fill_tabs,
		bool	$a_skip_main_menu,
		Container	$DIC
	)

Exceptions

ilTemplateException
ilCtrlException

Definition at line 380 of file class.ilGlobalTemplate.php.

References $id, XapiProxy\$resp, ilObjLanguageAccess\_saveUsages(), blockExists(), fillAdminPanel(), fillBodyClass(), fillContentLanguage(), fillCssFiles(), fillHeader(), fillInlineCss(), fillJavaScriptFiles(), fillLeftContent(), fillLeftNav(), fillMainContent(), fillMainMenu(), fillMessage(), fillNewContentStyle(), fillOnLoadCode(), fillPermanentLink(), fillRightContent(), fillScreenReaderFocus(), fillSideIcons(), fillTabs(), fillToolbar(), fillWindowTitle(), getMainMenu(), getTabsHTML(), initHelp(), ilUIHookPluginGUI\KEEP, parseCurrentBlock(), setCenterColumnClass(), and setCurrentBlock().

Referenced by printToStdout(), and printToString().

     : string {
        $this->fillMessage();

        // set standard parts (tabs and title icon)
        $this->fillBodyClass();

        // see #22992
        $this->fillContentLanguage();

        if ($a_fill_tabs) {
            if ($this->blockExists("content")) {
                // determine default screen id
                $this->getTabsHTML();
            }
            // to get also the js files for the main menu
            if (!$a_skip_main_menu) {
                $this->getMainMenu();
                $this->initHelp();
            }

            // these fill blocks in tpl.main.html
            $this->fillCssFiles();
            $this->fillInlineCss();
            //$this->fillJavaScriptFiles();

            // these fill just plain placeholder variables in tpl.main.html
            $this->setCurrentBlock();
            $this->fillNewContentStyle();
            $this->fillWindowTitle();

            // these fill blocks in tpl.adm_content.html
            $this->fillHeader();
            $this->fillSideIcons();
            $this->fillScreenReaderFocus();
            $this->fillLeftContent();
            $this->fillLeftNav();
            $this->fillRightContent();
            $this->fillAdminPanel();
            $this->fillToolbar();
            $this->fillPermanentLink();

            $this->setCenterColumnClass();

            // late loading of javascipr files, since operations above may add files
            $this->fillJavaScriptFiles();
            $this->fillOnLoadCode();

            // these fill just plain placeholder variables in tpl.adm_content.html
            if ($this->blockExists("content")) {
                $this->setCurrentBlock("content");
                $this->fillTabs();
                $this->fillMainContent();
                $this->fillMainMenu();
                $this->parseCurrentBlock();
            }
        }

        if ($part === self::DEFAULT_BLOCK) {
            $html = $this->template->getUnmodified();
        } else {
            $html = $this->template->getUnmodified($part);
        }

        // Modification of html is done inline here and can't be done
        // by ilTemplate, because the "phase" is template_show in this
        // case here.
        $component_factory = $DIC["component.factory"];

        // not quite sure if that's good.
        $id = $this->template->getTemplateIdentifier(
            $this->template_name,
            $this->in_module
        );

        foreach ($component_factory->getActivePluginsInSlot("uihk") as $ui_plugin) {
            $gui_class = $ui_plugin->getUIClassInstance();
            $resp = $gui_class->getHTML(
                "",
                "template_show",
                [
                    "tpl_id" => $id,
                    "tpl_obj" => $this,
                    "html" => $html
                ]
            );

            if ($resp["mode"] !== ilUIHookPluginGUI::KEEP) {
                $html = $gui_class->modifyHTML($html, $resp);
            }
        }

        // save language usages as late as possible
        \ilObjLanguageAccess::_saveUsages();

        return $html;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

resetCss()

ilGlobalTemplate::resetCss ( )

protected

Definition at line 482 of file class.ilGlobalTemplate.php.

                                 : void
    {
        $this->css_files = [];
    }

resetHeaderBlock()

ilGlobalTemplate::resetHeaderBlock

(

bool

$a_reset_header_action = true

)

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

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 1144 of file class.ilGlobalTemplate.php.

References null, setAlertProperties(), setDescription(), setHeaderActionMenu(), setTitle(), and setTitleIcon().

                                                                        : void
    {
        $this->setTitle('');
        $this->setTitleIcon('');
        $this->setDescription('');
        $this->setAlertProperties([]);
        $this->enable_fileupload = null;

        // see setFullscreenHeader()
        if ($a_reset_header_action) {
            $this->setHeaderActionMenu('');
        }
    }

Here is the call graph for this function:

resetJavascript()

ilGlobalTemplate::resetJavascript

(

)

Reset javascript files.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 247 of file class.ilGlobalTemplate.php.

                                     : void
    {
        $this->js_files = [];
        $this->js_files_vp = [];
        $this->js_files_batch = [];
    }

setAlertProperties()

ilGlobalTemplate::setAlertProperties

(

array

$alerts

)

Set alert properties.

Parameters

array<int,array>

$alerts

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 561 of file class.ilGlobalTemplate.php.

Referenced by clearHeader(), and resetHeaderBlock().

                                                      : void
    {
        $this->title_alerts = $a_props;
    }

Here is the caller graph for this function:

setBodyClass()

ilGlobalTemplate::setBodyClass

(

string

$a_class = ""

)

Sets the body-tags class.

Implements ILIAS\UICore\GlobalTemplate.

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

Referenced by ilIndependentGlobalTemplate\__construct(), and __construct().

                                                      : void
    {
        $this->body_class = $a_class;
    }

Here is the caller graph for this function:

setCenterColumnClass()

ilGlobalTemplate::setCenterColumnClass ( )

protected

Exceptions

ilTemplateException

Definition at line 770 of file class.ilGlobalTemplate.php.

References blockExists(), parseCurrentBlock(), setCurrentBlock(), and setVariable().

Referenced by getSpecial(), and renderPage().

                                             : void
    {
        if (!$this->blockExists("center_col_width")) {
            return;
        }

        $left = trim($this->left_content);
        $right = trim($this->right_content);

        switch (true) {
            case ('' !== $left && '' !== $right):
                $center_column_class = 'col-sm-6';
                break;

            case ('' !== $left || '' !== $right):
                $center_column_class = 'col-sm-9';
                break;

            default:
                $center_column_class = "col-sm-12";
                break;
        }

        if ('' !== $left) {
            $center_column_class .= " col-sm-push-3";
        }

        $this->setCurrentBlock("center_col_width");
        $this->setVariable("CENTER_COL", $center_column_class);
        $this->parseCurrentBlock();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setContent()

ilGlobalTemplate::setContent

(

string

$a_html

)

Sets content for standard template.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 726 of file class.ilGlobalTemplate.php.

                                              : void
    {
        if ($a_html !== "") {
            $this->main_content = $a_html;
        }
    }

setCurrentBlock()

ilGlobalTemplate::setCurrentBlock

(

string

$part = self::DEFAULT_BLOCK

)

Exceptions

ilTemplateException

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 1184 of file class.ilGlobalTemplate.php.

Referenced by fillAdminPanel(), fillBodyClass(), fillCssFiles(), fillInlineCss(), fillJavascriptFile(), fillLeftContent(), fillLeftNav(), fillOnLoadCode(), fillPageFormAction(), fillRightContent(), fillSideIcons(), fillToolbar(), getSpecial(), ilInternalLinkGUI\outputThumbnail(), ilInternalLinkGUI\renderLink(), renderPage(), and setCenterColumnClass().

                                                                     : bool
    {
        return $this->template->setCurrentBlock($part);
    }

Here is the caller graph for this function:

setDescription()

ilGlobalTemplate::setDescription

(

string

$a_descr

)

Sets descripton below title in standard template.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 547 of file class.ilGlobalTemplate.php.

Referenced by clearHeader(), and resetHeaderBlock().

                                                   : void
    {
        $this->title_desc = $a_descr;
    }

Here is the caller graph for this function:

setFileUploadRefId()

ilGlobalTemplate::setFileUploadRefId

(

int

$a_ref_id

)

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

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 1158 of file class.ilGlobalTemplate.php.

                                                     : void
    {
        $this->enable_fileupload = $a_ref_id;
    }

setHeaderActionMenu()

ilGlobalTemplate::setHeaderActionMenu

(

string

$a_header

)

Set header action menu.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 574 of file class.ilGlobalTemplate.php.

Referenced by resetHeaderBlock().

                                                         : void
    {
        $this->header_action = $a_header;
    }

Here is the caller graph for this function:

setHeaderPageTitle()

ilGlobalTemplate::setHeaderPageTitle

(

string

$a_title

)

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

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 579 of file class.ilGlobalTemplate.php.

                                                       : void
    {
        $this->header_page_title = $a_title;
    }

setLeftContent()

ilGlobalTemplate::setLeftContent

(

string

$a_html

)

Sets content of left column.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 733 of file class.ilGlobalTemplate.php.

                                                  : void
    {
        if ($a_html !== "") {
            $this->left_content = $a_html;
        }
    }

setLeftNavContent()

ilGlobalTemplate::setLeftNavContent

(

string

$a_content

)

Sets content of left navigation column.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 740 of file class.ilGlobalTemplate.php.

                                                        : void
    {
        if ($a_content !== "") {
            $this->left_nav_content = $a_content;
        }
    }

setLocator()

ilGlobalTemplate::setLocator

(

)

Insert locator.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 657 of file class.ilGlobalTemplate.php.

References $DIC, and setVariable().

                                : void
    {
        global $DIC;

        $ilLocator = $DIC["ilLocator"];
        $html = "";

        $uip = new ilUIHookProcessor(
            "components/ILIAS/Locator",
            "main_locator",
            ["locator_gui" => $ilLocator]
        );
        if (!$uip->replaced()) {
            $html = $ilLocator->getHTML();
        }
        $html = $uip->getHTML($html);

        $this->setVariable("LOCATOR", $html);
    }

Here is the call graph for this function:

setLoginTargetPar()

ilGlobalTemplate::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 911 of file class.ilGlobalTemplate.php.

                                                    : void
    {
        $this->login_target_par = $a_val;
    }

setOnScreenMessage()

ilGlobalTemplate::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 153 of file class.ilGlobalTemplate.php.

References ilSession\set().

                                                                                           : void
    {
        if ($a_txt === "" ||
            !in_array($a_type, self::MESSAGE_TYPES, true)
        ) {
            return;
        }

        if (!$a_keep) {
            $this->messages[$a_type] = $a_txt;
        } else {
            ilSession::set($a_type, $a_txt);
        }
    }

Here is the call graph for this function:

setPageFormAction()

ilGlobalTemplate::setPageFormAction

(

string

$a_action

)

Sets the pages form action.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 889 of file class.ilGlobalTemplate.php.

                                                       : void
    {
        $this->page_form_action = $a_action;
    }

setPermanentLink()

ilGlobalTemplate::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 1112 of file class.ilGlobalTemplate.php.

     : void {
        $this->permanent_link = [
            "type" => $a_type,
            "id" => $a_id,
            "append" => $a_append,
            "target" => $a_target,
            "title" => $a_title
        ];
    }

setRightContent()

ilGlobalTemplate::setRightContent

(

string

$a_html

)

Sets content of right column.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 760 of file class.ilGlobalTemplate.php.

                                                   : void
    {
        if ($a_html !== '') {
            $this->right_content = $a_html;
        }
    }

setSubTabs()

ilGlobalTemplate::setSubTabs

(

string

$a_tabs_html

)

sets subtabs in standard template

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 691 of file class.ilGlobalTemplate.php.

References setVariable().

                                                   : void
    {
        $this->setVariable("SUB_TABS", $a_tabs_html);
    }

Here is the call graph for this function:

setTabs()

ilGlobalTemplate::setTabs

(

string

$a_tabs_html

)

Exceptions

ilTemplateException

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 680 of file class.ilGlobalTemplate.php.

References blockExists(), setVariable(), and touchBlock().

                                                : void
    {
        if ($a_tabs_html !== "" && $this->blockExists("tabs_outer_start")) {
            $this->touchBlock("tabs_outer_start");
            $this->touchBlock("tabs_outer_end");
            $this->touchBlock("tabs_inner_start");
            $this->touchBlock("tabs_inner_end");
            $this->setVariable("TABS", $a_tabs_html);
        }
    }

Here is the call graph for this function:

setTitle()

ilGlobalTemplate::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 538 of file class.ilGlobalTemplate.php.

Referenced by clearHeader(), and resetHeaderBlock().

                                                                   : void
    {
        $this->title = $a_title;
        $this->header_page_title = $a_title;
    }

Here is the caller graph for this function:

setTitleIcon()

ilGlobalTemplate::setTitleIcon	(	string	$a_icon_path,
		string	$a_icon_desc = ""
	)

set title icon

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 555 of file class.ilGlobalTemplate.php.

Referenced by clearHeader(), and resetHeaderBlock().

                                                                               : void
    {
        $this->icon_desc = $a_icon_desc;
        $this->icon_path = $a_icon_path;
    }

Here is the caller graph for this function:

setTreeFlatIcon()

ilGlobalTemplate::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 1059 of file class.ilGlobalTemplate.php.

                                                                   : void
    {
        $this->tree_flat_link = $a_link;
        $this->tree_flat_mode = $a_mode;
    }

setVariable()

ilGlobalTemplate::setVariable	(	string	$variable,
			$value = ''
	)

Sets the given variable to the given value.

Parameters

mixed

$value

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 1171 of file class.ilGlobalTemplate.php.

Referenced by fillAdminPanel(), fillBodyClass(), fillContentLanguage(), fillCssFiles(), fillHeader(), fillInlineCss(), fillJavascriptFile(), fillLeftContent(), fillLeftNav(), fillMainContent(), fillMessage(), fillNewContentStyle(), fillOnLoadCode(), fillPageFormAction(), fillPermanentLink(), fillRightContent(), fillSideIcons(), fillTabs(), fillToolbar(), fillWindowTitle(), ilInternalLinkGUI\outputThumbnail(), ilInternalLinkGUI\renderLink(), setCenterColumnClass(), setLocator(), setSubTabs(), and setTabs().

                                                              : void
    {
        $this->template->setVariable($variable, $value);
    }

Here is the caller graph for this function:

touchBlock()

ilGlobalTemplate::touchBlock

(

string

$block

)

Exceptions

ilTemplateException

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 1192 of file class.ilGlobalTemplate.php.

Referenced by fillLeftNav(), fillPageFormAction(), fillSideIcons(), fillTabs(), and setTabs().

                                             : bool
    {
        return $this->template->touchBlock($block);
    }

Here is the caller graph for this function:

variableExists()

ilGlobalTemplate::variableExists ( string  $a_variablename )

protected

Definition at line 1176 of file class.ilGlobalTemplate.php.

                                                             : bool
    {
        return $this->template->variableExists($a_variablename);
    }

Field Documentation

$admin_panel_arrow

bool ilGlobalTemplate::$admin_panel_arrow = false

protected

Definition at line 86 of file class.ilGlobalTemplate.php.

$admin_panel_bottom

bool ilGlobalTemplate::$admin_panel_bottom = false

protected

Definition at line 87 of file class.ilGlobalTemplate.php.

$admin_panel_commands_toolbar

ilToolbarGUI ilGlobalTemplate::$admin_panel_commands_toolbar = null

protected

Definition at line 32 of file class.ilGlobalTemplate.php.

Referenced by fillAdminPanel().

$body_class

string ilGlobalTemplate::$body_class = ''

protected

Definition at line 72 of file class.ilGlobalTemplate.php.

$css_files

array ilGlobalTemplate::$css_files = []

protected

Definition at line 62 of file class.ilGlobalTemplate.php.

Referenced by getCSSFiles().

$enable_fileupload

int ilGlobalTemplate::$enable_fileupload = null

protected

Definition at line 88 of file class.ilGlobalTemplate.php.

$header_action

string ilGlobalTemplate::$header_action = ''

protected

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

Referenced by getHeaderActionMenu().

$header_page_title

string ilGlobalTemplate::$header_page_title = ""

protected

Definition at line 89 of file class.ilGlobalTemplate.php.

$icon_desc

string ilGlobalTemplate::$icon_desc = ''

protected

Definition at line 94 of file class.ilGlobalTemplate.php.

$icon_path

string ilGlobalTemplate::$icon_path = ''

protected

Definition at line 95 of file class.ilGlobalTemplate.php.

$in_module

string ilGlobalTemplate::$in_module

protected

Definition at line 70 of file class.ilGlobalTemplate.php.

Referenced by LTI\ilGlobalTemplate\__construct(), ilIndependentGlobalTemplate\__construct(), and __construct().

$inline_css

array ilGlobalTemplate::$inline_css = []

protected

Definition at line 68 of file class.ilGlobalTemplate.php.

$js_files

array ilGlobalTemplate::$js_files

protected

Initial value:

= [
        "assets/js/Basic.js",
    ]

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

$js_files_batch

array ilGlobalTemplate::$js_files_batch

protected

Initial value:

= [
        "assets/js/Basic.js" => 1

Definition at line 54 of file class.ilGlobalTemplate.php.

Referenced by getJSFiles().

$js_files_vp

array ilGlobalTemplate::$js_files_vp

protected

Initial value:

= [
        "assets/js/Basic.js" => true

Definition at line 46 of file class.ilGlobalTemplate.php.

$left_content

string ilGlobalTemplate::$left_content = ''

protected

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

$left_nav_content

string ilGlobalTemplate::$left_nav_content = ''

protected

Definition at line 84 of file class.ilGlobalTemplate.php.

$lightbox

array ilGlobalTemplate::$lightbox = []

protected

Definition at line 77 of file class.ilGlobalTemplate.php.

$login_target_par

string ilGlobalTemplate::$login_target_par = ''

protected

Definition at line 100 of file class.ilGlobalTemplate.php.

Referenced by getLoginTargetPar().

$main_content

string ilGlobalTemplate::$main_content = ""

protected

Definition at line 76 of file class.ilGlobalTemplate.php.

$main_menu

string ilGlobalTemplate::$main_menu = ''

protected

Definition at line 79 of file class.ilGlobalTemplate.php.

$main_menu_spacer

string ilGlobalTemplate::$main_menu_spacer = ''

protected

Definition at line 80 of file class.ilGlobalTemplate.php.

$messages

array ilGlobalTemplate::$messages = []

protected

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

$on_load_code

array ilGlobalTemplate::$on_load_code = []

protected

Definition at line 83 of file class.ilGlobalTemplate.php.

$page_form_action

string ilGlobalTemplate::$page_form_action = ""

protected

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

$permanent_link

array ilGlobalTemplate::$permanent_link = []

protected

Definition at line 75 of file class.ilGlobalTemplate.php.

$right_content

string ilGlobalTemplate::$right_content = ''

protected

Definition at line 99 of file class.ilGlobalTemplate.php.

$show_footer

bool ilGlobalTemplate::$show_footer = true

protected

Definition at line 82 of file class.ilGlobalTemplate.php.

$standard_template_loaded

bool ilGlobalTemplate::$standard_template_loaded = false

protected

Definition at line 78 of file class.ilGlobalTemplate.php.

$sub_tabs_html

string ilGlobalTemplate::$sub_tabs_html = ""

protected

Definition at line 97 of file class.ilGlobalTemplate.php.

$tabs_html

string ilGlobalTemplate::$tabs_html = ""

protected

Definition at line 96 of file class.ilGlobalTemplate.php.

$template

ilTemplate ilGlobalTemplate::$template

protected

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

$template_name

string ilGlobalTemplate::$template_name

protected

Definition at line 71 of file class.ilGlobalTemplate.php.

$title

string ilGlobalTemplate::$title = ""

protected

Definition at line 90 of file class.ilGlobalTemplate.php.

$title_alerts

array ilGlobalTemplate::$title_alerts = []

protected

Definition at line 92 of file class.ilGlobalTemplate.php.

$title_desc

string ilGlobalTemplate::$title_desc = ""

protected

Definition at line 91 of file class.ilGlobalTemplate.php.

$tree_flat_link

string ilGlobalTemplate::$tree_flat_link = ""

protected

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

$tree_flat_mode

string ilGlobalTemplate::$tree_flat_mode = ''

protected

Definition at line 85 of file class.ilGlobalTemplate.php.

---

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

• components/ILIAS/UICore/classes/class.ilGlobalTemplate.php