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

Inheritance diagram for LTI\ilGlobalTemplate:

Collaboration diagram for LTI\ilGlobalTemplate:

Public Member Functions
	__construct (string $file, bool $flag1, bool $flag2, string $in_module='', string $vars="DEFAULT", bool $plugin=false, bool $a_use_cache=false)

Public Member Functions inherited from ilGlobalTemplate
	__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...

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

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

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

	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 ilGlobalTemplateInterface
	printToString ()
	Use this method to get the finally rendered page as string. More...

Additional Inherited Members
Data Fields inherited from ilGlobalTemplateInterface
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'

Protected Member Functions inherited from ilGlobalTemplate
	fillFooter ()

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

	fillLightbox ()

	fillAdminPanel ()

	fillPermanentLink ()

	variableExists (string $a_variablename)

Protected Attributes inherited from ilGlobalTemplate
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 = ''

Detailed Description

special template class to simplify handling of ITX/PEAR

Author: Stefan Schneider schne.nosp@m.ider.nosp@m.@hrz..nosp@m.uni-.nosp@m.marbu.nosp@m.rg.d.nosp@m.e

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

LTI\ilGlobalTemplate::__construct	(	string	$file,
		bool	$flag1,
		bool	$flag2,
		string	$in_module = `''`,
		string	$vars = `"DEFAULT"`,
		bool	$plugin = `false`,
		bool	$a_use_cache = `false`
	)

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

References ilGlobalTemplate\$in_module, XapiProxy\$plugin, and ILIAS\GlobalScreen\Provider\__construct().

       {
         parent::__construct(
             $file,
             $flag1,
             $flag2,
             $in_module,
             $vars,
             $plugin,
             $a_use_cache
         );
     }

Here is the call graph for this function:

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

Services/LTI/classes/class.ilGlobalTemplate.php

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()