ilGlobalTemplateInterface Interface Reference

Created by PhpStorm. More...

Inheritance diagram for ilGlobalTemplateInterface:

Collaboration diagram for ilGlobalTemplateInterface:

Public Member Functions
	hideFooter ()
	Make the template hide the footer. More...
	setOnScreenMessage ($a_type, $a_txt, $a_keep=false)
	Set a message to be displayed to the user. More...
	addJavaScript ($a_js_file, $a_add_version_parameter=true, $a_batch=2)
	Add a javascript file that should be included in the header. More...
	addOnLoadCode ($a_code, $a_batch=2)
	Add on load code. More...
	getOnLoadCodeForAsynch ()
	Get js onload code for ajax calls. More...
	resetJavascript ()
	Reset javascript files. More...
	fillJavaScriptFiles ($a_force=false)
	addCss ($a_css_file, $media="screen")
	Add a css file that should be included in the header. More...
	addInlineCss ($a_css, $media="screen")
	Add a css file that should be included in the header. More...
	setBodyClass ($a_class="")
	loadStandardTemplate ()
	This loads the standard template "tpl.adm_content.html" and "tpl.statusline.html" the CONTENT and STATUSLINE placeholders if they are not already loaded. More...
	setTitle ($a_title, $hidden=false)
	Sets title in standard template. More...
	setDescription ($a_descr)
	Sets descripton below title in standard template. More...
	setTitleIcon ($a_icon_path, $a_icon_desc="")
	set title icon More...
	setAlertProperties (array $a_props)
	Set alert properties. More...
	clearHeader ()
	Clear header. More...
	setHeaderActionMenu ($a_header)
	Set header action menu. More...
	setHeaderPageTitle ($a_title)
	Sets the title of the page (for browser window). More...
	setLocator ()
	Insert locator. More...
	setTabs ($a_tabs_html)
	sets tabs in standard template More...
	setSubTabs ($a_tabs_html)
	sets subtabs in standard template More...
	setContent ($a_html)
	Sets content for standard template. More...
	setLeftContent ($a_html)
	Sets content of left column. More...
	setLeftNavContent ($a_content)
	Sets content of left navigation column. More...
	setRightContent ($a_html)
	Sets content of right column. More...
	setPageFormAction ($a_action)
	setLoginTargetPar ($a_val)
	Set target parameter for login (public sector). More...
	getSpecial ($part="DEFAULT", $add_error_mess=false, $handle_referer=false, $add_ilias_footer=false, $add_standard_elements=false, $a_main_menu=true, $a_tabs=true)
	printToStdout ($part="DEFAULT", $a_fill_tabs=true, $a_skip_main_menu=false)
	printToString ()
	Use this method to get the finally rendered page as string. More...
	setTreeFlatIcon ($a_link, $a_mode)
	set tree/flat icon More...
	addLightbox ($a_html, $a_id)
	Add lightbox html. More...
	addAdminPanelToolbar (ilToolbarGUI $toolb, $a_bottom_panel=true, $a_arrow=false)
	Add admin panel commands as toolbar. More...
	setPermanentLink ($a_type, $a_id, $a_append="", $a_target="", $a_title="")
	resetHeaderBlock ($a_reset_header_action=true)
	Reset all header properties: title, icon, description, alerts, action menu. More...
	enableDragDropFileUpload ($a_ref_id)
	Enables the file upload into this object by dropping a file. More...
	get ($part="DEFAULT")
	setVariable ($variable, $value='')
	setCurrentBlock ($part="DEFAULT")
	public More...
	touchBlock ($block)
	overwrites ITX::touchBlock. More...
	parseCurrentBlock ($part="DEFAULT")
	Überladene Funktion, die auf den aktuelle Block vorher noch ein replace ausführt. More...
	addBlockFile ($var, $block, $tplname, $in_module=false)
	overwrites ITX::addBlockFile More...
	blockExists ($a_blockname)
	check if block exists in actual template More...

Detailed Description

Created by PhpStorm.

User: fschmid Date: 2019-03-18 Time: 11:22 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

Version

$Id$

Definition at line 16 of file interface.ilGlobalTemplateInterface.php.

Member Function Documentation

addAdminPanelToolbar()

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

Add admin panel commands as toolbar.

Parameters

ilToolbarGUI	$toolb
bool	$a_top_only

Implemented in ilDataCollectionGlobalTemplate, ilGlobalTemplate, ilRTEGlobalTemplate, ilCOPageGlobalTemplate, and ilGlobalPageTemplate.

addBlockFile()

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

overwrites ITX::addBlockFile

public

Parameters

	string
	string
string	$tplname	template name
boolean	$in_module	should be set to true, if template file is in module subdirectory

Returns

boolean/string

Implemented in ilDataCollectionGlobalTemplate, ilGlobalTemplate, ilRTEGlobalTemplate, ilCOPageGlobalTemplate, and ilGlobalPageTemplate.

addCss()

ilGlobalTemplateInterface::addCss	(		$a_css_file,
			$media = "screen"
	)

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

Implemented in ilDataCollectionGlobalTemplate, ilGlobalTemplate, ilCOPageGlobalTemplate, ilRTEGlobalTemplate, and ilGlobalPageTemplate.

Referenced by ilPageObjectGUI\addResourcesToTemplate(), and ILIAS\COPage\ResourcesInjector\inject().

Here is the caller graph for this function:

addInlineCss()

ilGlobalTemplateInterface::addInlineCss	(		$a_css,
			$media = "screen"
	)

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

Implemented in ilDataCollectionGlobalTemplate, ilGlobalTemplate, ilCOPageGlobalTemplate, ilRTEGlobalTemplate, and ilGlobalPageTemplate.

addJavaScript()

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

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

Implemented in ilDataCollectionGlobalTemplate, ilGlobalTemplate, ilCOPageGlobalTemplate, ilRTEGlobalTemplate, and ilGlobalPageTemplate.

Referenced by ilObjStudyProgrammeAutoMembershipsGUI\__construct(), ilOnScreenChatGUI\initializeFrontend(), ILIAS\COPage\ResourcesInjector\inject(), and assQuestionGUI\populateJavascriptFilesRequiredForWorkForm().

Here is the caller graph for this function:

addLightbox()

ilGlobalTemplateInterface::addLightbox	(		$a_html,
			$a_id
	)

Add lightbox html.

Implemented in ilDataCollectionGlobalTemplate, ilGlobalTemplate, ilRTEGlobalTemplate, ilCOPageGlobalTemplate, and ilGlobalPageTemplate.

addOnLoadCode()

ilGlobalTemplateInterface::addOnLoadCode	(		$a_code,
			$a_batch = 2
	)

Add on load code.

Implemented in ilDataCollectionGlobalTemplate, ilGlobalTemplate, ilCOPageGlobalTemplate, ilRTEGlobalTemplate, and ilGlobalPageTemplate.

Referenced by ilWikiPageGUI\initEditingJS(), ilBuddySystemGUI\initializeFrontend(), ilOnScreenChatGUI\initializeFrontend(), ILIAS\Accessibility\GlobalPageHandler\initPage(), and ILIAS\COPage\ResourcesInjector\inject().

Here is the caller graph for this function:

blockExists()

ilGlobalTemplateInterface::blockExists

(

$a_blockname

)

check if block exists in actual template

private

Parameters

string

blockname

Returns

boolean

Implemented in ilDataCollectionGlobalTemplate, ilGlobalTemplate, ilRTEGlobalTemplate, ilCOPageGlobalTemplate, and ilGlobalPageTemplate.

clearHeader()

ilGlobalTemplateInterface::clearHeader

(

)

Clear header.

Implemented in ilGlobalTemplate, ilDataCollectionGlobalTemplate, ilCOPageGlobalTemplate, ilRTEGlobalTemplate, and ilGlobalPageTemplate.

enableDragDropFileUpload()

ilGlobalTemplateInterface::enableDragDropFileUpload

(

$a_ref_id

)

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

Implemented in ilDataCollectionGlobalTemplate, ilGlobalTemplate, ilRTEGlobalTemplate, ilCOPageGlobalTemplate, and ilGlobalPageTemplate.

fillJavaScriptFiles()

ilGlobalTemplateInterface::fillJavaScriptFiles

(

$a_force = false

)

Implemented in ilGlobalPageTemplate, ilDataCollectionGlobalTemplate, ilGlobalTemplate, ilCOPageGlobalTemplate, and ilRTEGlobalTemplate.

get()

ilGlobalTemplateInterface::get

(

$part = "DEFAULT"

)

Parameters

string

Returns

string

Implemented in ilDataCollectionGlobalTemplate, ilGlobalTemplate, ilRTEGlobalTemplate, ilCOPageGlobalTemplate, and ilGlobalPageTemplate.

getOnLoadCodeForAsynch()

ilGlobalTemplateInterface::getOnLoadCodeForAsynch

(

)

Get js onload code for ajax calls.

Returns

string

Implemented in ilGlobalPageTemplate, ilDataCollectionGlobalTemplate, ilGlobalTemplate, ilCOPageGlobalTemplate, and ilRTEGlobalTemplate.

getSpecial()

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

Parameters

string

Returns

string

Implemented in ilGlobalTemplate, ilDataCollectionGlobalTemplate, ilRTEGlobalTemplate, ilCOPageGlobalTemplate, and ilGlobalPageTemplate.

hideFooter()

ilGlobalTemplateInterface::hideFooter

(

)

Make the template hide the footer.

Implemented in ilGlobalPageTemplate, ilGlobalTemplate, ilDataCollectionGlobalTemplate, ilCOPageGlobalTemplate, and ilRTEGlobalTemplate.

loadStandardTemplate()

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

Implemented in ilGlobalTemplate, ilDataCollectionGlobalTemplate, ilCOPageGlobalTemplate, ilRTEGlobalTemplate, and ilGlobalPageTemplate.

parseCurrentBlock()

ilGlobalTemplateInterface::parseCurrentBlock

(

$part = "DEFAULT"

)

Überladene Funktion, die auf den aktuelle Block vorher noch ein replace ausführt.

public

Parameters

string

Returns

string

Implemented in ilDataCollectionGlobalTemplate, ilGlobalTemplate, ilRTEGlobalTemplate, ilCOPageGlobalTemplate, and ilGlobalPageTemplate.

printToStdout()

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

Parameters

string | bool	$part
bool	$a_fill_tabs	fill template variable {TABS} with content of ilTabs
bool	$a_skip_main_menu

Implemented in ilGlobalTemplate, ilDataCollectionGlobalTemplate, ilRTEGlobalTemplate, ilCOPageGlobalTemplate, and ilGlobalPageTemplate.

printToString()

ilGlobalTemplateInterface::printToString

(

)

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

Returns

string

Implemented in ilGlobalPageTemplate, ilDataCollectionGlobalTemplate, ilCOPageGlobalTemplate, and ilRTEGlobalTemplate.

resetHeaderBlock()

ilGlobalTemplateInterface::resetHeaderBlock

(

$a_reset_header_action = true

)

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

Implemented in ilDataCollectionGlobalTemplate, ilGlobalTemplate, ilRTEGlobalTemplate, ilCOPageGlobalTemplate, and ilGlobalPageTemplate.

resetJavascript()

ilGlobalTemplateInterface::resetJavascript

(

)

Reset javascript files.

Implemented in ilDataCollectionGlobalTemplate, ilGlobalTemplate, ilCOPageGlobalTemplate, ilRTEGlobalTemplate, and ilGlobalPageTemplate.

setAlertProperties()

ilGlobalTemplateInterface::setAlertProperties

(

array

$a_props

)

Set alert properties.

Parameters

array

$a_props

Returns

void

Implemented in ilGlobalTemplate, ilDataCollectionGlobalTemplate, ilCOPageGlobalTemplate, ilRTEGlobalTemplate, and ilGlobalPageTemplate.

setBodyClass()

ilGlobalTemplateInterface::setBodyClass

(

$a_class = ""

)

Implemented in ilDataCollectionGlobalTemplate, ilGlobalTemplate, ilCOPageGlobalTemplate, ilRTEGlobalTemplate, and ilGlobalPageTemplate.

setContent()

ilGlobalTemplateInterface::setContent

(

$a_html

)

Sets content for standard template.

Implemented in ilGlobalTemplate, ilDataCollectionGlobalTemplate, ilCOPageGlobalTemplate, ilRTEGlobalTemplate, and ilGlobalPageTemplate.

setCurrentBlock()

ilGlobalTemplateInterface::setCurrentBlock

(

$part = "DEFAULT"

)

public

Parameters

string

Returns

???

Implemented in ilDataCollectionGlobalTemplate, ilGlobalTemplate, ilRTEGlobalTemplate, ilCOPageGlobalTemplate, and ilGlobalPageTemplate.

setDescription()

ilGlobalTemplateInterface::setDescription

(

$a_descr

)

Sets descripton below title in standard template.

Implemented in ilGlobalTemplate, ilDataCollectionGlobalTemplate, ilCOPageGlobalTemplate, ilRTEGlobalTemplate, and ilGlobalPageTemplate.

setHeaderActionMenu()

ilGlobalTemplateInterface::setHeaderActionMenu

(

$a_header

)

Set header action menu.

Parameters

string

$a_gui

$a_header

Implemented in ilGlobalTemplate, ilDataCollectionGlobalTemplate, ilCOPageGlobalTemplate, ilRTEGlobalTemplate, and ilGlobalPageTemplate.

setHeaderPageTitle()

ilGlobalTemplateInterface::setHeaderPageTitle

(

$a_title

)

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

Implemented in ilGlobalTemplate, ilDataCollectionGlobalTemplate, ilCOPageGlobalTemplate, ilRTEGlobalTemplate, and ilGlobalPageTemplate.

setLeftContent()

ilGlobalTemplateInterface::setLeftContent

(

$a_html

)

Sets content of left column.

Implemented in ilGlobalTemplate, ilDataCollectionGlobalTemplate, ilCOPageGlobalTemplate, ilRTEGlobalTemplate, and ilGlobalPageTemplate.

setLeftNavContent()

ilGlobalTemplateInterface::setLeftNavContent

(

$a_content

)

Sets content of left navigation column.

Implemented in ilGlobalTemplate, ilDataCollectionGlobalTemplate, ilCOPageGlobalTemplate, ilRTEGlobalTemplate, and ilGlobalPageTemplate.

setLocator()

ilGlobalTemplateInterface::setLocator

(

)

Insert locator.

Implemented in ilGlobalTemplate, ilDataCollectionGlobalTemplate, ilCOPageGlobalTemplate, ilRTEGlobalTemplate, and ilGlobalPageTemplate.

setLoginTargetPar()

ilGlobalTemplateInterface::setLoginTargetPar

(

$a_val

)

Set target parameter for login (public sector).

This is used by the main menu

Implemented in ilGlobalTemplate, ilDataCollectionGlobalTemplate, ilRTEGlobalTemplate, ilCOPageGlobalTemplate, and ilGlobalPageTemplate.

setOnScreenMessage()

ilGlobalTemplateInterface::setOnScreenMessage	(		$a_type,
			$a_txt,
			$a_keep = false
	)

Set a message to be displayed to the user.

Please use ilUtil::sendInfo(), ilUtil::sendSuccess() and ilUtil::sendFailure()

Parameters

string	$a_type	::MESSAGE_TYPE_SUCCESS, ::MESSAGE_TYPE_FAILURE,, ::MESSAGE_TYPE_QUESTION, ::MESSAGE_TYPE_INFO
string	$a_txt	The message to be sent
bool	$a_keep	Keep this message over one redirect

Implemented in ilDataCollectionGlobalTemplate, ilGlobalTemplate, ilCOPageGlobalTemplate, ilRTEGlobalTemplate, and ilGlobalPageTemplate.

setPageFormAction()

ilGlobalTemplateInterface::setPageFormAction

(

$a_action

)

Implemented in ilGlobalTemplate, ilDataCollectionGlobalTemplate, ilRTEGlobalTemplate, ilCOPageGlobalTemplate, and ilGlobalPageTemplate.

setPermanentLink()

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

Implemented in ilDataCollectionGlobalTemplate, ilGlobalTemplate, ilRTEGlobalTemplate, ilCOPageGlobalTemplate, and ilGlobalPageTemplate.

setRightContent()

ilGlobalTemplateInterface::setRightContent

(

$a_html

)

Sets content of right column.

Implemented in ilGlobalTemplate, ilDataCollectionGlobalTemplate, ilCOPageGlobalTemplate, ilRTEGlobalTemplate, and ilGlobalPageTemplate.

setSubTabs()

ilGlobalTemplateInterface::setSubTabs

(

$a_tabs_html

)

sets subtabs in standard template

Implemented in ilGlobalTemplate, ilDataCollectionGlobalTemplate, ilCOPageGlobalTemplate, ilRTEGlobalTemplate, and ilGlobalPageTemplate.

setTabs()

ilGlobalTemplateInterface::setTabs

(

$a_tabs_html

)

sets tabs in standard template

Implemented in ilGlobalTemplate, ilDataCollectionGlobalTemplate, ilCOPageGlobalTemplate, ilRTEGlobalTemplate, and ilGlobalPageTemplate.

setTitle()

ilGlobalTemplateInterface::setTitle	(		$a_title,
			$hidden = false
	)

Sets title in standard template.

Will override the header_page_title.

Implemented in ilGlobalTemplate, ilDataCollectionGlobalTemplate, ilCOPageGlobalTemplate, ilRTEGlobalTemplate, and ilGlobalPageTemplate.

setTitleIcon()

ilGlobalTemplateInterface::setTitleIcon	(		$a_icon_path,
			$a_icon_desc = ""
	)

set title icon

Implemented in ilGlobalTemplate, ilDataCollectionGlobalTemplate, ilCOPageGlobalTemplate, ilRTEGlobalTemplate, and ilGlobalPageTemplate.

setTreeFlatIcon()

ilGlobalTemplateInterface::setTreeFlatIcon	(		$a_link,
			$a_mode
	)

set tree/flat icon

Parameters

string	link target
strong	mode ("tree" | "flat")

Implemented in ilDataCollectionGlobalTemplate, ilGlobalTemplate, ilRTEGlobalTemplate, ilCOPageGlobalTemplate, and ilGlobalPageTemplate.

setVariable()

ilGlobalTemplateInterface::setVariable	(		$variable,
			$value = ''
	)

Implemented in ilDataCollectionGlobalTemplate, ilGlobalTemplate, ilRTEGlobalTemplate, ilCOPageGlobalTemplate, and ilGlobalPageTemplate.

touchBlock()

ilGlobalTemplateInterface::touchBlock

(

$block

)

overwrites ITX::touchBlock.

public

Parameters

string

Returns

???

Implemented in ilDataCollectionGlobalTemplate, ilGlobalTemplate, ilRTEGlobalTemplate, ilCOPageGlobalTemplate, and ilGlobalPageTemplate.

---

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

• Services/UICore/interfaces/interface.ilGlobalTemplateInterface.php