ILIAS  release_8 Revision v8.19
All Data Structures Namespaces Files Functions Variables Modules Pages
ilInfoScreenGUI Class Reference

Class ilInfoScreenGUI. More...

+ Collaboration diagram for ilInfoScreenGUI:

Public Member Functions

 __construct (?object $a_gui_object=null)
 
 executeCommand ()
 
 setMessageBox (ILIAS\UI\Component\MessageBox\MessageBox $a_val)
 
 getMessageBox ()
 
 setTableClass (string $a_val)
 
 getTableClass ()
 
 enablePrivateNotes (bool $a_enable=true)
 
 enableLearningProgress (bool $a_enable=true)
 
 enableAvailability (bool $a_enable=true)
 
 enableBookingInfo (bool $a_enable=true)
 
 enableFeedback (bool $a_enable=true)
 
 enableNews (bool $a_enable=true)
 
 enableNewsEditing (bool $a_enable=true)
 
 setBlockProperty (string $a_block_type, string $a_property, string $a_value)
 This function is supposed to be used for block type specific properties, that should be passed to ilBlockGUI->setProperty. More...
 
 getAllBlockProperties ()
 
 addSection (string $a_title)
 
 setFormAction (string $a_form_action)
 
 removeFormAction ()
 
 addProperty (string $a_name, string $a_value, string $a_link="")
 add a property to current section More...
 
 addPropertyCheckbox (string $a_name, string $a_checkbox_name, string $a_checkbox_value, string $a_checkbox_label="", bool $a_checkbox_checked=false)
 
 addPropertyTextinput (string $a_name, string $a_input_name, string $a_input_value="", string $a_input_size="", string $direct_button_command="", string $direct_button_label="", bool $direct_button_primary=false)
 
 addButton (string $a_title, string $a_link, string $a_frame="", string $a_position="top", bool $a_primary=false)
 
 addFormButton (string $a_command, string $a_title, string $a_position="top")
 add a form button to the info screen the form buttons are only valid if a form action is set More...
 
 addHiddenElement (string $a_name, string $a_value)
 
 addMetaDataSections (int $a_rep_obj_id, int $a_obj_id, string $a_type)
 
 showSummary ()
 
 getCenterColumnHTML ()
 
 getRightColumnHTML ()
 
 setColumnSettings (ilColumnGUI $column_gui)
 Set column settings. More...
 
 setOpenFormTag (bool $a_val)
 
 setCloseFormTag (bool $a_val)
 
 getHTML ()
 
 getContextRefId ()
 
 setContextRefId (int $contextRefId)
 
 getContextObjId ()
 
 setContextObjId (int $contextObjId)
 
 getContentObjType ()
 
 setContentObjType (string $contentObjType)
 
 showLearningProgress (ilTemplate $a_tpl)
 
 saveProgress (bool $redirect=true)
 
 showNotesSection ()
 
 showLDAPRoleGroupMappingInfo (string $a_section='')
 
 setTabs ()
 
 getTabs (ilTabsGUI $tabs_gui)
 
 addTagging ()
 
 saveTags ()
 
 hideFurtherSections (bool $a_add_toggle=true)
 
 getHiddenToggleButton ()
 
 addAccessPeriodProperty ()
 

Data Fields

ilLanguage $lng
 
ilCtrl $ctrl
 
object $gui_object
 
array $top_buttons = array()
 
array $top_formbuttons = array()
 
array $hiddenelements = array()
 
string $table_class = "il_InfoScreen"
 
bool $open_form_tag = true
 
bool $close_form_tag = true
 
string $form_action
 

Protected Member Functions

 addAvailability ()
 
 addPreconditions ()
 Add preconditions. More...
 
 addPreconditionSection (ilObject $obj, array $conditions, bool $obligatory=true)
 

Protected Attributes

ILIAS DI UIServices $ui
 
ILIAS UI Component MessageBox MessageBox $mbox = null
 
ilTabsGUI $tabs_gui
 
ilRbacSystem $rbacsystem
 
ilGlobalPageTemplate $tpl
 
ilAccessHandler $access
 
ilObjUser $user
 
ilTree $tree
 
ilSetting $settings
 
int $contextRefId = null
 
int $contextObjId = null
 
string $contentObjType = null
 
bool $booking_enabled = false
 
bool $availability_enabled = true
 
bool $hidden = false
 
array $section = []
 
array $block_property = []
 
bool $news_editing = false
 
bool $show_hidden_toggle = false
 
int $sec_nr = 0
 
bool $private_notes_enabled = false
 
bool $news_enabled = false
 
bool $feedback_enabled = false
 
bool $learning_progress_enabled = false
 
StandardGUIRequest $request
 

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

ilInfoScreenGUI::__construct ( ?object  $a_gui_object = null)

Definition at line 69 of file class.ilInfoScreenGUI.php.

References $DIC, $lng, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ILIAS\Repository\settings(), ILIAS\Repository\ui(), and ILIAS\Repository\user().

70  {
71  global $DIC;
72 
73  $this->rbacsystem = $DIC->rbac()->system();
74  $this->tpl = $DIC["tpl"];
75  $this->access = $DIC->access();
76  $this->user = $DIC->user();
77  $this->tree = $DIC->repositoryTree();
78  $this->settings = $DIC->settings();
79  $ilCtrl = $DIC->ctrl();
80  $lng = $DIC->language();
81  $ilTabs = $DIC->tabs();
82 
83  $this->ctrl = $ilCtrl;
84  $this->lng = $lng;
85  $this->tabs_gui = $ilTabs;
86  $this->gui_object = $a_gui_object;
87  $this->form_action = "";
88  $this->top_formbuttons = array();
89  $this->hiddenelements = array();
90  $this->ui = $DIC->ui();
91  $this->request = new StandardGUIRequest(
92  $DIC->http(),
93  $DIC->refinery()
94  );
95  }
global $DIC
Definition: feed.php:28
+ Here is the call graph for this function:

Member Function Documentation

◆ addAccessPeriodProperty()

ilInfoScreenGUI::addAccessPeriodProperty ( )
Exceptions
ilDatabaseException
ilDateTimeException

Definition at line 1272 of file class.ilInfoScreenGUI.php.

References addProperty(), ilDatePresentation\formatPeriod(), IL_CAL_UNIX, ILIAS\Repository\lng(), and ilObjectActivation\TIMINGS_ACTIVATION.

Referenced by addAvailability().

1272  : void
1273  {
1274  $a_obj = $this->gui_object->getObject();
1275 
1276  $this->lng->loadLanguageModule("rep");
1277  $this->lng->loadLanguageModule("crs");
1278 
1279  // links to the object
1280  if (is_object($a_obj)) {
1281  $act = new ilObjectActivation();
1282  $act->read($a_obj->getRefId());
1283  if ($act->getTimingType() == ilObjectActivation::TIMINGS_ACTIVATION) {
1284  $this->addProperty(
1285  $this->lng->txt('rep_activation_access'),
1287  new ilDateTime($act->getTimingStart(), IL_CAL_UNIX),
1288  new ilDateTime($act->getTimingEnd(), IL_CAL_UNIX)
1289  )
1290  );
1291  } else {
1292  $this->addProperty(
1293  $this->lng->txt('rep_activation_access'),
1294  $this->lng->txt('crs_visibility_limitless')
1295  );
1296  }
1297  }
1298  }
addProperty(string $a_name, string $a_value, string $a_link="")
add a property to current section
const IL_CAL_UNIX
static formatPeriod(ilDateTime $start, ilDateTime $end, bool $a_skip_starting_day=false)
Format a period of two dates Shows: 14.
Class ilObjectActivation.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ addAvailability()

ilInfoScreenGUI::addAvailability ( )
protected
Exceptions
ilDatabaseException
ilDateTimeException

Definition at line 1133 of file class.ilInfoScreenGUI.php.

References addAccessPeriodProperty(), addSection(), ILIAS\Repository\lng(), and ilObjectActivation\TIMINGS_ACTIVATION.

Referenced by getHTML().

1133  : void
1134  {
1135  if (
1136  !is_object($this->gui_object) ||
1137  !method_exists($this->gui_object, "getObject") ||
1138  !is_object($this->gui_object->getObject())
1139  ) {
1140  return;
1141  }
1142 
1143  $obj = $this->gui_object->getObject();
1144  if ($obj->getRefId() <= 0) {
1145  return;
1146  }
1147 
1148  $act = new ilObjectActivation();
1149  $act->read($obj->getRefId());
1150  if ($act->getTimingType() == ilObjectActivation::TIMINGS_ACTIVATION) {
1151  $this->lng->loadLanguageModule("rep");
1152  $this->addSection($this->lng->txt("rep_activation_availability"));
1153  $this->addAccessPeriodProperty();
1154  }
1155  }
addSection(string $a_title)
Class ilObjectActivation.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ addButton()

ilInfoScreenGUI::addButton ( string  $a_title,
string  $a_link,
string  $a_frame = "",
string  $a_position = "top",
bool  $a_primary = false 
)

Definition at line 304 of file class.ilInfoScreenGUI.php.

Referenced by getHTML().

310  : void {
311  if ($a_position == "top") {
312  $this->top_buttons[] =
313  array("title" => $a_title,"link" => $a_link,"target" => $a_frame,"primary" => $a_primary);
314  }
315  }
+ Here is the caller graph for this function:

◆ addFormButton()

ilInfoScreenGUI::addFormButton ( string  $a_command,
string  $a_title,
string  $a_position = "top" 
)

add a form button to the info screen the form buttons are only valid if a form action is set

Definition at line 321 of file class.ilInfoScreenGUI.php.

325  : void {
326  if ($a_position == "top") {
327  $this->top_formbuttons[] = array("command" => $a_command, "title" => $a_title);
328  }
329  }

◆ addHiddenElement()

ilInfoScreenGUI::addHiddenElement ( string  $a_name,
string  $a_value 
)

Definition at line 331 of file class.ilInfoScreenGUI.php.

Referenced by ILIAS\Survey\InfoScreen\InfoScreenGUI\addStartResumeSection().

331  : void
332  {
333  $this->hiddenelements[] = array("name" => $a_name, "value" => $a_value);
334  }
+ Here is the caller graph for this function:

◆ addMetaDataSections()

ilInfoScreenGUI::addMetaDataSections ( int  $a_rep_obj_id,
int  $a_obj_id,
string  $a_type 
)

Definition at line 336 of file class.ilInfoScreenGUI.php.

References $access, $ctrl, $id, $ilUser, $lng, $ref_id, $tree, $type, $user, $webdav_dic, ilObject\_getAllReferences(), ilMDUtils\_getDefaultCopyright(), ilDAVActivationChecker\_isActive(), ilChangeEvent\_isActive(), ilChangeEvent\_lookupReadEvents(), ilMDUtils\_parseCopyright(), addProperty(), addSection(), ANONYMOUS_USER_ID, ilDatePresentation\formatDate(), ilECSServerSettings\getInstance(), ilObjectFactory\getInstanceByObjId(), IL_CAL_DATETIME, ilTree\isInTree(), ILIAS\Repository\lng(), ilLanguage\loadLanguageModule(), ilDatePresentation\secondsToString(), ilLanguage\txt(), and ilObjUser\userExists().

336  : void
337  {
338  $lng = $this->lng;
339 
340  $lng->loadLanguageModule("meta");
341 
342  $md = new ilMD($a_rep_obj_id, $a_obj_id, $a_type);
343  $description = "";
344  $langs = '';
345  $keywords = "";
346  if ($md_gen = $md->getGeneral()) {
347  // get first descrption
348  // The description is shown on the top of the page.
349  // Thus it is not necessary to show it again.
350  foreach ($md_gen->getDescriptionIds() as $id) {
351  $md_des = $md_gen->getDescription($id);
352  $description = $md_des->getDescription();
353  break;
354  }
355 
356  // get language(s)
357  $language_arr = [];
358  foreach ($md_gen->getLanguageIds() as $id) {
359  $md_lan = $md_gen->getLanguage($id);
360  if ($md_lan->getLanguageCode() != "") {
361  $language_arr[] = $lng->txt("meta_l_" . $md_lan->getLanguageCode());
362  }
363  }
364  $langs = implode(", ", $language_arr);
365 
366  // keywords
367  $keyword_arr = [];
368  foreach ($md_gen->getKeywordIds() as $id) {
369  $md_key = $md_gen->getKeyword($id);
370  $keyword_arr[] = $md_key->getKeyword();
371  }
372  $keywords = implode(", ", $keyword_arr);
373  }
374 
375  // authors
376  $author = "";
377  if (is_object($lifecycle = $md->getLifecycle())) {
378  $sep = "";
379  foreach (($lifecycle->getContributeIds()) as $con_id) {
380  $md_con = $lifecycle->getContribute($con_id);
381  if ($md_con->getRole() == "Author") {
382  foreach ($md_con->getEntityIds() as $ent_id) {
383  $md_ent = $md_con->getEntity($ent_id);
384  $author = $author . $sep . $md_ent->getEntity();
385  $sep = ", ";
386  }
387  }
388  }
389  }
390 
391  // copyright
392  $copyright = "";
393  if (is_object($rights = $md->getRights())) {
394  $copyright = ilMDUtils::_parseCopyright($rights->getDescription());
395  } else {
396  $copyright = ilMDUtils::_getDefaultCopyright();
397  }
398 
399  // learning time
400  #if(is_object($educational = $md->getEducational()))
401  #{
402  # $learning_time = $educational->getTypicalLearningTime();
403  #}
404  $learning_time = "";
405  if (is_object($educational = $md->getEducational())) {
406  if ($seconds = $educational->getTypicalLearningTimeSeconds()) {
407  $learning_time = ilDatePresentation::secondsToString($seconds);
408  }
409  }
410 
411 
412  // output
413 
414  // description
415  if ($description != "") {
416  $this->addSection($lng->txt("description"));
417  $this->addProperty("", nl2br($description));
418  }
419 
420  // general section
421  $this->addSection($lng->txt("meta_general"));
422  if ($langs != "") { // language
423  $this->addProperty(
424  $lng->txt("language"),
425  $langs
426  );
427  }
428  if ($keywords != "") { // keywords
429  $this->addProperty(
430  $lng->txt("keywords"),
431  $keywords
432  );
433  }
434  if ($author != "") { // author
435  $this->addProperty(
436  $lng->txt("author"),
437  $author
438  );
439  }
440  if ($copyright != "") { // copyright
441  $this->addProperty(
442  $lng->txt("meta_copyright"),
443  $copyright
444  );
445  }
446  if ($learning_time != "") { // typical learning time
447  $this->addProperty(
448  $lng->txt("meta_typical_learning_time"),
449  $learning_time
450  );
451  }
452  }
static _parseCopyright(string $a_copyright)
txt(string $a_topic, string $a_default_lang_fallback_mod="")
gets the text for a given topic if the topic is not in the list, the topic itself with "-" will be re...
addProperty(string $a_name, string $a_value, string $a_link="")
add a property to current section
static _getDefaultCopyright()
loadLanguageModule(string $a_module)
Load language module.
static secondsToString(int $seconds, bool $force_with_seconds=false, ?ilLanguage $a_lng=null)
converts seconds to string: Long: 7 days 4 hour(s) ...
addSection(string $a_title)
$id
plugin.php for ilComponentBuildPluginInfoObjectiveTest::testAddPlugins
Definition: plugin.php:23
+ Here is the call graph for this function:

◆ addPreconditions()

ilInfoScreenGUI::addPreconditions ( )
protected

Add preconditions.

Definition at line 1160 of file class.ilInfoScreenGUI.php.

References $i, ilObject\_lookupTitle(), addPreconditionSection(), and ilArrayUtil\sortArray().

Referenced by getHTML().

1160  : void
1161  {
1162  if (
1163  !is_object($this->gui_object) ||
1164  !method_exists($this->gui_object, "getObject") ||
1165  !is_object($this->gui_object->getObject())
1166  ) {
1167  return;
1168  }
1169 
1170  $obj = $this->gui_object->getObject();
1171  if ($obj->getRefId() <= 0) {
1172  return;
1173  }
1174 
1175  $conditions = ilConditionHandler::_getEffectiveConditionsOfTarget($obj->getRefId(), $obj->getId());
1176 
1177  if (sizeof($conditions)) {
1178  for ($i = 0; $i < count($conditions); $i++) {
1179  $conditions[$i]['title'] = ilObject::_lookupTitle($conditions[$i]['trigger_obj_id']);
1180  }
1181  $conditions = ilArrayUtil::sortArray($conditions, 'title', 'DESC');
1182 
1183  // Show obligatory and optional preconditions seperated
1184  $this->addPreconditionSection($obj, $conditions, true);
1185  $this->addPreconditionSection($obj, $conditions, false);
1186  }
1187  }
addPreconditionSection(ilObject $obj, array $conditions, bool $obligatory=true)
static _lookupTitle(int $obj_id)
$i
Definition: metadata.php:41
static sortArray(array $array, string $a_array_sortby_key, string $a_array_sortorder="asc", bool $a_numeric=false, bool $a_keep_keys=false)
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ addPreconditionSection()

ilInfoScreenGUI::addPreconditionSection ( ilObject  $obj,
array  $conditions,
bool  $obligatory = true 
)
protected

Definition at line 1189 of file class.ilInfoScreenGUI.php.

References $lng, $tree, ilConditionHandler\_checkCondition(), ilLink\_getLink(), ilObject\_lookupTitle(), addProperty(), addSection(), ilConditionHandler\calculateEffectiveRequiredTriggers(), ilConditionHandler\getEffectiveOptionalConditionsOfTarget(), ilObject\getId(), ilMemberViewSettings\getInstance(), ilObject\getRefId(), ilTree\isDeleted(), ilUtil\stripSlashes(), ilConditionHandlerGUI\translateOperator(), and ilLanguage\txt().

Referenced by addPreconditions().

1193  : void {
1194  $lng = $this->lng;
1195  $tree = $this->tree;
1196 
1197  $num_required = ilConditionHandler::calculateEffectiveRequiredTriggers($obj->getRefId(), $obj->getId());
1198  $num_optional_required =
1199  $num_required - count($conditions) + count(ilConditionHandler::getEffectiveOptionalConditionsOfTarget($obj->getRefId(), $obj->getId()));
1200 
1201  // Check if all conditions are fulfilled
1202  $visible_conditions = array();
1203  $passed_optional = 0;
1204  foreach ($conditions as $condition) {
1205  if ($obligatory and !$condition['obligatory']) {
1206  continue;
1207  }
1208  if (!$obligatory and $condition['obligatory']) {
1209  continue;
1210  }
1211 
1212  if ($tree->isDeleted($condition['trigger_ref_id'])) {
1213  continue;
1214  }
1215 
1216  $ok = ilConditionHandler::_checkCondition($condition) and
1217  !ilMemberViewSettings::getInstance()->isActive();
1218 
1219  if (!$ok) {
1220  $visible_conditions[] = $condition['id'];
1221  }
1222 
1223  if (!$obligatory and $ok) {
1224  ++$passed_optional;
1225  // optional passed
1226  if ($passed_optional >= $num_optional_required) {
1227  return;
1228  }
1229  }
1230  }
1231 
1232  $properties = [];
1233 
1234  foreach ($conditions as $condition) {
1235  if (!isset($condition["id"]) || !in_array($condition['id'], $visible_conditions)) {
1236  continue;
1237  }
1238 
1239  $properties[] = [
1241  $condition['trigger_obj_id'],
1242  $condition['operator']
1243  ) . ' ' . $condition['value'],
1244  "title" => ilObject::_lookupTitle($condition['trigger_obj_id']),
1245  "link" => ilLink::_getLink($condition['trigger_ref_id'])
1246  ];
1247  }
1248 
1249  if (count($properties) > 0) {
1250  if ($obligatory) {
1251  $this->addSection($lng->txt("preconditions_obligatory_hint"));
1252  } else {
1253  $this->addSection(sprintf(
1254  $lng->txt("preconditions_optional_hint"),
1255  $num_optional_required - $passed_optional
1256  ));
1257  }
1258 
1259  foreach ($properties as $p) {
1260  $this->addProperty(
1261  $p["condition"],
1262  "<a href='" . $p["link"] . "'>" . ilUtil::stripSlashes($p["title"]) . "</a>"
1263  );
1264  }
1265  }
1266  }
txt(string $a_topic, string $a_default_lang_fallback_mod="")
gets the text for a given topic if the topic is not in the list, the topic itself with "-" will be re...
static stripSlashes(string $a_str, bool $a_strip_html=true, string $a_allow="")
addProperty(string $a_name, string $a_value, string $a_link="")
add a property to current section
isDeleted(int $a_node_id)
This is a wrapper for isSaved() with a more useful name.
static _checkCondition(array $condition, int $a_usr_id=0)
checks wether a single condition is fulfilled every trigger object type must implement a static metho...
static _lookupTitle(int $obj_id)
static calculateEffectiveRequiredTriggers(int $a_target_ref_id, int $a_target_obj_id, string $a_target_obj_type='')
addSection(string $a_title)
static translateOperator(int $a_obj_id, string $a_operator)
static getEffectiveOptionalConditionsOfTarget(int $a_target_ref_id, int $a_target_obj_id, string $a_obj_type='')
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ addProperty()

ilInfoScreenGUI::addProperty ( string  $a_name,
string  $a_value,
string  $a_link = "" 
)

add a property to current section

Parameters
string$a_nameproperty name string
string$a_valueproperty value
string$a_linklink (will link the property value string)

Definition at line 240 of file class.ilInfoScreenGUI.php.

References $sec_nr.

Referenced by ilLearningProgressBaseGUI\__appendLPDetails(), ilLearningProgressBaseGUI\__showObjectDetails(), addAccessPeriodProperty(), ILIAS\Survey\InfoScreen\InfoScreenGUI\addAppraiseeInfo(), ilObjIndividualAssessmentGUI\addContactDataToInfo(), ilObjRemoteCourseGUI\addCustomInfoFields(), ilObjRemoteGlossaryGUI\addCustomInfoFields(), ilObjRemoteGroupGUI\addCustomInfoFields(), ilObjRemoteTestGUI\addCustomInfoFields(), ilObjRemoteFileGUI\addCustomInfoFields(), ilObjRemoteLearningModuleGUI\addCustomInfoFields(), ilObjRemoteWikiGUI\addCustomInfoFields(), ilExAssignmentGUI\addFiles(), ilObjIndividualAssessmentGUI\addGeneralDataToInfo(), ilExAssignmentGUI\addInstructions(), ilObjIndividualAssessmentGUI\addMemberDataToInfo(), addMetaDataSections(), addPreconditionSection(), ILIAS\Survey\InfoScreen\InfoScreenGUI\addPrivacyInfo(), ilExAssignmentGUI\addPublicSubmissions(), ilExAssignmentGUI\addSchedule(), ILIAS\Survey\InfoScreen\InfoScreenGUI\addStartResumeSection(), ilExAssignmentGUI\addSubmission(), ilExAssignmentGUI\addSubmissionFeedback(), addTagging(), ilObjGlossaryGUI\addUsagesToInfo(), ilResourceStorageInfoGUI\append(), ilAppointmentPresentationGUI\getHTML(), ilExSubmissionTextGUI\getOverviewContent(), ilExSubmissionFileGUI\getOverviewContent(), ilExSubmissionTeamGUI\getOverviewContent(), ilExPeerReviewGUI\getOverviewContent(), ilExSubmissionObjectGUI\getOverviewContentBlog(), ilExPeerReviewGUI\renderInfoWidget(), ilExAssTypeWikiTeamGUI\renderOverviewContent(), and showLDAPRoleGroupMappingInfo().

240  : void
241  {
242  $this->section[$this->sec_nr]["properties"][] =
243  array("name" => $a_name, "value" => $a_value,
244  "link" => $a_link);
245  }
+ Here is the caller graph for this function:

◆ addPropertyCheckbox()

ilInfoScreenGUI::addPropertyCheckbox ( string  $a_name,
string  $a_checkbox_name,
string  $a_checkbox_value,
string  $a_checkbox_label = "",
bool  $a_checkbox_checked = false 
)
Deprecated:

Definition at line 250 of file class.ilInfoScreenGUI.php.

References $sec_nr.

256  : void {
257  $checkbox = "<input type=\"checkbox\" name=\"$a_checkbox_name\" value=\"$a_checkbox_value\" id=\"$a_checkbox_name$a_checkbox_value\"";
258  if ($a_checkbox_checked) {
259  $checkbox .= " checked=\"checked\"";
260  }
261  $checkbox .= " />";
262  if (strlen($a_checkbox_label)) {
263  $checkbox .= "&nbsp;<label for=\"$a_checkbox_name$a_checkbox_value\">$a_checkbox_label</label>";
264  }
265  $this->section[$this->sec_nr]["properties"][] =
266  array("name" => $a_name, "value" => $checkbox, "link" => "");
267  }

◆ addPropertyTextinput()

ilInfoScreenGUI::addPropertyTextinput ( string  $a_name,
string  $a_input_name,
string  $a_input_value = "",
string  $a_input_size = "",
string  $direct_button_command = "",
string  $direct_button_label = "",
bool  $direct_button_primary = false 
)
Deprecated:

Definition at line 272 of file class.ilInfoScreenGUI.php.

References $sec_nr, and ilLegacyFormElementsUtil\prepareFormOutput().

280  : void {
281  $input = "<span class=\"form-inline\"><input class=\"form-control\" type=\"text\" name=\"$a_input_name\" id=\"$a_input_name\"";
282  if (strlen($a_input_value)) {
283  $input .= " value=\"" . ilLegacyFormElementsUtil::prepareFormOutput($a_input_value) . "\"";
284  }
285  if (strlen($a_input_size)) {
286  $input .= " size=\"" . $a_input_size . "\"";
287  }
288  $input .= " />";
289  if (strlen($direct_button_command) && strlen($direct_button_label)) {
290  $css = "";
291  if ($direct_button_primary) {
292  $css = " btn-primary";
293  }
294  $input .= " <input type=\"submit\" class=\"btn btn-default" . $css . "\" name=\"cmd[$direct_button_command]\" value=\"$direct_button_label\" />";
295  }
296  $input .= "</span>";
297  $this->section[$this->sec_nr]["properties"][] =
298  array("name" => "<label for=\"$a_input_name\">$a_name</label>", "value" => $input);
299  }
static prepareFormOutput($a_str, bool $a_strip=false)
+ Here is the call graph for this function:

◆ addSection()

◆ addTagging()

ilInfoScreenGUI::addTagging ( )

Definition at line 1074 of file class.ilInfoScreenGUI.php.

References $lng, addProperty(), addSection(), ilLanguage\loadLanguageModule(), and ilLanguage\txt().

Referenced by getHTML().

1074  : void
1075  {
1076  $lng = $this->lng;
1077 
1078  $lng->loadLanguageModule("tagging");
1079  $tags_set = new ilSetting("tags");
1080 
1081  $tagging_gui = new ilTaggingGUI();
1082  $tagging_gui->setObject(
1083  $this->gui_object->getObject()->getId(),
1084  $this->gui_object->getObject()->getType()
1085  );
1086 
1087  $this->addSection($lng->txt("tagging_tags"));
1088 
1089  if ($tags_set->get("enable_all_users")) {
1090  $this->addProperty(
1091  $lng->txt("tagging_all_users"),
1092  $tagging_gui->getAllUserTagsForObjectHTML()
1093  );
1094  }
1095 
1096  $this->addProperty(
1097  $lng->txt("tagging_my_tags"),
1098  $tagging_gui->getTaggingInputHTML()
1099  );
1100  }
txt(string $a_topic, string $a_default_lang_fallback_mod="")
gets the text for a given topic if the topic is not in the list, the topic itself with "-" will be re...
Class ilTaggingGUI.
addProperty(string $a_name, string $a_value, string $a_link="")
add a property to current section
loadLanguageModule(string $a_module)
Load language module.
addSection(string $a_title)
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ enableAvailability()

ilInfoScreenGUI::enableAvailability ( bool  $a_enable = true)

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

176  : void
177  {
178  $this->availability_enabled = $a_enable;
179  }

◆ enableBookingInfo()

ilInfoScreenGUI::enableBookingInfo ( bool  $a_enable = true)

Definition at line 181 of file class.ilInfoScreenGUI.php.

181  : void
182  {
183  $this->booking_enabled = $a_enable;
184  }

◆ enableFeedback()

ilInfoScreenGUI::enableFeedback ( bool  $a_enable = true)

Definition at line 187 of file class.ilInfoScreenGUI.php.

187  : void
188  {
189  $this->feedback_enabled = $a_enable;
190  }

◆ enableLearningProgress()

ilInfoScreenGUI::enableLearningProgress ( bool  $a_enable = true)

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

171  : void
172  {
173  $this->learning_progress_enabled = $a_enable;
174  }

◆ enableNews()

ilInfoScreenGUI::enableNews ( bool  $a_enable = true)

Definition at line 192 of file class.ilInfoScreenGUI.php.

192  : void
193  {
194  $this->news_enabled = $a_enable;
195  }

◆ enableNewsEditing()

ilInfoScreenGUI::enableNewsEditing ( bool  $a_enable = true)

Definition at line 197 of file class.ilInfoScreenGUI.php.

197  : void
198  {
199  $this->news_editing = $a_enable;
200  }

◆ enablePrivateNotes()

ilInfoScreenGUI::enablePrivateNotes ( bool  $a_enable = true)

Definition at line 166 of file class.ilInfoScreenGUI.php.

166  : void
167  {
168  $this->private_notes_enabled = $a_enable;
169  }

◆ executeCommand()

ilInfoScreenGUI::executeCommand ( )
Exceptions
ilCtrlException
ilDatabaseException
ilDateTimeException
ilObjectNotFoundException

Definition at line 103 of file class.ilInfoScreenGUI.php.

References $tpl, ILIAS\Repository\ctrl(), ilCommonActionDispatcherGUI\getInstanceFromAjaxCall(), ilPublicUserProfileGUI\setBackUrl(), ilGlobalPageTemplate\setContent(), setTabs(), showNotesSection(), and showSummary().

103  : void
104  {
105  $tpl = $this->tpl;
106 
107  $next_class = $this->ctrl->getNextClass($this);
108 
109  $cmd = $this->ctrl->getCmd("showSummary");
110  $this->ctrl->setReturn($this, "showSummary");
111 
112  $this->setTabs();
113 
114  switch ($next_class) {
115  case "ilnotegui":
116  if ($this->ctrl->isAsynch()) {
117  $this->showNotesSection();
118  } else {
119  $this->showSummary(); // forwards command
120  }
121  break;
122 
123  case "ilcolumngui":
124  $this->showSummary();
125  break;
126 
127  case "ilpublicuserprofilegui":
128  $user_profile = new ilPublicUserProfileGUI($this->request->getUserId());
129  $user_profile->setBackUrl($this->ctrl->getLinkTarget($this, "showSummary"));
130  $html = $this->ctrl->forwardCommand($user_profile);
131  $tpl->setContent($html);
132  break;
133 
134  case "ilcommonactiondispatchergui":
136  $this->ctrl->forwardCommand($gui);
137  break;
138 
139  default:
140  $this->$cmd();
141  break;
142  }
143  }
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
setBackUrl(string $a_backurl)
Set Back Link URL.
ilGlobalPageTemplate $tpl
static getInstanceFromAjaxCall()
(Re-)Build instance from ajax call
setContent(string $a_html)
Sets content for standard template.
+ Here is the call graph for this function:

◆ getAllBlockProperties()

ilInfoScreenGUI::getAllBlockProperties ( )

Definition at line 211 of file class.ilInfoScreenGUI.php.

References $block_property.

Referenced by setColumnSettings().

211  : array
212  {
213  return $this->block_property;
214  }
+ Here is the caller graph for this function:

◆ getCenterColumnHTML()

ilInfoScreenGUI::getCenterColumnHTML ( )
Returns
string
Exceptions
ilCtrlException
ilDatabaseException
ilDateTimeException
ilObjectNotFoundException

Definition at line 634 of file class.ilInfoScreenGUI.php.

References $ctrl, getHTML(), IL_COL_CENTER, IL_COL_LEFT, IL_COL_RIGHT, IL_SCREEN_SIDE, and setColumnSettings().

Referenced by showSummary().

634  : string
635  {
636  $ilCtrl = $this->ctrl;
637  $html = "";
638  $column_gui = new ilColumnGUI("info", IL_COL_CENTER);
639  $this->setColumnSettings($column_gui);
640 
641  if (!$ilCtrl->isAsynch()) {
642  if ($column_gui->getScreenMode() != IL_SCREEN_SIDE) {
643  // right column wants center
644  if ($column_gui->getCmdSide() == IL_COL_RIGHT) {
645  $column_gui = new ilColumnGUI("info", IL_COL_RIGHT);
646  $this->setColumnSettings($column_gui);
647  $html = $ilCtrl->forwardCommand($column_gui);
648  }
649  // left column wants center
650  if ($column_gui->getCmdSide() == IL_COL_LEFT) {
651  $column_gui = new ilColumnGUI("info", IL_COL_LEFT);
652  $this->setColumnSettings($column_gui);
653  $html = $ilCtrl->forwardCommand($column_gui);
654  }
655  } else {
656  $html = $this->getHTML();
657  }
658  }
659 
660  return $html;
661  }
const IL_COL_CENTER
const IL_COL_RIGHT
setColumnSettings(ilColumnGUI $column_gui)
Set column settings.
Column user interface class.
const IL_SCREEN_SIDE
const IL_COL_LEFT
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getContentObjType()

ilInfoScreenGUI::getContentObjType ( )

Definition at line 897 of file class.ilInfoScreenGUI.php.

References $contentObjType.

897  : string
898  {
899  if ($this->contentObjType !== null) {
900  return $this->contentObjType;
901  }
902 
903  return $this->gui_object->getObject()->getType();
904  }

◆ getContextObjId()

ilInfoScreenGUI::getContextObjId ( )

Definition at line 883 of file class.ilInfoScreenGUI.php.

References $contextObjId.

Referenced by ilBookingInfoScreenAdapter\__construct(), saveProgress(), and showLearningProgress().

883  : int
884  {
885  if ($this->contextObjId !== null) {
886  return $this->contextObjId;
887  }
888 
889  return $this->gui_object->getObject()->getId();
890  }
+ Here is the caller graph for this function:

◆ getContextRefId()

ilInfoScreenGUI::getContextRefId ( )

Definition at line 869 of file class.ilInfoScreenGUI.php.

References $contextRefId.

Referenced by saveProgress().

869  : int
870  {
871  if ($this->contextRefId !== null) {
872  return $this->contextRefId;
873  }
874 
875  return $this->gui_object->getObject()->getRefId();
876  }
+ Here is the caller graph for this function:

◆ getHiddenToggleButton()

ilInfoScreenGUI::getHiddenToggleButton ( )

Definition at line 1121 of file class.ilInfoScreenGUI.php.

References $lng, and ilLanguage\txt().

1121  : string
1122  {
1123  $lng = $this->lng;
1124 
1125  return "<a onClick=\"toggleSections(this, '" . $lng->txt("show_hidden_sections") . "', '" . $lng->txt("hide_visible_sections") . "'); return false;\" href=\"#\">" . $lng->txt("show_hidden_sections") . "</a>";
1126  }
txt(string $a_topic, string $a_default_lang_fallback_mod="")
gets the text for a given topic if the topic is not in the list, the topic itself with "-" will be re...
+ Here is the call graph for this function:

◆ getHTML()

ilInfoScreenGUI::getHTML ( )
Returns
string
Exceptions
ilCtrlException
ilDatabaseException
ilDateTimeException
ilObjectNotFoundException

Definition at line 713 of file class.ilInfoScreenGUI.php.

References $ctrl, $i, $ilSetting, $ilUser, $lng, $sec_nr, $settings, $user, addAvailability(), ilGlobalPageTemplate\addBlockFile(), addButton(), addPreconditions(), addTagging(), ANONYMOUS_USER_ID, ilGlobalPageTemplate\get(), getTableClass(), iljQueryUtil\initjQuery(), ilGlobalPageTemplate\parseCurrentBlock(), ilGlobalPageTemplate\setCurrentBlock(), setFormAction(), ilGlobalPageTemplate\setVariable(), showLearningProgress(), showNotesSection(), ilGlobalPageTemplate\touchBlock(), ilLanguage\txt(), and ILIAS\Repository\ui().

Referenced by getCenterColumnHTML(), and ilCalendarAppointmentPresentationGUI\getModalHTML().

713  : string
714  {
715  $lng = $this->lng;
717  $ilCtrl = $this->ctrl;
719 
720  $tpl = new ilTemplate("tpl.infoscreen.html", true, true, "Services/InfoScreen");
721 
722  // other class handles form action (@todo: this is not implemented/tested)
723  if ($this->form_action == "") {
724  $this->setFormAction($ilCtrl->getFormAction($this));
725  }
726 
728 
729  if ($this->hidden) {
730  $tpl->touchBlock("hidden_js");
731  if ($this->show_hidden_toggle) {
732  $this->addButton($lng->txt("show_hidden_sections"), "JavaScript:toggleSections(this, '" . $lng->txt("show_hidden_sections") . "', '" . $lng->txt("hide_visible_sections") . "');");
733  }
734  }
735 
736 
737  // DEPRECATED - use ilToolbarGUI
738 
739  // add top buttons
740  if (count($this->top_buttons) > 0) {
741  $tpl->addBlockFile("TOP_BUTTONS", "top_buttons", "tpl.buttons.html");
742 
743  foreach ($this->top_buttons as $button) {
744  // view button
745  $tpl->setCurrentBlock("btn_cell");
746  $tpl->setVariable("BTN_LINK", $button["link"]);
747  $tpl->setVariable("BTN_TARGET", $button["target"]);
748  $tpl->setVariable("BTN_TXT", $button["title"]);
749  if ($button["primary"]) {
750  $tpl->setVariable("BTN_CLASS", " btn-primary");
751  }
753  }
754  }
755 
756  // add top formbuttons
757  if ((count($this->top_formbuttons) > 0) && ($this->form_action !== '')) {
758  $tpl->addBlockFile("TOP_FORMBUTTONS", "top_submitbuttons", "tpl.submitbuttons.html", "Services/InfoScreen");
759 
760  foreach ($this->top_formbuttons as $button) {
761  // view button
762  $tpl->setCurrentBlock("btn_submit_cell");
763  $tpl->setVariable("BTN_COMMAND", $button["command"]);
764  $tpl->setVariable("BTN_NAME", $button["title"]);
766  }
767  }
768 
769  // add form action
770  if ($this->form_action != "") {
771  if ($this->open_form_tag) {
772  $tpl->setCurrentBlock("formtop");
773  $tpl->setVariable("FORMACTION", $this->form_action);
775  }
776 
777  if ($this->close_form_tag) {
778  $tpl->touchBlock("formbottom");
779  }
780  }
781 
782  if (count($this->hiddenelements)) {
783  foreach ($this->hiddenelements as $hidden) {
784  $tpl->setCurrentBlock("hidden_element");
785  $tpl->setVariable("HIDDEN_NAME", $hidden["name"]);
786  $tpl->setVariable("HIDDEN_VALUE", $hidden["value"]);
788  }
789  }
790 
791  if ($this->availability_enabled) {
792  $this->addAvailability();
793  }
794 
795  $this->addPreconditions();
796 
797  // learning progress
798  if ($this->learning_progress_enabled) {
799  $this->showLearningProgress($tpl);
800  }
801 
802  // notes section
803  if ($this->private_notes_enabled && !$ilSetting->get('disable_notes')) {
804  $html = $this->showNotesSection();
805  $tpl->setCurrentBlock("notes");
806  $tpl->setVariable("NOTES", $html);
808  }
809 
810  // tagging
811  if (
812  isset($this->gui_object) &&
813  method_exists($this->gui_object, "getObject") &&
814  is_object($this->gui_object->getObject())
815  ) {
816  $tags_set = new ilSetting("tags");
817  if ($tags_set->get("enable") && $ilUser->getId() != ANONYMOUS_USER_ID) {
818  $this->addTagging();
819  }
820 
821  $this->addObjectSections();
822  }
823 
824  // render all sections
825  for ($i = 1; $i <= $this->sec_nr; $i++) {
826  if (isset($this->section[$i]["properties"])) {
827  // section properties
828  foreach ($this->section[$i]["properties"] as $property) {
829  if ($property["name"] != "") {
830  if (($property["link"] ?? "") == "") {
831  $tpl->setCurrentBlock("pv");
832  $tpl->setVariable("TXT_PROPERTY_VALUE", $property["value"]);
833  } else {
834  $tpl->setCurrentBlock("lpv");
835  $tpl->setVariable("TXT_PROPERTY_LVALUE", $property["value"]);
836  $tpl->setVariable("LINK_PROPERTY_VALUE", $property["link"]);
837  }
839  $tpl->setCurrentBlock("property_row");
840  $tpl->setVariable("TXT_PROPERTY", $property["name"]);
841  } else {
842  $tpl->setCurrentBlock("property_full_row");
843  $tpl->setVariable("TXT_PROPERTY_FULL_VALUE", $property["value"]);
844  }
846  }
847 
848  // section header
849  if ($this->section[$i]["hidden"] ?? false) {
850  $tpl->setVariable("SECTION_HIDDEN", " style=\"display:none;\"");
851  $tpl->setVariable("SECTION_ID", "hidable_" . $i);
852  } else {
853  $tpl->setVariable("SECTION_ID", $i);
854  }
855  $tpl->setVariable("TCLASS", $this->getTableClass());
856  $tpl->setVariable("TXT_SECTION", $this->section[$i]["title"]);
857  $tpl->setCurrentBlock("row");
859  }
860  }
861 
862  if (!is_null($this->mbox)) {
863  $tpl->setVariable("MBOX", $this->ui->renderer()->render([$this->mbox]));
864  }
865 
866  return $tpl->get();
867  }
addPreconditions()
Add preconditions.
setCurrentBlock(string $blockname=self::DEFAULT_BLOCK)
Sets the template to the given block.
const ANONYMOUS_USER_ID
Definition: constants.php:27
addButton(string $a_title, string $a_link, string $a_frame="", string $a_position="top", bool $a_primary=false)
txt(string $a_topic, string $a_default_lang_fallback_mod="")
gets the text for a given topic if the topic is not in the list, the topic itself with "-" will be re...
parseCurrentBlock(string $blockname=self::DEFAULT_BLOCK)
Parses the given block.
setFormAction(string $a_form_action)
addBlockFile(string $var, string $block, string $template_name, string $in_module=null)
overwrites ITX::addBlockFile
get(string $part=self::DEFAULT_BLOCK)
Renders the given block and returns the html string.
showLearningProgress(ilTemplate $a_tpl)
touchBlock(string $blockname)
overwrites ITX::touchBlock.
static initjQuery(ilGlobalTemplateInterface $a_tpl=null)
inits and adds the jQuery JS-File to the global or a passed template
global $ilSetting
Definition: privfeed.php:17
$ilUser
Definition: imgupload.php:34
ilGlobalPageTemplate $tpl
setVariable(string $variable, $value='')
Sets the given variable to the given value.
$i
Definition: metadata.php:41
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getMessageBox()

ilInfoScreenGUI::getMessageBox ( )

Definition at line 150 of file class.ilInfoScreenGUI.php.

References $mbox.

151  {
152  return $this->mbox;
153  }
ILIAS UI Component MessageBox MessageBox $mbox

◆ getRightColumnHTML()

ilInfoScreenGUI::getRightColumnHTML ( )
Returns
string
Exceptions
ilCtrlException

Definition at line 667 of file class.ilInfoScreenGUI.php.

References $ctrl, $news_enabled, IL_COL_RIGHT, IL_SCREEN_SIDE, and setColumnSettings().

Referenced by showSummary().

667  : string
668  {
669  $ilCtrl = $this->ctrl;
670 
671  $html = "";
672  $column_gui = new ilColumnGUI("info", IL_COL_RIGHT);
673  $this->setColumnSettings($column_gui);
674 
675  if ($ilCtrl->getNextClass() == "ilcolumngui" &&
676  $column_gui->getCmdSide() == IL_COL_RIGHT &&
677  $column_gui->getScreenMode() == IL_SCREEN_SIDE) {
678  $html = $ilCtrl->forwardCommand($column_gui);
679  } elseif (!$ilCtrl->isAsynch() && $this->news_enabled) {
680  $html = $ilCtrl->getHTML($column_gui);
681  }
682 
683  return $html;
684  }
const IL_COL_RIGHT
setColumnSettings(ilColumnGUI $column_gui)
Set column settings.
Column user interface class.
const IL_SCREEN_SIDE
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getTableClass()

ilInfoScreenGUI::getTableClass ( )

Definition at line 161 of file class.ilInfoScreenGUI.php.

References $table_class.

Referenced by getHTML().

161  : string
162  {
163  return $this->table_class;
164  }
+ Here is the caller graph for this function:

◆ getTabs()

ilInfoScreenGUI::getTabs ( ilTabsGUI  $tabs_gui)

Definition at line 1058 of file class.ilInfoScreenGUI.php.

References ilTabsGUI\addSubTabTarget(), and ILIAS\Repository\ctrl().

Referenced by setTabs().

1058  : void
1059  {
1060  $next_class = $this->ctrl->getNextClass($this);
1061  $force_active = ($next_class == "ilnotegui");
1062 
1063  $tabs_gui->addSubTabTarget(
1064  'summary',
1065  $this->ctrl->getLinkTarget($this, "showSummary"),
1066  array("showSummary", ""),
1067  get_class($this),
1068  "",
1069  $force_active
1070  );
1071  }
addSubTabTarget(string $a_text, string $a_link, $a_cmd="", $a_cmdClass="", string $a_frame="", bool $a_activate=false, bool $a_dir_text=false)
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ hideFurtherSections()

ilInfoScreenGUI::hideFurtherSections ( bool  $a_add_toggle = true)

Definition at line 1115 of file class.ilInfoScreenGUI.php.

1115  : void
1116  {
1117  $this->hidden = true;
1118  $this->show_hidden_toggle = $a_add_toggle;
1119  }

◆ removeFormAction()

ilInfoScreenGUI::removeFormAction ( )

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

228  : void
229  {
230  $this->form_action = "";
231  }

◆ saveProgress()

ilInfoScreenGUI::saveProgress ( bool  $redirect = true)

Definition at line 949 of file class.ilInfoScreenGUI.php.

References $ilUser, $user, ilObject\_lookupType(), ilLearningProgress\_tracProgress(), ilLPStatusWrapper\_updateStatus(), ILIAS\Repository\ctrl(), getContextObjId(), getContextRefId(), ILIAS\Repository\lng(), and ilLPMarks\setCompleted().

949  : void
950  {
952 
953  // ensure a read event
955  $ilUser->getId(),
956  $this->getContextObjId(),
957  $this->getContextRefId(),
959  );
960 
961  $lp_marks = new ilLPMarks($this->getContextObjId(), $ilUser->getId());
962  $lp_marks->setCompleted((bool) $this->request->getLPEdit());
963  $lp_marks->update();
964 
966 
967  $this->lng->loadLanguageModule('trac');
968  $this->tpl->setOnScreenMessage('success', $this->lng->txt('trac_updated_status'), true);
969 
970  if ($redirect) {
971  $this->ctrl->redirect($this, ""); // #14993
972  }
973  }
static _tracProgress(int $a_user_id, int $a_obj_id, int $a_ref_id, string $a_obj_type='')
$ilUser
Definition: imgupload.php:34
setCompleted(bool $a_status)
static _lookupType(int $id, bool $reference=false)
static _updateStatus(int $a_obj_id, int $a_usr_id, ?object $a_obj=null, bool $a_percentage=false, bool $a_force_raise=false)
+ Here is the call graph for this function:

◆ saveTags()

ilInfoScreenGUI::saveTags ( )

Definition at line 1102 of file class.ilInfoScreenGUI.php.

References ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

1102  : void
1103  {
1104  $tagging_gui = new ilTaggingGUI();
1105  $tagging_gui->setObject(
1106  $this->gui_object->getObject()->getId(),
1107  $this->gui_object->getObject()->getType()
1108  );
1109  $tagging_gui->saveInput();
1110 
1111  $this->tpl->setOnScreenMessage('success', $this->lng->txt('msg_obj_modified'), true);
1112  $this->ctrl->redirect($this, ""); // #14993
1113  }
Class ilTaggingGUI.
+ Here is the call graph for this function:

◆ setBlockProperty()

ilInfoScreenGUI::setBlockProperty ( string  $a_block_type,
string  $a_property,
string  $a_value 
)

This function is supposed to be used for block type specific properties, that should be passed to ilBlockGUI->setProperty.

Definition at line 206 of file class.ilInfoScreenGUI.php.

206  : void
207  {
208  $this->block_property[$a_block_type][$a_property] = $a_value;
209  }

◆ setCloseFormTag()

ilInfoScreenGUI::setCloseFormTag ( bool  $a_val)

Definition at line 701 of file class.ilInfoScreenGUI.php.

701  : void
702  {
703  $this->close_form_tag = $a_val;
704  }

◆ setColumnSettings()

ilInfoScreenGUI::setColumnSettings ( ilColumnGUI  $column_gui)

Set column settings.

Definition at line 689 of file class.ilInfoScreenGUI.php.

References getAllBlockProperties(), ilColumnGUI\setAllBlockProperties(), ilColumnGUI\setEnableEdit(), and ilColumnGUI\setRepositoryMode().

Referenced by getCenterColumnHTML(), and getRightColumnHTML().

689  : void
690  {
691  $column_gui->setEnableEdit($this->news_editing);
692  $column_gui->setRepositoryMode(true);
693  $column_gui->setAllBlockProperties($this->getAllBlockProperties());
694  }
setRepositoryMode(bool $a_repositorymode)
setEnableEdit(bool $a_enableedit)
setAllBlockProperties(array $a_block_properties)
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setContentObjType()

ilInfoScreenGUI::setContentObjType ( string  $contentObjType)

Definition at line 906 of file class.ilInfoScreenGUI.php.

References $contentObjType.

906  : void
907  {
908  $this->contentObjType = $contentObjType;
909  }

◆ setContextObjId()

ilInfoScreenGUI::setContextObjId ( int  $contextObjId)

Definition at line 892 of file class.ilInfoScreenGUI.php.

References $contextObjId.

892  : void
893  {
894  $this->contextObjId = $contextObjId;
895  }

◆ setContextRefId()

ilInfoScreenGUI::setContextRefId ( int  $contextRefId)

Definition at line 878 of file class.ilInfoScreenGUI.php.

References $contextRefId.

878  : void
879  {
880  $this->contextRefId = $contextRefId;
881  }

◆ setFormAction()

ilInfoScreenGUI::setFormAction ( string  $a_form_action)

Definition at line 223 of file class.ilInfoScreenGUI.php.

Referenced by getHTML(), and ilCalendarAppointmentPresentationGUI\getModalHTML().

223  : void
224  {
225  $this->form_action = $a_form_action;
226  }
+ Here is the caller graph for this function:

◆ setMessageBox()

ilInfoScreenGUI::setMessageBox ( ILIAS\UI\Component\MessageBox\MessageBox  $a_val)

Definition at line 145 of file class.ilInfoScreenGUI.php.

Referenced by ILIAS\Survey\InfoScreen\InfoScreenGUI\displayNotStartableReasons().

145  : void
146  {
147  $this->mbox = $a_val;
148  }
+ Here is the caller graph for this function:

◆ setOpenFormTag()

ilInfoScreenGUI::setOpenFormTag ( bool  $a_val)

Definition at line 696 of file class.ilInfoScreenGUI.php.

696  : void
697  {
698  $this->open_form_tag = $a_val;
699  }

◆ setTableClass()

ilInfoScreenGUI::setTableClass ( string  $a_val)

Definition at line 156 of file class.ilInfoScreenGUI.php.

156  : void
157  {
158  $this->table_class = $a_val;
159  }

◆ setTabs()

ilInfoScreenGUI::setTabs ( )

Definition at line 1053 of file class.ilInfoScreenGUI.php.

References getTabs().

Referenced by executeCommand().

1053  : void
1054  {
1055  $this->getTabs($this->tabs_gui);
1056  }
getTabs(ilTabsGUI $tabs_gui)
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ showLDAPRoleGroupMappingInfo()

ilInfoScreenGUI::showLDAPRoleGroupMappingInfo ( string  $a_section = '')
Parameters
string$a_sectionsection name. Leave empty to place this info string inside a section

Definition at line 1033 of file class.ilInfoScreenGUI.php.

References ilLDAPRoleGroupMapping\_getInstance(), addProperty(), addSection(), and ILIAS\Repository\lng().

1033  : void
1034  {
1035  if (strlen($a_section)) {
1036  $this->addSection($a_section);
1037  }
1038  $ldap_mapping = ilLDAPRoleGroupMapping::_getInstance();
1039  if ($infos = $ldap_mapping->getInfoStrings($this->gui_object->getObject()->getId())) {
1040  $info_combined = '<div style="color:green;">';
1041  $counter = 0;
1042  foreach ($infos as $info_string) {
1043  if ($counter++) {
1044  $info_combined .= '<br />';
1045  }
1046  $info_combined .= $info_string;
1047  }
1048  $info_combined .= '</div>';
1049  $this->addProperty($this->lng->txt('applications'), $info_combined);
1050  }
1051  }
addProperty(string $a_name, string $a_value, string $a_link="")
add a property to current section
static _getInstance()
Get singleton instance of this class.
addSection(string $a_title)
+ Here is the call graph for this function:

◆ showLearningProgress()

ilInfoScreenGUI::showLearningProgress ( ilTemplate  $a_tpl)
Parameters
ilTemplate$a_tpl
Exceptions
ilDateTimeException

Definition at line 915 of file class.ilInfoScreenGUI.php.

References $ilUser, $rbacsystem, $user, ilObjUserTracking\_enabledLearningProgress(), ANONYMOUS_USER_ID, ilRbacSystem\checkAccess(), getContextObjId(), ilObjectLP\getInstance(), ILIAS\Repository\lng(), ilLPObjSettings\LP_MODE_MANUAL, ilTemplate\parseCurrentBlock(), and HTML_Template_IT\setVariable().

Referenced by getHTML().

915  : void
916  {
917  return;
918 
921 
922  if (!$rbacsystem->checkAccess('read', $this->getContextRefId())) {
923  return;
924  }
925  if ($ilUser->getId() == ANONYMOUS_USER_ID) {
926  return;
927  }
928 
930  return;
931  }
932 
933  $olp = ilObjectLP::getInstance($this->getContextObjId());
934  if ($olp->getCurrentMode() != ilLPObjSettings::LP_MODE_MANUAL) {
935  return;
936  }
937 
938  $this->lng->loadLanguageModule('trac');
939 
940  // section header
941  // $a_tpl->setCurrentBlock("header_row");
942  $a_tpl->setVariable(
943  "TXT_SECTION",
944  $this->lng->txt('learning_progress')
945  );
946  $a_tpl->parseCurrentBlock();
947  }
parseCurrentBlock(string $part=ilGlobalTemplateInterface::DEFAULT_BLOCK)
const ANONYMOUS_USER_ID
Definition: constants.php:27
checkAccess(string $a_operations, int $a_ref_id, string $a_type="")
checkAccess represents the main method of the RBAC-system in ILIAS3 developers want to use With this ...
setVariable($variable, $value='')
Sets a variable value.
Definition: IT.php:514
$ilUser
Definition: imgupload.php:34
static getInstance(int $obj_id)
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ showNotesSection()

ilInfoScreenGUI::showNotesSection ( )
Returns
string
Exceptions
ilCtrlException

Definition at line 980 of file class.ilInfoScreenGUI.php.

References $access, $DIC, $ilSetting, $ref_id, $settings, ILIAS\Repository\ctrl(), and ilNoteGUI\setUseObjectTitleHeader().

Referenced by executeCommand(), and getHTML().

980  : string
981  {
982  global $DIC;
983 
984  $ilAccess = $this->access;
986  $DIC->notes()->gui()->initJavascript();
987 
988  $next_class = $this->ctrl->getNextClass($this);
989  $notes_gui = new ilNoteGUI(
990  $this->gui_object->getObject()->getId(),
991  0,
992  $this->gui_object->getObject()->getType()
993  );
994  $notes_gui->setUseObjectTitleHeader(false);
995 
996  // global switch
997  if ($ilSetting->get("disable_comments")) {
998  return "";
999  } else {
1000  $ref_id = $this->gui_object->getObject()->getRefId();
1001  $has_write = $ilAccess->checkAccess("write", "", $ref_id);
1002 
1003  if ($has_write && $ilSetting->get("comments_del_tutor", "1")) {
1004  $notes_gui->enablePublicNotesDeletion();
1005  }
1006 
1007  /* should probably be discussed further
1008  for now this will only work properly with comments settings
1009  (see ilNoteGUI constructor)
1010  */
1011  if ($has_write ||
1012  $ilAccess->checkAccess("edit_permissions", "", $ref_id)) {
1013  $notes_gui->enableCommentsSettings();
1014  }
1015  }
1016 
1017  /* moved to action menu
1018  $notes_gui->enablePrivateNotes();
1019  */
1020 
1021  if ($next_class == "ilnotegui") {
1022  $html = $this->ctrl->forwardCommand($notes_gui);
1023  } else {
1024  $html = $notes_gui->getCommentsHTML();
1025  }
1026 
1027  return $html;
1028  }
ilAccessHandler $access
Notes GUI class.
global $DIC
Definition: feed.php:28
setUseObjectTitleHeader(bool $a_val)
$ref_id
Definition: ltiauth.php:67
global $ilSetting
Definition: privfeed.php:17
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ showSummary()

ilInfoScreenGUI::showSummary ( )
Exceptions
ilCtrlException
ilDatabaseException
ilDateTimeException
ilObjectNotFoundException

Definition at line 618 of file class.ilInfoScreenGUI.php.

References $tpl, getCenterColumnHTML(), getRightColumnHTML(), ilGlobalPageTemplate\setContent(), and ilGlobalPageTemplate\setRightContent().

Referenced by executeCommand().

618  : void
619  {
620  $tpl = $this->tpl;
621 
624  }
setRightContent(string $a_html)
Sets content of right column.
ilGlobalPageTemplate $tpl
setContent(string $a_html)
Sets content for standard template.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Field Documentation

◆ $access

ilAccessHandler ilInfoScreenGUI::$access
protected

Definition at line 37 of file class.ilInfoScreenGUI.php.

Referenced by addMetaDataSections(), and showNotesSection().

◆ $availability_enabled

bool ilInfoScreenGUI::$availability_enabled = true
protected

Definition at line 55 of file class.ilInfoScreenGUI.php.

◆ $block_property

array ilInfoScreenGUI::$block_property = []
protected

Definition at line 58 of file class.ilInfoScreenGUI.php.

Referenced by getAllBlockProperties().

◆ $booking_enabled

bool ilInfoScreenGUI::$booking_enabled = false
protected

Definition at line 54 of file class.ilInfoScreenGUI.php.

◆ $close_form_tag

bool ilInfoScreenGUI::$close_form_tag = true

Definition at line 49 of file class.ilInfoScreenGUI.php.

◆ $contentObjType

string ilInfoScreenGUI::$contentObjType = null
protected

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

Referenced by getContentObjType(), and setContentObjType().

◆ $contextObjId

int ilInfoScreenGUI::$contextObjId = null
protected

Definition at line 51 of file class.ilInfoScreenGUI.php.

Referenced by getContextObjId(), and setContextObjId().

◆ $contextRefId

int ilInfoScreenGUI::$contextRefId = null
protected

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

Referenced by getContextRefId(), and setContextRefId().

◆ $ctrl

ilCtrl ilInfoScreenGUI::$ctrl

◆ $feedback_enabled

bool ilInfoScreenGUI::$feedback_enabled = false
protected

Definition at line 64 of file class.ilInfoScreenGUI.php.

◆ $form_action

string ilInfoScreenGUI::$form_action

Definition at line 53 of file class.ilInfoScreenGUI.php.

◆ $gui_object

object ilInfoScreenGUI::$gui_object

Definition at line 43 of file class.ilInfoScreenGUI.php.

◆ $hidden

bool ilInfoScreenGUI::$hidden = false
protected

Definition at line 56 of file class.ilInfoScreenGUI.php.

Referenced by addSection().

◆ $hiddenelements

array ilInfoScreenGUI::$hiddenelements = array()

Definition at line 46 of file class.ilInfoScreenGUI.php.

◆ $learning_progress_enabled

bool ilInfoScreenGUI::$learning_progress_enabled = false
protected

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

◆ $lng

◆ $mbox

ILIAS UI Component MessageBox MessageBox ilInfoScreenGUI::$mbox = null
protected

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

Referenced by getMessageBox().

◆ $news_editing

bool ilInfoScreenGUI::$news_editing = false
protected

Definition at line 59 of file class.ilInfoScreenGUI.php.

◆ $news_enabled

bool ilInfoScreenGUI::$news_enabled = false
protected

Definition at line 63 of file class.ilInfoScreenGUI.php.

Referenced by getRightColumnHTML().

◆ $open_form_tag

bool ilInfoScreenGUI::$open_form_tag = true

Definition at line 48 of file class.ilInfoScreenGUI.php.

◆ $private_notes_enabled

bool ilInfoScreenGUI::$private_notes_enabled = false
protected

Definition at line 62 of file class.ilInfoScreenGUI.php.

◆ $rbacsystem

ilRbacSystem ilInfoScreenGUI::$rbacsystem
protected

Definition at line 35 of file class.ilInfoScreenGUI.php.

Referenced by showLearningProgress().

◆ $request

StandardGUIRequest ilInfoScreenGUI::$request
protected

Definition at line 66 of file class.ilInfoScreenGUI.php.

◆ $sec_nr

int ilInfoScreenGUI::$sec_nr = 0
protected

◆ $section

array ilInfoScreenGUI::$section = []
protected

Definition at line 57 of file class.ilInfoScreenGUI.php.

◆ $settings

ilSetting ilInfoScreenGUI::$settings
protected

Definition at line 40 of file class.ilInfoScreenGUI.php.

Referenced by getHTML(), and showNotesSection().

◆ $show_hidden_toggle

bool ilInfoScreenGUI::$show_hidden_toggle = false
protected

Definition at line 60 of file class.ilInfoScreenGUI.php.

◆ $table_class

string ilInfoScreenGUI::$table_class = "il_InfoScreen"

Definition at line 47 of file class.ilInfoScreenGUI.php.

Referenced by getTableClass().

◆ $tabs_gui

ilTabsGUI ilInfoScreenGUI::$tabs_gui
protected

Definition at line 34 of file class.ilInfoScreenGUI.php.

◆ $top_buttons

array ilInfoScreenGUI::$top_buttons = array()

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

◆ $top_formbuttons

array ilInfoScreenGUI::$top_formbuttons = array()

Definition at line 45 of file class.ilInfoScreenGUI.php.

◆ $tpl

ilGlobalPageTemplate ilInfoScreenGUI::$tpl
protected

Definition at line 36 of file class.ilInfoScreenGUI.php.

Referenced by executeCommand(), and showSummary().

◆ $tree

ilTree ilInfoScreenGUI::$tree
protected

Definition at line 39 of file class.ilInfoScreenGUI.php.

Referenced by addMetaDataSections(), and addPreconditionSection().

◆ $ui

ILIAS DI UIServices ilInfoScreenGUI::$ui
protected

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

◆ $user

ilObjUser ilInfoScreenGUI::$user
protected

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