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

Inheritance diagram for ilRTEGlobalTemplate:

Collaboration diagram for ilRTEGlobalTemplate:

Public Member Functions
	__construct (string $file, bool $flag1, bool $flag2, string $in_module='', string $vars='DEFAULT', 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...

	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=self::DEFAULT_BLOCK)
	Renders the given block and returns the html string. More...

	setVariable (string $variable, $value='')
	Sets the given variable to the given value. More...

	setCurrentBlock (string $part=self::DEFAULT_BLOCK)
	Sets the template to the given block. More...

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

	parseCurrentBlock (string $block_name=self::DEFAULT_BLOCK)
	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
	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...

	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)

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

	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)
	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)
	Renders the given block and returns the html string. More...

	setVariable (string $variable, $value='')
	Sets the given variable to the given value. More...

	setCurrentBlock (string $part=self::DEFAULT_BLOCK)
	Sets the template to the given block. More...

	parseCurrentBlock (string $block_name=self::DEFAULT_BLOCK)
	Parses the given block. More...

	touchBlock (string $block)
	overwrites ITX::touchBlock. 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...

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

Protected Attributes
string	$tree_flat_link = ''

string	$page_form_action = ''

bool	$permanent_link = false

bool	$standard_template_loaded = false

ilTemplate	$template

string	$body_class = ''

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]

Private Member Functions
	fillBodyClass ()

Additional Inherited Members
Data Fields inherited from ILIAS\UICore\GlobalTemplate
const	MESSAGE_TYPE_FAILURE = 'failure'

const	MESSAGE_TYPE_SUCCESS = "success"

const	MESSAGE_TYPE_QUESTION = "question"

const	MESSAGE_TYPE_INFO = "info"

const	MESSAGE_TYPES

const	DEFAULT_BLOCK = 'DEFAULT'

Detailed Description

Special template class to simplify handling of ITX/PEAR.

Author: Stefan Kesseler skess.nosp@m.eler.nosp@m.@data.nosp@m.bay..nosp@m.de; Sascha Hofmann shofm.nosp@m.ann@.nosp@m.datab.nosp@m.ay.d.nosp@m.e

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

Constructor & Destructor Documentation

◆ __construct()

ilRTEGlobalTemplate::__construct	(	string	$file,
		bool	$flag1,
		bool	$flag2,
		string	$in_module = `''`,
		string	$vars = `'DEFAULT'`,
		bool	$plugin = `false`,
		bool	$a_use_cache = `true`
	)

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

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

References XapiProxy\$plugin, and setBodyClass().

Here is the call graph for this function:

Member Function Documentation

◆ addAdminPanelToolbar()

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

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

318 : void {

319 }

◆ addBlockFile()

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

overwrites ITX::addBlockFile

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 363 of file class.ilRTEGlobalTemplate.php.

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

Referenced by loadStandardTemplate().

Here is the caller graph for this function:

◆ addCss()

ilRTEGlobalTemplate::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 163 of file class.ilRTEGlobalTemplate.php.

                                                                        : void
    {
    }

◆ addInlineCss()

ilRTEGlobalTemplate::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 167 of file class.ilRTEGlobalTemplate.php.

                                                                         : void
    {
    }

◆ addJavaScript()

ilRTEGlobalTemplate::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 78 of file class.ilRTEGlobalTemplate.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, true)) {
            $this->js_files[] = $a_js_file;
            $this->js_files_vp[$a_js_file] = $a_add_version_parameter;
            $this->js_files_batch[$a_js_file] = $a_batch;
        }
    }

◆ addOnLoadCode()

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

Add on load code.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 101 of file class.ilRTEGlobalTemplate.php.

                                                                   : void
    {
    }

◆ blockExists()

ilRTEGlobalTemplate::blockExists ( string $block_name )

check if block exists in actual template

Parameters

string $block_name

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 368 of file class.ilRTEGlobalTemplate.php.

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

Referenced by fillBodyClass(), and fillJavaScriptFiles().

Here is the caller graph for this function:

◆ clearHeader()

ilRTEGlobalTemplate::clearHeader ( )

Clear header.

Implements ILIAS\UICore\GlobalTemplate.

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

                                 : void
    {
    }

◆ fillBodyClass()

ilRTEGlobalTemplate::fillBodyClass ( )

private

Definition at line 176 of file class.ilRTEGlobalTemplate.php.

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

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

Here is the call graph for this function:

◆ fillJavascriptFile()

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

protected

Definition at line 152 of file class.ilRTEGlobalTemplate.php.

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

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

Referenced by fillJavaScriptFiles().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fillJavaScriptFiles()

ilRTEGlobalTemplate::fillJavaScriptFiles ( bool $a_force = false )

Probably adds javascript files.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 118 of file class.ilRTEGlobalTemplate.php.

                                                              : void
    {
        global $DIC;
 
        $ilSetting = $DIC->settings();
 
        $vers = '';
        if (is_object($ilSetting)) {
            $vers = 'vers=' . str_replace(['.', ' '], '-', ILIAS_VERSION);
 
            if (defined('DEVMODE') && DEVMODE) {
                $vers .= '-' . time();
            }
        }
 
        if ($this->blockExists('js_file')) {
            for ($i = 0; $i <= 3; $i++) {
                reset($this->js_files);
                foreach ($this->js_files as $file) {
                    if ($this->js_files_batch[$file] === $i) {
                        if ($a_force || is_file($file) || strpos($file, 'http') === 0 || strpos($file, '//') === 0) {
                            $this->fillJavascriptFile($file, $vers);
                        } elseif (strpos($file, './') === 0) { // #13962
                            $url_parts = parse_url($file);
                            if (is_file($url_parts['path'])) {
                                $this->fillJavascriptFile($file, $vers);
                            }
                        }
                    }
                }
            }
        }
    }

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

Here is the call graph for this function:

◆ get()

ilRTEGlobalTemplate::get ( string $part = self::DEFAULT_BLOCK )

Renders the given block and returns the html string.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 338 of file class.ilRTEGlobalTemplate.php.

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

◆ getOnLoadCodeForAsynch()

ilRTEGlobalTemplate::getOnLoadCodeForAsynch ( )

Get js onload code for ajax calls.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 106 of file class.ilRTEGlobalTemplate.php.

                                            : string
    {
        return '';
    }

◆ getSpecial()

ilRTEGlobalTemplate::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 265 of file class.ilRTEGlobalTemplate.php.

     : string {
        return '';
    }

◆ hideFooter()

ilRTEGlobalTemplate::hideFooter ( )

Make the template hide the footer.

Implements ILIAS\UICore\GlobalTemplate.

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

                                : void
    {
    }

◆ loadStandardTemplate()

ilRTEGlobalTemplate::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 185 of file class.ilRTEGlobalTemplate.php.

                                          : void
    {
        if ($this->standard_template_loaded) {
            return;
        }
 
        iljQueryUtil::initjQuery();
        iljQueryUtil::initjQueryUI();
 
        $this->addBlockFile('CONTENT', 'content', 'tpl.adm_content.html');
        $this->addBlockFile('STATUSLINE', 'statusline', 'tpl.statusline.html');
 
        $this->standard_template_loaded = true;
    }

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

Here is the call graph for this function:

◆ parseCurrentBlock()

ilRTEGlobalTemplate::parseCurrentBlock ( string $block_name = self::DEFAULT_BLOCK )

Parses the given block.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 358 of file class.ilRTEGlobalTemplate.php.

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

Referenced by fillBodyClass(), and fillJavascriptFile().

Here is the caller graph for this function:

◆ printToStdout()

ilRTEGlobalTemplate::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 277 of file class.ilRTEGlobalTemplate.php.

     : void {
        global $DIC;
 
        $http = $DIC->http();
        switch ($http->request()->getHeaderLine('Accept')) {
            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->fillBodyClass();
                if ($has_tabs) {
                    $this->setCurrentBlock(self::DEFAULT_BLOCK);
                    $this->fillJavaScriptFiles();
                }
 
                if ($part === self::DEFAULT_BLOCK) {
                    $html = $this->template->getUnmodified();
                } else {
                    $html = $this->template->getUnmodified($part);
                }
 
                print $html;
 
                break;
        }
    }

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

Here is the call graph for this function:

◆ printToString()

ilRTEGlobalTemplate::printToString ( )

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

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 65 of file class.ilRTEGlobalTemplate.php.

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

◆ resetHeaderBlock()

ilRTEGlobalTemplate::resetHeaderBlock ( bool $a_reset_header_action = true )

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

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 330 of file class.ilRTEGlobalTemplate.php.

                                                                        : void
    {
    }

◆ resetJavascript()

ilRTEGlobalTemplate::resetJavascript ( )

Reset javascript files.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 111 of file class.ilRTEGlobalTemplate.php.

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

◆ setAlertProperties()

ilRTEGlobalTemplate::setAlertProperties ( array $alerts )

Set alert properties.

Parameters

array<int,array> $alerts

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 212 of file class.ilRTEGlobalTemplate.php.

                                                     : void
    {
    }

◆ setBodyClass()

ilRTEGlobalTemplate::setBodyClass ( string $a_class = '' )

Sets the body-tags class.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 171 of file class.ilRTEGlobalTemplate.php.

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

Referenced by __construct().

Here is the caller graph for this function:

◆ setContent()

ilRTEGlobalTemplate::setContent ( string $a_html )

Sets content for standard template.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 241 of file class.ilRTEGlobalTemplate.php.

                                              : void
    {
    }

◆ setCurrentBlock()

ilRTEGlobalTemplate::setCurrentBlock ( string $part = self::DEFAULT_BLOCK )

Sets the template to the given block.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 348 of file class.ilRTEGlobalTemplate.php.

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

Referenced by fillBodyClass(), and fillJavascriptFile().

Here is the caller graph for this function:

◆ setDescription()

ilRTEGlobalTemplate::setDescription ( string $a_descr )

Sets description below title in standard template.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 204 of file class.ilRTEGlobalTemplate.php.

                                                   : void
    {
    }

◆ setFileUploadRefId()

ilRTEGlobalTemplate::setFileUploadRefId ( int $a_ref_id )

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

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 334 of file class.ilRTEGlobalTemplate.php.

                                                     : void
    {
    }

◆ setHeaderActionMenu()

ilRTEGlobalTemplate::setHeaderActionMenu ( string $a_header )

Set header action menu.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 220 of file class.ilRTEGlobalTemplate.php.

                                                         : void
    {
    }

◆ setHeaderPageTitle()

ilRTEGlobalTemplate::setHeaderPageTitle ( string $a_title )

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

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 224 of file class.ilRTEGlobalTemplate.php.

                                                       : void
    {
    }

◆ setLeftContent()

ilRTEGlobalTemplate::setLeftContent ( string $a_html )

Sets content of left column.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 245 of file class.ilRTEGlobalTemplate.php.

                                                  : void
    {
    }

◆ setLeftNavContent()

ilRTEGlobalTemplate::setLeftNavContent ( string $a_content )

Sets content of left navigation column.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 249 of file class.ilRTEGlobalTemplate.php.

                                                        : void
    {
    }

◆ setLocator()

ilRTEGlobalTemplate::setLocator ( )

Insert locator.

Implements ILIAS\UICore\GlobalTemplate.

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

                                : void
    {
    }

◆ setLoginTargetPar()

ilRTEGlobalTemplate::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 261 of file class.ilRTEGlobalTemplate.php.

                                                    : void
    {
    }

◆ setOnScreenMessage()

ilRTEGlobalTemplate::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 74 of file class.ilRTEGlobalTemplate.php.

                                                                                         : void
    {
    }

◆ setPageFormAction()

ilRTEGlobalTemplate::setPageFormAction ( string $a_action )

Sets the pages form action.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 257 of file class.ilRTEGlobalTemplate.php.

                                                       : void
    {
    }

◆ setPermanentLink()

ilRTEGlobalTemplate::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 321 of file class.ilRTEGlobalTemplate.php.

327 : void {

328 }

◆ setRightContent()

ilRTEGlobalTemplate::setRightContent ( string $a_html )

Sets content of right column.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 253 of file class.ilRTEGlobalTemplate.php.

                                                   : void
    {
    }

◆ setSubTabs()

ilRTEGlobalTemplate::setSubTabs ( string $a_tabs_html )

sets subtabs in standard template

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 237 of file class.ilRTEGlobalTemplate.php.

                                                   : void
    {
    }

◆ setTabs()

ilRTEGlobalTemplate::setTabs ( string $a_tabs_html )

sets tabs in standard template

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 232 of file class.ilRTEGlobalTemplate.php.

                                                : void
    {
    }

◆ setTitle()

ilRTEGlobalTemplate::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 200 of file class.ilRTEGlobalTemplate.php.

                                                                   : void
    {
    }

◆ setTitleIcon()

ilRTEGlobalTemplate::setTitleIcon	(	string	$a_icon_path,
		string	$a_icon_desc = `""`
	)

set title icon

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 208 of file class.ilRTEGlobalTemplate.php.

                                                                               : void
    {
    }

◆ setTreeFlatIcon()

ilRTEGlobalTemplate::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 310 of file class.ilRTEGlobalTemplate.php.

                                                                   : void
    {
    }

◆ setVariable()

ilRTEGlobalTemplate::setVariable	(	string	$variable,
			$value = `''`
	)

Sets the given variable to the given value.

Parameters

mixed $value

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 343 of file class.ilRTEGlobalTemplate.php.

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

Referenced by fillBodyClass(), and fillJavascriptFile().

Here is the caller graph for this function:

◆ touchBlock()

ilRTEGlobalTemplate::touchBlock ( string $block )

overwrites ITX::touchBlock.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 353 of file class.ilRTEGlobalTemplate.php.

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

Field Documentation

◆ $body_class

string ilRTEGlobalTemplate::$body_class = ''

protected

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

◆ $js_files

array ilRTEGlobalTemplate::$js_files = [0 => 'assets/js/Basic.js']

protected

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

◆ $js_files_batch

array ilRTEGlobalTemplate::$js_files_batch = ['assets/js/Basic.js' => 1]

protected

Definition at line 50 of file class.ilRTEGlobalTemplate.php.

◆ $js_files_vp

array ilRTEGlobalTemplate::$js_files_vp = ['assets/js/Basic.js' => true]

protected

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

◆ $page_form_action

string ilRTEGlobalTemplate::$page_form_action = ''

protected

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

◆ $permanent_link

bool ilRTEGlobalTemplate::$permanent_link = false

protected

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

◆ $standard_template_loaded

bool ilRTEGlobalTemplate::$standard_template_loaded = false

protected

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

◆ $template

ilTemplate ilRTEGlobalTemplate::$template

protected

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

◆ $tree_flat_link

string ilRTEGlobalTemplate::$tree_flat_link = ''

protected

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

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

components/ILIAS/RTE/classes/class.ilRTEGlobalTemplate.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addAdminPanelToolbar()

◆ addBlockFile()

◆ addCss()

◆ addInlineCss()

◆ addJavaScript()

◆ addOnLoadCode()

◆ blockExists()

◆ clearHeader()

◆ fillBodyClass()

◆ fillJavascriptFile()

◆ fillJavaScriptFiles()

◆ get()

◆ getOnLoadCodeForAsynch()

◆ getSpecial()

◆ hideFooter()

◆ loadStandardTemplate()

◆ parseCurrentBlock()

◆ printToStdout()

◆ printToString()

◆ resetHeaderBlock()

◆ resetJavascript()

◆ setAlertProperties()

◆ setBodyClass()

◆ setContent()

◆ setCurrentBlock()

◆ setDescription()

◆ setFileUploadRefId()

◆ setHeaderActionMenu()

◆ setHeaderPageTitle()

◆ setLeftContent()

◆ setLeftNavContent()

◆ setLocator()

◆ setLoginTargetPar()

◆ setOnScreenMessage()

◆ setPageFormAction()

◆ setPermanentLink()

◆ setRightContent()

◆ setSubTabs()

◆ setTabs()

◆ setTitle()

◆ setTitleIcon()

◆ setTreeFlatIcon()

◆ setVariable()

◆ touchBlock()

Field Documentation

◆ $body_class

◆ $js_files

◆ $js_files_batch

◆ $js_files_vp

◆ $page_form_action

◆ $permanent_link

◆ $standard_template_loaded

◆ $template

◆ $tree_flat_link