ILIAS  release_8 Revision v8.24
ilGlobalTemplateInterface Interface Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

+ Inheritance diagram for ilGlobalTemplateInterface:
+ Collaboration diagram for ilGlobalTemplateInterface:

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...
 
 addLightbox (string $a_html, string $a_id)
 Add a lightbox html to the template. 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

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning

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
Thibeau Fuhrer thibe.nosp@m.au@s.nosp@m.r.sol.nosp@m.utio.nosp@m.ns

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

Member Function Documentation

◆ addAdminPanelToolbar()

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

Implemented in ilGlobalPageTemplate, ilGlobalTemplate, ilDataCollectionGlobalTemplate, and ilRTEGlobalTemplate.

◆ addBlockFile()

ilGlobalTemplateInterface::addBlockFile ( string  $var,
string  $block,
string  $template_name,
string  $in_module = null 
)

overwrites ITX::addBlockFile

Implemented in ilDataCollectionGlobalTemplate, ilRTEGlobalTemplate, ilGlobalPageTemplate, and ilGlobalTemplate.

Referenced by ilAccessibilityControlConceptGUI\initTemplate(), and ilObjSystemFolderGUI\showJavaServerObject().

+ Here is the caller graph for this function:

◆ addCss()

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

◆ addInlineCss()

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

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

Implemented in ilDataCollectionGlobalTemplate, ilRTEGlobalTemplate, ilGlobalPageTemplate, and ilGlobalTemplate.

◆ addJavaScript()

◆ addLightbox()

ilGlobalTemplateInterface::addLightbox ( string  $a_html,
string  $a_id 
)

Add a lightbox html to the template.

Implemented in ilDataCollectionGlobalTemplate, ilRTEGlobalTemplate, ilGlobalPageTemplate, and ilGlobalTemplate.

Referenced by ilCharSelectorGUI\addToPage().

+ Here is the caller graph for this function:

◆ addOnLoadCode()

◆ blockExists()

ilGlobalTemplateInterface::blockExists ( string  $block_name)

check if block exists in actual template

Parameters
string$block_name

Implemented in ilGlobalTemplate, ilDataCollectionGlobalTemplate, ilRTEGlobalTemplate, and ilGlobalPageTemplate.

◆ clearHeader()

ilGlobalTemplateInterface::clearHeader ( )

◆ fillJavaScriptFiles()

ilGlobalTemplateInterface::fillJavaScriptFiles ( bool  $a_force = false)

Probably adds javascript files.

Implemented in ilDataCollectionGlobalTemplate, ilRTEGlobalTemplate, ilGlobalPageTemplate, and ilGlobalTemplate.

◆ get()

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

Renders the given block and returns the html string.

Implemented in ilDataCollectionGlobalTemplate, ilRTEGlobalTemplate, ilGlobalPageTemplate, and ilGlobalTemplate.

Referenced by ilLearningProgressBaseGUI\__getLegendHTML(), ilMDEditorGUI\__showLanguageSelect(), ilCharSelectorGUI\addFormProperties(), ilObjIndividualAssessmentGUI\addMemberDataToInfo(), ilCalendarCategoryGUI\addReferenceLinks(), ilObjFileGUI\addUIFormToAccordion(), ilCalendarCategoryGUI\appendCalendarSelection(), ilObjStudyProgrammeIndividualPlanGUI\buildFrame(), ilECSSettingsGUI\communities(), ilPageObjectGUI\compareVersion(), ilCourseRegistrationGUI\fillMaxMembers(), ilGroupRegistrationGUI\fillMaxMembers(), ilRegistrationGUI\fillMembershipLimitation(), ilCourseRegistrationGUI\fillRegistrationPeriod(), ilGroupRegistrationGUI\fillRegistrationPeriod(), ilSCORMExplorer\formatHeader(), ilContainerSelectionExplorer\formatHeader(), ilStudyProgrammeProgressListGUI\getHTML(), ilCalendarHeaderNavigationGUI\getHTML(), ilMiniCalendarGUI\getHTML(), ilAttendanceList\getHTML(), ilUserFilterGUI\getHTML(), ilLightboxGUI\getHTML(), ilContainerByTypeContentGUI\getMainContent(), ilContainerObjectiveGUI\getMainContent(), ilContainerSessionsContentGUI\getMainContent(), ilContainerSimpleContentGUI\getMainContent(), ilDashboardGUI\getMainContent(), ilCalendarSubscriptionGUI\getModalForSubscription(), ilCalendarAppointmentPresentationGUI\getModalHTML(), ilObjStudyProgrammeTreeExplorerGUI\getNodeContent(), ilCharSelectorGUI\getSelectorHTML(), ilPersonalSkillsGUI\getSkillEntriesHeader(), ilLPListOfSettingsGUI\handleLPUsageInfo(), ilObjCourseGUI\infoScreen(), ilECSSettingsGUI\initCategoryMappingForm(), ilECSMappingSettingsGUI\initFormCSettings(), ilCourseObjectivesGUI\initFormLimits(), ilECSSettingsGUI\initSettingsForm(), ilMatrixRowWizardInputGUI\insert(), ilFileWizardInputGUI\insert(), ilSelectBuilderInputGUI\insert(), ilAssQuestionPageGUI\insertPageToc(), ilMDEditorGUI\listAnnotation(), ilMDEditorGUI\listClassification(), ilMDEditorGUI\listEducational(), ilMDEditorGUI\listGeneral(), ilMDEditorGUI\listLifecycle(), ilMDEditorGUI\listMetaMetaData(), ilMDEditorGUI\listQuickEdit_scorm(), ilMDEditorGUI\listRelation(), ilMDEditorGUI\listRights(), ilMDEditorGUI\listTechnical(), ilRegistrationSettingsGUI\parseRoleList(), ilObjectPermissionStatusGUI\perminfo(), ilAccessibilityControlConceptGUI\printToGlobalTemplate(), ilRepositorySelectorInputGUI\render(), ILIAS\MediaCast\Presentation\VideoViewGUI\render(), ilTagInputGUI\render(), ilMultipleImagesInputGUI\render(), ilTextWizardInputGUI\render(), ILIAS\MediaCast\Presentation\VideoViewGUI\renderSideColumn(), ilAssQuestionPreviewGUI\showCmd(), ilCalendarPresentationGUI\showSideBlocks(), ilAssQuestionSkillAssignmentsGUI\showSkillSelectionCmd(), ilPersonalProfileGUI\showUserAgreement(), and ilObjStudyProgrammeIndividualPlanGUI\view().

+ Here is the caller graph for this function:

◆ getOnLoadCodeForAsynch()

ilGlobalTemplateInterface::getOnLoadCodeForAsynch ( )

Get js onload code for ajax calls.

Implemented in ilDataCollectionGlobalTemplate, ilRTEGlobalTemplate, ilGlobalPageTemplate, and ilGlobalTemplate.

◆ getSpecial()

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

Implemented in ilDataCollectionGlobalTemplate, ilRTEGlobalTemplate, ilGlobalPageTemplate, and ilGlobalTemplate.

◆ hideFooter()

ilGlobalTemplateInterface::hideFooter ( )

Make the template hide the footer.

Implemented in ilDataCollectionGlobalTemplate, ilRTEGlobalTemplate, ilGlobalPageTemplate, and ilGlobalTemplate.

◆ loadStandardTemplate()

ilGlobalTemplateInterface::loadStandardTemplate ( )

This loads the standard template "tpl.adm_content.html" and "tpl.statusline.html" the CONTENT and STATUSLINE placeholders if they are not already loaded.

Implemented in ilDataCollectionGlobalTemplate, ilRTEGlobalTemplate, ilGlobalPageTemplate, and ilGlobalTemplate.

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

+ Here is the caller graph for this function:

◆ parseCurrentBlock()

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

Parses the given block.

Implemented in ilDataCollectionGlobalTemplate, ilRTEGlobalTemplate, ilGlobalPageTemplate, and ilGlobalTemplate.

Referenced by ilBlogPostingGUI\__construct(), ilPortfolioPageGUI\__construct(), ilPageLayoutGUI\__construct(), ilMDEditorGUI\__showLanguageSelect(), ilCalendarCategoryGUI\addReferenceLinks(), ilObjStudyProgrammeIndividualPlanGUI\buildFrame(), ilECSSettingsGUI\communities(), ilSCORMExplorer\createOutput(), ilRegistrationGUI\fillMembershipLimitation(), ilStudyProgrammeExpandableProgressListGUI\fillTemplate(), ilStudyProgrammeProgressListGUI\fillTemplate(), ilSCORMExplorer\formatHeader(), ilContainerSelectionExplorer\formatHeader(), ilRepositoryExplorer\formatHeader(), ilECSNodeMappingCmsExplorer\formatHeader(), ilECSNodeMappingLocalExplorer\formatHeader(), ilECSNodeMappingCmsExplorer\formatObject(), ilECSNodeMappingLocalExplorer\formatObject(), ilAttendanceList\getHTML(), ilCalendarAppointmentPresentationGUI\getModalHTML(), ilObjStudyProgrammeTreeExplorerGUI\getNodeContent(), ilSCORMExplorer\getOutputIcons(), ilCharSelectorGUI\getSelectorHTML(), ilPersonalSkillsGUI\getSkillEntriesHeader(), ilLPListOfSettingsGUI\handleLPUsageInfo(), ilObjCourseGUI\infoScreen(), ilCourseObjectivesGUI\initFormLimits(), ilMatrixRowWizardInputGUI\insert(), ilFileWizardInputGUI\insert(), ilSelectBuilderInputGUI\insert(), ilSCORMExplorer\insertObject(), ilMDEditorGUI\listAnnotation(), ilMDEditorGUI\listClassification(), ilMDEditorGUI\listEducational(), ilMDEditorGUI\listGeneral(), ilExplorerBaseGUI\listItemStart(), ilMDEditorGUI\listLifecycle(), ilMDEditorGUI\listMetaMetaData(), ilMDEditorGUI\listQuickEdit_scorm(), ilMDEditorGUI\listRelation(), ilMDEditorGUI\listRights(), ilMDEditorGUI\listTechnical(), ilRegistrationSettingsGUI\parseRoleList(), ilAssQuestionPreviewGUI\populateGenericQuestionFeedback(), ilAssQuestionPreviewGUI\populateInstantResponseHeader(), ilAssQuestionPreviewGUI\populateInstantResponseMessage(), ilAssQuestionPreviewGUI\populateNotesPanel(), ilAssQuestionPreviewGUI\populateReachedPointsOutput(), ilAssQuestionPreviewGUI\populateSolutionOutput(), ilAssQuestionPreviewGUI\populateSpecificQuestionFeedback(), SurveyQuestionGUI\preview(), ilTagInputGUI\render(), ilMultipleImagesInputGUI\render(), ilTextWizardInputGUI\render(), ilExplorerBaseGUI\renderNode(), ilContainerGUI\showLinkListObject(), ilContainerObjectiveGUI\showObjectives(), ilPageObjectGUI\showPage(), ilLMPresentationGUI\showPrintView(), and ilLocalUserGUI\showRolesTable().

+ Here is the caller graph for this function:

◆ printToStdout()

ilGlobalTemplateInterface::printToStdout ( string  $part = self::DEFAULT_BLOCK,
bool  $has_tabs = true,
bool  $skip_main_menu = false 
)

◆ printToString()

ilGlobalTemplateInterface::printToString ( )

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

Implemented in ilDataCollectionGlobalTemplate, ilRTEGlobalTemplate, and ilGlobalPageTemplate.

◆ resetHeaderBlock()

ilGlobalTemplateInterface::resetHeaderBlock ( bool  $a_reset_header_action = true)

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

Implemented in ilDataCollectionGlobalTemplate, ilRTEGlobalTemplate, ilGlobalPageTemplate, and ilGlobalTemplate.

◆ resetJavascript()

ilGlobalTemplateInterface::resetJavascript ( )

◆ setAlertProperties()

ilGlobalTemplateInterface::setAlertProperties ( array  $alerts)

Set alert properties.

Parameters
array<int,array>$alerts

Implemented in ilGlobalPageTemplate, ilGlobalTemplate, ilDataCollectionGlobalTemplate, and ilRTEGlobalTemplate.

◆ setBodyClass()

ilGlobalTemplateInterface::setBodyClass ( string  $a_class = "")

◆ setContent()

ilGlobalTemplateInterface::setContent ( string  $a_html)

Sets content for standard template.

Implemented in ilDataCollectionGlobalTemplate, ilRTEGlobalTemplate, ilGlobalPageTemplate, and ilGlobalTemplate.

Referenced by ilExcCriteriaGUI\add(), ilRatingCategoryGUI\add(), ilPortfolioRoleAssignmentGUI\addAssignment(), ilBadgeManagementGUI\addBadge(), ilObjMediaCastGUI\addCastItemObject(), ilContentStyleImageGUI\addImage(), ilBasicSkillGUI\addLevel(), ilBasicSkillGUI\addLevelResource(), ilObjLanguageExtGUI\addNewEntryObject(), ilObjTestGUI\addQuestionObject(), ilSettingsTemplateGUI\addSettingsTemplate(), ilObjMediaPoolGUI\allMedia(), ilContSkillAdminGUI\assignCompetences(), ilSkillProfileGUI\assignLevel(), ilSkillProfileGUI\assignLevelSelectSkill(), ilObjSessionGUI\attendanceListObject(), ilObjSystemFolderGUI\benchmarkObject(), ilBookingProcessGUI\book(), ilObjMediaPoolGUI\bulkUpload(), ilPageEditorGUI\characteristic(), ilSurveyParticipantsGUI\confirmAppraiseeCloseObject(), ilPortfolioRoleAssignmentGUI\confirmAssignmentDeletion(), ilDclCreateViewDefinitionGUI\confirmDelete(), ilDclEditViewDefinitionGUI\confirmDelete(), ilRatingCategoryGUI\confirmDelete(), ilSkillProfileGUI\confirmDeleteProfiles(), ilContSkillAdminGUI\confirmDeleteSelectedLocalProfiles(), ilContSkillAdminGUI\confirmDeleteSingleLocalProfile(), ilExcCriteriaCatalogueGUI\confirmDeletion(), ilExcCriteriaGUI\confirmDeletion(), ilObjHelpSettingsGUI\confirmHelpModulesDeletion(), ilSkillProfileGUI\confirmLevelAssignmentRemoval(), ilBasicSkillGUI\confirmLevelDeletion(), ilBasicSkillGUI\confirmLevelResourcesRemoval(), ilRecommendedContentRoleConfigGUI\confirmRemoveItems(), ilContSkillAdminGUI\confirmRemoveSelectedGlobalProfiles(), ilContSkillAdminGUI\confirmRemoveSelectedSkill(), ilContSkillAdminGUI\confirmRemoveSingleGlobalProfile(), ilSettingsTemplateGUI\confirmSettingsTemplateDeletion(), ilSkillProfileGUI\confirmUserRemoval(), ilBookingScheduleGUI\create(), ilPCAMDFormGUI\create(), ilPCContentTemplateGUI\create(), ilPCListGUI\create(), ilPCMapGUI\create(), ilSkillProfileGUI\create(), ilSkillTreeNodeGUI\create(), ilBookingObjectGUI\create(), ilObjMediaPoolGUI\createFolderForm(), ilSkillProfileGUI\createLocal(), ilObjStyleSheetGUI\createObject(), ilMediaCreationGUI\creationSelection(), ilContSkillAdminGUI\deassignCompetencesConfirm(), ilAdministrationCommandGUI\delete(), ilPageEditorGUI\delete(), ilObjWorkspaceFolderGUI\deleteConfirmation(), ilObjSkillManagementGUI\deleteNodes(), ilObjSkillTreeGUI\deleteNodes(), ilBookingScheduleGUI\edit(), ilObjMediaPoolGUI\edit(), ilPCMapGUI\edit(), ilBasicSkillGUI\edit(), ilBasicSkillTemplateGUI\edit(), ilSkillCategoryGUI\edit(), ilSkillProfileGUI\edit(), ilPCLoginPageElementGUI\edit(), ilPCPluggedGUI\edit(), ilPCResourcesGUI\edit(), ilBookingObjectGUI\edit(), ilPCConsultationHoursGUI\edit(), ilPCMyCoursesGUI\edit(), ilPCAMDPageListGUI\edit(), ilPCBlogGUI\edit(), ilPCProfileGUI\edit(), ilPCSkillsGUI\edit(), ilPCLearningHistoryGUI\edit(), ilRatingCategoryGUI\edit(), ilObjMediaCastGUI\editCastItemObject(), ilObjMediaPoolGUI\editFolder(), ilObjTaggingSettingsGUI\editForbiddenTags(), ilLMPageObjectGUI\editLayout(), ilBasicSkillGUI\editLevel(), ilObjExternalToolsSettingsGUI\editMapsObject(), ilObjContentObjectGUI\editMenuProperties(), ilObjBibliographicGUI\editObject(), ilPCAMDFormGUI\editPortfolio(), ilSkillTemplateReferenceGUI\editProperties(), ilSkillTreeNodeGUI\editProperties(), ilObjLearningHistorySettingsGUI\editSettings(), ilObjCommentsSettingsGUI\editSettings(), ilObjNotesSettingsGUI\editSettings(), ilObjWikiSettingsGUI\editSettings(), ilObjWikiGUI\editSettingsObject(), ilSettingsTemplateGUI\editSettingsTemplate(), ilPCAMDFormGUI\editTemplate(), ilObjMediaPoolGUI\editTitlesAndDescriptions(), ilMediaCreationGUI\editTitlesAndDescriptions(), ilTermDefinitionEditorGUI\executeCommand(), ilLMPageObjectGUI\executeCommand(), ilObjLearningSequenceGUI\executeCommand(), ilObjMediaPoolGUI\executeCommand(), ilObjTestGUI\executeCommand(), ilObjWikiGUI\executeCommand(), ilContainerGUI\executeCommand(), ilWorkspaceAccessGUI\executeCommand(), ilObjContentObjectGUI\importFileObject(), ilObjSurveyQuestionPoolGUI\importFileObject(), ilPersonalProfileGUI\importPersonalData(), ilSkillProfileGUI\importProfiles(), ilObjSurveyQuestionPoolGUI\importQuestionsObject(), ilSkillRootGUI\importSkills(), ilPCContentTemplateGUI\insert(), ilPCMapGUI\insert(), ilSkillTemplateReferenceGUI\insert(), ilPCAMDFormGUI\insert(), ilPCConsultationHoursGUI\insert(), ilPCMyCoursesGUI\insert(), ilPCAMDPageListGUI\insert(), ilPCBlogGUI\insert(), ilPCProfileGUI\insert(), ilPCSkillsGUI\insert(), ilPCLearningHistoryGUI\insert(), ilPCContentIncludeGUI\insertFromPool(), ilPCFileItemGUI\insertFromRepository(), ilPCFileListGUI\insertFromRepository(), ilPCFileItemGUI\insertFromWorkspace(), ilBadgeProfileGUI\listBackpackGroups(), ilBadgeManagementGUI\listBadges(), ilBadgeProfileGUI\listBadges(), ilBookingPreferencesGUI\listBookingResults(), ilRatingCategoryGUI\listCategories(), ilSurveySkillThresholdsGUI\listCompetences(), ilContSkillAdminGUI\listCompetences(), ilObjWikiGUI\listContributorsObject(), ilTestExportGUI\listExportFiles(), 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(), ilSettingsTemplateGUI\listSettingsTemplates(), ilSurveySkillDeterminationGUI\listSkillChanges(), ilSkillRootGUI\listSkills(), ilSurveySkillThresholdsGUI\listSkillThresholds(), ilSkillRootGUI\listTemplates(), ilBookingReservationsGUI\log(), ilBadgeProfileGUI\manageBadges(), ilObjTestGUI\movePageFormObject(), ilObjWorkspaceFolderGUI\passwordForm(), ilPCContentIncludeGUI\poolSelection(), ilPCQuestionGUI\poolSelection(), ilMediaCreationGUI\poolSelection(), ilObjFileBasedLMGUI\properties(), ilObjSCORM2004LearningModuleGUI\properties(), ilObjStyleSheetGUI\propertiesObject(), ilBookingObjectGUI\render(), ilBookingScheduleGUI\render(), ilObjWorkspaceFolderGUI\render(), ilSkillProfileGUI\save(), ilObjSkillTreeGUI\save(), ilSkillTreeNodeGUI\save(), ilTaxMDGUI\save(), ilUserProfileInfoSettingsGUI\save(), ilObjAccessibilitySettingsGUI\saveAccessibilitySettings(), ilPortfolioRoleAssignmentGUI\saveAssignment(), ilObjSystemFolderGUI\saveBasicSettingsObject(), ilObjSystemFolderGUI\saveContactInformationObject(), ilObjMediaPoolGUI\saveFolder(), ilObjSystemFolderGUI\saveJavaServerObject(), ilLMPageObjectGUI\saveLayout(), ilBasicSkillGUI\saveLevel(), ilSkillProfileGUI\saveLocal(), ilObjWikiGUI\saveObject(), ilObjFileBasedLMGUI\saveProperties(), ilPCListGUI\saveProperties(), ilSettingsTemplateGUI\saveSettingsTemplate(), ilUserStartingPointGUI\saveStartingPoint(), ilContainerFilterAdminGUI\selectFields(), ilRecommendedContentRoleConfigGUI\selectItem(), ilContSkillAdminGUI\selectSkill(), ilContainerContentGUI\setOutput(), ilContentStyleSettingsGUI\setScope(), ilContSkillAdminGUI\settings(), ilObjAdvancedEditingGUI\settingsObject(), ilWorkspaceAccessGUI\share(), ilObjWorkspaceFolderGUI\share(), ilLearningHistoryGUI\show(), ilMembershipOverviewGUI\show(), ilObjNotificationSettingsGUI\show(), ilDerivedTasksGUI\show(), ilTaxMDGUI\show(), ilUserProfileInfoSettingsGUI\show(), ilObjSystemFolderGUI\showBasicSettingsObject(), ilObjSystemFolderGUI\showContactInformationObject(), ilObjSystemFolderGUI\showDbBenchResults(), ilSurveyExecutionGUI\showFinishConfirmation(), ilObjSystemFolderGUI\showHeaderTitleObject(), ilSkillRootGUI\showImportForm(), ilSkillProfileGUI\showImportForm(), ilBasicSkillGUI\showLevelResources(), ilSkillProfileGUI\showLevels(), ilSkillProfileGUI\showLevelsWithLocalContext(), ilBasicSkillTemplateGUI\showObjects(), ilSkillTemplateReferenceGUI\showObjects(), ilSkillProfileGUI\showObjects(), ilSkillTreeNodeGUI\showObjects(), ilWorkspaceAccessGUI\showPasswordForm(), ilObjFileAccessSettingsGUI\showPreviewRenderers(), ilBasicSkillGUI\showProperties(), ilRepositorySelectorInputGUI\showRepositorySelection(), ilLMImportGUI\showTranslationImportForm(), ilMediaPoolImportGUI\showTranslationImportForm(), ilBasicSkillTemplateGUI\showUsage(), ilSkillTemplateCategoryGUI\showUsage(), ilSkillTreeNodeGUI\showUsage(), ilSkillProfileGUI\showUsers(), ilObjTaggingSettingsGUI\showUsers(), ilPCAMDFormGUI\update(), ilPCMapGUI\update(), ilSkillProfileGUI\update(), ilSkillTreeNodeGUI\update(), ilObjMediaPoolGUI\updateFolder(), ilBasicSkillGUI\updateLevel(), ilSettingsTemplateGUI\updateSettingsTemplate(), ilSkillTemplateReferenceGUI\updateSkillTemplateReference(), ilContentStyleImageGUI\uploadImage(), ilObjSurveyQuestionPoolGUI\uploadQuestionsObject(), ilExcCriteriaCatalogueGUI\view(), ilExcCriteriaGUI\view(), ilEditClipboardGUI\view(), ilPDNewsGUI\view(), and ilObjLanguageExtGUI\viewObject().

+ Here is the caller graph for this function:

◆ setCurrentBlock()

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

Sets the template to the given block.

Implemented in ilGlobalPageTemplate, ilDataCollectionGlobalTemplate, ilRTEGlobalTemplate, and ilGlobalTemplate.

Referenced by ilBlogPostingGUI\__construct(), ilPortfolioPageGUI\__construct(), ilPageLayoutGUI\__construct(), ilMDEditorGUI\__fillSubelements(), ilMDEditorGUI\__showLanguageSelect(), ilCalendarCategoryGUI\addReferenceLinks(), ilObjStudyProgrammeIndividualPlanGUI\buildFrame(), ilECSSettingsGUI\communities(), ilSCORMExplorer\createOutput(), ilRegistrationGUI\fillMembershipLimitation(), ilStudyProgrammeExpandableProgressListGUI\fillTemplate(), ilStudyProgrammeProgressListGUI\fillTemplate(), ilSCORMExplorer\formatHeader(), ilContainerSelectionExplorer\formatHeader(), ilRepositoryExplorer\formatHeader(), ilSearchRootSelector\formatHeader(), ilECSNodeMappingCmsExplorer\formatHeader(), ilECSNodeMappingLocalExplorer\formatHeader(), ilECSNodeMappingCmsExplorer\formatObject(), ilECSNodeMappingLocalExplorer\formatObject(), ilAttendanceList\getHTML(), ilCalendarAppointmentPresentationGUI\getModalHTML(), ilObjStudyProgrammeTreeExplorerGUI\getNodeContent(), ilSCORMExplorer\getOutputIcons(), ilCharSelectorGUI\getSelectorHTML(), ilPersonalSkillsGUI\getSkillEntriesHeader(), ilLPListOfSettingsGUI\handleLPUsageInfo(), ilObjCourseGUI\infoScreen(), ilCourseObjectivesGUI\initFormLimits(), ilMatrixRowWizardInputGUI\insert(), ilFileWizardInputGUI\insert(), ilImageFileInputGUI\insert(), ilSelectBuilderInputGUI\insert(), ilSCORMExplorer\insertObject(), ilMDEditorGUI\listAnnotation(), ilMDEditorGUI\listClassification(), ilMDEditorGUI\listEducational(), ilMDEditorGUI\listGeneral(), ilExplorerBaseGUI\listItemStart(), ilMDEditorGUI\listLifecycle(), ilMDEditorGUI\listMetaMetaData(), ilMDEditorGUI\listQuickEdit_scorm(), ilMDEditorGUI\listRelation(), ilMDEditorGUI\listRights(), ilMDEditorGUI\listTechnical(), ilRegistrationSettingsGUI\parseRoleList(), ilAssQuestionPreviewGUI\populateGenericQuestionFeedback(), ilAssQuestionPreviewGUI\populateInstantResponseHeader(), ilAssQuestionPreviewGUI\populateInstantResponseMessage(), ilAssQuestionPreviewGUI\populateNotesPanel(), ilAssQuestionPreviewGUI\populateReachedPointsOutput(), ilAssQuestionPreviewGUI\populateSolutionOutput(), ilAssQuestionPreviewGUI\populateSpecificQuestionFeedback(), SurveyQuestionGUI\preview(), ILIAS\MediaCast\Presentation\VideoViewGUI\render(), ilTagInputGUI\render(), ilMultipleImagesInputGUI\render(), ilTextWizardInputGUI\render(), ilExplorerBaseGUI\renderChilds(), ilExplorerBaseGUI\renderNode(), ilLMPresentationGUI\showDownloadList(), ilContainerGUI\showLinkListObject(), ilContainerObjectiveGUI\showObjectives(), ilPageObjectGUI\showPage(), ilLMPresentationGUI\showPrintView(), and ilLocalUserGUI\showRolesTable().

+ Here is the caller graph for this function:

◆ setDescription()

◆ setFileUploadRefId()

ilGlobalTemplateInterface::setFileUploadRefId ( int  $a_ref_id)

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

Implemented in ilDataCollectionGlobalTemplate, ilRTEGlobalTemplate, ilGlobalPageTemplate, and ilGlobalTemplate.

◆ setHeaderActionMenu()

ilGlobalTemplateInterface::setHeaderActionMenu ( string  $a_header)

Set header action menu.

Implemented in ilDataCollectionGlobalTemplate, ilRTEGlobalTemplate, ilGlobalPageTemplate, and ilGlobalTemplate.

Referenced by ilCalendarPresentationGUI\prepareOutput(), and ilDashboardGUI\show().

+ Here is the caller graph for this function:

◆ setHeaderPageTitle()

ilGlobalTemplateInterface::setHeaderPageTitle ( string  $a_title)

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

Implemented in ilDataCollectionGlobalTemplate, ilRTEGlobalTemplate, ilGlobalPageTemplate, and ilGlobalTemplate.

Referenced by ilWikiPageGUI\executeCommand().

+ Here is the caller graph for this function:

◆ setLeftContent()

ilGlobalTemplateInterface::setLeftContent ( string  $a_html)

Sets content of left column.

Implemented in ilDataCollectionGlobalTemplate, ilRTEGlobalTemplate, ilGlobalPageTemplate, and ilGlobalTemplate.

◆ setLeftNavContent()

ilGlobalTemplateInterface::setLeftNavContent ( string  $a_content)

Sets content of left navigation column.

Implemented in ilDataCollectionGlobalTemplate, ilRTEGlobalTemplate, ilGlobalPageTemplate, and ilGlobalTemplate.

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

+ Here is the caller graph for this function:

◆ setLocator()

◆ setLoginTargetPar()

ilGlobalTemplateInterface::setLoginTargetPar ( string  $a_val)

Set target parameter for login (public sector).

This is used by the main menu

Implemented in ilDataCollectionGlobalTemplate, ilRTEGlobalTemplate, ilGlobalPageTemplate, and ilGlobalTemplate.

◆ setOnScreenMessage()

◆ setPageFormAction()

ilGlobalTemplateInterface::setPageFormAction ( string  $a_action)

◆ setPermanentLink()

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

◆ setRightContent()

ilGlobalTemplateInterface::setRightContent ( string  $a_html)

Sets content of right column.

Implemented in ilDataCollectionGlobalTemplate, ilRTEGlobalTemplate, ilGlobalPageTemplate, and ilGlobalTemplate.

Referenced by ilContainerContentGUI\setOutput().

+ Here is the caller graph for this function:

◆ setSubTabs()

ilGlobalTemplateInterface::setSubTabs ( string  $a_tabs_html)

sets subtabs in standard template

Implemented in ilDataCollectionGlobalTemplate, ilRTEGlobalTemplate, ilGlobalPageTemplate, and ilGlobalTemplate.

◆ setTabs()

ilGlobalTemplateInterface::setTabs ( string  $a_tabs_html)

sets tabs in standard template

Implemented in ilDataCollectionGlobalTemplate, ilRTEGlobalTemplate, ilGlobalPageTemplate, and ilGlobalTemplate.

◆ setTitle()

◆ setTitleIcon()

◆ setTreeFlatIcon()

ilGlobalTemplateInterface::setTreeFlatIcon ( string  $a_link,
string  $a_mode 
)

Sets a tree or flat icon.

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

Implemented in ilDataCollectionGlobalTemplate, ilRTEGlobalTemplate, ilGlobalPageTemplate, and ilGlobalTemplate.

◆ setVariable()

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

Sets the given variable to the given value.

Parameters
mixed$value

Implemented in ilDataCollectionGlobalTemplate, ilRTEGlobalTemplate, ilGlobalPageTemplate, and ilGlobalTemplate.

Referenced by ilBlogPostingGUI\__construct(), ilPortfolioPageGUI\__construct(), ilPageLayoutGUI\__construct(), ilMDEditorGUI\__fillSubelements(), ilLearningProgressBaseGUI\__getLegendHTML(), ilMDEditorGUI\__showLanguageSelect(), ilCharSelectorGUI\addFormProperties(), ilObjIndividualAssessmentGUI\addMemberDataToInfo(), ilCalendarCategoryGUI\addReferenceLinks(), ilObjFileGUI\addUIFormToAccordion(), ilCalendarCategoryGUI\appendCalendarSelection(), ilObjStudyProgrammeIndividualPlanGUI\buildFrame(), ilECSSettingsGUI\communities(), ilPageObjectGUI\compareVersion(), ilSCORMExplorer\createOutput(), ilAccountRegistrationGUI\displayForm(), ilCourseRegistrationGUI\fillMaxMembers(), ilGroupRegistrationGUI\fillMaxMembers(), ilRegistrationGUI\fillMembershipLimitation(), ilCourseRegistrationGUI\fillRegistrationPeriod(), ilGroupRegistrationGUI\fillRegistrationPeriod(), ilStudyProgrammeExpandableProgressListGUI\fillTemplate(), ilStudyProgrammeProgressListGUI\fillTemplate(), ilSCORMExplorer\formatHeader(), ilContainerSelectionExplorer\formatHeader(), ilRepositoryExplorer\formatHeader(), ilSearchRootSelector\formatHeader(), ilECSNodeMappingCmsExplorer\formatHeader(), ilECSNodeMappingLocalExplorer\formatHeader(), ilECSNodeMappingCmsExplorer\formatObject(), ilECSNodeMappingLocalExplorer\formatObject(), ilCalendarHeaderNavigationGUI\getHTML(), ilAttendanceList\getHTML(), ilUserFilterGUI\getHTML(), ilLightboxGUI\getHTML(), ilLMPresentationGUI\getHTML(), ilContainerByTypeContentGUI\getMainContent(), ilContainerObjectiveGUI\getMainContent(), ilCalendarSubscriptionGUI\getModalForSubscription(), ilCalendarAppointmentPresentationGUI\getModalHTML(), ilObjStudyProgrammeTreeExplorerGUI\getNodeContent(), ilSCORMExplorer\getOutputIcons(), ilCharSelectorGUI\getSelectorHTML(), ilLPListOfSettingsGUI\handleLPUsageInfo(), ilObjCourseGUI\infoScreen(), ilECSSettingsGUI\initCategoryMappingForm(), ilECSMappingSettingsGUI\initFormCSettings(), ilCourseObjectivesGUI\initFormLimits(), ilECSSettingsGUI\initSettingsForm(), ilMatrixRowWizardInputGUI\insert(), ilFileWizardInputGUI\insert(), ilSelectBuilderInputGUI\insert(), ilSCORMExplorer\insertObject(), ilAssQuestionPageGUI\insertPageToc(), ilPageObjectGUI\insertPageToc(), ilMDEditorGUI\listAnnotation(), ilPersonalSkillsGUI\listAssignedProfile(), ilMDEditorGUI\listClassification(), ilGlossaryTermGUI\listDefinitions(), ilMDEditorGUI\listEducational(), ilMDEditorGUI\listGeneral(), ilExplorerBaseGUI\listItemStart(), ilMDEditorGUI\listLifecycle(), ilMDEditorGUI\listMetaMetaData(), ilMDEditorGUI\listQuickEdit_scorm(), ilMDEditorGUI\listRelation(), ilMDEditorGUI\listRights(), ilPersonalSkillsGUI\listSkills(), ilMDEditorGUI\listTechnical(), ilAccountRegistrationGUI\login(), ilRegistrationSettingsGUI\parseRoleList(), ilObjectPermissionStatusGUI\perminfo(), ilAssQuestionPreviewGUI\populateGenericQuestionFeedback(), ilAssQuestionPreviewGUI\populateInstantResponseHeader(), ilAssQuestionPreviewGUI\populateInstantResponseMessage(), ilAssQuestionPreviewGUI\populateNotesPanel(), ilAssQuestionPreviewGUI\populatePreviewToolbar(), ilAssQuestionPreviewGUI\populateQuestionOutput(), ilAssQuestionPreviewGUI\populateReachedPointsOutput(), ilAssQuestionPreviewGUI\populateSolutionOutput(), ilAssQuestionPreviewGUI\populateSpecificQuestionFeedback(), ilUsersGalleryGUI\populateTemplate(), ilRepositorySelectorInputGUI\render(), ILIAS\MediaCast\Presentation\VideoViewGUI\render(), ilTagInputGUI\render(), ilMultipleImagesInputGUI\render(), ilTextWizardInputGUI\render(), ilExplorerBaseGUI\renderChilds(), ilExplorerBaseGUI\renderNode(), ilForumExportGUI\renderPostHtml(), ILIAS\MediaCast\Presentation\VideoViewGUI\renderSideColumn(), ilPasswordAssistanceGUI\showAssignPasswordForm(), ilPasswordAssistanceGUI\showAssistanceForm(), ilAssQuestionPreviewGUI\showCmd(), ilAccessibilityControlConceptGUI\showControlConcept(), ilLMPresentationGUI\showDownloadList(), ilObjSystemFolderGUI\showJavaServerObject(), ilContainerGUI\showLinkListObject(), ilPasswordAssistanceGUI\showMessageForm(), ilContainerObjectiveGUI\showObjectives(), ilObjMediaPoolGUI\showPage(), ilPageObjectGUI\showPage(), ilLMPresentationGUI\showPrintView(), ilLMPresentationGUI\showPrintViewSelection(), ilLocalUserGUI\showRolesTable(), ilCalendarPresentationGUI\showSideBlocks(), ilAssQuestionSkillAssignmentsGUI\showSkillSelectionCmd(), ilPersonalProfileGUI\showUserAgreement(), ilPasswordAssistanceGUI\showUsernameAssistanceForm(), ilObjStudyProgrammeIndividualPlanGUI\view(), and ilObjLanguageExtGUI\viewObject().

+ Here is the caller graph for this function:

◆ touchBlock()

Field Documentation

◆ DEFAULT_BLOCK

const ilGlobalTemplateInterface::DEFAULT_BLOCK = 'DEFAULT'

◆ MESSAGE_TYPE_FAILURE

const ilGlobalTemplateInterface::MESSAGE_TYPE_FAILURE = 'failure'

◆ MESSAGE_TYPE_INFO

const ilGlobalTemplateInterface::MESSAGE_TYPE_INFO = "info"

◆ MESSAGE_TYPE_QUESTION

const ilGlobalTemplateInterface::MESSAGE_TYPE_QUESTION = "question"

◆ MESSAGE_TYPE_SUCCESS

const ilGlobalTemplateInterface::MESSAGE_TYPE_SUCCESS = "success"

◆ MESSAGE_TYPES


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