ILIAS  trunk Revision v11.0_alpha-3011-gc6b235a2e85
ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter Class Reference
+ Inheritance diagram for ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter:
+ Collaboration diagram for ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter:

Public Member Functions

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

 getLegacyGlobalTemplateInstance ()
 

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

Member Function Documentation

◆ addAdminPanelToolbar()

ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter::addAdminPanelToolbar ( ilToolbarGUI  $toolbar,
bool  $is_bottom_panel = true,
bool  $has_arrow = false 
)

Definition at line 201 of file GlobalTemplateLegacyInitialisationAdapter.php.

205 : void {
206 $this->getLegacyGlobalTemplateInstance()->addAdminPanelToolbar($toolbar, $is_bottom_panel, $has_arrow);
207 }

◆ addBlockFile()

ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter::addBlockFile ( string  $var,
string  $block,
string  $template_name,
?string  $in_module = null 
)

overwrites ITX::addBlockFile

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 254 of file GlobalTemplateLegacyInitialisationAdapter.php.

254 : bool
255 {
256 return $this->getLegacyGlobalTemplateInstance()->addBlockFile($var, $block, $template_name, $in_module);
257 }

◆ addCss()

ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter::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 63 of file GlobalTemplateLegacyInitialisationAdapter.php.

63 : void
64 {
65 $this->getLegacyGlobalTemplateInstance()->addCss($a_css_file, $media);
66 }

References ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter\getLegacyGlobalTemplateInstance().

+ Here is the call graph for this function:

◆ addInlineCss()

ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter::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 68 of file GlobalTemplateLegacyInitialisationAdapter.php.

68 : void
69 {
70 $this->getLegacyGlobalTemplateInstance()->addInlineCss($a_css, $media);
71 }

References ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter\getLegacyGlobalTemplateInstance().

+ Here is the call graph for this function:

◆ addJavaScript()

ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter::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 38 of file GlobalTemplateLegacyInitialisationAdapter.php.

38 : void
39 {
40 $this->getLegacyGlobalTemplateInstance()->addJavaScript($a_js_file, $a_add_version_parameter, $a_batch);
41 }

References ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter\getLegacyGlobalTemplateInstance().

+ Here is the call graph for this function:

◆ addOnLoadCode()

ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter::addOnLoadCode ( string  $a_code,
int  $a_batch = 2 
)

Add on load code.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 43 of file GlobalTemplateLegacyInitialisationAdapter.php.

43 : void
44 {
45 $this->getLegacyGlobalTemplateInstance()->addOnLoadCode($a_code, $a_batch);
46 }

References ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter\getLegacyGlobalTemplateInstance().

+ Here is the call graph for this function:

◆ blockExists()

ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter::blockExists ( string  $block_name)

check if block exists in actual template

Parameters
string$block_name

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 259 of file GlobalTemplateLegacyInitialisationAdapter.php.

259 : bool
260 {
261 return $this->getLegacyGlobalTemplateInstance()->blockExists($block_name);
262 }

◆ clearHeader()

ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter::clearHeader ( )

Clear header.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 103 of file GlobalTemplateLegacyInitialisationAdapter.php.

103 : void
104 {
105 $this->getLegacyGlobalTemplateInstance()->clearHeader();
106 }

References ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter\getLegacyGlobalTemplateInstance().

+ Here is the call graph for this function:

◆ fillJavaScriptFiles()

ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter::fillJavaScriptFiles ( bool  $a_force = false)

Probably adds javascript files.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 58 of file GlobalTemplateLegacyInitialisationAdapter.php.

58 : void
59 {
60 $this->getLegacyGlobalTemplateInstance()->fillJavaScriptFiles($a_force);
61 }

References ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter\getLegacyGlobalTemplateInstance().

+ Here is the call graph for this function:

◆ get()

ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter::get ( string  $part = self::DEFAULT_BLOCK)

Renders the given block and returns the html string.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 229 of file GlobalTemplateLegacyInitialisationAdapter.php.

229 : string
230 {
231 return $this->getLegacyGlobalTemplateInstance()->get($part);
232 }

◆ getLegacyGlobalTemplateInstance()

ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter::getLegacyGlobalTemplateInstance ( )
protected

Definition at line 264 of file GlobalTemplateLegacyInitialisationAdapter.php.

264 : GlobalTemplate
265 {
266 global $DIC;
267 return $DIC->ui()->mainTemplate();
268 }
global $DIC
Definition: shib_login.php:26

References $DIC.

Referenced by ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter\addCss(), ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter\addInlineCss(), ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter\addJavaScript(), ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter\addOnLoadCode(), ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter\clearHeader(), ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter\fillJavaScriptFiles(), ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter\getOnLoadCodeForAsynch(), ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter\hideFooter(), ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter\loadStandardTemplate(), ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter\resetJavascript(), ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter\setAlertProperties(), ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter\setBodyClass(), ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter\setContent(), ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter\setDescription(), ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter\setHeaderActionMenu(), ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter\setHeaderPageTitle(), ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter\setLeftContent(), ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter\setLeftNavContent(), ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter\setLocator(), ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter\setLoginTargetPar(), ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter\setOnScreenMessage(), ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter\setPageFormAction(), ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter\setRightContent(), ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter\setSubTabs(), ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter\setTabs(), ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter\setTitle(), and ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter\setTitleIcon().

+ Here is the caller graph for this function:

◆ getOnLoadCodeForAsynch()

ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter::getOnLoadCodeForAsynch ( )

Get js onload code for ajax calls.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 48 of file GlobalTemplateLegacyInitialisationAdapter.php.

48 : string
49 {
50 return $this->getLegacyGlobalTemplateInstance()->getOnLoadCodeForAsynch();
51 }

References ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter\getLegacyGlobalTemplateInstance().

+ Here is the call graph for this function:

◆ getSpecial()

ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter::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 163 of file GlobalTemplateLegacyInitialisationAdapter.php.

171 : string {
172 return $this->getLegacyGlobalTemplateInstance()->getSpecial(
173 $part,
174 $add_error_mess,
175 $handle_referer,
176 $add_ilias_footer,
177 $add_standard_elements,
178 $a_main_menu,
179 $a_tabs
180 );
181 }

◆ hideFooter()

ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter::hideFooter ( )

Make the template hide the footer.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 28 of file GlobalTemplateLegacyInitialisationAdapter.php.

28 : void
29 {
30 $this->getLegacyGlobalTemplateInstance()->hideFooter();
31 }

References ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter\getLegacyGlobalTemplateInstance().

+ Here is the call graph for this function:

◆ loadStandardTemplate()

ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter::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 78 of file GlobalTemplateLegacyInitialisationAdapter.php.

78 : void
79 {
80 $this->getLegacyGlobalTemplateInstance()->loadStandardTemplate();
81 }

References ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter\getLegacyGlobalTemplateInstance().

+ Here is the call graph for this function:

◆ parseCurrentBlock()

ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter::parseCurrentBlock ( string  $block_name = self::DEFAULT_BLOCK)

Parses the given block.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 244 of file GlobalTemplateLegacyInitialisationAdapter.php.

244 : bool
245 {
246 return $this->getLegacyGlobalTemplateInstance()->parseCurrentBlock($block_name);
247 }

◆ printToStdout()

ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter::printToStdout ( string  $part = self::DEFAULT_BLOCK,
bool  $has_tabs = true,
bool  $skip_main_menu = false 
)
Parameters
bool$has_tabsif template variable {TABS} should be filled with content of ilTabs
bool$skip_main_menuif the main menu should be rendered.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 183 of file GlobalTemplateLegacyInitialisationAdapter.php.

187 : void {
188 $this->getLegacyGlobalTemplateInstance()->printToStdout($part, $has_tabs, $skip_main_menu);
189 }

◆ printToString()

ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter::printToString ( )

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

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 191 of file GlobalTemplateLegacyInitialisationAdapter.php.

191 : string
192 {
193 return $this->getLegacyGlobalTemplateInstance()->printToString();
194 }

◆ resetHeaderBlock()

ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter::resetHeaderBlock ( bool  $a_reset_header_action = true)

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

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 219 of file GlobalTemplateLegacyInitialisationAdapter.php.

219 : void
220 {
221 $this->getLegacyGlobalTemplateInstance()->resetHeaderBlock($a_reset_header_action);
222 }

◆ resetJavascript()

ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter::resetJavascript ( )

Reset javascript files.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 53 of file GlobalTemplateLegacyInitialisationAdapter.php.

53 : void
54 {
55 $this->getLegacyGlobalTemplateInstance()->resetJavascript();
56 }

References ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter\getLegacyGlobalTemplateInstance().

+ Here is the call graph for this function:

◆ setAlertProperties()

ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter::setAlertProperties ( array  $alerts)

Set alert properties.

Parameters
array<int,array>$alerts

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 98 of file GlobalTemplateLegacyInitialisationAdapter.php.

98 : void
99 {
100 $this->getLegacyGlobalTemplateInstance()->setAlertProperties($alerts);
101 }

References ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter\getLegacyGlobalTemplateInstance().

+ Here is the call graph for this function:

◆ setBodyClass()

ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter::setBodyClass ( string  $a_class = "")

Sets the body-tags class.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 73 of file GlobalTemplateLegacyInitialisationAdapter.php.

73 : void
74 {
75 $this->getLegacyGlobalTemplateInstance()->setBodyClass($a_class);
76 }

References ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter\getLegacyGlobalTemplateInstance().

+ Here is the call graph for this function:

◆ setContent()

ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter::setContent ( string  $a_html)

Sets content for standard template.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 133 of file GlobalTemplateLegacyInitialisationAdapter.php.

133 : void
134 {
135 $this->getLegacyGlobalTemplateInstance()->setContent($a_html);
136 }

References ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter\getLegacyGlobalTemplateInstance().

+ Here is the call graph for this function:

◆ setCurrentBlock()

ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter::setCurrentBlock ( string  $part = self::DEFAULT_BLOCK)

Sets the template to the given block.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 239 of file GlobalTemplateLegacyInitialisationAdapter.php.

239 : bool
240 {
241 return $this->getLegacyGlobalTemplateInstance()->setCurrentBlock($part);
242 }

◆ setDescription()

ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter::setDescription ( string  $a_descr)

Sets description below title in standard template.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 88 of file GlobalTemplateLegacyInitialisationAdapter.php.

88 : void
89 {
90 $this->getLegacyGlobalTemplateInstance()->setDescription($a_descr);
91 }

References ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter\getLegacyGlobalTemplateInstance().

+ Here is the call graph for this function:

◆ setFileUploadRefId()

ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter::setFileUploadRefId ( int  $a_ref_id)

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

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 224 of file GlobalTemplateLegacyInitialisationAdapter.php.

224 : void
225 {
226 $this->getLegacyGlobalTemplateInstance()->setFileUploadRefId($a_ref_id);
227 }

◆ setHeaderActionMenu()

ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter::setHeaderActionMenu ( string  $a_header)

Set header action menu.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 108 of file GlobalTemplateLegacyInitialisationAdapter.php.

108 : void
109 {
110 $this->getLegacyGlobalTemplateInstance()->setHeaderActionMenu($a_header);
111 }

References ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter\getLegacyGlobalTemplateInstance().

+ Here is the call graph for this function:

◆ setHeaderPageTitle()

ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter::setHeaderPageTitle ( string  $a_title)

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

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 113 of file GlobalTemplateLegacyInitialisationAdapter.php.

113 : void
114 {
115 $this->getLegacyGlobalTemplateInstance()->setHeaderPageTitle($a_title);
116 }

References ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter\getLegacyGlobalTemplateInstance().

+ Here is the call graph for this function:

◆ setLeftContent()

ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter::setLeftContent ( string  $a_html)

Sets content of left column.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 138 of file GlobalTemplateLegacyInitialisationAdapter.php.

138 : void
139 {
140 $this->getLegacyGlobalTemplateInstance()->setLeftContent($a_html);
141 }

References ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter\getLegacyGlobalTemplateInstance().

+ Here is the call graph for this function:

◆ setLeftNavContent()

ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter::setLeftNavContent ( string  $a_content)

Sets content of left navigation column.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 143 of file GlobalTemplateLegacyInitialisationAdapter.php.

143 : void
144 {
145 $this->getLegacyGlobalTemplateInstance()->setLeftNavContent($a_content);
146 }

References ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter\getLegacyGlobalTemplateInstance().

+ Here is the call graph for this function:

◆ setLocator()

ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter::setLocator ( )

Insert locator.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 118 of file GlobalTemplateLegacyInitialisationAdapter.php.

118 : void
119 {
120 $this->getLegacyGlobalTemplateInstance()->setLocator();
121 }

References ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter\getLegacyGlobalTemplateInstance().

+ Here is the call graph for this function:

◆ setLoginTargetPar()

ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter::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 158 of file GlobalTemplateLegacyInitialisationAdapter.php.

158 : void
159 {
160 $this->getLegacyGlobalTemplateInstance()->setLoginTargetPar($a_val);
161 }

References ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter\getLegacyGlobalTemplateInstance().

+ Here is the call graph for this function:

◆ setOnScreenMessage()

ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter::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 33 of file GlobalTemplateLegacyInitialisationAdapter.php.

33 : void
34 {
35 $this->getLegacyGlobalTemplateInstance()->setOnScreenMessage($type, $a_txt, $a_keep);
36 }

References ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter\getLegacyGlobalTemplateInstance().

+ Here is the call graph for this function:

◆ setPageFormAction()

ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter::setPageFormAction ( string  $a_action)

Sets the pages form action.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 153 of file GlobalTemplateLegacyInitialisationAdapter.php.

153 : void
154 {
155 $this->getLegacyGlobalTemplateInstance()->setPageFormAction($a_action);
156 }

References ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter\getLegacyGlobalTemplateInstance().

+ Here is the call graph for this function:

◆ setPermanentLink()

ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter::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 209 of file GlobalTemplateLegacyInitialisationAdapter.php.

215 : void {
216 $this->getLegacyGlobalTemplateInstance()->setPermanentLink($a_type, $a_id, $a_append, $a_target, $a_title);
217 }

◆ setRightContent()

ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter::setRightContent ( string  $a_html)

Sets content of right column.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 148 of file GlobalTemplateLegacyInitialisationAdapter.php.

148 : void
149 {
150 $this->getLegacyGlobalTemplateInstance()->setRightContent($a_html);
151 }

References ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter\getLegacyGlobalTemplateInstance().

+ Here is the call graph for this function:

◆ setSubTabs()

ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter::setSubTabs ( string  $a_tabs_html)

sets subtabs in standard template

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 128 of file GlobalTemplateLegacyInitialisationAdapter.php.

128 : void
129 {
130 $this->getLegacyGlobalTemplateInstance()->setSubTabs($a_tabs_html);
131 }

References ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter\getLegacyGlobalTemplateInstance().

+ Here is the call graph for this function:

◆ setTabs()

ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter::setTabs ( string  $a_tabs_html)

sets tabs in standard template

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 123 of file GlobalTemplateLegacyInitialisationAdapter.php.

123 : void
124 {
125 $this->getLegacyGlobalTemplateInstance()->setTabs($a_tabs_html);
126 }

References ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter\getLegacyGlobalTemplateInstance().

+ Here is the call graph for this function:

◆ setTitle()

ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter::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 83 of file GlobalTemplateLegacyInitialisationAdapter.php.

83 : void
84 {
85 $this->getLegacyGlobalTemplateInstance()->setTitle($a_title, $hidden);
86 }

References ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter\getLegacyGlobalTemplateInstance().

+ Here is the call graph for this function:

◆ setTitleIcon()

ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter::setTitleIcon ( string  $a_icon_path,
string  $a_icon_desc = "" 
)

set title icon

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 93 of file GlobalTemplateLegacyInitialisationAdapter.php.

93 : void
94 {
95 $this->getLegacyGlobalTemplateInstance()->setTitleIcon($a_icon_path, $a_icon_desc);
96 }

References ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter\getLegacyGlobalTemplateInstance().

+ Here is the call graph for this function:

◆ setTreeFlatIcon()

ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter::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 196 of file GlobalTemplateLegacyInitialisationAdapter.php.

196 : void
197 {
198 $this->getLegacyGlobalTemplateInstance()->setTreeFlatIcon($a_link, $a_mode);
199 }

◆ setVariable()

ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter::setVariable ( string  $variable,
  $value = '' 
)

Sets the given variable to the given value.

Parameters
mixed$value

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 234 of file GlobalTemplateLegacyInitialisationAdapter.php.

234 : void
235 {
236 $this->getLegacyGlobalTemplateInstance()->setVariable($variable, $value);
237 }

◆ touchBlock()

ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter::touchBlock ( string  $block)

overwrites ITX::touchBlock.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 249 of file GlobalTemplateLegacyInitialisationAdapter.php.

249 : bool
250 {
251 return $this->getLegacyGlobalTemplateInstance()->touchBlock($block);
252 }

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