ilGlobalTemplateInterface Interface Reference
Inheritance diagram for ilGlobalTemplateInterface:
Collaboration diagram for ilGlobalTemplateInterface:
Additional Inherited Members | |
| 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... | |
| 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 26 of file interface.ilGlobalTemplateInterface.php.
The documentation for this interface was generated from the following file:
- components/ILIAS/UICore/interfaces/interface.ilGlobalTemplateInterface.php
