ilDataCollectionGlobalTemplate Class Reference

Inheritance diagram for ilDataCollectionGlobalTemplate:

Collaboration diagram for ilDataCollectionGlobalTemplate:

Public Member Functions
	__construct (string $file, bool $flag1, bool $flag2, string $in_module="", string $vars=ilGlobalTemplateInterface::DEFAULT_BLOCK, bool $plugin=false, bool $a_use_cache=true)
	printToString ()
	Use this method to get the finally rendered page as string. More...
	hideFooter ()
	Make the template hide the footer. More...
	setOnScreenMessage (string $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...
	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)
	Fill in the css file tags. More...
	setBodyClass (string $a_class="")
	Sets the body-tags class. More...
	loadStandardTemplate ()
	This loads the standard template "tpl.adm_content.html" and "tpl.statusline.html" the CONTENT and STATUSLINE placeholders if they are not already loaded. More...
	setTitle (string $a_title, bool $hidden=false)
	Sets title in standard template. More...
	setDescription (string $a_descr)
	Sets description below title in standard template. More...
	setTitleIcon (string $a_icon_path, string $a_icon_desc="")
	set title icon More...
	setAlertProperties (array $alerts)
	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)
	sets tabs in standard template More...
	setSubTabs (string $a_tabs_html)
	sets subtabs in standard template More...
	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...
	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)
	Renders the page with specific elements enabled. More...
	printToStdout (string $part=self::DEFAULT_BLOCK, bool $has_tabs=true, bool $skip_main_menu=false)
	setTreeFlatIcon (string $a_link, string $a_mode)
	Sets a tree or flat icon. More...
	addAdminPanelToolbar (ilToolbarGUI $toolbar, bool $is_bottom_panel=true, bool $has_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="DEFAULT")
	setVariable (string $variable, $value='')
	Sets the given variable to the given value. More...
	setCurrentBlock (string $part="DEFAULT")
	Sets the template to the given block. More...
	touchBlock (string $block)
	overwrites ITX::touchBlock. More...
	parseCurrentBlock (string $block_name="DEFAULT")
	Parses the given block. More...
	addBlockFile (string $var, string $block, string $template_name, ?string $in_module=null)
	overwrites ITX::addBlockFile More...
	blockExists (string $block_name)
	check if block exists in actual template More...
Public Member Functions inherited from ILIAS\UICore\GlobalTemplate
	addAdminPanelToolbar (\ilToolbarGUI $toolbar, bool $is_bottom_panel=true, bool $has_arrow=false)
	Add admin panel commands as toolbar. More...

Protected Member Functions
	fillJavascriptFile (string $file, string $vers)

Protected Attributes
string	$tree_flat_link = ""
string	$page_form_action = ""
array	$permanent_link = []
bool	$standard_template_loaded = false
ilTemplate	$template
array	$on_load_code
string	$body_class
string	$icon_path
bool	$enable_fileupload = null
string	$left_content = ""
string	$left_nav_content = ""
string	$right_content = ""
string	$main_content = ""
string	$login_target_par = ""
string	$tplIdentifier = ""
string	$tree_flat_mode = ""
string	$icon_desc = ""
ILIAS HTTP Services	$http
ILIAS Refinery Factory	$refinery
string	$main_menu
string	$main_menu_spacer
array	$message = []
array	$js_files = [0 => "assets/js/Basic.js"]
array	$js_files_vp = ["assets/js/Basic.js" => true]
array	$js_files_batch = ["assets/js/Basic.js" => 1]
array	$css_files = []
	Stores CSS-files to be included. More...
array	$inline_css = []
	Stores CSS to be included directly. More...
string	$header_page_title = ""
string	$title = ""
string	$title_desc = ""
array	$title_alerts = []
string	$header_action
string	$tabs_html = ""
string	$sub_tabs_html = ""
ilToolbarGUI	$admin_panel_commands_toolbar = null
bool	$admin_panel_arrow = null
bool	$admin_panel_bottom = null

Static Protected Attributes
static array	$message_types

Private Member Functions
	getMainMenu ()
	fillMainMenu ()
	initHelp ()
	fillMessage ()
	Fill message area. More...
	getMessageTextForType (string $m)
	fillOnLoadCode ()
	Fill add on load code. More...
	fillBodyClass ()
	fillInlineCss ()
	Fill in the inline css. More...
	fillNewContentStyle ()
	Fill Content Style. More...
	fillHeader ()
	Fill header. More...
	getHeaderActionMenu ()
	Get header action menu. More...
	fillTabs ()
	getTabsHTML ()
	fillLeftNav ()
	Fill left navigation frame. More...
	setCenterColumnClass ()
	fillMainContent ()
	fillLeftContent ()
	fillRightContent ()
	fillToolbar ()
	fillContentLanguage ()
	Add current user language to meta tags. More...
	fillWindowTitle ()
	fillPageFormAction ()
	fillSideIcons ()
	Fill side icons (upper icon, tree icon, web folder icon) More...
	fillAdminPanel ()
	Put admin panel into template: More...

Private Attributes
ilLanguage	$lng
ilLocatorGUI	$locator
ilTabsGUI	$tabs
ilToolbarGUI	$toolbar
ilSetting	$settings
ilComponentFactory	$component_factory

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

Definition at line 21 of file class.ilDataCollectionGlobalTemplate.php.

Constructor & Destructor Documentation

__construct()

ilDataCollectionGlobalTemplate::__construct	(	string	$file,
		bool	$flag1,
		bool	$flag2,
		string	$in_module = "",
		string	$vars = ilGlobalTemplateInterface::DEFAULT_BLOCK,
		bool	$plugin = false,
		bool	$a_use_cache = true
	)

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

References $DIC, XapiProxy\$plugin, ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\locator(), setBodyClass(), ILIAS\Repository\settings(), ILIAS\Repository\tabs(), and ILIAS\Repository\toolbar().

      {
        global $DIC;

        $this->setBodyClass("std");
        $this->lng = $DIC->language();
        $this->http = $DIC->http();
        $this->locator = $DIC["ilLocator"];
        $this->tabs = $DIC->tabs();
        $this->toolbar = $DIC->toolbar();
        $this->settings = $DIC->settings();
        $this->component_factory = $DIC["component.factory"];

        $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()

ilDataCollectionGlobalTemplate::addAdminPanelToolbar	(	ilToolbarGUI	$toolbar,
		bool	$is_bottom_panel = true,
		bool	$has_arrow = false
	)

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

References $toolbar.

     : void {
        $this->admin_panel_commands_toolbar = $toolbar;
        $this->admin_panel_arrow = $has_arrow;
        $this->admin_panel_bottom = $is_bottom_panel;
    }

addBlockFile()

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

overwrites ITX::addBlockFile

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 1268 of file class.ilDataCollectionGlobalTemplate.php.

Referenced by loadStandardTemplate().

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

Here is the caller graph for this function:

addCss()

ilDataCollectionGlobalTemplate::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 360 of file class.ilDataCollectionGlobalTemplate.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()

ilDataCollectionGlobalTemplate::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 374 of file class.ilDataCollectionGlobalTemplate.php.

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

addJavaScript()

ilDataCollectionGlobalTemplate::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 201 of file class.ilDataCollectionGlobalTemplate.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-min.js"))
        ) {
            $a_batch = 0;
        }

        if (!in_array($a_js_file, $this->js_files)) {
            $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()

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

Add on load code.

Implements ILIAS\UICore\GlobalTemplate.

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

                                                                   : void
    {
        // three batches currently
        if ($a_batch < 1 || $a_batch > 3) {
            $a_batch = 2;
        }
        $this->on_load_code[$a_batch][] = $a_code;
    }

blockExists()

ilDataCollectionGlobalTemplate::blockExists

(

string

$block_name

)

check if block exists in actual template

Parameters

string

$block_name

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 1273 of file class.ilDataCollectionGlobalTemplate.php.

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

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

Here is the caller graph for this function:

clearHeader()

ilDataCollectionGlobalTemplate::clearHeader

(

)

Clear header.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 522 of file class.ilDataCollectionGlobalTemplate.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()

ilDataCollectionGlobalTemplate::fillAdminPanel ( )

private

Put admin panel into template:

• creation selector
• admin view on/off button

Definition at line 1159 of file class.ilDataCollectionGlobalTemplate.php.

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

Referenced by getSpecial(), and printToStdout().

                                     : void
    {
        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"), $this->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"), $this->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()

ilDataCollectionGlobalTemplate::fillBodyClass ( )

private

Definition at line 422 of file class.ilDataCollectionGlobalTemplate.php.

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

Referenced by getSpecial(), and printToStdout().

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

ilDataCollectionGlobalTemplate::fillContentLanguage ( )

private

Add current user language to meta tags.

Definition at line 841 of file class.ilDataCollectionGlobalTemplate.php.

References ILIAS\Repository\lng(), and setVariable().

Referenced by getSpecial(), and printToStdout().

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

Here is the call graph for this function:

Here is the caller graph for this function:

fillCssFiles()

ilDataCollectionGlobalTemplate::fillCssFiles

(

bool

$a_force = false

)

Fill in the css file tags.

Parameters

bool

$a_force

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

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

Referenced by getSpecial(), and printToStdout().

                                                       : 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 (is_file($filename) || $a_force) {
                $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()

ilDataCollectionGlobalTemplate::fillHeader ( )

private

Fill header.

Definition at line 557 of file class.ilDataCollectionGlobalTemplate.php.

References $icon_desc, getHeaderActionMenu(), ILIAS\Repository\lng(), and ilUtil\stripScriptHTML().

Referenced by getSpecial(), and printToStdout().

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

        $header = false;

        if ($this->icon_path != "") {
            $header_tpl->setCurrentBlock("header_image");
            if ($this->icon_desc != "") {
                $header_tpl->setVariable("IMAGE_DESC", $this->lng->txt("icon") . " " . $this->icon_desc);
                $header_tpl->setVariable("IMAGE_ALT", $this->lng->txt("icon") . " " . $this->icon_desc);
            }

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

        $header = $this->getHeaderActionMenu();
        if ($header) {
            $header_tpl->setCurrentBlock("head_action_inner");
            $header_tpl->setVariable("HEAD_ACTION", $header);
            $header_tpl->parseCurrentBlock();
            $header_tpl->touchBlock("head_action");
        }

        if (count($this->title_alerts)) {
            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();
            }
        }

        $this->template->setVariable("IL_HEADER", $header_tpl->get());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

fillInlineCss()

ilDataCollectionGlobalTemplate::fillInlineCss ( )

private

Fill in the inline css.

Definition at line 434 of file class.ilDataCollectionGlobalTemplate.php.

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

Referenced by getSpecial(), and printToStdout().

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

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

protected

Definition at line 330 of file class.ilDataCollectionGlobalTemplate.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()

ilDataCollectionGlobalTemplate::fillJavaScriptFiles

(

bool

$a_force = false

)

Probably adds javascript files.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 277 of file class.ilDataCollectionGlobalTemplate.php.

References blockExists(), fillJavascriptFile(), and ILIAS_VERSION.

Referenced by getSpecial(), and printToStdout().

                                                              : void
    {
        $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 (is_file($file) || substr($file, 0, 4) == "http" || substr(
                            $file,
                            0,
                            2
                        ) == "//" || $a_force) {
                            $this->fillJavascriptFile($file, $vers);
                        } else {
                            if (substr($file, 0, 2) == './') { // #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()

ilDataCollectionGlobalTemplate::fillLeftContent ( )

private

Definition at line 795 of file class.ilDataCollectionGlobalTemplate.php.

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

Referenced by getSpecial(), and printToStdout().

                                      : void
    {
        if (trim($this->left_content) != "") {
            $this->setCurrentBlock("left_column");
            $this->setVariable("LEFT_CONTENT", $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()

ilDataCollectionGlobalTemplate::fillLeftNav ( )

private

Fill left navigation frame.

Definition at line 736 of file class.ilDataCollectionGlobalTemplate.php.

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

Referenced by getSpecial(), and printToStdout().

                                  : void
    {
        if (trim($this->left_nav_content) != "") {
            $this->setCurrentBlock("left_nav");
            $this->setVariable("LEFT_NAV_CONTENT", $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()

ilDataCollectionGlobalTemplate::fillMainContent ( )

private

Definition at line 788 of file class.ilDataCollectionGlobalTemplate.php.

References setVariable().

Referenced by getSpecial(), and printToStdout().

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

Here is the call graph for this function:

Here is the caller graph for this function:

fillMainMenu()

ilDataCollectionGlobalTemplate::fillMainMenu ( )

private

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

Referenced by getSpecial(), and printToStdout().

                                   : void
    {
    }

Here is the caller graph for this function:

fillMessage()

ilDataCollectionGlobalTemplate::fillMessage ( )

private

Fill message area.

Definition at line 139 of file class.ilDataCollectionGlobalTemplate.php.

References $out, $txt, ilSession\clear(), ilSession\get(), getMessageTextForType(), ilUtil\getSystemMessageHTML(), ilSession\has(), ILIAS\FileDelivery\http(), and setVariable().

Referenced by getSpecial(), and printToStdout().

                                  : void
    {
        $out = "";

        foreach (self::$message_types as $m) {
            $txt = $this->getMessageTextForType($m);

            if ($txt != "") {
                $out .= ilUtil::getSystemMessageHTML($txt, $m);
            }

            $request = $this->http->request();
            $accept_header = $request->getHeaderLine('Accept');
            if (ilSession::has($m) && ilSession::get($m) && ($accept_header !== 'application/json')) {
                ilSession::clear($m);
            }
        }

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

Here is the call graph for this function:

Here is the caller graph for this function:

fillNewContentStyle()

ilDataCollectionGlobalTemplate::fillNewContentStyle ( )

private

Fill Content Style.

Definition at line 449 of file class.ilDataCollectionGlobalTemplate.php.

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

Referenced by getSpecial(), and printToStdout().

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

ilDataCollectionGlobalTemplate::fillOnLoadCode ( )

private

Fill add on load code.

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

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

Referenced by getSpecial(), and printToStdout().

                                     : void
    {
        for ($i = 1; $i <= 3; $i++) {
            if (is_array($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()

ilDataCollectionGlobalTemplate::fillPageFormAction ( )

private

Definition at line 877 of file class.ilDataCollectionGlobalTemplate.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:

fillRightContent()

ilDataCollectionGlobalTemplate::fillRightContent ( )

private

Definition at line 808 of file class.ilDataCollectionGlobalTemplate.php.

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

Referenced by getSpecial(), and printToStdout().

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

Here is the call graph for this function:

Here is the caller graph for this function:

fillSideIcons()

ilDataCollectionGlobalTemplate::fillSideIcons ( )

private

Fill side icons (upper icon, tree icon, web folder icon)

Definition at line 1102 of file class.ilDataCollectionGlobalTemplate.php.

References ilFrameTargetInfo\_getFrame(), ilUtil\getImagePath(), ILIAS\Repository\lng(), parseCurrentBlock(), setCurrentBlock(), ILIAS\Repository\settings(), setVariable(), and touchBlock().

Referenced by getSpecial(), and printToStdout().

                                    : void
    {
        // tree/flat icon
        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);
            if ($this->settings->get("tree_frame") == "right") {
                $this->setVariable("IMG_TREE", ilUtil::getImagePath("standard/icon_sidebar_on.svg"));
                $this->setVariable("RIGHT", "Right");
            } else {
                $this->setVariable("IMG_TREE", ilUtil::getImagePath("standard/icon_sidebar_on.svg"));
            }
            $this->setVariable("ALT_TREE", $this->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()

ilDataCollectionGlobalTemplate::fillTabs ( )

private

Definition at line 677 of file class.ilDataCollectionGlobalTemplate.php.

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

Referenced by getSpecial(), and printToStdout().

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

ilDataCollectionGlobalTemplate::fillToolbar ( )

private

Definition at line 824 of file class.ilDataCollectionGlobalTemplate.php.

References parseCurrentBlock(), setCurrentBlock(), setVariable(), and ILIAS\Repository\toolbar().

Referenced by getSpecial(), and printToStdout().

                                  : void
    {
        $thtml = $this->toolbar->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()

ilDataCollectionGlobalTemplate::fillWindowTitle ( )

private

Definition at line 847 of file class.ilDataCollectionGlobalTemplate.php.

References ILIAS\Repository\settings(), setVariable(), and ilUtil\stripScriptHTML().

Referenced by getSpecial(), and printToStdout().

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

        if ($this->settings->get('short_inst_name') != "") {
            $this->setVariable(
                "WINDOW_TITLE",
                $this->settings->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()

ilDataCollectionGlobalTemplate::get

(

string

$part = "DEFAULT"

)

Parameters

string

Returns

string

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 1243 of file class.ilDataCollectionGlobalTemplate.php.

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

getHeaderActionMenu()

ilDataCollectionGlobalTemplate::getHeaderActionMenu ( )

private

Get header action menu.

Definition at line 618 of file class.ilDataCollectionGlobalTemplate.php.

References $header_action.

Referenced by fillHeader().

                                          : string
    {
        return $this->header_action;
    }

Here is the caller graph for this function:

getMainMenu()

ilDataCollectionGlobalTemplate::getMainMenu ( )

private

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

Referenced by getSpecial(), and printToStdout().

                                  : void
    {
    }

Here is the caller graph for this function:

getMessageTextForType()

ilDataCollectionGlobalTemplate::getMessageTextForType ( string  $m )

private

Definition at line 162 of file class.ilDataCollectionGlobalTemplate.php.

References $txt, ilSession\get(), and ilSession\has().

Referenced by fillMessage().

                                                     : string
    {
        $txt = "";
        if (ilSession::has($m) && ilSession::get($m) != "") {
            $txt = ilSession::get($m);
        } else {
            if (isset($this->message[$m])) {
                $txt = $this->message[$m];
            }
        }

        return $txt;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getOnLoadCodeForAsynch()

ilDataCollectionGlobalTemplate::getOnLoadCodeForAsynch

(

)

Get js onload code for ajax calls.

Returns

string

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 239 of file class.ilDataCollectionGlobalTemplate.php.

                                            : string
    {
        $js = "";
        for ($i = 1; $i <= 3; $i++) {
            if (is_array($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()

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

Renders the page with specific elements enabled.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 917 of file class.ilDataCollectionGlobalTemplate.php.

References ilObjLanguageAccess\_saveUsages(), blockExists(), fillAdminPanel(), fillBodyClass(), fillContentLanguage(), fillCssFiles(), fillHeader(), fillInlineCss(), fillJavaScriptFiles(), fillLeftContent(), fillLeftNav(), fillMainContent(), fillMainMenu(), fillMessage(), fillNewContentStyle(), fillOnLoadCode(), fillRightContent(), 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 ($this->blockExists("content") && $a_tabs) {
                // 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->fillLeftContent();
            $this->fillLeftNav();
            $this->fillRightContent();
            $this->fillAdminPanel();
            $this->fillToolbar();

            $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 == "DEFAULT") {
            $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()

ilDataCollectionGlobalTemplate::getTabsHTML ( )

private

Definition at line 692 of file class.ilDataCollectionGlobalTemplate.php.

References blockExists(), and ILIAS\Repository\tabs().

Referenced by getSpecial(), and printToStdout().

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

Here is the call graph for this function:

Here is the caller graph for this function:

hideFooter()

ilDataCollectionGlobalTemplate::hideFooter

(

)

Make the template hide the footer.

Implements ILIAS\UICore\GlobalTemplate.

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

References $message_types.

                                : void
    {
    }

initHelp()

ilDataCollectionGlobalTemplate::initHelp ( )

private

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

Referenced by getSpecial(), and printToStdout().

                               : void
    {
    }

Here is the caller graph for this function:

loadStandardTemplate()

ilDataCollectionGlobalTemplate::loadStandardTemplate

(

)

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

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 468 of file class.ilDataCollectionGlobalTemplate.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()

ilDataCollectionGlobalTemplate::parseCurrentBlock

(

string

$block_name = "DEFAULT"

)

Parses the given block.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 1263 of file class.ilDataCollectionGlobalTemplate.php.

Referenced by fillAdminPanel(), fillBodyClass(), fillCssFiles(), fillInlineCss(), fillJavascriptFile(), fillLeftContent(), fillLeftNav(), fillOnLoadCode(), fillPageFormAction(), fillRightContent(), fillSideIcons(), fillToolbar(), getSpecial(), printToStdout(), and setCenterColumnClass().

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

Here is the caller graph for this function:

printToStdout()

ilDataCollectionGlobalTemplate::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 993 of file class.ilDataCollectionGlobalTemplate.php.

References XapiProxy\$plugin, XapiProxy\$resp, ilObjLanguageAccess\_saveUsages(), blockExists(), exit, fillAdminPanel(), fillBodyClass(), fillContentLanguage(), fillCssFiles(), fillHeader(), fillInlineCss(), fillJavaScriptFiles(), fillLeftContent(), fillLeftNav(), fillMainContent(), fillMainMenu(), fillMessage(), fillNewContentStyle(), fillOnLoadCode(), fillRightContent(), fillSideIcons(), fillTabs(), fillToolbar(), fillWindowTitle(), getMainMenu(), getTabsHTML(), ILIAS\UI\examples\Symbol\Glyph\Header\header(), ILIAS\FileDelivery\http(), ilYuiUtil\initDom(), initHelp(), ilUIHookPluginGUI\KEEP, ILIAS\Filesystem\Stream\Streams\ofString(), parseCurrentBlock(), setCenterColumnClass(), and setCurrentBlock().

     : void {
        switch ($this->http->request()->getHeaderLine('Accept')) {
            case 'application/json':
                $string = json_encode([
                    self::MESSAGE_TYPE_SUCCESS => is_null($this->message[self::MESSAGE_TYPE_FAILURE]),
                    'message' => '',
                ]);
                $stream = \ILIAS\Filesystem\Stream\Streams::ofString($string);
                $this->http->saveResponse($this->http->response()->withBody($stream));
                $this->http->sendResponse();
                exit;
            default:
                // 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");

                $this->fillMessage();

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

                    // to get also the js files for the main menu
                    if (!$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->fillContentLanguage();
                    $this->fillWindowTitle();

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

                    $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 == "DEFAULT" or is_bool($part)) {
                    $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.
                foreach ($this->component_factory->getActivePluginsInSlot("uihk") as $plugin) {
                    $gui_class = $plugin->getUIClassInstance();

                    $resp = $gui_class->getHTML(
                        "",
                        "template_show",
                        ["tpl_id" => $this->tplIdentifier, "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();

                print $html;

                break;
        }
    }

Here is the call graph for this function:

printToString()

ilDataCollectionGlobalTemplate::printToString

(

)

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

Implements ILIAS\UICore\GlobalTemplate.

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

                                   : string
    {
        throw new ilException('not implemented');
    }

resetHeaderBlock()

ilDataCollectionGlobalTemplate::resetHeaderBlock

(

bool

$a_reset_header_action = true

)

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

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 1212 of file class.ilDataCollectionGlobalTemplate.php.

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

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

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

Here is the call graph for this function:

resetJavascript()

ilDataCollectionGlobalTemplate::resetJavascript

(

)

Reset javascript files.

Implements ILIAS\UICore\GlobalTemplate.

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

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

setAlertProperties()

ilDataCollectionGlobalTemplate::setAlertProperties

(

array

$alerts

)

Set alert properties.

Parameters

array<int,array>

$alerts

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 514 of file class.ilDataCollectionGlobalTemplate.php.

Referenced by clearHeader(), and resetHeaderBlock().

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

Here is the caller graph for this function:

setBodyClass()

ilDataCollectionGlobalTemplate::setBodyClass

(

string

$a_class = ""

)

Sets the body-tags class.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 417 of file class.ilDataCollectionGlobalTemplate.php.

Referenced by __construct().

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

Here is the caller graph for this function:

setCenterColumnClass()

ilDataCollectionGlobalTemplate::setCenterColumnClass ( )

private

Definition at line 754 of file class.ilDataCollectionGlobalTemplate.php.

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

Referenced by getSpecial(), and printToStdout().

                                           : void
    {
        if (!$this->blockExists("center_col_width")) {
            return;
        }
        $center_column_class = "";
        if (trim($this->right_content) != "" && trim($this->left_content) != "") {
            $center_column_class = "two_side_col";
        } else {
            if (trim($this->right_content) != "" || trim($this->left_content) != "") {
                $center_column_class = "one_side_col";
            }
        }

        switch ($center_column_class) {
            case "one_side_col":
                $center_column_class = "col-sm-9";
                break;
            case "two_side_col":
                $center_column_class = "col-sm-6";
                break;
            default:
                $center_column_class = "col-sm-12";
                break;
        }
        if (trim($this->left_content) != "") {
            $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()

ilDataCollectionGlobalTemplate::setContent

(

string

$a_html

)

Sets content for standard template.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 710 of file class.ilDataCollectionGlobalTemplate.php.

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

setCurrentBlock()

ilDataCollectionGlobalTemplate::setCurrentBlock

(

string

$part = "DEFAULT"

)

Sets the template to the given block.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 1253 of file class.ilDataCollectionGlobalTemplate.php.

Referenced by fillAdminPanel(), fillBodyClass(), fillCssFiles(), fillInlineCss(), fillJavascriptFile(), fillLeftContent(), fillLeftNav(), fillOnLoadCode(), fillPageFormAction(), fillRightContent(), fillSideIcons(), fillToolbar(), getSpecial(), printToStdout(), and setCenterColumnClass().

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

Here is the caller graph for this function:

setDescription()

ilDataCollectionGlobalTemplate::setDescription

(

string

$a_descr

)

Sets description below title in standard template.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 503 of file class.ilDataCollectionGlobalTemplate.php.

Referenced by clearHeader(), and resetHeaderBlock().

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

Here is the caller graph for this function:

setFileUploadRefId()

ilDataCollectionGlobalTemplate::setFileUploadRefId

(

int

$a_ref_id

)

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

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 1229 of file class.ilDataCollectionGlobalTemplate.php.

Referenced by resetHeaderBlock().

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

Here is the caller graph for this function:

setHeaderActionMenu()

ilDataCollectionGlobalTemplate::setHeaderActionMenu

(

string

$a_header

)

Set header action menu.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 539 of file class.ilDataCollectionGlobalTemplate.php.

Referenced by resetHeaderBlock().

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

Here is the caller graph for this function:

setHeaderPageTitle()

ilDataCollectionGlobalTemplate::setHeaderPageTitle

(

string

$a_title

)

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

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 549 of file class.ilDataCollectionGlobalTemplate.php.

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

setLeftContent()

ilDataCollectionGlobalTemplate::setLeftContent

(

string

$a_html

)

Sets content of left column.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 720 of file class.ilDataCollectionGlobalTemplate.php.

                                                  : void
    {
        $this->left_content = $a_html;
    }

setLeftNavContent()

ilDataCollectionGlobalTemplate::setLeftNavContent

(

string

$a_content

)

Sets content of left navigation column.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 728 of file class.ilDataCollectionGlobalTemplate.php.

                                                        : void
    {
        $this->left_nav_content = $a_content;
    }

setLocator()

ilDataCollectionGlobalTemplate::setLocator

(

)

Insert locator.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 630 of file class.ilDataCollectionGlobalTemplate.php.

References ILIAS\Repository\locator(), and setVariable().

                                : void
    {
        $html = "";

        include_once("./components/ILIAS/UIComponent/classes/class.ilUIHookProcessor.php");
        $html = $this->locator->getHTML();
        $uip = new ilUIHookProcessor(
            "components/ILIAS/Locator",
            "main_locator",
            ["locator_gui" => $this->locator, "html" => $html]
        );
        $html = $uip->getHTML($html);

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

Here is the call graph for this function:

setLoginTargetPar()

ilDataCollectionGlobalTemplate::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 897 of file class.ilDataCollectionGlobalTemplate.php.

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

setOnScreenMessage()

ilDataCollectionGlobalTemplate::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 124 of file class.ilDataCollectionGlobalTemplate.php.

References ilSession\set().

                                                                                         : void
    {
        if (!in_array($type, self::$message_types) || $a_txt == "") {
            return;
        }
        if (!$a_keep) {
            $this->message[$type] = $a_txt;
        } else {
            ilSession::set($type, $a_txt);
        }
    }

Here is the call graph for this function:

setPageFormAction()

ilDataCollectionGlobalTemplate::setPageFormAction

(

string

$a_action

)

Sets the pages form action.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 872 of file class.ilDataCollectionGlobalTemplate.php.

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

setPermanentLink()

ilDataCollectionGlobalTemplate::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 1193 of file class.ilDataCollectionGlobalTemplate.php.

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

setRightContent()

ilDataCollectionGlobalTemplate::setRightContent

(

string

$a_html

)

Sets content of right column.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 749 of file class.ilDataCollectionGlobalTemplate.php.

                                                   : void
    {
        $this->right_content = $a_html;
    }

setSubTabs()

ilDataCollectionGlobalTemplate::setSubTabs

(

string

$a_tabs_html

)

sets subtabs in standard template

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 672 of file class.ilDataCollectionGlobalTemplate.php.

References setVariable().

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

Here is the call graph for this function:

setTabs()

ilDataCollectionGlobalTemplate::setTabs

(

string

$a_tabs_html

)

sets tabs in standard template

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 658 of file class.ilDataCollectionGlobalTemplate.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()

ilDataCollectionGlobalTemplate::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 497 of file class.ilDataCollectionGlobalTemplate.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()

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

set title icon

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 508 of file class.ilDataCollectionGlobalTemplate.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()

ilDataCollectionGlobalTemplate::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 1127 of file class.ilDataCollectionGlobalTemplate.php.

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

setVariable()

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

Sets the given variable to the given value.

Parameters

mixed

$value

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 1248 of file class.ilDataCollectionGlobalTemplate.php.

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

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

Here is the caller graph for this function:

touchBlock()

ilDataCollectionGlobalTemplate::touchBlock

(

string

$block

)

overwrites ITX::touchBlock.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 1258 of file class.ilDataCollectionGlobalTemplate.php.

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

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

Here is the caller graph for this function:

Field Documentation

$admin_panel_arrow

bool ilDataCollectionGlobalTemplate::$admin_panel_arrow = null

protected

Definition at line 1141 of file class.ilDataCollectionGlobalTemplate.php.

$admin_panel_bottom

bool ilDataCollectionGlobalTemplate::$admin_panel_bottom = null

protected

Definition at line 1142 of file class.ilDataCollectionGlobalTemplate.php.

$admin_panel_commands_toolbar

ilToolbarGUI ilDataCollectionGlobalTemplate::$admin_panel_commands_toolbar = null

protected

Definition at line 1140 of file class.ilDataCollectionGlobalTemplate.php.

Referenced by fillAdminPanel().

$body_class

string ilDataCollectionGlobalTemplate::$body_class

protected

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

$component_factory

ilComponentFactory ilDataCollectionGlobalTemplate::$component_factory

private

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

$css_files

array ilDataCollectionGlobalTemplate::$css_files = []

protected

Stores CSS-files to be included.

Definition at line 351 of file class.ilDataCollectionGlobalTemplate.php.

$enable_fileupload

bool ilDataCollectionGlobalTemplate::$enable_fileupload = null

protected

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

$header_action

string ilDataCollectionGlobalTemplate::$header_action

protected

Definition at line 495 of file class.ilDataCollectionGlobalTemplate.php.

Referenced by getHeaderActionMenu().

$header_page_title

string ilDataCollectionGlobalTemplate::$header_page_title = ""

protected

Definition at line 491 of file class.ilDataCollectionGlobalTemplate.php.

$http

ILIAS HTTP Services ilDataCollectionGlobalTemplate::$http

protected

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

$icon_desc

string ilDataCollectionGlobalTemplate::$icon_desc = ""

protected

Definition at line 45 of file class.ilDataCollectionGlobalTemplate.php.

Referenced by fillHeader().

$icon_path

string ilDataCollectionGlobalTemplate::$icon_path

protected

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

$inline_css

array ilDataCollectionGlobalTemplate::$inline_css = []

protected

Stores CSS to be included directly.

Definition at line 355 of file class.ilDataCollectionGlobalTemplate.php.

$js_files

array ilDataCollectionGlobalTemplate::$js_files = [0 => "assets/js/Basic.js"]

protected

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

$js_files_batch

array ilDataCollectionGlobalTemplate::$js_files_batch = ["assets/js/Basic.js" => 1]

protected

Definition at line 196 of file class.ilDataCollectionGlobalTemplate.php.

$js_files_vp

array ilDataCollectionGlobalTemplate::$js_files_vp = ["assets/js/Basic.js" => true]

protected

Definition at line 191 of file class.ilDataCollectionGlobalTemplate.php.

$left_content

string ilDataCollectionGlobalTemplate::$left_content = ""

protected

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

$left_nav_content

string ilDataCollectionGlobalTemplate::$left_nav_content = ""

protected

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

$lng

ilLanguage ilDataCollectionGlobalTemplate::$lng

private

Definition at line 23 of file class.ilDataCollectionGlobalTemplate.php.

$locator

ilLocatorGUI ilDataCollectionGlobalTemplate::$locator

private

Definition at line 24 of file class.ilDataCollectionGlobalTemplate.php.

$login_target_par

string ilDataCollectionGlobalTemplate::$login_target_par = ""

protected

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

$main_content

string ilDataCollectionGlobalTemplate::$main_content = ""

protected

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

$main_menu

string ilDataCollectionGlobalTemplate::$main_menu

protected

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

$main_menu_spacer

string ilDataCollectionGlobalTemplate::$main_menu_spacer

protected

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

$message

array ilDataCollectionGlobalTemplate::$message = []

protected

Definition at line 122 of file class.ilDataCollectionGlobalTemplate.php.

$message_types

array ilDataCollectionGlobalTemplate::$message_types

staticprotected

Initial value:

= [
            self::MESSAGE_TYPE_FAILURE,
            self::MESSAGE_TYPE_INFO,
            self::MESSAGE_TYPE_SUCCESS,
            self::MESSAGE_TYPE_QUESTION,
        ]

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

Referenced by hideFooter().

$on_load_code

array ilDataCollectionGlobalTemplate::$on_load_code

protected

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

$page_form_action

string ilDataCollectionGlobalTemplate::$page_form_action = ""

protected

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

$permanent_link

array ilDataCollectionGlobalTemplate::$permanent_link = []

protected

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

$refinery

ILIAS Refinery Factory ilDataCollectionGlobalTemplate::$refinery

protected

Definition at line 47 of file class.ilDataCollectionGlobalTemplate.php.

$right_content

string ilDataCollectionGlobalTemplate::$right_content = ""

protected

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

$settings

ilSetting ilDataCollectionGlobalTemplate::$settings

private

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

$standard_template_loaded

bool ilDataCollectionGlobalTemplate::$standard_template_loaded = false

protected

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

$sub_tabs_html

string ilDataCollectionGlobalTemplate::$sub_tabs_html = ""

protected

Definition at line 653 of file class.ilDataCollectionGlobalTemplate.php.

$tabs

ilTabsGUI ilDataCollectionGlobalTemplate::$tabs

private

Definition at line 25 of file class.ilDataCollectionGlobalTemplate.php.

$tabs_html

string ilDataCollectionGlobalTemplate::$tabs_html = ""

protected

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

$template

ilTemplate ilDataCollectionGlobalTemplate::$template

protected

Definition at line 33 of file class.ilDataCollectionGlobalTemplate.php.

$title

string ilDataCollectionGlobalTemplate::$title = ""

protected

Definition at line 492 of file class.ilDataCollectionGlobalTemplate.php.

$title_alerts

array ilDataCollectionGlobalTemplate::$title_alerts = []

protected

Definition at line 494 of file class.ilDataCollectionGlobalTemplate.php.

$title_desc

string ilDataCollectionGlobalTemplate::$title_desc = ""

protected

Definition at line 493 of file class.ilDataCollectionGlobalTemplate.php.

$toolbar

ilToolbarGUI ilDataCollectionGlobalTemplate::$toolbar

private

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

Referenced by addAdminPanelToolbar().

$tplIdentifier

string ilDataCollectionGlobalTemplate::$tplIdentifier = ""

protected

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

$tree_flat_link

string ilDataCollectionGlobalTemplate::$tree_flat_link = ""

protected

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

$tree_flat_mode

string ilDataCollectionGlobalTemplate::$tree_flat_mode = ""

protected

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

---

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

• components/ILIAS/DataCollection/classes/class.ilDataCollectionGlobalTemplate.php