Personal Desktop-Presentation for the Study Programme. More...

Inheritance diagram for ilPDStudyProgrammeSimpleListGUI:

Collaboration diagram for ilPDStudyProgrammeSimpleListGUI:

Public Member Functions
	__construct ()

	getHTML ()

	getDataSectionContent ()

	getBlockType ()

	fillDataSection ()

Public Member Functions inherited from ilBlockGUI
	getBlockType ()

	__construct ()
	Constructor. More...

	setData ($a_data)
	Set Data. More...

	getData ()
	Get Data. More...

	setPresentation (int $type)
	Set presentation. More...

	getPresentation ()
	Get presentation type. More...

	setBlockId ($a_block_id=0)
	Set Block Id. More...

	getBlockId ()
	Get Block Id. More...

	setGuiObject (&$a_gui_object)
	Set GuiObject. More...

	getGuiObject ()
	Get GuiObject. More...

	setTitle ($a_title)
	Set Title. More...

	getTitle ()
	Get Title. More...

	setOffset ($a_offset)
	Set Offset. More...

	getOffset ()
	Get Offset. More...

	correctOffset ()

	setLimit ($a_limit)
	Set Limit. More...

	getLimit ()
	Get Limit. More...

	setEnableEdit ($a_enableedit)
	Set EnableEdit. More...

	getEnableEdit ()
	Get EnableEdit. More...

	setRepositoryMode ($a_repositorymode)
	Set RepositoryMode. More...

	getRepositoryMode ()
	Get RepositoryMode. More...

	setSubtitle ($a_subtitle)
	Set Subtitle. More...

	getSubtitle ()
	Get Subtitle. More...

	setRefId ($a_refid)
	Set Ref Id (only used if isRepositoryObject() is true). More...

	getRefId ()
	Get Ref Id (only used if isRepositoryObject() is true). More...

	setAdminCommands (bool $a_admincommands)
	Set Administration Commmands. More...

	getAdminCommands ()
	Get Administration Commmands. More...

	setEnableNumInfo ($a_enablenuminfo)
	Set Enable Item Number Info. More...

	getEnableNumInfo ()
	Get Enable Item Number Info. More...

	setProperties ($a_properties)
	This function is supposed to be used for block type specific properties, that should be inherited through ilColumnGUI->setBlockProperties. More...

	getProperty ($a_property)

	setProperty ($a_property, $a_value)

	setRowTemplate ($a_rowtemplatename, $a_rowtemplatedir="")
	Set Row Template Name. More...

	getNavParameter ()

	getConfigParameter ()

	getMoveParameter ()

	getRowTemplateName ()
	Get Row Template Name. More...

	getRowTemplateDir ()
	Get Row Template Directory. More...

	addBlockCommand (string $a_href, string $a_text, string $a_onclick="")
	Add Block Command. More...

	getBlockCommands ()
	Get Block commands. More...

	getHTML ()
	Get HTML. More...

	fillHeaderCommands ()
	Fill header commands block. More...

	fillHeaderTitleBlock ()
	Fill header title block (title and. More...

	setDataSection ($a_content)
	Call this from overwritten fillDataSection(), if standard row based data is not used. More...

	fillDataSection ()
	Standard implementation for row based data. More...

	fillRow ($a_set)

	fillFooter ()

	fillPreviousNext ()
	Fill previous/next row. More...

	setPreviousNextLinks ()
	Get previous/next linkbar. More...

	getAsynch ()
	Use this for final get before sending asynchronous output (ajax) per echo to output. More...

	getPaginationViewControl ()
	Fill previous/next row. More...

	getHTMLNew ()
	Get HTML. More...

Data Fields
const	BLOCK_TYPE = "prgsimplelist"

Data Fields inherited from ilBlockGUI
const	PRES_MAIN_LEG = 0

const	PRES_SEC_LEG = 1

const	PRES_SEC_LIST = 2

const	PRES_MAIN_LIST = 3

Protected Member Functions
	isRepositoryObject ()

	userHasVisibleStudyProgrammes ()

	userHasReadableStudyProgrammes ()

	readVisibleOnPDMode ()

	hasPermission (ilStudyProgrammeUserAssignment $assignment, $permission)

	readToShowInfoMessage ()

	isVisible (ilStudyProgrammeUserAssignment $assignment)

	isReadable (ilStudyProgrammeUserAssignment $assignment)

	shouldShowThisList ()

	readUsersAssignments ()

	new_ilStudyProgrammeAssignmentListGUI (ilStudyProgrammeUserAssignment $a_assignment)

Protected Member Functions inherited from ilBlockGUI
	isRepositoryObject ()
	Returns whether block has a corresponding repository object. More...

	initCommands ()
	Init commands. More...

	fillRowColor ($a_placeholder="CSS_ROW")

	preloadData (array $data)
	Can be overwritten in subclasses. More...

	getLegacyContent ()
	Get legacy content. More...

	getViewControls ()
	Get view controls. More...

	getListItemForData (array $data)
	Get list item for data array. More...

	handleNavigation ()
	Handle navigation. More...

	loadData ()
	Load data for current page. More...

	getListItemGroups ()
	Get items. More...

	addRepoCommands ()
	Add repo commands. More...

	getNoItemFoundContent ()
	No item entry. More...

Protected Attributes
	$il_lng

	$il_user

	$il_access

	$il_setting

	$users_assignments

	$visible_on_pd_mode

	$show_info_message

Protected Attributes inherited from ilBlockGUI
	$ui

	$data = array()

	$enablenuminfo = true

	$footer_links = array()

	$block_id = 0

	$allow_moving = true

	$move = array("left" => false, "right" => false, "up" => false, "down" => false)

	$block_commands = array()

	$max_count = false

	$close_command = false

	$image = false

	$property = false

	$nav_value = ""

	$css_row = ""

	$title = ""

	$admincommands = false

	$dropdown

	$tpl

	$main_tpl

	$user

	$ctrl

	$access

	$lng

	$obj_def

	$presentation

	$new_rendering = false

Additional Inherited Members
Static Public Member Functions inherited from ilBlockGUI
static	getScreenMode ()
	Get Screen Mode for current command. More...

Detailed Description

Personal Desktop-Presentation for the Study Programme.

Author: : Richard Klees richa.nosp@m.rd.k.nosp@m.lees@.nosp@m.conc.nosp@m.epts-.nosp@m.and-.nosp@m.train.nosp@m.ing..nosp@m.de; : Stefan Hecken stefa.nosp@m.n.he.nosp@m.cken@.nosp@m.conc.nosp@m.epts-.nosp@m.and-.nosp@m.train.nosp@m.ing..nosp@m.de ilPDStudyProgrammeSimpleListGUI: ilColumnGUI

Definition at line 15 of file class.ilPDStudyProgrammeSimpleListGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilPDStudyProgrammeSimpleListGUI::__construct ( )

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

References $DIC, $ilSetting, $ilUser, ilBlockGUI\$lng, ILIAS\GlobalScreen\Provider\__construct(), ilStudyProgrammeDIC\dic(), ilLoggerFactory\getLogger(), readToShowInfoMessage(), readUsersAssignments(), readVisibleOnPDMode(), ilBlockGUI\setTitle(), shouldShowThisList(), and userHasReadableStudyProgrammes().

     {
         global $DIC;
 
         parent::__construct();
 
         $lng = $DIC['lng'];
         $ilUser = $DIC['ilUser'];
         $ilAccess = $DIC['ilAccess'];
         $ilSetting = $DIC['ilSetting'];
         $this->il_lng = $lng;
         $this->il_user = $ilUser;
         $this->il_access = $ilAccess;
         $this->il_setting = $ilSetting;
         $this->il_logger = ilLoggerFactory::getLogger('prg');
 
         $this->sp_user_assignment_db = ilStudyProgrammeDIC::dic()['ilStudyProgrammeUserAssignmentDB'];
 
         // No need to load data, as we won't display this.
         if (!$this->shouldShowThisList()) {
             return;
         }
 
         $this->readUsersAssignments();
         //check which kind of option is selected in settings
         $this->readVisibleOnPDMode();
         //check to display info message if option "read" is selected
         $this->readToShowInfoMessage();
         
         // As this won't be visible we don't have to initialize this.
         if (!$this->userHasReadableStudyProgrammes()) {
             return;
         }
 
         $this->setTitle($this->il_lng->txt("objs_prg"));
     }

Here is the call graph for this function:

Member Function Documentation

◆ fillDataSection()

ilPDStudyProgrammeSimpleListGUI::fillDataSection ( )

Definition at line 144 of file class.ilPDStudyProgrammeSimpleListGUI.php.

References getDataSectionContent(), and userHasReadableStudyProgrammes().

     {
         assert($this->userHasReadableStudyProgrammes()); // We should not get here.
         $this->tpl->setVariable("BLOCK_ROW", $this->getDataSectionContent());
     }

Here is the call graph for this function:

◆ getBlockType()

ilPDStudyProgrammeSimpleListGUI::getBlockType ( )

Definition at line 131 of file class.ilPDStudyProgrammeSimpleListGUI.php.

                                    : string
     {
         return self::BLOCK_TYPE;
     }

◆ getDataSectionContent()

ilPDStudyProgrammeSimpleListGUI::getDataSectionContent ( )

Definition at line 106 of file class.ilPDStudyProgrammeSimpleListGUI.php.

References Vendor\Package\$e, isReadable(), and new_ilStudyProgrammeAssignmentListGUI().

Referenced by fillDataSection().

     {
         $content = "";
         foreach ($this->users_assignments as $assignment) {
             if (!$this->isReadable($assignment)) {
                 continue;
             }
 
             try {
                 $list_item = $this->new_ilStudyProgrammeAssignmentListGUI($assignment);
                 $list_item->setShowInfoMessage($this->show_info_message);
                 $list_item->setVisibleOnPDMode($this->visible_on_pd_mode);
                 $content .= $list_item->getHTML();
             } catch (ilStudyProgrammeNoProgressForAssignmentException $e) {
                 $this->il_logger->alert("$e");
             } catch (ilStudyProgrammeTreeException $e) {
                 $this->il_logger->alert("$e");
             }
         }
         return $content;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getHTML()

ilPDStudyProgrammeSimpleListGUI::getHTML ( )

Definition at line 91 of file class.ilPDStudyProgrammeSimpleListGUI.php.

References shouldShowThisList(), and userHasReadableStudyProgrammes().

     {
         // TODO: This should be determined from somewhere up in the hierarchy, as
         // this will lead to problems, when e.g. a command changes. But i don't see
         // how atm...
         if (!$this->shouldShowThisList()) {
             return "";
         }
         
         if (!$this->userHasReadableStudyProgrammes()) {
             return "";
         }
         return parent::getHTML();
     }

Here is the call graph for this function:

◆ hasPermission()

ilPDStudyProgrammeSimpleListGUI::hasPermission	(	ilStudyProgrammeUserAssignment	$assignment,
			$permission
	)

protected

Definition at line 182 of file class.ilPDStudyProgrammeSimpleListGUI.php.

References ilStudyProgrammeUserAssignment\getStudyProgramme().

Referenced by isReadable(), and isVisible().

     {
         $prg = $assignment->getStudyProgramme();
         return $this->il_access->checkAccess($permission, "", $prg->getRefId(), "prg", $prg->getId());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isReadable()

ilPDStudyProgrammeSimpleListGUI::isReadable ( ilStudyProgrammeUserAssignment $assignment )

protected

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

References hasPermission(), and ilObjStudyProgrammeAdmin\SETTING_VISIBLE_ON_PD_ALLWAYS.

Referenced by getDataSectionContent(), and userHasReadableStudyProgrammes().

     {
         if ($this->visible_on_pd_mode == ilObjStudyProgrammeAdmin::SETTING_VISIBLE_ON_PD_ALLWAYS) {
             return true;
         }
 
         return $this->hasPermission($assignment, "read");
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isRepositoryObject()

ilPDStudyProgrammeSimpleListGUI::isRepositoryObject ( )

protected

Definition at line 139 of file class.ilPDStudyProgrammeSimpleListGUI.php.

                                             : bool
     {
         return false;
     }

◆ isVisible()

ilPDStudyProgrammeSimpleListGUI::isVisible ( ilStudyProgrammeUserAssignment $assignment )

protected

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

References hasPermission().

Referenced by userHasVisibleStudyProgrammes().

     {
         return $this->hasPermission($assignment, "visible");
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ new_ilStudyProgrammeAssignmentListGUI()

ilPDStudyProgrammeSimpleListGUI::new_ilStudyProgrammeAssignmentListGUI ( ilStudyProgrammeUserAssignment $a_assignment )

protected

Definition at line 222 of file class.ilPDStudyProgrammeSimpleListGUI.php.

References ilStudyProgrammeUserAssignment\getId(), and ilStudyProgrammeUserAssignment\getStudyProgramme().

Referenced by getDataSectionContent().

     {
         $progress = $a_assignment->getStudyProgramme()->getProgressForAssignment($a_assignment->getId());
         $progress_gui = new ilStudyProgrammeProgressListGUI($progress);
         $progress_gui->setOnlyRelevant(true);
         return $progress_gui;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readToShowInfoMessage()

ilPDStudyProgrammeSimpleListGUI::readToShowInfoMessage ( )

protected

Definition at line 188 of file class.ilPDStudyProgrammeSimpleListGUI.php.

References $_GET, $GLOBALS, and user().

Referenced by __construct().

     {
         $viewSettings = new ilPDSelectedItemsBlockViewSettings($GLOBALS['DIC']->user(), (int) $_GET['view']);
         $this->show_info_message = $viewSettings->isStudyProgrammeViewActive();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readUsersAssignments()

ilPDStudyProgrammeSimpleListGUI::readUsersAssignments ( )

protected

Definition at line 217 of file class.ilPDStudyProgrammeSimpleListGUI.php.

Referenced by __construct().

     {
         $this->users_assignments = $this->sp_user_assignment_db->getInstancesOfUser($this->il_user->getId());
     }

Here is the caller graph for this function:

◆ readVisibleOnPDMode()

ilPDStudyProgrammeSimpleListGUI::readVisibleOnPDMode ( )

protected

Definition at line 177 of file class.ilPDStudyProgrammeSimpleListGUI.php.

References ilObjStudyProgrammeAdmin\SETTING_VISIBLE_ON_PD.

Referenced by __construct().

     {
         $this->visible_on_pd_mode = $this->il_setting->get(ilObjStudyProgrammeAdmin::SETTING_VISIBLE_ON_PD);
     }

Here is the caller graph for this function:

◆ shouldShowThisList()

ilPDStudyProgrammeSimpleListGUI::shouldShowThisList ( )

protected

Definition at line 208 of file class.ilPDStudyProgrammeSimpleListGUI.php.

References $_GET, ilBlockGUI\$ctrl, and $DIC.

Referenced by __construct(), and getHTML().

     {
         global $DIC;
         $ctrl = $DIC->ctrl();
         return ($_GET["cmd"] == "jumpToSelectedItems" ||
                 ($ctrl->getCmdClass() == "ildashboardgui" && $ctrl->getCmd() == "show")
             ) && !$_GET["expand"];
     }

Here is the caller graph for this function:

◆ userHasReadableStudyProgrammes()

ilPDStudyProgrammeSimpleListGUI::userHasReadableStudyProgrammes ( )

protected

Definition at line 164 of file class.ilPDStudyProgrammeSimpleListGUI.php.

References isReadable().

Referenced by __construct(), fillDataSection(), and getHTML().

     {
         if (count($this->users_assignments) == 0) {
             return false;
         }
         foreach ($this->users_assignments as $assignment) {
             if ($this->isReadable($assignment)) {
                 return true;
             }
         }
         return false;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ userHasVisibleStudyProgrammes()

ilPDStudyProgrammeSimpleListGUI::userHasVisibleStudyProgrammes ( )

protected

Definition at line 151 of file class.ilPDStudyProgrammeSimpleListGUI.php.

References isVisible().

     {
         if (count($this->users_assignments) == 0) {
             return false;
         }
         foreach ($this->users_assignments as $assignment) {
             if ($this->isVisible($assignment)) {
                 return true;
             }
         }
         return false;
     }

Here is the call graph for this function:

Field Documentation

◆ $il_access

ilPDStudyProgrammeSimpleListGUI::$il_access

protected

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

◆ $il_lng

ilPDStudyProgrammeSimpleListGUI::$il_lng

protected

Definition at line 22 of file class.ilPDStudyProgrammeSimpleListGUI.php.

◆ $il_setting

ilPDStudyProgrammeSimpleListGUI::$il_setting

protected

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

◆ $il_user

ilPDStudyProgrammeSimpleListGUI::$il_user

protected

Definition at line 27 of file class.ilPDStudyProgrammeSimpleListGUI.php.

◆ $show_info_message

ilPDStudyProgrammeSimpleListGUI::$show_info_message

protected

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

◆ $users_assignments

ilPDStudyProgrammeSimpleListGUI::$users_assignments

protected

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

◆ $visible_on_pd_mode

ilPDStudyProgrammeSimpleListGUI::$visible_on_pd_mode

protected

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

◆ BLOCK_TYPE

const ilPDStudyProgrammeSimpleListGUI::BLOCK_TYPE = "prgsimplelist"

Definition at line 17 of file class.ilPDStudyProgrammeSimpleListGUI.php.

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

Modules/StudyProgramme/classes/class.ilPDStudyProgrammeSimpleListGUI.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ fillDataSection()

◆ getBlockType()

◆ getDataSectionContent()

◆ getHTML()

◆ hasPermission()

◆ isReadable()

◆ isRepositoryObject()

◆ isVisible()

◆ new_ilStudyProgrammeAssignmentListGUI()

◆ readToShowInfoMessage()

◆ readUsersAssignments()

◆ readVisibleOnPDMode()

◆ shouldShowThisList()

◆ userHasReadableStudyProgrammes()

◆ userHasVisibleStudyProgrammes()

Field Documentation

◆ $il_access

◆ $il_lng

◆ $il_setting

◆ $il_user

◆ $show_info_message

◆ $users_assignments

◆ $visible_on_pd_mode

◆ BLOCK_TYPE