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 Repository HTML HTMLUtil	$html
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
Metadata	$metadata
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

Class ilInfoScreenGUI.

Author

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de ilInfoScreenGUI: ilCommentGUI, ilColumnGUI, ilPublicUserProfileGUI ilInfoScreenGUI: ilCommonActionDispatcherGUI

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

Constructor & Destructor Documentation

__construct()

ilInfoScreenGUI::__construct

(

?object

$a_gui_object = null

)

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

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

    {
        global $DIC;

        $this->rbacsystem = $DIC->rbac()->system();
        $this->tpl = $DIC["tpl"];
        $this->access = $DIC->access();
        $this->user = $DIC->user();
        $this->tree = $DIC->repositoryTree();
        $this->settings = $DIC->settings();
        $ilCtrl = $DIC->ctrl();
        $lng = $DIC->language();
        $ilTabs = $DIC->tabs();
        $this->metadata = $DIC->learningObjectMetadata();

        $this->ctrl = $ilCtrl;
        $this->lng = $lng;
        $this->tabs_gui = $ilTabs;
        $this->gui_object = $a_gui_object;
        $this->form_action = "";
        $this->top_formbuttons = array();
        $this->hiddenelements = array();
        $this->ui = $DIC->ui();
        $this->request = $DIC->infoScreen()->internal()->gui()->standardRequest();
        $this->html = $DIC->infoScreen()->internal()->gui()->html();
    }

Here is the call graph for this function:

Member Function Documentation

addAccessPeriodProperty()

ilInfoScreenGUI::addAccessPeriodProperty

(

)

Exceptions

ilDatabaseException
ilDateTimeException

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

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

Referenced by addAvailability().

                                             : void
    {
        $a_obj = $this->gui_object->getObject();

        $this->lng->loadLanguageModule("rep");
        $this->lng->loadLanguageModule("crs");

        // links to the object
        if (is_object($a_obj)) {
            $act = new ilObjectActivation();
            $act->read($a_obj->getRefId());
            if ($act->getTimingType() == ilObjectActivation::TIMINGS_ACTIVATION) {
                $this->addProperty(
                    $this->lng->txt('rep_activation_access'),
                    ilDatePresentation::formatPeriod(
                        new ilDateTime($act->getTimingStart(), IL_CAL_UNIX),
                        new ilDateTime($act->getTimingEnd(), IL_CAL_UNIX)
                    )
                );
            } else {
                $this->addProperty(
                    $this->lng->txt('rep_activation_access'),
                    $this->lng->txt('crs_visibility_limitless')
                );
            }
        }
    }

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 1085 of file class.ilInfoScreenGUI.php.

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

Referenced by getHTML().

                                        : void
    {
        if (
            !is_object($this->gui_object) ||
            !method_exists($this->gui_object, "getObject") ||
            !is_object($this->gui_object->getObject())
        ) {
            return;
        }

        $obj = $this->gui_object->getObject();
        if ($obj->getRefId() <= 0) {
            return;
        }

        $act = new ilObjectActivation();
        $act->read($obj->getRefId());
        if ($act->getTimingType() == ilObjectActivation::TIMINGS_ACTIVATION) {
            $this->lng->loadLanguageModule("rep");
            $this->addSection($this->lng->txt("rep_activation_availability"));
            $this->addAccessPeriodProperty();
        }
    }

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 306 of file class.ilInfoScreenGUI.php.

Referenced by getHTML().

     : void {
        if ($a_position == "top") {
            $this->top_buttons[] =
                array("title" => $a_title,"link" => $a_link,"target" => $a_frame,"primary" => $a_primary);
        }
    }

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 323 of file class.ilInfoScreenGUI.php.

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

addHiddenElement()

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

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

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

                                                                     : void
    {
        $this->hiddenelements[] = array("name" => $a_name, "value" => $a_value);
    }

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 338 of file class.ilInfoScreenGUI.php.

References $access, $ctrl, $lng, $r, $ref_id, $tree, $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(), ILIAS\Repository\html(), IL_CAL_DATETIME, ilTree\isInTree(), ILIAS\Repository\lng(), ilLanguage\loadLanguageModule(), ilLanguage\txt(), and ilObjUser\userExists().

                                                                                         : void
    {
        $lng = $this->lng;

        $lng->loadLanguageModule("meta");

        $md_reader = $this->metadata->read($a_rep_obj_id, $a_obj_id, $a_type);
        $md_paths = $this->metadata->paths();
        $md_data_helper = $this->metadata->dataHelper();

        // general
        $lang_data = $md_reader->allData($md_paths->languages());
        $langs = $md_data_helper->makePresentableAsList(', ', ...$lang_data);

        $keyword_data = $md_reader->allData($md_paths->keywords());
        $keywords = $md_data_helper->makePresentableAsList(', ', ...$keyword_data);

        // authors
        $author_data = $md_reader->allData($md_paths->authors());
        $author = $md_data_helper->makePresentableAsList(', ', ...$author_data);

        // copyright
        $copyright_description = $md_reader->firstData($md_paths->copyright())->value();
        if ($copyright_description) {
            $copyright = ilMDUtils::_parseCopyright($copyright_description);
        } else {
            $copyright = ilMDUtils::_getDefaultCopyright();
        }

        // learning time
        $learning_time_data = $md_reader->firstData($md_paths->firstTypicalLearningTime());
        $learning_time = $md_data_helper->makePresentable($learning_time_data);

        // output

        // general section
        $this->addSection($lng->txt("meta_general"));
        if ($langs != "") {     // language
            $this->addProperty(
                $lng->txt("language"),
                $this->html->escape($langs)
            );
        }
        if ($keywords != "") {  // keywords
            $this->addProperty(
                $lng->txt("keywords"),
                $this->html->escape($keywords)
            );
        }
        if ($author != "") {            // author
            $this->addProperty(
                $lng->txt("author"),
                $this->html->escape($author)
            );
        }
        if ($copyright != "") {         // copyright
            $this->addProperty(
                $lng->txt("meta_copyright"),
                $copyright
            );
        }
        if ($learning_time != "") {             // typical learning time
            $this->addProperty(
                $lng->txt("meta_typical_learning_time"),
                $this->html->escape($learning_time)
            );
        }
    }

Here is the call graph for this function:

addPreconditions()

ilInfoScreenGUI::addPreconditions ( )

protected

Add preconditions.

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

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

Referenced by getHTML().

                                         : void
    {
        if (
            !is_object($this->gui_object) ||
            !method_exists($this->gui_object, "getObject") ||
            !is_object($this->gui_object->getObject())
        ) {
            return;
        }

        $obj = $this->gui_object->getObject();
        if ($obj->getRefId() <= 0) {
            return;
        }

        $conditions = ilConditionHandler::_getEffectiveConditionsOfTarget($obj->getRefId(), $obj->getId());

        if (sizeof($conditions)) {
            for ($i = 0; $i < count($conditions); $i++) {
                $conditions[$i]['title'] = ilObject::_lookupTitle($conditions[$i]['trigger_obj_id']);
            }
            $conditions = ilArrayUtil::sortArray($conditions, 'title', 'DESC');

            // Show obligatory and optional preconditions seperated
            $this->addPreconditionSection($obj, $conditions, true);
            $this->addPreconditionSection($obj, $conditions, 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 1141 of file class.ilInfoScreenGUI.php.

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

Referenced by addPreconditions().

     : void {
        $lng = $this->lng;
        $tree = $this->tree;

        $num_required = ilConditionHandler::calculateEffectiveRequiredTriggers($obj->getRefId(), $obj->getId());
        $num_optional_required =
            $num_required - count($conditions) + count(ilConditionHandler::getEffectiveOptionalConditionsOfTarget($obj->getRefId(), $obj->getId()));

        // Check if all conditions are fulfilled
        $visible_conditions = array();
        $passed_optional = 0;
        foreach ($conditions as $condition) {
            if ($obligatory and !$condition['obligatory']) {
                continue;
            }
            if (!$obligatory and $condition['obligatory']) {
                continue;
            }

            if ($tree->isDeleted($condition['trigger_ref_id'])) {
                continue;
            }

            $ok = ilConditionHandler::_checkCondition($condition) and
            !ilMemberViewSettings::getInstance()->isActive();

            if (!$ok) {
                $visible_conditions[] = $condition['id'];
            }

            if (!$obligatory and $ok) {
                ++$passed_optional;
                // optional passed
                if ($passed_optional >= $num_optional_required) {
                    return;
                }
            }
        }

        $properties = [];

        foreach ($conditions as $condition) {
            if (!isset($condition["id"]) || !in_array($condition['id'], $visible_conditions)) {
                continue;
            }

            $properties[] = [
                "condition" => ilConditionHandlerGUI::translateOperator(
                    $condition['trigger_obj_id'],
                    $condition['operator']
                ) . ' ' . $condition['value'],
                "title" => ilObject::_lookupTitle($condition['trigger_obj_id']),
                "link" => ilLink::_getLink($condition['trigger_ref_id'])
            ];
        }

        if (count($properties) > 0) {
            if ($obligatory) {
                $this->addSection($lng->txt("preconditions_obligatory_hint"));
            } else {
                $this->addSection(sprintf(
                    $lng->txt("preconditions_optional_hint"),
                    $num_optional_required - $passed_optional
                ));
            }

            foreach ($properties as $p) {
                $this->addProperty(
                    $p["condition"],
                    "<a href='" . $p["link"] . "'>" . $this->html->strip($p["title"]) . "</a>"
                );
            }
        }
    }

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_name	property name string
string	$a_value	property value
string	$a_link	link (will link the property value string)

Definition at line 242 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(), ilExSubmissionObjectGUI\getOverviewContentPortfolio(), ilExAssTypeWikiTeamGUI\renderOverviewContent(), and showLDAPRoleGroupMappingInfo().

                                                                                     : void
    {
        $this->section[$this->sec_nr]["properties"][] =
            array("name" => $a_name, "value" => $a_value,
                "link" => $a_link);
    }

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 252 of file class.ilInfoScreenGUI.php.

References $sec_nr.

     : void {
        $checkbox = "<input type=\"checkbox\" name=\"$a_checkbox_name\" value=\"$a_checkbox_value\" id=\"$a_checkbox_name$a_checkbox_value\"";
        if ($a_checkbox_checked) {
            $checkbox .= " checked=\"checked\"";
        }
        $checkbox .= " />";
        if (strlen($a_checkbox_label)) {
            $checkbox .= "&nbsp;<label for=\"$a_checkbox_name$a_checkbox_value\">$a_checkbox_label</label>";
        }
        $this->section[$this->sec_nr]["properties"][] =
            array("name" => $a_name, "value" => $checkbox, "link" => "");
    }

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 274 of file class.ilInfoScreenGUI.php.

References $sec_nr, and ilLegacyFormElementsUtil\prepareFormOutput().

     : void {
        $input = "<span class=\"form-inline\"><input class=\"form-control\" type=\"text\" name=\"$a_input_name\" id=\"$a_input_name\"";
        if (strlen($a_input_value)) {
            $input .= " value=\"" . ilLegacyFormElementsUtil::prepareFormOutput($a_input_value) . "\"";
        }
        if (strlen($a_input_size)) {
            $input .= " size=\"" . $a_input_size . "\"";
        }
        $input .= " />";
        if (strlen($direct_button_command) && strlen($direct_button_label)) {
            $css = "";
            if ($direct_button_primary) {
                $css = " btn-primary";
            }
            $input .= " <input type=\"submit\" class=\"btn btn-default" . $css . "\" name=\"cmd[$direct_button_command]\" value=\"$direct_button_label\" />";
        }
        $input .= "</span>";
        $this->section[$this->sec_nr]["properties"][] =
            array("name" => "<label for=\"$a_input_name\">$a_name</label>", "value" => $input);
    }

Here is the call graph for this function:

addSection()

ilInfoScreenGUI::addSection

(

string

$a_title

)

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

References $hidden, and $sec_nr.

Referenced by ilLearningProgressBaseGUI\__appendLPDetails(), ilLearningProgressBaseGUI\__showObjectDetails(), ilBookingInfoScreenAdapter\add(), ILIAS\Survey\InfoScreen\InfoScreenGUI\addAppraiseeInfo(), addAvailability(), ilObjIndividualAssessmentGUI\addContactDataToInfo(), ilExAssignmentGUI\addFiles(), ilObjIndividualAssessmentGUI\addGeneralDataToInfo(), ilExAssignmentGUI\addInstructions(), ilObjIndividualAssessmentGUI\addMemberDataToInfo(), addMetaDataSections(), addPreconditionSection(), ilExAssignmentGUI\addSchedule(), ILIAS\Survey\InfoScreen\InfoScreenGUI\addStartResumeSection(), ilExAssignmentGUI\addSubmission(), ilExAssignmentGUI\addSubmissionFeedback(), addTagging(), ilObjGlossaryGUI\addUsagesToInfo(), ilResourceStorageInfoGUI\append(), ilAppointmentPresentationGUI\getHTML(), and showLDAPRoleGroupMappingInfo().

                                               : void
    {
        $this->sec_nr++;
        $this->section[$this->sec_nr]["title"] = $a_title;
        $this->section[$this->sec_nr]["hidden"] = $this->hidden;
    }

Here is the caller graph for this function:

addTagging()

ilInfoScreenGUI::addTagging

(

)

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

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

Referenced by getHTML().

                                : void
    {
        $lng = $this->lng;

        $lng->loadLanguageModule("tagging");
        $tags_set = new ilSetting("tags");

        $tagging_gui = new ilTaggingGUI();
        $tagging_gui->setObject(
            $this->gui_object->getObject()->getId(),
            $this->gui_object->getObject()->getType()
        );

        $this->addSection($lng->txt("tagging_tags"));

        if ($tags_set->get("enable_all_users")) {
            $this->addProperty(
                $lng->txt("tagging_all_users"),
                $tagging_gui->getAllUserTagsForObjectHTML()
            );
        }

        $this->addProperty(
            $lng->txt("tagging_my_tags"),
            $tagging_gui->getTaggingInputHTML()
        );
    }

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 178 of file class.ilInfoScreenGUI.php.

                                                             : void
    {
        $this->availability_enabled = $a_enable;
    }

enableBookingInfo()

ilInfoScreenGUI::enableBookingInfo

(

bool

$a_enable = true

)

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

                                                            : void
    {
        $this->booking_enabled = $a_enable;
    }

enableFeedback()

ilInfoScreenGUI::enableFeedback

(

bool

$a_enable = true

)

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

                                                         : void
    {
        $this->feedback_enabled = $a_enable;
    }

enableLearningProgress()

ilInfoScreenGUI::enableLearningProgress

(

bool

$a_enable = true

)

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

                                                                 : void
    {
        $this->learning_progress_enabled = $a_enable;
    }

enableNews()

ilInfoScreenGUI::enableNews

(

bool

$a_enable = true

)

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

                                                     : void
    {
        $this->news_enabled = $a_enable;
    }

enableNewsEditing()

ilInfoScreenGUI::enableNewsEditing

(

bool

$a_enable = true

)

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

                                                            : void
    {
        $this->news_editing = $a_enable;
    }

enablePrivateNotes()

ilInfoScreenGUI::enablePrivateNotes

(

bool

$a_enable = true

)

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

                                                             : void
    {
        $this->private_notes_enabled = $a_enable;
    }

executeCommand()

ilInfoScreenGUI::executeCommand

(

)

Exceptions

ilCtrlException
ilDatabaseException
ilDateTimeException
ilObjectNotFoundException

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

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

                                    : void
    {
        $tpl = $this->tpl;

        $next_class = $this->ctrl->getNextClass($this);

        $cmd = $this->ctrl->getCmd("showSummary");
        $this->ctrl->setReturn($this, "showSummary");

        $this->setTabs();

        switch ($next_class) {
            case strtolower(ilCommentGUI::class):
                if ($this->ctrl->isAsynch()) {
                    $this->showNotesSection();
                } else {
                    $this->showSummary();    // forwards command
                }
                break;

            case "ilcolumngui":
                $this->showSummary();
                break;

            case "ilpublicuserprofilegui":
                $user_profile = new ilPublicUserProfileGUI($this->request->getUserId());
                $user_profile->setBackUrl($this->ctrl->getLinkTarget($this, "showSummary"));
                $html = $this->ctrl->forwardCommand($user_profile);
                $tpl->setContent($html);
                break;

            case "ilcommonactiondispatchergui":
                $gui = ilCommonActionDispatcherGUI::getInstanceFromAjaxCall();
                $this->ctrl->forwardCommand($gui);
                break;

            default:
                $this->$cmd();
                break;
        }
    }

Here is the call graph for this function:

getAllBlockProperties()

ilInfoScreenGUI::getAllBlockProperties

(

)

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

References $block_property.

Referenced by setColumnSettings().

                                           : array
    {
        return $this->block_property;
    }

Here is the caller graph for this function:

getCenterColumnHTML()

ilInfoScreenGUI::getCenterColumnHTML

(

)

Returns

string

Exceptions

ilCtrlException
ilDatabaseException
ilDateTimeException
ilObjectNotFoundException

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

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

Referenced by showSummary().

                                         : string
    {
        $ilCtrl = $this->ctrl;
        $html = "";
        $column_gui = new ilColumnGUI("info", IL_COL_CENTER);
        $this->setColumnSettings($column_gui);

        if (!$ilCtrl->isAsynch()) {
            if ($column_gui->getScreenMode() != IL_SCREEN_SIDE) {
                // right column wants center
                if ($column_gui->getCmdSide() == IL_COL_RIGHT) {
                    $column_gui = new ilColumnGUI("info", IL_COL_RIGHT);
                    $this->setColumnSettings($column_gui);
                    $html = $ilCtrl->forwardCommand($column_gui);
                }
                // left column wants center
                if ($column_gui->getCmdSide() == IL_COL_LEFT) {
                    $column_gui = new ilColumnGUI("info", IL_COL_LEFT);
                    $this->setColumnSettings($column_gui);
                    $html = $ilCtrl->forwardCommand($column_gui);
                }
            } else {
                $html = $this->getHTML();
            }
        }

        return $html;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getContentObjType()

ilInfoScreenGUI::getContentObjType

(

)

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

References $contentObjType.

                                       : string
    {
        if ($this->contentObjType !== null) {
            return $this->contentObjType;
        }

        return $this->gui_object->getObject()->getType();
    }

getContextObjId()

ilInfoScreenGUI::getContextObjId

(

)

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

References $contextObjId.

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

                                     : int
    {
        if ($this->contextObjId !== null) {
            return $this->contextObjId;
        }

        return $this->gui_object->getObject()->getId();
    }

Here is the caller graph for this function:

getContextRefId()

ilInfoScreenGUI::getContextRefId

(

)

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

References $contextRefId.

Referenced by saveProgress().

                                     : int
    {
        if ($this->contextRefId !== null) {
            return $this->contextRefId;
        }

        return $this->gui_object->getObject()->getRefId();
    }

Here is the caller graph for this function:

getHiddenToggleButton()

ilInfoScreenGUI::getHiddenToggleButton

(

)

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

References $lng, and ilLanguage\txt().

                                           : string
    {
        $lng = $this->lng;

        return "<a onClick=\"toggleSections(this, '" . $lng->txt("show_hidden_sections") . "', '" . $lng->txt("hide_visible_sections") . "'); return false;\" href=\"#\">" . $lng->txt("show_hidden_sections") . "</a>";
    }

Here is the call graph for this function:

getHTML()

ilInfoScreenGUI::getHTML

(

)

Returns

string

Exceptions

ilCtrlException
ilDatabaseException
ilDateTimeException
ilObjectNotFoundException

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

References $ctrl, $ilSetting, $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().

                             : string
    {
        $lng = $this->lng;
        $ilSetting = $this->settings;
        $ilCtrl = $this->ctrl;
        $ilUser = $this->user;

        $tpl = new ilTemplate("tpl.infoscreen.html", true, true, "Services/InfoScreen");

        // other class handles form action (@todo: this is not implemented/tested)
        if ($this->form_action == "") {
            $this->setFormAction($ilCtrl->getFormAction($this));
        }

        iljQueryUtil::initjQuery();

        if ($this->hidden) {
            $tpl->touchBlock("hidden_js");
            if ($this->show_hidden_toggle) {
                $this->addButton($lng->txt("show_hidden_sections"), "JavaScript:toggleSections(this, '" . $lng->txt("show_hidden_sections") . "', '" . $lng->txt("hide_visible_sections") . "');");
            }
        }


        // DEPRECATED - use ilToolbarGUI

        // add top buttons
        if (count($this->top_buttons) > 0) {
            $tpl->addBlockFile("TOP_BUTTONS", "top_buttons", "tpl.buttons.html");

            foreach ($this->top_buttons as $button) {
                // view button
                $tpl->setCurrentBlock("btn_cell");
                $tpl->setVariable("BTN_LINK", $button["link"]);
                $tpl->setVariable("BTN_TARGET", $button["target"]);
                $tpl->setVariable("BTN_TXT", $button["title"]);
                if ($button["primary"]) {
                    $tpl->setVariable("BTN_CLASS", " btn-primary");
                }
                $tpl->parseCurrentBlock();
            }
        }

        // add top formbuttons
        if ((count($this->top_formbuttons) > 0) && ($this->form_action !== '')) {
            $tpl->addBlockFile("TOP_FORMBUTTONS", "top_submitbuttons", "tpl.submitbuttons.html", "Services/InfoScreen");

            foreach ($this->top_formbuttons as $button) {
                // view button
                $tpl->setCurrentBlock("btn_submit_cell");
                $tpl->setVariable("BTN_COMMAND", $button["command"]);
                $tpl->setVariable("BTN_NAME", $button["title"]);
                $tpl->parseCurrentBlock();
            }
        }

        // add form action
        if ($this->form_action != "") {
            if ($this->open_form_tag) {
                $tpl->setCurrentBlock("formtop");
                $tpl->setVariable("FORMACTION", $this->form_action);
                $tpl->parseCurrentBlock();
            }

            if ($this->close_form_tag) {
                $tpl->touchBlock("formbottom");
            }
        }

        if (count($this->hiddenelements)) {
            foreach ($this->hiddenelements as $hidden) {
                $tpl->setCurrentBlock("hidden_element");
                $tpl->setVariable("HIDDEN_NAME", $hidden["name"]);
                $tpl->setVariable("HIDDEN_VALUE", $hidden["value"]);
                $tpl->parseCurrentBlock();
            }
        }

        if ($this->availability_enabled) {
            $this->addAvailability();
        }

        $this->addPreconditions();

        // learning progress
        if ($this->learning_progress_enabled) {
            $this->showLearningProgress($tpl);
        }

        // notes section
        if ($this->private_notes_enabled && !$ilSetting->get('disable_notes')) {
            $html = $this->showNotesSection();
            $tpl->setCurrentBlock("notes");
            $tpl->setVariable("NOTES", $html);
            $tpl->parseCurrentBlock();
        }

        // tagging
        if (
            isset($this->gui_object) &&
            method_exists($this->gui_object, "getObject") &&
            is_object($this->gui_object->getObject())
        ) {
            $tags_set = new ilSetting("tags");
            if ($tags_set->get("enable") && $ilUser->getId() != ANONYMOUS_USER_ID) {
                $this->addTagging();
            }

            $this->addObjectSections();
        }

        // render all sections
        for ($i = 1; $i <= $this->sec_nr; $i++) {
            if (isset($this->section[$i]["properties"])) {
                // section properties
                foreach ($this->section[$i]["properties"] as $property) {
                    if ($property["name"] != "") {
                        if (($property["link"] ?? "") == "") {
                            $tpl->setCurrentBlock("pv");
                            $tpl->setVariable("TXT_PROPERTY_VALUE", $property["value"]);
                        } else {
                            $tpl->setCurrentBlock("lpv");
                            $tpl->setVariable("TXT_PROPERTY_LVALUE", $property["value"]);
                            $tpl->setVariable("LINK_PROPERTY_VALUE", $property["link"]);
                        }
                        $tpl->parseCurrentBlock();
                        $tpl->setCurrentBlock("property_row");
                        $tpl->setVariable("TXT_PROPERTY", $property["name"]);
                    } else {
                        $tpl->setCurrentBlock("property_full_row");
                        $tpl->setVariable("TXT_PROPERTY_FULL_VALUE", $property["value"]);
                    }
                    $tpl->parseCurrentBlock();
                }

                // section header
                if ($this->section[$i]["hidden"] ?? false) {
                    $tpl->setVariable("SECTION_HIDDEN", " style=\"display:none;\"");
                    $tpl->setVariable("SECTION_ID", "hidable_" . $i);
                } else {
                    $tpl->setVariable("SECTION_ID", $i);
                }
                $tpl->setVariable("TCLASS", $this->getTableClass());
                $tpl->setVariable("TXT_SECTION", $this->section[$i]["title"]);
                $tpl->setCurrentBlock("row");
                $tpl->parseCurrentBlock();
            }
        }

        if (!is_null($this->mbox)) {
            $tpl->setVariable("MBOX", $this->ui->renderer()->render([$this->mbox]));
        }

        return $tpl->get();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getMessageBox()

ilInfoScreenGUI::getMessageBox

(

)

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

References $mbox.

                                   : ILIAS\UI\Component\MessageBox\MessageBox
    {
        return $this->mbox;
    }

getRightColumnHTML()

ilInfoScreenGUI::getRightColumnHTML

(

)

Returns

string

Exceptions

ilCtrlException

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

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

Referenced by showSummary().

                                        : string
    {
        $ilCtrl = $this->ctrl;

        $html = "";
        $column_gui = new ilColumnGUI("info", IL_COL_RIGHT);
        $this->setColumnSettings($column_gui);

        if ($ilCtrl->getNextClass() == "ilcolumngui" &&
            $column_gui->getCmdSide() == IL_COL_RIGHT &&
            $column_gui->getScreenMode() == IL_SCREEN_SIDE) {
            $html = $ilCtrl->forwardCommand($column_gui);
        } elseif (!$ilCtrl->isAsynch() && $this->news_enabled) {
            $html = $ilCtrl->getHTML($column_gui);
        }

        return $html;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getTableClass()

ilInfoScreenGUI::getTableClass

(

)

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

References $table_class.

Referenced by getHTML().

                                   : string
    {
        return $this->table_class;
    }

Here is the caller graph for this function:

getTabs()

ilInfoScreenGUI::getTabs

(

ilTabsGUI

$tabs_gui

)

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

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

Referenced by setTabs().

                                                : void
    {
        $next_class = $this->ctrl->getNextClass($this);
        $force_active = ($next_class == "ilnotegui");

        $tabs_gui->addSubTabTarget(
            'summary',
            $this->ctrl->getLinkTarget($this, "showSummary"),
            array("showSummary", ""),
            get_class($this),
            "",
            $force_active
        );
    }

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 1067 of file class.ilInfoScreenGUI.php.

                                                                  : void
    {
        $this->hidden = true;
        $this->show_hidden_toggle = $a_add_toggle;
    }

removeFormAction()

ilInfoScreenGUI::removeFormAction

(

)

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

                                      : void
    {
        $this->form_action = "";
    }

saveProgress()

ilInfoScreenGUI::saveProgress

(

bool

$redirect = true

)

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

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

                                                       : void
    {
        $ilUser = $this->user;

        // ensure a read event
        ilLearningProgress::_tracProgress(
            $ilUser->getId(),
            $this->getContextObjId(),
            $this->getContextRefId(),
            ilObject::_lookupType($this->getContextObjId())
        );

        $lp_marks = new ilLPMarks($this->getContextObjId(), $ilUser->getId());
        $lp_marks->setCompleted((bool) $this->request->getLPEdit());
        $lp_marks->update();

        ilLPStatusWrapper::_updateStatus($this->getContextObjId(), $ilUser->getId());

        $this->lng->loadLanguageModule('trac');
        $this->tpl->setOnScreenMessage('success', $this->lng->txt('trac_updated_status'), true);

        if ($redirect) {
            $this->ctrl->redirect($this, ""); // #14993
        }
    }

Here is the call graph for this function:

saveTags()

ilInfoScreenGUI::saveTags

(

)

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

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

                              : void
    {
        $tagging_gui = new ilTaggingGUI();
        $tagging_gui->setObject(
            $this->gui_object->getObject()->getId(),
            $this->gui_object->getObject()->getType()
        );
        $tagging_gui->saveInput();

        $this->tpl->setOnScreenMessage('success', $this->lng->txt('msg_obj_modified'), true);
        $this->ctrl->redirect($this, ""); // #14993
    }

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 208 of file class.ilInfoScreenGUI.php.

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

setCloseFormTag()

ilInfoScreenGUI::setCloseFormTag

(

bool

$a_val

)

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

                                                : void
    {
        $this->close_form_tag = $a_val;
    }

setColumnSettings()

ilInfoScreenGUI::setColumnSettings

(

ilColumnGUI

$column_gui

)

Set column settings.

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

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

Referenced by getCenterColumnHTML(), and getRightColumnHTML().

                                                              : void
    {
        $column_gui->setEnableEdit($this->news_editing);
        $column_gui->setRepositoryMode(true);
        $column_gui->setAllBlockProperties($this->getAllBlockProperties());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setContentObjType()

ilInfoScreenGUI::setContentObjType

(

string

$contentObjType

)

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

References $contentObjType.

                                                             : void
    {
        $this->contentObjType = $contentObjType;
    }

setContextObjId()

ilInfoScreenGUI::setContextObjId

(

int

$contextObjId

)

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

References $contextObjId.

                                                      : void
    {
        $this->contextObjId = $contextObjId;
    }

setContextRefId()

ilInfoScreenGUI::setContextRefId

(

int

$contextRefId

)

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

References $contextRefId.

                                                      : void
    {
        $this->contextRefId = $contextRefId;
    }

setFormAction()

ilInfoScreenGUI::setFormAction

(

string

$a_form_action

)

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

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

                                                        : void
    {
        $this->form_action = $a_form_action;
    }

Here is the caller graph for this function:

setMessageBox()

ilInfoScreenGUI::setMessageBox

(

ILIAS\UI\Component\MessageBox\MessageBox

$a_val

)

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

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

                                                                                  : void
    {
        $this->mbox = $a_val;
    }

Here is the caller graph for this function:

setOpenFormTag()

ilInfoScreenGUI::setOpenFormTag

(

bool

$a_val

)

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

                                               : void
    {
        $this->open_form_tag = $a_val;
    }

setTableClass()

ilInfoScreenGUI::setTableClass

(

string

$a_val

)

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

                                                : void
    {
        $this->table_class = $a_val;
    }

setTabs()

ilInfoScreenGUI::setTabs

(

)

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

References getTabs().

Referenced by executeCommand().

                             : void
    {
        $this->getTabs($this->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_section

section name. Leave empty to place this info string inside a section

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

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

                                                                        : void
    {
        if (strlen($a_section)) {
            $this->addSection($a_section);
        }
        $ldap_mapping = ilLDAPRoleGroupMapping::_getInstance();
        if ($infos = $ldap_mapping->getInfoStrings($this->gui_object->getObject()->getId())) {
            $info_combined = '<div style="color:green;">';
            $counter = 0;
            foreach ($infos as $info_string) {
                if ($counter++) {
                    $info_combined .= '<br />';
                }
                $info_combined .= $info_string;
            }
            $info_combined .= '</div>';
            $this->addProperty($this->lng->txt('applications'), $info_combined);
        }
    }

Here is the call graph for this function:

showLearningProgress()

ilInfoScreenGUI::showLearningProgress

(

ilTemplate

$a_tpl

)

Parameters

ilTemplate

$a_tpl

Exceptions

ilDateTimeException

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

References $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().

                                                           : void
    {
        return;

        $ilUser = $this->user;
        $rbacsystem = $this->rbacsystem;

        if (!$rbacsystem->checkAccess('read', $this->getContextRefId())) {
            return;
        }
        if ($ilUser->getId() == ANONYMOUS_USER_ID) {
            return;
        }

        if (!ilObjUserTracking::_enabledLearningProgress()) {
            return;
        }

        $olp = ilObjectLP::getInstance($this->getContextObjId());
        if ($olp->getCurrentMode() != ilLPObjSettings::LP_MODE_MANUAL) {
            return;
        }

        $this->lng->loadLanguageModule('trac');

        // section header
        //              $a_tpl->setCurrentBlock("header_row");
        $a_tpl->setVariable(
            "TXT_SECTION",
            $this->lng->txt('learning_progress')
        );
        $a_tpl->parseCurrentBlock();
    }

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 932 of file class.ilInfoScreenGUI.php.

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

Referenced by executeCommand(), and getHTML().

                                      : string
    {
        global $DIC;

        $ilAccess = $this->access;
        $ilSetting = $this->settings;
        $notes_gui = $DIC->notes()->gui();
        $notes_gui->initJavascript();
        $comments_gui = $notes_gui->getCommentsGUI(
            $this->gui_object->getObject()->getId(),
            0,
            $this->gui_object->getObject()->getType()
        );

        $next_class = $this->ctrl->getNextClass($this);
        $comments_gui->setUseObjectTitleHeader(false);

        // global switch
        if ($ilSetting->get("disable_comments")) {
            return "";
        } else {
            $ref_id = $this->gui_object->getObject()->getRefId();
            $has_write = $ilAccess->checkAccess("write", "", $ref_id);

            if ($has_write && $ilSetting->get("comments_del_tutor", "1")) {
                $comments_gui->enablePublicNotesDeletion();
            }

            /* should probably be discussed further
            for now this will only work properly with comments settings
            (see ilNoteGUI constructor)
            */
            if ($has_write ||
                $ilAccess->checkAccess("edit_permissions", "", $ref_id)) {
                $comments_gui->enableCommentsSettings();
            }
        }

        /* moved to action menu
        $notes_gui->enablePrivateNotes();
        */
        if ($next_class === strtolower(ilCommentGUI::class)) {
            $html = $this->ctrl->forwardCommand($comments_gui);
        } else {
            $html = $comments_gui->getListHTML();
        }

        return $html;
    }

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 570 of file class.ilInfoScreenGUI.php.

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

Referenced by executeCommand().

                                 : void
    {
        $tpl = $this->tpl;

        $tpl->setContent($this->getCenterColumnHTML());
        $tpl->setRightContent($this->getRightColumnHTML());
    }

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 39 of file class.ilInfoScreenGUI.php.

Referenced by addMetaDataSections(), and showNotesSection().

$availability_enabled

bool ilInfoScreenGUI::$availability_enabled = true

protected

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

$block_property

array ilInfoScreenGUI::$block_property = []

protected

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

Referenced by getAllBlockProperties().

$booking_enabled

bool ilInfoScreenGUI::$booking_enabled = false

protected

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

$close_form_tag

bool ilInfoScreenGUI::$close_form_tag = true

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

$contentObjType

string ilInfoScreenGUI::$contentObjType = null

protected

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

Referenced by getContentObjType(), and setContentObjType().

$contextObjId

int ilInfoScreenGUI::$contextObjId = null

protected

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

Referenced by getContextObjId(), and setContextObjId().

$contextRefId

int ilInfoScreenGUI::$contextRefId = null

protected

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

Referenced by getContextRefId(), and setContextRefId().

$ctrl

ilCtrl ilInfoScreenGUI::$ctrl

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

Referenced by addMetaDataSections(), getCenterColumnHTML(), getHTML(), and getRightColumnHTML().

$feedback_enabled

bool ilInfoScreenGUI::$feedback_enabled = false

protected

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

$form_action

string ilInfoScreenGUI::$form_action

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

$gui_object

object ilInfoScreenGUI::$gui_object

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

$hidden

bool ilInfoScreenGUI::$hidden = false

protected

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

Referenced by addSection().

$hiddenelements

array ilInfoScreenGUI::$hiddenelements = array()

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

$html

ILIAS Repository HTML HTMLUtil ilInfoScreenGUI::$html

protected

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

Referenced by getCenterColumnHTML(), getRightColumnHTML(), and showNotesSection().

$learning_progress_enabled

bool ilInfoScreenGUI::$learning_progress_enabled = false

protected

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

$lng

ilLanguage ilInfoScreenGUI::$lng

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

Referenced by __construct(), addMetaDataSections(), addPreconditionSection(), addTagging(), getHiddenToggleButton(), and getHTML().

$mbox

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

protected

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

Referenced by getMessageBox().

$metadata

Metadata ilInfoScreenGUI::$metadata

protected

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

$news_editing

bool ilInfoScreenGUI::$news_editing = false

protected

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

$news_enabled

bool ilInfoScreenGUI::$news_enabled = false

protected

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

Referenced by getRightColumnHTML().

$open_form_tag

bool ilInfoScreenGUI::$open_form_tag = true

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

$private_notes_enabled

bool ilInfoScreenGUI::$private_notes_enabled = false

protected

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

$rbacsystem

ilRbacSystem ilInfoScreenGUI::$rbacsystem

protected

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

Referenced by showLearningProgress().

$request

StandardGUIRequest ilInfoScreenGUI::$request

protected

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

$sec_nr

int ilInfoScreenGUI::$sec_nr = 0

protected

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

Referenced by addProperty(), addPropertyCheckbox(), addPropertyTextinput(), addSection(), and getHTML().

$section

array ilInfoScreenGUI::$section = []

protected

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

$settings

ilSetting ilInfoScreenGUI::$settings

protected

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

Referenced by getHTML(), and showNotesSection().

$show_hidden_toggle

bool ilInfoScreenGUI::$show_hidden_toggle = false

protected

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

$table_class

string ilInfoScreenGUI::$table_class = "il_InfoScreen"

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

Referenced by getTableClass().

$tabs_gui

ilTabsGUI ilInfoScreenGUI::$tabs_gui

protected

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

$top_buttons

array ilInfoScreenGUI::$top_buttons = array()

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

$top_formbuttons

array ilInfoScreenGUI::$top_formbuttons = array()

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

$tpl

ilGlobalPageTemplate ilInfoScreenGUI::$tpl

protected

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

Referenced by executeCommand(), and showSummary().

$tree

ilTree ilInfoScreenGUI::$tree

protected

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

Referenced by addMetaDataSections(), and addPreconditionSection().

$ui

ILIAS DI UIServices ilInfoScreenGUI::$ui

protected

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

$user

ilObjUser ilInfoScreenGUI::$user

protected

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

Referenced by addMetaDataSections(), getHTML(), saveProgress(), and showLearningProgress().

---

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

• Services/InfoScreen/classes/class.ilInfoScreenGUI.php