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

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

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

Author
Thibeau Fuhrer thibe.nosp@m.au@s.nosp@m.r.sol.nosp@m.utio.nosp@m.ns

Definition at line 26 of file GlobalTemplate.php.

Member Function Documentation

◆ addAdminPanelToolbar()

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

Add admin panel commands as toolbar.

Parameters
bool$is_bottom_panelif the panel should be rendered at the bottom of the page as well.
bool$has_arrowif the panel should be rendered with an arrow icon.

◆ addBlockFile()

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

◆ addCss()

◆ addInlineCss()

ILIAS\UICore\GlobalTemplate::addInlineCss ( string  $a_css,
string  $media = "screen" 
)

◆ addJavaScript()

◆ addOnLoadCode()

◆ blockExists()

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

check if block exists in actual template

Parameters
string$block_name

Implemented in ilGlobalTemplate, ilDataCollectionGlobalTemplate, ilRTEGlobalTemplate, ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter, and ilGlobalPageTemplate.

◆ clearHeader()

◆ fillJavaScriptFiles()

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

◆ get()

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

Renders the given block and returns the html string.

Implemented in ilDataCollectionGlobalTemplate, ilRTEGlobalTemplate, ilGlobalPageTemplate, ilGlobalTemplate, and ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter.

Referenced by ilLearningProgressBaseGUI\__getLegendHTML(), ilObjIndividualAssessmentGUI\addMemberDataToInfo(), ilCalendarCategoryGUI\addReferenceLinks(), ilCalendarCategoryGUI\appendCalendarSelection(), ilSearchResultPresentation\appendMorePathes(), ilSearchResultPresentation\appendPath(), ilObjStudyProgrammeIndividualPlanGUI\buildFrame(), ilECSSettingsGUI\communities(), ilPageObjectGUI\compareVersion(), ilCourseRegistrationGUI\fillMaxMembers(), ilGroupRegistrationGUI\fillMaxMembers(), ilRegistrationGUI\fillMembershipLimitation(), ilCourseRegistrationGUI\fillRegistrationPeriod(), ilGroupRegistrationGUI\fillRegistrationPeriod(), ilContainerSelectionExplorer\formatHeader(), ilSCORMExplorer\formatHeader(), ilPersonalSkillsGUI\getActualGapItem(), ilPersonalSkillsGUI\getBasicSkillDescription(), ILIAS\User\Profile\PublicProfileGUI\getEmbeddable(), ilPersonalSkillsGUI\getEvalItem(), ilCalendarHeaderNavigationGUI\getHTML(), ilMiniCalendarGUI\getHTML(), ilAttendanceList\getHTML(), ilUserFilterGUI\getHTML(), ilStudyProgrammeProgressListGUI\getHTML(), ilLMPresentationGUI\getHTML(), ilContainerContentGUI\getIntroduction(), ilContainerContentGUI\getMainContent(), ilContainerObjectiveGUI\getMainContent(), ilDashboardGUI\getMainContent(), ilCalendarSubscriptionGUI\getModalForSubscription(), ilCalendarAppointmentPresentationGUI\getModalHTML(), ilPersonalSkillsGUI\getProfileTargetItem(), ilPersonalSkillsGUI\getSelfEvalGapItem(), ilPersonalSkillsGUI\getSkillCategoryDescription(), ilPersonalSkillsGUI\getSkillEntriesHeader(), ilPersonalSkillsGUI\getSkillLevelDescription(), ilLPListOfSettingsGUI\handleLPUsageInfo(), ilObjCourseGUI\infoScreen(), ilECSSettingsGUI\initCategoryMappingForm(), ilECSMappingSettingsGUI\initFormCSettings(), ilCourseObjectivesGUI\initFormLimits(), ilECSSettingsGUI\initSettingsForm(), ilFileWizardInputGUI\insert(), ilSelectBuilderInputGUI\insert(), ilMatrixRowWizardInputGUI\insert(), ilPageObjectGUI\insertPageToc(), ilAssQuestionPageGUI\insertPageToc(), ilPCResourcesGUI\insertResourcesIntoPageContent(), ilPersonalSkillsGUI\listAssignedProfile(), ilPersonalSkillsGUI\listSkills(), ilTestEvaluationGUI\outUserPassDetails(), ilRegistrationSettingsGUI\parseRoleList(), ilObjectPermissionStatusGUI\perminfo(), SurveyQuestionGUI\preview(), ilAccessibilityControlConceptGUI\printToGlobalTemplate(), ilRepositorySelectorInputGUI\render(), ILIAS\MediaCast\Presentation\VideoViewGUI\render(), ilTagInputGUI\render(), ilTextWizardInputGUI\render(), ilMultipleImagesInputGUI\render(), ilMultipleTextsInputGUI\render(), ILIAS\MediaCast\Presentation\VideoViewGUI\renderSideColumn(), ilPageObjectGUI\showPage(), ilLMPresentationGUI\showPrintView(), ilLMPresentationGUI\showPrintViewSelection(), ilCalendarPresentationGUI\showSideBlocks(), ilTestEvalObjectiveOrientedGUI\showVirtualPassCmd(), and ilObjStudyProgrammeIndividualPlanGUI\view().

+ Here is the caller graph for this function:

◆ getOnLoadCodeForAsynch()

ILIAS\UICore\GlobalTemplate::getOnLoadCodeForAsynch ( )

◆ getSpecial()

ILIAS\UICore\GlobalTemplate::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 
)

◆ hideFooter()

ILIAS\UICore\GlobalTemplate::hideFooter ( )

◆ loadStandardTemplate()

ILIAS\UICore\GlobalTemplate::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 ilDataCollectionGlobalTemplate, ilRTEGlobalTemplate, ilGlobalPageTemplate, ilGlobalTemplate, and ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter.

Referenced by ilObjBlogGUI\executeCommand(), ilSharedResourceGUI\executeCommand(), ilObjectPluginGUI\executeCommand(), and ilDerivedTasksGUI\executeCommand().

+ Here is the caller graph for this function:

◆ parseCurrentBlock()

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

Parses the given block.

Implemented in ilDataCollectionGlobalTemplate, ilRTEGlobalTemplate, ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter, ilGlobalPageTemplate, and ilGlobalTemplate.

Referenced by ilBlogPostingGUI\__construct(), ilPortfolioPageGUI\__construct(), ilPageLayoutGUI\__construct(), ilCalendarCategoryGUI\addReferenceLinks(), ilObjStudyProgrammeIndividualPlanGUI\buildFrame(), ilECSSettingsGUI\communities(), ilSCORMExplorer\createOutput(), ilRegistrationGUI\fillMembershipLimitation(), ilStudyProgrammeExpandableProgressListGUI\fillTemplate(), ilStudyProgrammeProgressListGUI\fillTemplate(), ilContainerSelectionExplorer\formatHeader(), ilRepositoryExplorer\formatHeader(), ilSCORMExplorer\formatHeader(), ilECSNodeMappingCmsExplorer\formatHeader(), ilECSNodeMappingLocalExplorer\formatHeader(), ilECSNodeMappingCmsExplorer\formatObject(), ilECSNodeMappingLocalExplorer\formatObject(), ilPersonalSkillsGUI\getBasicSkillDescription(), ILIAS\User\Profile\PublicProfileGUI\getEmbeddable(), ilAttendanceList\getHTML(), ilCalendarAppointmentPresentationGUI\getModalHTML(), ilSCORMExplorer\getOutputIcons(), ilContainerStartObjectsContentGUI\getPageHTML(), ilPersonalSkillsGUI\getSkillCategoryDescription(), ilPersonalSkillsGUI\getSkillEntriesHeader(), ilPersonalSkillsGUI\getSkillLevelDescription(), ilLPListOfSettingsGUI\handleLPUsageInfo(), ilObjCourseGUI\infoScreen(), ilCourseObjectivesGUI\initFormLimits(), ilFileWizardInputGUI\insert(), ilSelectBuilderInputGUI\insert(), ilMatrixRowWizardInputGUI\insert(), ilSCORMExplorer\insertObject(), ilPCResourcesGUI\insertResourcesIntoPageContent(), ilExplorerBaseGUI\listItemStart(), ilTestEvaluationGUI\outUserPassDetails(), ilRegistrationSettingsGUI\parseRoleList(), SurveyQuestionGUI\preview(), ilTagInputGUI\render(), ilTextWizardInputGUI\render(), ilMultipleImagesInputGUI\render(), ilMultipleTextsInputGUI\render(), ilExplorerBaseGUI\renderNode(), ilForumExportGUI\renderPostHtml(), ilContainerObjectiveGUI\showObjectives(), ilPageObjectGUI\showPage(), ilLMPresentationGUI\showPrintView(), ilLocalUserGUI\showRolesTable(), and ilTestEvalObjectiveOrientedGUI\showVirtualPassCmd().

+ Here is the caller graph for this function:

◆ printToStdout()

ILIAS\UICore\GlobalTemplate::printToStdout ( string  $part = self::DEFAULT_BLOCK,
bool  $has_tabs = true,
bool  $skip_main_menu = false 
)

◆ printToString()

ILIAS\UICore\GlobalTemplate::printToString ( )

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

Implemented in ilDataCollectionGlobalTemplate, ilRTEGlobalTemplate, ilGlobalPageTemplate, and ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter.

◆ resetHeaderBlock()

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

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

Implemented in ilDataCollectionGlobalTemplate, ilRTEGlobalTemplate, ilGlobalPageTemplate, ilGlobalTemplate, and ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter.

◆ resetJavascript()

ILIAS\UICore\GlobalTemplate::resetJavascript ( )

◆ setAlertProperties()

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

◆ setBodyClass()

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

◆ setContent()

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

Sets content for standard template.

Implemented in ilDataCollectionGlobalTemplate, ilRTEGlobalTemplate, ilGlobalPageTemplate, ilGlobalTemplate, and ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter.

Referenced by ilExcCriteriaCatalogueGUI\add(), ilExcCriteriaGUI\add(), ilRatingCategoryGUI\add(), ilPortfolioRoleAssignmentGUI\addAssignment(), ilBadgeManagementGUI\addBadge(), ilObjMediaCastGUI\addCastItemObject(), ilContentStyleImageGUI\addImage(), ilMultilingualismGUI\addLanguages(), ilBasicSkillGUI\addLevel(), ilBasicSkillGUI\addLevelResource(), ilObjLanguageExtGUI\addNewEntryObject(), ilObjMediaPoolGUI\allMedia(), ilContSkillAdminGUI\assignCompetences(), ilSkillProfileGUI\assignLevel(), ilSkillProfileGUI\assignLevelSelectSkill(), ilPersonalSkillsGUI\assignMaterial(), ilPersonalSkillsGUI\assignMaterials(), ilObjSessionGUI\attendanceListObject(), ilBookingProcessWithScheduleGUI\book(), ilObjMediaPoolGUI\bulkUpload(), ilPageEditorGUI\characteristic(), ilSurveyEvaluationGUI\competenceEval(), ilSurveyParticipantsGUI\confirmAdminAppraiseesCloseObject(), ilSurveyParticipantsGUI\confirmAppraiseeCloseObject(), ilPortfolioRoleAssignmentGUI\confirmAssignmentDeletion(), ilMultilingualismGUI\confirmDeactivateContentMultiLang(), ilBadgeManagementGUI\confirmDeassignBadge(), ilExerciseManagementGUI\confirmDeassignMembersObject(), ilBookingObjectGUI\confirmDelete(), ilBookingScheduleGUI\confirmDelete(), ilRatingCategoryGUI\confirmDelete(), ilBadgeManagementGUI\confirmDeleteBadges(), ilFileSystemGUI\confirmDeleteFile(), ilContSkillAdminGUI\confirmDeleteSingleLocalProfile(), ilExcCriteriaCatalogueGUI\confirmDeletion(), ilExcCriteriaGUI\confirmDeletion(), ilSkillProfileGUI\confirmLevelAssignmentRemoval(), ilBasicSkillGUI\confirmLevelDeletion(), ilRecommendedContentRoleConfigGUI\confirmRemoveItems(), ilMultilingualismGUI\confirmRemoveLanguages(), ilContSkillAdminGUI\confirmRemoveSelectedGlobalProfiles(), ilContSkillAdminGUI\confirmRemoveSelectedSkill(), ilContSkillAdminGUI\confirmRemoveSingleGlobalProfile(), ilPersonalSkillsGUI\confirmSkillRemove(), ilBookingScheduleGUI\create(), ilPCContentTemplateGUI\create(), ilPCLayoutTemplateGUI\create(), ilPCListGUI\create(), ilPCMapGUI\create(), ilPCAMDFormGUI\create(), ilSkillTreeNodeGUI\create(), ilSkillProfileGUI\create(), ilBookingObjectGUI\create(), ilObjMediaPoolGUI\createFolderForm(), ilSkillProfileGUI\createLocal(), ilObjStyleSheetGUI\createObject(), ilExSubmissionTeamGUI\createTeamObject(), ilMediaCreationGUI\creationSelection(), ilContSkillAdminGUI\deassignCompetencesConfirm(), ilAdministrationCommandGUI\delete(), ilPageEditorGUI\delete(), ilObjWorkspaceFolderGUI\deleteConfirmation(), ilObjSkillTreeGUI\deleteNodes(), ilBookingScheduleGUI\edit(), ilPCMapGUI\edit(), ilBasicSkillGUI\edit(), ilBasicSkillTemplateGUI\edit(), ilSkillCategoryGUI\edit(), ilSkillProfileGUI\edit(), ilBookingObjectGUI\edit(), ilPCBlogGUI\edit(), ilPCProfileGUI\edit(), ilPCSkillsGUI\edit(), ilExcCriteriaCatalogueGUI\edit(), ilExcCriteriaGUI\edit(), ilPCLearningHistoryGUI\edit(), ilPCConsultationHoursGUI\edit(), ilPCMyCoursesGUI\edit(), ilRatingCategoryGUI\edit(), ilPCAMDPageListGUI\edit(), ilPCLoginPageElementGUI\edit(), ilPCPluggedGUI\edit(), ilPCResourcesGUI\edit(), ilBadgeManagementGUI\editBadge(), ilObjMediaCastGUI\editCastItemObject(), ilObjMediaPoolGUI\editFolder(), ilObjTaggingSettingsGUI\editForbiddenTags(), ilLMPageObjectGUI\editLayout(), ilBasicSkillGUI\editLevel(), ilObjExternalToolsSettingsGUI\editMapsObject(), ilObjContentObjectGUI\editMenuProperties(), ilPCAMDFormGUI\editPortfolio(), ilSkillTemplateReferenceGUI\editProperties(), ilSkillTreeNodeGUI\editProperties(), ilObjLearningHistorySettingsGUI\editSettings(), ilObjCommentsSettingsGUI\editSettings(), ilObjNotesSettingsGUI\editSettings(), ilObjWikiSettingsGUI\editSettings(), ilPCAMDFormGUI\editTemplate(), ilMediaCreationGUI\editTitlesAndDescriptions(), ilObjMediaPoolGUI\editTitlesAndDescriptions(), ilObjBlogGUI\executeCommand(), ilLMPageObjectGUI\executeCommand(), ilObjLearningSequenceGUI\executeCommand(), ilObjMediaPoolGUI\executeCommand(), ilWorkspaceAccessGUI\executeCommand(), ilObjWikiGUI\executeCommand(), ilContainerStartObjectsContentGUI\getHTML(), ilSkillProfileGUI\importProfiles(), ilObjSurveyQuestionPoolGUI\importQuestionsObject(), ilSkillRootGUI\importSkills(), ilPCContentTemplateGUI\insert(), ilPCLayoutTemplateGUI\insert(), ilPCMapGUI\insert(), ilSkillTemplateReferenceGUI\insert(), ilPCAMDFormGUI\insert(), ilPCBlogGUI\insert(), ilPCProfileGUI\insert(), ilPCSkillsGUI\insert(), ilPCLearningHistoryGUI\insert(), ilPCConsultationHoursGUI\insert(), ilPCMyCoursesGUI\insert(), ilPCAMDPageListGUI\insert(), ilPCContentIncludeGUI\insertFromPool(), ilPCFileItemGUI\insertFromRepository(), ilPCFileListGUI\insertFromRepository(), ilPCFileItemGUI\insertFromWorkspace(), ilBadgeProfileGUI\listBackpackGroups(), ilBookingPreferencesGUI\listBookingResults(), ilRatingCategoryGUI\listCategories(), ilContSkillAdminGUI\listCompetences(), ilSurveySkillThresholdsGUI\listCompetences(), ilObjWikiGUI\listContributorsObject(), ilContentStyleImageGUI\listImages(), ilRecommendedContentRoleConfigGUI\listItems(), ilSkillCategoryGUI\listItems(), ilSkillTemplateCategoryGUI\listItems(), ilSkillTemplateReferenceGUI\listItems(), ilObjMediaCastGUI\listItemsObject(), ilObjItemGroupGUI\listMaterials(), ilObjMediaPoolGUI\listMedia(), ilContSkillAdminGUI\listMembers(), ilMediaCreationGUI\listPoolItems(), ilPCQuestionGUI\listPoolQuestions(), ilContSkillAdminGUI\listProfiles(), ilSkillProfileGUI\listProfiles(), ilSurveySkillDeterminationGUI\listSkillChanges(), ilSkillRootGUI\listSkills(), ilPersonalSkillsGUI\listSkillsForAdd(), ilSurveySkillThresholdsGUI\listSkillThresholds(), ilSkillRootGUI\listTemplates(), ilGlossaryTermGUI\listUsages(), ilBookingReservationsGUI\log(), ilBookingReservationsGUI\logDetails(), ilExerciseManagementGUI\membersObject(), ilSharedResourceGUI\passwordForm(), ilObjWorkspaceFolderGUI\passwordForm(), ilPCContentIncludeGUI\poolSelection(), ilPCQuestionGUI\poolSelection(), ilMediaCreationGUI\poolSelection(), ilObjSCORM2004LearningModuleGUI\properties(), ilObjStyleSheetGUI\propertiesObject(), ilObjBlogGUI\render(), ilBookingObjectGUI\render(), ilBookingScheduleGUI\render(), ilObjWorkspaceFolderGUI\render(), ilBookingReservationsGUI\rsvCancel(), ilBookingReservationsGUI\rsvConfirmCancel(), ilBookingReservationsGUI\rsvConfirmCancelAggregation(), ilBookingReservationsGUI\rsvConfirmCancelUser(), ilBookingScheduleGUI\save(), ilSkillTreeNodeGUI\save(), ilSkillProfileGUI\save(), ilObjSkillTreeGUI\save(), ilTaxMDGUI\save(), ilObjAccessibilitySettingsGUI\saveAccessibilitySettings(), ilPortfolioRoleAssignmentGUI\saveAssignment(), ilObjSystemFolderGUI\saveBasicSettingsObject(), ilObjMediaPoolGUI\saveFolder(), ilLMPageObjectGUI\saveLayout(), ilBasicSkillGUI\saveLevel(), ilSkillProfileGUI\saveLocal(), ilPCListGUI\saveProperties(), ilContainerFilterAdminGUI\selectFields(), ilRecommendedContentRoleConfigGUI\selectItem(), ilContSkillAdminGUI\selectSkill(), ilPersonalSkillsGUI\selfEvaluation(), ilContainerContentGUI\setOutput(), ilContentStyleSettingsGUI\setScope(), ilContSkillAdminGUI\settings(), ilWorkspaceAccessGUI\share(), ilObjWorkspaceFolderGUI\share(), ilLearningHistoryGUI\show(), ilMembershipOverviewGUI\show(), ilObjNotificationSettingsGUI\show(), ilDerivedTasksGUI\show(), ilTaxMDGUI\show(), ilObjSystemFolderGUI\showBasicSettingsObject(), ilBookingProcessWithoutScheduleGUI\showConfirmation(), ilObjSystemFolderGUI\showDbBenchResults(), ilSurveyExecutionGUI\showFinishConfirmation(), ilExerciseManagementGUI\showGradesOverviewObject(), ilSkillRootGUI\showImportForm(), ilSkillProfileGUI\showImportForm(), ilBasicSkillGUI\showLevelResources(), ilSkillProfileGUI\showLevels(), ilSkillProfileGUI\showLevelsWithLocalContext(), ilExerciseManagementGUI\showMultiFeedbackConfirmationTableObject(), ilBasicSkillTemplateGUI\showObjects(), ilSkillTemplateReferenceGUI\showObjects(), ilSkillTreeNodeGUI\showObjects(), ilSkillProfileGUI\showObjects(), ilExerciseManagementGUI\showParticipantObject(), ilWorkspaceAccessGUI\showPasswordForm(), ilObjBookingPoolGUI\showProfileObject(), ilBasicSkillGUI\showProperties(), ilRepositorySelectorInputGUI\showRepositorySelection(), ilPageEditorGUI\showSnippetInfo(), ilLMImportGUI\showTranslationImportForm(), ilMediaPoolImportGUI\showTranslationImportForm(), ilBasicSkillTemplateGUI\showUsage(), ilSkillTemplateCategoryGUI\showUsage(), ilSkillTreeNodeGUI\showUsage(), ilSkillProfileGUI\showUsers(), ilObjTaggingSettingsGUI\showUsers(), ilBookingScheduleGUI\update(), ilPCMapGUI\update(), ilPCAMDFormGUI\update(), ilSkillTreeNodeGUI\update(), ilSkillProfileGUI\update(), ilObjMediaPoolGUI\updateFolder(), ilBasicSkillGUI\updateLevel(), ilSkillTemplateReferenceGUI\updateSkillTemplateReference(), ilObjSurveyQuestionPoolGUI\uploadQuestionsObject(), ilExcCriteriaCatalogueGUI\view(), ilExcCriteriaGUI\view(), ilEditClipboardGUI\view(), ilObjLanguageExtGUI\viewObject(), and ilBookingProcessWithScheduleGUI\week().

+ Here is the caller graph for this function:

◆ setCurrentBlock()

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

Sets the template to the given block.

Implemented in ilGlobalPageTemplate, ilDataCollectionGlobalTemplate, ilRTEGlobalTemplate, ilGlobalTemplate, and ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter.

Referenced by ilBlogPostingGUI\__construct(), ilPortfolioPageGUI\__construct(), ilPageLayoutGUI\__construct(), ilCalendarCategoryGUI\addReferenceLinks(), ilObjStudyProgrammeIndividualPlanGUI\buildFrame(), ilECSSettingsGUI\communities(), ilSCORMExplorer\createOutput(), ilPageObjectGUI\displayMedia(), ilRegistrationGUI\fillMembershipLimitation(), ilStudyProgrammeExpandableProgressListGUI\fillTemplate(), ilStudyProgrammeProgressListGUI\fillTemplate(), ilContainerSelectionExplorer\formatHeader(), ilRepositoryExplorer\formatHeader(), ilSCORMExplorer\formatHeader(), ilSearchRootSelector\formatHeader(), ilECSNodeMappingCmsExplorer\formatHeader(), ilECSNodeMappingLocalExplorer\formatHeader(), ilECSNodeMappingCmsExplorer\formatObject(), ilECSNodeMappingLocalExplorer\formatObject(), ilPersonalSkillsGUI\getBasicSkillDescription(), ILIAS\User\Profile\PublicProfileGUI\getEmbeddable(), ilAttendanceList\getHTML(), ilCalendarAppointmentPresentationGUI\getModalHTML(), ilSCORMExplorer\getOutputIcons(), ilContainerStartObjectsContentGUI\getPageHTML(), ilPersonalSkillsGUI\getSkillCategoryDescription(), ilPersonalSkillsGUI\getSkillEntriesHeader(), ilPersonalSkillsGUI\getSkillLevelDescription(), ilLPListOfSettingsGUI\handleLPUsageInfo(), ilObjCourseGUI\infoScreen(), ilCourseObjectivesGUI\initFormLimits(), ilFileWizardInputGUI\insert(), ilImageFileInputGUI\insert(), ilSelectBuilderInputGUI\insert(), ilMatrixRowWizardInputGUI\insert(), ilTagInputGUI\insert(), ilSCORMExplorer\insertObject(), ilPCResourcesGUI\insertResourcesIntoPageContent(), ilExplorerBaseGUI\listItemStart(), ilTestEvaluationGUI\outUserPassDetails(), ilRegistrationSettingsGUI\parseRoleList(), SurveyQuestionGUI\preview(), ILIAS\MediaCast\Presentation\VideoViewGUI\render(), ilTagInputGUI\render(), ilTextWizardInputGUI\render(), ilMultipleImagesInputGUI\render(), ilMultipleTextsInputGUI\render(), ilExplorerBaseGUI\renderChilds(), ilExplorerBaseGUI\renderNode(), ilForumExportGUI\renderPostHtml(), ilContainerObjectiveGUI\showObjectives(), ilPageObjectGUI\showPage(), ilLMPresentationGUI\showPrintView(), ilLocalUserGUI\showRolesTable(), and ilTestEvalObjectiveOrientedGUI\showVirtualPassCmd().

+ Here is the caller graph for this function:

◆ setDescription()

◆ setFileUploadRefId()

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

◆ setHeaderActionMenu()

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

◆ setHeaderPageTitle()

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

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

Implemented in ilDataCollectionGlobalTemplate, ilRTEGlobalTemplate, ilGlobalPageTemplate, ilGlobalTemplate, and ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter.

Referenced by ilWikiPageGUI\executeCommand().

+ Here is the caller graph for this function:

◆ setLeftContent()

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

◆ setLeftNavContent()

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

Sets content of left navigation column.

Implemented in ilDataCollectionGlobalTemplate, ilRTEGlobalTemplate, ilGlobalPageTemplate, ilGlobalTemplate, and ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter.

Referenced by ilObjWorkspaceFolderGUI\render(), and ilObjSkillTreeGUI\showTree().

+ Here is the caller graph for this function:

◆ setLocator()

◆ setLoginTargetPar()

ILIAS\UICore\GlobalTemplate::setLoginTargetPar ( string  $a_val)

Set target parameter for login (public sector).

This is used by the main menu

Implemented in ilDataCollectionGlobalTemplate, ilRTEGlobalTemplate, ilGlobalPageTemplate, ilGlobalTemplate, and ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter.

◆ setOnScreenMessage()

ILIAS\UICore\GlobalTemplate::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().

Implemented in ilGlobalPageTemplate, ilGlobalTemplate, ilDataCollectionGlobalTemplate, ilRTEGlobalTemplate, and ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter.

Referenced by ilSurveySkillThresholdsTableGUI\__construct(), ilBookingAssignParticipantsTableGUI\__construct(), ilObjDataCollectionGUI\_goto(), ilObjMediaPoolGUI\_goto(), ilDidacticTemplateSettingsGUI\activateTemplates(), ilPortfolioRoleAssignmentGUI\confirmAssignmentDeletion(), ilExcCriteriaCatalogueGUI\confirmDeletion(), ilExcCriteriaGUI\confirmDeletion(), ilRecommendedContentRoleConfigGUI\confirmRemoveItems(), ilExSubmissionTeamGUI\confirmRemoveTeamMemberObject(), ilPersonalSkillsGUI\confirmSkillRemove(), ilTestExportPlugin\createExportFile(), ilDidacticTemplateSettingsGUI\deactivateTemplates(), ilObjSkillTreeGUI\deleteNodes(), ilDidacticTemplateSettingsGUI\deleteTemplates(), ilObjLearningSequenceGUI\executeCommand(), ilContSkillAdminGUI\initCompetenceAssignmentForm(), ILIAS\LegalDocuments\PageFragment\ShowOnScreenMessage\render(), ilBasicSkillGUI\saveResourcesAsNoTrigger(), ilBasicSkillGUI\saveResourcesAsNotSuggested(), ilBasicSkillGUI\saveResourcesAsSuggested(), ilBasicSkillGUI\saveResourcesAsTrigger(), ilRepositoryTrashGUI\showDeleteConfirmation(), ilLMImportGUI\showTranslationImportForm(), and ilMediaPoolImportGUI\showTranslationImportForm().

+ Here is the caller graph for this function:

◆ setPageFormAction()

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

◆ setPermanentLink()

ILIAS\UICore\GlobalTemplate::setPermanentLink ( string  $a_type,
?int  $a_id,
string  $a_append = "",
string  $a_target = "",
string  $a_title = "" 
)

◆ setRightContent()

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

◆ setSubTabs()

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

◆ setTabs()

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

◆ setTitle()

◆ setTitleIcon()

◆ setTreeFlatIcon()

ILIAS\UICore\GlobalTemplate::setTreeFlatIcon ( string  $a_link,
string  $a_mode 
)

Sets a tree or flat icon.

Parameters
string$a_mode("tree" | "flat")

Implemented in ilDataCollectionGlobalTemplate, ilRTEGlobalTemplate, ilGlobalPageTemplate, ilGlobalTemplate, and ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter.

◆ setVariable()

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

Sets the given variable to the given value.

Parameters
mixed$value

Implemented in ilDataCollectionGlobalTemplate, ilRTEGlobalTemplate, ilGlobalPageTemplate, ilGlobalTemplate, and ILIAS\UICore\GlobalTemplateLegacyInitialisationAdapter.

Referenced by ilBlogPostingGUI\__construct(), ilPortfolioPageGUI\__construct(), ilPageLayoutGUI\__construct(), ilLearningProgressBaseGUI\__getLegendHTML(), ilObjIndividualAssessmentGUI\addMemberDataToInfo(), ilCalendarCategoryGUI\addReferenceLinks(), ilCalendarCategoryGUI\appendCalendarSelection(), ilSearchResultPresentation\appendMorePathes(), ilSearchResultPresentation\appendPath(), ilObjStudyProgrammeIndividualPlanGUI\buildFrame(), ilECSSettingsGUI\communities(), ilPageObjectGUI\compareVersion(), ilSCORMExplorer\createOutput(), ilAccountRegistrationGUI\displayForm(), ilPageObjectGUI\displayMedia(), ilCourseRegistrationGUI\fillMaxMembers(), ilGroupRegistrationGUI\fillMaxMembers(), ilRegistrationGUI\fillMembershipLimitation(), ilCourseRegistrationGUI\fillRegistrationPeriod(), ilGroupRegistrationGUI\fillRegistrationPeriod(), ilStudyProgrammeExpandableProgressListGUI\fillTemplate(), ilStudyProgrammeProgressListGUI\fillTemplate(), ilContainerSelectionExplorer\formatHeader(), ilRepositoryExplorer\formatHeader(), ilSCORMExplorer\formatHeader(), ilSearchRootSelector\formatHeader(), ilECSNodeMappingCmsExplorer\formatHeader(), ilECSNodeMappingLocalExplorer\formatHeader(), ilECSNodeMappingCmsExplorer\formatObject(), ilECSNodeMappingLocalExplorer\formatObject(), ilPersonalSkillsGUI\getActualGapItem(), ilPersonalSkillsGUI\getBasicSkillDescription(), ILIAS\User\Profile\PublicProfileGUI\getEmbeddable(), ilPersonalSkillsGUI\getEvalItem(), ilCalendarHeaderNavigationGUI\getHTML(), ilAttendanceList\getHTML(), ilUserFilterGUI\getHTML(), ilLMPresentationGUI\getHTML(), ilContainerContentGUI\getIntroduction(), ilContainerContentGUI\getMainContent(), ilContainerObjectiveGUI\getMainContent(), ilDashboardGUI\getMainContent(), ilCalendarSubscriptionGUI\getModalForSubscription(), ilCalendarAppointmentPresentationGUI\getModalHTML(), ilSCORMExplorer\getOutputIcons(), ilContainerStartObjectsContentGUI\getPageHTML(), ilPersonalSkillsGUI\getProfileTargetItem(), ilPersonalSkillsGUI\getSelfEvalGapItem(), ilPersonalSkillsGUI\getSkillCategoryDescription(), ilPersonalSkillsGUI\getSkillEntriesHeader(), ilPersonalSkillsGUI\getSkillLevelDescription(), ilLPListOfSettingsGUI\handleLPUsageInfo(), ilObjCourseGUI\infoScreen(), ilECSSettingsGUI\initCategoryMappingForm(), ilECSMappingSettingsGUI\initFormCSettings(), ilCourseObjectivesGUI\initFormLimits(), ilECSSettingsGUI\initSettingsForm(), ilFileWizardInputGUI\insert(), ilSelectBuilderInputGUI\insert(), ilMatrixRowWizardInputGUI\insert(), ilTagInputGUI\insert(), ilSCORMExplorer\insertObject(), ilPageObjectGUI\insertPageToc(), ilAssQuestionPageGUI\insertPageToc(), ilPCResourcesGUI\insertResourcesIntoPageContent(), ilPersonalSkillsGUI\listAssignedProfile(), ilExplorerBaseGUI\listItemStart(), ilPersonalSkillsGUI\listSkills(), ilAccountRegistrationGUI\login(), ilTestEvaluationGUI\outUserPassDetails(), ilRegistrationSettingsGUI\parseRoleList(), ilObjectPermissionStatusGUI\perminfo(), SurveyQuestionGUI\preview(), ilRepositorySelectorInputGUI\render(), ILIAS\MediaCast\Presentation\VideoViewGUI\render(), ilTagInputGUI\render(), ilTextWizardInputGUI\render(), ilMultipleImagesInputGUI\render(), ilMultipleTextsInputGUI\render(), ilExplorerBaseGUI\renderChilds(), ilExplorerBaseGUI\renderNode(), ilForumExportGUI\renderPostHtml(), ILIAS\MediaCast\Presentation\VideoViewGUI\renderSideColumn(), ilPasswordAssistanceGUI\showAssistanceForm(), ilAccessibilityControlConceptGUI\showControlConcept(), ilPasswordAssistanceGUI\showMessageForm(), ilContainerObjectiveGUI\showObjectives(), ilPageObjectGUI\showPage(), ilObjMediaPoolGUI\showPage(), ilLMPresentationGUI\showPrintView(), ilLMPresentationGUI\showPrintViewSelection(), ilLocalUserGUI\showRolesTable(), ilCalendarPresentationGUI\showSideBlocks(), ilPasswordAssistanceGUI\showUsernameAssistanceForm(), ilTestEvalObjectiveOrientedGUI\showVirtualPassCmd(), ilObjStudyProgrammeIndividualPlanGUI\view(), and ilObjLanguageExtGUI\viewObject().

+ Here is the caller graph for this function:

◆ touchBlock()

Field Documentation

◆ DEFAULT_BLOCK

const ILIAS\UICore\GlobalTemplate::DEFAULT_BLOCK = 'DEFAULT'

◆ MESSAGE_TYPE_FAILURE

◆ MESSAGE_TYPE_INFO

const ILIAS\UICore\GlobalTemplate::MESSAGE_TYPE_INFO = "info"

◆ MESSAGE_TYPE_QUESTION

const ILIAS\UICore\GlobalTemplate::MESSAGE_TYPE_QUESTION = "question"

Definition at line 30 of file GlobalTemplate.php.

Referenced by ilStartUpGUI\retrieveMessagesFromSession().

◆ MESSAGE_TYPE_SUCCESS

◆ MESSAGE_TYPES


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