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

Inheritance diagram for ilPDStudyProgrammeSimpleListGUI:

Collaboration diagram for ilPDStudyProgrammeSimpleListGUI:

Public Member Functions
	__construct ()

	getHTML ()

	getDataSectionContent ()

	fillDataSection ()

Public Member Functions inherited from ilBlockGUI
	__construct ()
	Constructor. More...

	addHeaderLink ($a_href, $a_text, $status=true)

	getHeaderLinks ()

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

	getData ()
	Get Data. More...

	setBigMode ($a_bigmode)
	Set Big Mode. More...

	getBigMode ()
	Get Big Mode. More...

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

	getBlockId ()
	Get Block Id. More...

	setAvailableDetailLevels ($a_max, $a_min=0)
	Set Available Detail Levels. More...

	setCurrentDetailLevel ($a_currentdetaillevel)
	Set Current Detail Level. More...

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

	getGuiObject ()
	Get GuiObject. More...

	getCurrentDetailLevel ()
	Get Current Detail Level. More...

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

	getTitle ()
	Get Title. More...

	setImage ($a_image)
	Set Image. More...

	getImage ()
	Get Image. 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...

	setFooterInfo ($a_footerinfo, $a_hide_and_icon=false)
	Set Footer Info. More...

	getFooterInfo ($a_hide_and_icon=false)
	Get Footer Info. 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 ($a_admincommands)
	Set Administration Commmands. More...

	getAdminCommands ()
	Get Administration Commmands. More...

	setColSpan ($a_colspan)
	Set Columns Span. More...

	getColSpan ()
	Get Columns Span. More...

	setEnableDetailRow ($a_enabledetailrow)
	Set EnableDetailRow. More...

	getEnableDetailRow ()
	Get EnableDetailRow. 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 ()

	getDetailParameter ()

	getConfigParameter ()

	getMoveParameter ()

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

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

	addBlockCommand ( $a_href, $a_text, $a_target="", $a_img="", $a_right_aligned=false, $a_checked=false, $a_html="")
	Add Block Command. More...

	getBlockCommands ()
	Get Block commands. More...

	addHeaderCommand ($a_href, $a_text, $a_as_close=false)
	Add Header Block Command. More...

	getHeaderCommands ()
	Get Header Block commands. More...

	addFooterLink ( $a_text, $a_href="", $a_onclick="", $a_block_id="", $a_top=false, $a_omit_separator=false, $a_checked=false)
	Add a footer text/link. More...

	getFooterLinks ()
	Get footer links. More...

	clearFooterLinks ()
	Clear footer links. More...

	handleDetailLevel ()
	Handle read/write current detail level. More...

	getHTML ()
	Handle config status. 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...

	fillFooterLinks ($a_top=false, $a_numinfo="")
	Fill footer links. More...

	fillDetailRow ()
	Fill Detail Setting Row. More...

Static Public Member Functions
static	getBlockType ()

static	isRepositoryObject ()

Static Public Member Functions inherited from ilBlockGUI
static	getBlockType ()

static	isRepositoryObject ()

static	getScreenMode ()
	Get Screen Mode for current command. More...

Data Fields
const	BLOCK_TYPE = "prgsimplelist"

Protected Member Functions
	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
	fillRowColor ($a_placeholder="CSS_ROW")

	preloadData (array $data)
	Can be overwritten in subclasses. 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
	$data = array()

	$colspan = 1

	$enablenuminfo = true

	$detail_min = 0

	$detail_max = 0

	$bigmode = false

	$footer_links = array()

	$block_id = 0

	$header_commands = array()

	$allow_moving = true

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

	$enabledetailrow = true

	$header_links = array()

	$footerinfo = false

	$footerinfo_icon = false

	$block_commands = array()

	$max_count = false

	$close_command = false

	$image = false

	$property = false

	$nav_value = ""

	$css_row = ""

	$dropdown

	$tpl

	$main_tpl

	$user

	$ctrl

	$access

	$lng

	$obj_def

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 16 of file class.ilPDStudyProgrammeSimpleListGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilPDStudyProgrammeSimpleListGUI::__construct ( )

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

References $DIC, $ilSetting, $ilUser, ilBlockGUI\$lng, 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');
 
         // 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 137 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()

static ilPDStudyProgrammeSimpleListGUI::getBlockType ( )

static

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

     {
         return self::BLOCK_TYPE;
     }

◆ getDataSectionContent()

ilPDStudyProgrammeSimpleListGUI::getDataSectionContent ( )

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

References 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 90 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 175 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 193 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()

static ilPDStudyProgrammeSimpleListGUI::isRepositoryObject ( )

static

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

     {
         return false;
     }

◆ isVisible()

ilPDStudyProgrammeSimpleListGUI::isVisible ( ilStudyProgrammeUserAssignment $assignment )

protected

Definition at line 188 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 217 of file class.ilPDStudyProgrammeSimpleListGUI.php.

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

Referenced by getDataSectionContent().

     {
         require_once("Modules/StudyProgramme/classes/class.ilStudyProgrammeProgressListGUI.php");
         $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 181 of file class.ilPDStudyProgrammeSimpleListGUI.php.

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

Referenced by __construct().

     {
         require_once 'Services/PersonalDesktop/ItemsBlock/classes/class.ilPDSelectedItemsBlockViewSettings.php';
         $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 211 of file class.ilPDStudyProgrammeSimpleListGUI.php.

References ilStudyProgrammeUserAssignment\getInstancesOfUser().

Referenced by __construct().

     {
         require_once("Modules/StudyProgramme/classes/class.ilStudyProgrammeUserAssignment.php");
         $this->users_assignments = ilStudyProgrammeUserAssignment::getInstancesOfUser($this->il_user->getId());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readVisibleOnPDMode()

ilPDStudyProgrammeSimpleListGUI::readVisibleOnPDMode ( )

protected

Definition at line 170 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 202 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() == "ilpersonaldesktopgui" && $ctrl->getCmd() == "show")
             ) && !$_GET["expand"];
     }

Here is the caller graph for this function:

◆ userHasReadableStudyProgrammes()

ilPDStudyProgrammeSimpleListGUI::userHasReadableStudyProgrammes ( )

protected

Definition at line 157 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 144 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 33 of file class.ilPDStudyProgrammeSimpleListGUI.php.

◆ $il_lng

ilPDStudyProgrammeSimpleListGUI::$il_lng

protected

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

◆ $il_setting

ilPDStudyProgrammeSimpleListGUI::$il_setting

protected

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

◆ $il_user

ilPDStudyProgrammeSimpleListGUI::$il_user

protected

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

◆ $show_info_message

ilPDStudyProgrammeSimpleListGUI::$show_info_message

protected

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

◆ $users_assignments

ilPDStudyProgrammeSimpleListGUI::$users_assignments

protected

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

◆ $visible_on_pd_mode

ilPDStudyProgrammeSimpleListGUI::$visible_on_pd_mode

protected

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

◆ BLOCK_TYPE

const ilPDStudyProgrammeSimpleListGUI::BLOCK_TYPE = "prgsimplelist"

Definition at line 18 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

Static Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

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