ilStudyProgrammeUserTable Class Reference

ilStudyProgrammeUserTable provides a flattened list of progresses at a programme-node. More...

Collaboration diagram for ilStudyProgrammeUserTable:

Public Member Functions
	__construct (ilDBInterface $db, ilExportFieldsInfo $export_fields_info, ilPRGAssignmentDBRepository $assignment_repo, ilLanguage $lng, ilPRGPermissionsHelper $permissions)
	getColumns (int $prg_id, bool $add_active_column=false)
	countFetchData (int $prg_id, ?array $valid_user_ids, ilPRGAssignmentFilter $custom_filters)
	fetchData (int $prg_id, ?array $valid_user_ids, Order $order, ilPRGAssignmentFilter $custom_filters=null, int $limit=null, int $offset=null)
	fetchSingleUserRootAssignments (int $usr_id)
	disablePermissionCheck ($flag=false)
	statusToRepresent ($a_status)
	boolToRepresent (bool $value)
	validToRepresent (ilPRGProgress $pgs)
	activeToRepresent (bool $value)
	assignmentSourceToRepresent (bool $manually, int $assignment_src)
	completionByToRepresent (ilPRGProgress $progress)

Static Public Member Functions
static	lookupTitle (int $obj_id)

Data Fields
const	OPTION_ALL = -1
const	VALIDITY_OPTION_VALID = 1
const	VALIDITY_OPTION_INVALID = 3
const	OPTION_USR_ACTIVE = 1
const	OPTION_USR_INACTIVE = 2
const	PRG_COLS

Protected Member Functions
	getUserDataColumns (int $prg_id)
	getPrgColumns ()
	includeLearningProgress (int $usr_id)
	toRow (ilPRGAssignment $ass, int $node_id)
	getUserDateFormat ()
	completionByToCollection (ilPRGProgress $progress)
	postOrder (array $list, \ILIAS\Data\Order $order)

Protected Attributes
ilDBInterface	$db
ilExportFieldsInfo	$export_fields_info
ilLanguage	$lng
ilPRGPermissionsHelper	$permissions
array	$user_ids_viewer_may_read_learning_progress_of
ilPRGAssignmentDBRepository	$assignment_repo
	$skip_perm_check_on_user = false

Private Attributes
const	ORDER_MAPPING

Detailed Description

ilStudyProgrammeUserTable provides a flattened list of progresses at a programme-node.

Definition at line 26 of file class.ilStudyProgrammeUserTable.php.

Constructor & Destructor Documentation

__construct()

ilStudyProgrammeUserTable::__construct	(	ilDBInterface	$db,
		ilExportFieldsInfo	$export_fields_info,
		ilPRGAssignmentDBRepository	$assignment_repo,
		ilLanguage	$lng,
		ilPRGPermissionsHelper	$permissions
	)

Definition at line 75 of file class.ilStudyProgrammeUserTable.php.

      {
        $this->db = $db;
        $this->export_fields_info = $export_fields_info;
        $this->assignment_repo = $assignment_repo;
        $this->lng = $lng;
        $this->permissions = $permissions;
        $this->user_ids_viewer_may_read_learning_progress_of = $this->permissions->getUserIdsSusceptibleTo(
            ilOrgUnitOperation::OP_READ_LEARNING_PROGRESS
        );
 
        $this->lng->loadLanguageModule("prg");
    }

References $assignment_repo, $db, $export_fields_info, $lng, $permissions, ilPRGPermissionsHelper\getUserIdsSusceptibleTo(), ILIAS\Repository\lng(), and ilOrgUnitOperation\OP_READ_LEARNING_PROGRESS.

Here is the call graph for this function:

Member Function Documentation

activeToRepresent()

ilStudyProgrammeUserTable::activeToRepresent

(

bool

$value

)

Definition at line 283 of file class.ilStudyProgrammeUserTable.php.

                                                  : string
    {
        return $value ? $this->lng->txt('active') : $this->lng->txt('inactive');
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

assignmentSourceToRepresent()

ilStudyProgrammeUserTable::assignmentSourceToRepresent	(	bool	$manually,
		int	$assignment_src
	)

Definition at line 288 of file class.ilStudyProgrammeUserTable.php.

                                                                                    : string
    {
        $srcs = array_flip(ilStudyProgrammeAutoMembershipSource::SOURCE_MAPPING);
        if ($manually || ! in_array($assignment_src, $srcs)) {
            return $this::lookupTitle($assignment_src);
        }
        return implode(' ', [
            $this->lng->txt('prg_autoassignment'),
            $this->lng->txt($srcs[$assignment_src])
        ]);
    }

References ILIAS\Repository\lng(), and ilStudyProgrammeAutoMembershipSource\SOURCE_MAPPING.

Here is the call graph for this function:

boolToRepresent()

ilStudyProgrammeUserTable::boolToRepresent

(

bool

$value

)

Definition at line 270 of file class.ilStudyProgrammeUserTable.php.

                                                : string
    {
        return ($value) ? $this->lng->txt("yes") : $this->lng->txt("no");
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

completionByToCollection()

ilStudyProgrammeUserTable::completionByToCollection ( ilPRGProgress  $progress )

protected

Definition at line 315 of file class.ilStudyProgrammeUserTable.php.

                                                                        : array
    {
        $completion_by = $progress->getCompletionBy();
        if ($completion_by !== ilPRGProgress::COMPLETED_BY_SUBNODES) {
            return [$completion_by];
        }
        $successful_subnodes = array_filter(
            $progress->getSubnodes(),
            static fn (ilPRGProgress $pgs): bool => $pgs->isSuccessful()
        );
        return  array_map(
            static fn (ilPRGProgress $pgs): int => $pgs->getNodeId(),
            $successful_subnodes
        );
    }

References ilPRGProgress\COMPLETED_BY_SUBNODES, ilPRGProgress\getCompletionBy(), ilPRGProgress\getNodeId(), ILIAS\StudyProgramme\Assignment\Node\getSubnodes(), and ilPRGProgress\isSuccessful().

Here is the call graph for this function:

completionByToRepresent()

ilStudyProgrammeUserTable::completionByToRepresent

(

ilPRGProgress

$progress

)

Definition at line 300 of file class.ilStudyProgrammeUserTable.php.

                                                                    : string
    {
        $completion_by = $progress->getCompletionBy();
        if ($completion_by !== ilPRGProgress::COMPLETED_BY_SUBNODES) {
            return $this::lookupTitle($completion_by);
        }
 
        $out = array_map(
            fn (int $node_obj_id): string => self::lookupTitle($node_obj_id),
            $this->completionByToCollection($progress)
        );
 
        return implode(', ', $out);
    }

References $out, ilPRGProgress\COMPLETED_BY_SUBNODES, and ilPRGProgress\getCompletionBy().

Here is the call graph for this function:

countFetchData()

ilStudyProgrammeUserTable::countFetchData	(	int	$prg_id,
		?array	$valid_user_ids,
		ilPRGAssignmentFilter	$custom_filters
	)

Definition at line 128 of file class.ilStudyProgrammeUserTable.php.

                                                                                                              : int
    {
        return $this->assignment_repo->countAllForNodeIsContained($prg_id, $valid_user_ids, $custom_filters);
    }

disablePermissionCheck()

ilStudyProgrammeUserTable::disablePermissionCheck

(

$flag = false

)

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

                                                         : void
    {
        $this->skip_perm_check_on_user = $flag;
    }

fetchData()

ilStudyProgrammeUserTable::fetchData	(	int	$prg_id,
		?array	$valid_user_ids,
		Order	$order,
		ilPRGAssignmentFilter	$custom_filters = null,
		int	$limit = null,
		int	$offset = null
	)

Returns

ilStudyProgrammeUserTableRow[]

Exceptions

ilException

Definition at line 137 of file class.ilStudyProgrammeUserTable.php.

     : array {
        $data = $this->assignment_repo->getAllForNodeIsContained(
            $prg_id,
            $valid_user_ids,
            $custom_filters
        );
        $rows = array_map(fn ($ass) => $this->toRow($ass, $prg_id), $data);
        $rows = $this->postOrder($rows, $order);
        if ($limit) {
            $offset = $offset ?? 0;
            $rows = array_slice($rows, $offset, $limit);
        }
        return $rows;
    }

fetchSingleUserRootAssignments()

ilStudyProgrammeUserTable::fetchSingleUserRootAssignments

(

int

$usr_id

)

Definition at line 159 of file class.ilStudyProgrammeUserTable.php.

                                                               : array
    {
        $data = $this->assignment_repo->getForUser($usr_id);
        $row = array_map(fn ($ass) => $this->toRow($ass, $ass->getRootId()), $data);
        return $row;
    }

References $data.

getColumns()

ilStudyProgrammeUserTable::getColumns	(	int	$prg_id,
		bool	$add_active_column = false
	)

Definition at line 114 of file class.ilStudyProgrammeUserTable.php.

                                                                            : array
    {
        $columns = array_merge(
            $this->getPrgColumns(),
            $this->getUserDataColumns($prg_id)
        );
 
        if ($add_active_column) {
            $columns["active"] = ["active", $this->lng->txt("active"), true, true, true];
        }
        return $columns;
    }

References getPrgColumns(), getUserDataColumns(), and ILIAS\Repository\lng().

Here is the call graph for this function:

getPrgColumns()

ilStudyProgrammeUserTable::getPrgColumns ( )

protected

Definition at line 104 of file class.ilStudyProgrammeUserTable.php.

                                      : array
    {
        $cols = [];
        foreach (self::PRG_COLS as $k) {
            $k[1] = $this->lng->txt($k[1]);
            $cols[$k[0]] = $k;
        }
        return $cols;
    }

References $cols, and ILIAS\Repository\lng().

Referenced by getColumns().

Here is the call graph for this function:

Here is the caller graph for this function:

getUserDataColumns()

ilStudyProgrammeUserTable::getUserDataColumns ( int  $prg_id )

protected

Definition at line 94 of file class.ilStudyProgrammeUserTable.php.

                                                      : array
    {
        $cols = [];
        $user_data_cols = $this->export_fields_info->getSelectableFieldsInfo($prg_id);
        foreach ($user_data_cols as $k => $column_definition) {
            $cols[$k] = [$k, $column_definition['txt'], true, true, true];
        }
        return $cols;
    }

References $cols.

Referenced by getColumns().

Here is the caller graph for this function:

getUserDateFormat()

ilStudyProgrammeUserTable::getUserDateFormat ( )

protected

Definition at line 242 of file class.ilStudyProgrammeUserTable.php.

                                          : string
    {
        return ilCalendarUtil::getUserDateFormat(0, true);
    }

References ilCalendarUtil\getUserDateFormat().

Here is the call graph for this function:

includeLearningProgress()

ilStudyProgrammeUserTable::includeLearningProgress ( int  $usr_id )

protected

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

                                                           : bool
    {
        return
            in_array($usr_id, $this->user_ids_viewer_may_read_learning_progress_of)
            || $this->skip_perm_check_on_user;
    }

lookupTitle()

static ilStudyProgrammeUserTable::lookupTitle ( int  $obj_id )

static

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

                                                   : string
    {
        $type = ilObject::_lookupType($obj_id);
        switch ($type) {
            case 'usr':
            case 'prg':
                return ilObject::_lookupTitle($obj_id);
            case 'prg':
                $title = ilObject::_lookupTitle($obj_id);
                if(ilObject::_isInTrash(ilObjStudyProgramme::getRefIdFor($obj_id))) {
                    return sprintf('(%s)', $title);
                }
                return $title;
            case 'crs':
                $title = ilObject::_lookupTitle($obj_id);
                $refs = ilObject::_getAllReferences($obj_id);
                $target_ref_id = array_shift($refs) ?? null;
                if($target_ref_id === null || ilObject::_isInTrash($target_ref_id)) {
                    return sprintf('(%s)', $title);
                }
                return $title;
        }
 
        if ($del = ilObjectDataDeletionLog::get($obj_id)) {
            return sprintf('(%s)', $del['title']);
        }
        return 'object id ' . $obj_id;
    }

References $type, ilObject\_getAllReferences(), ilObject\_isInTrash(), ilObject\_lookupTitle(), ilObject\_lookupType(), ilObjectDataDeletionLog\get(), and ilObjStudyProgramme\getRefIdFor().

Referenced by ilStudyProgrammeIndividualPlanTableGUI\fetchData(), and ilStudyProgrammeMembersTableGUI\fillRow().

Here is the call graph for this function:

Here is the caller graph for this function:

postOrder()

ilStudyProgrammeUserTable::postOrder ( array  $list, \ILIAS\Data\Order  $order  )

protected

Definition at line 360 of file class.ilStudyProgrammeUserTable.php.

                                                                       : array
    {
        [$aspect, $direction] = $order->join('', function ($i, $k, $v) {
            return [$k, $v];
        });
 
        if (array_key_exists($aspect, self::ORDER_MAPPING)) {
            $aspect = self::ORDER_MAPPING[$aspect];
        }
 
        usort($list, static function (ilStudyProgrammeUserTableRow $a, ilStudyProgrammeUserTableRow $b) use ($aspect): int {
            $a = $a->toArray();
            $b = $b->toArray();
 
            if (is_numeric($a[$aspect])) {
                return $a[$aspect] <=> $b[$aspect];
            }
            return strcmp($a[$aspect], $b[$aspect]);
        });
 
        if ($direction === $order::DESC) {
            $list = array_reverse($list);
        }
        return $list;
    }

References Vendor\Package\$a, Vendor\Package\$b, and $i.

statusToRepresent()

ilStudyProgrammeUserTable::statusToRepresent

(

$a_status

)

Exceptions

ilException

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

                                                : string
    {
        if ($a_status == ilPRGProgress::STATUS_IN_PROGRESS) {
            return $this->lng->txt("prg_status_in_progress");
        }
        if ($a_status == ilPRGProgress::STATUS_COMPLETED) {
            return $this->lng->txt("prg_status_completed");
        }
        if ($a_status == ilPRGProgress::STATUS_ACCREDITED) {
            return $this->lng->txt("prg_status_accredited");
        }
        if ($a_status == ilPRGProgress::STATUS_NOT_RELEVANT) {
            return $this->lng->txt("prg_status_not_relevant");
        }
        if ($a_status == ilPRGProgress::STATUS_FAILED) {
            return $this->lng->txt("prg_status_failed");
        }
        throw new ilException("Unknown status: '$a_status'");
    }

References ILIAS\Repository\lng(), ilPRGProgress\STATUS_ACCREDITED, ilPRGProgress\STATUS_COMPLETED, ilPRGProgress\STATUS_FAILED, ilPRGProgress\STATUS_IN_PROGRESS, and ilPRGProgress\STATUS_NOT_RELEVANT.

Here is the call graph for this function:

toRow()

ilStudyProgrammeUserTable::toRow ( ilPRGAssignment  $ass, int  $node_id  )

protected

Definition at line 180 of file class.ilStudyProgrammeUserTable.php.

                                                                : ilStudyProgrammeUserTableRow
    {
        $pgs = $ass->getProgressForNode($node_id);
        $row = new ilStudyProgrammeUserTableRow(
            $ass->getId(),
            $ass->getUserId(),
            $node_id,
            $ass->getRootId() === $node_id
        );
 
        $show_lp = $this->includeLearningProgress($ass->getUserId());
 
        $prg_node = ilObjStudyProgramme::getInstanceByObjId($node_id);
        $points_reachable = (string) $pgs->getPossiblePointsOfRelevantChildren();
        if ($prg_node->getLPMode() === ilStudyProgrammeSettings::MODE_LP_COMPLETED) {
            $points_reachable = (string) $pgs->getAmountOfPoints();
        }
 
        $row = $row
            ->withUserActiveRaw($ass->getUserInformation()->isActive())
            ->withUserActive($this->activeToRepresent($ass->getUserInformation()->isActive()))
            ->withFirstname($ass->getUserInformation()->getFirstname())
            ->withLastname($ass->getUserInformation()->getLastname())
            ->withLogin($ass->getUserInformation()->getLogin())
            ->withOrgUs($ass->getUserInformation()->getOrguRepresentation())
            ->withUDF($ass->getUserInformation()->getAllUdf())
            ->withGender($this->lng->txt('gender_' . $ass->getUserInformation()->getUdf('gender')))
            ->withStatus($show_lp ? $this->statusToRepresent($pgs->getStatus()) : '')
            ->withStatusRaw($pgs->getStatus())
            ->withCompletionDate(
                $show_lp && $pgs->getCompletionDate() ? $pgs->getCompletionDate()->format($this->getUserDateFormat()) : ''
            )
            ->withCompletionBy(
                $show_lp && $pgs->getCompletionBy() ? $this->completionByToRepresent($pgs) : ''
            )
            ->withCompletionByObjIds(
                $show_lp && $pgs->getCompletionBy() ? $this->completionByToCollection($pgs) : null
            )
            ->withPointsReachable($points_reachable)
            ->withPointsRequired((string) $pgs->getAmountOfPoints())
            ->withPointsCurrent($show_lp ? (string) $pgs->getCurrentAmountOfPoints() : '')
            ->withCustomPlan($this->boolToRepresent($pgs->hasIndividualModifications()))
            ->withBelongsTo($this::lookupTitle($ass->getRootId()))
            ->withAssignmentDate($pgs->getAssignmentDate()->format($this->getUserDateFormat()))
            ->withAssignmentBy(
                $this->assignmentSourceToRepresent(
                    $ass->isManuallyAssigned(),
                    $ass->getLastChangeBy()
                )
            )
            ->withDeadline(
                $show_lp && $pgs->getDeadline() && !$pgs->isSuccessful() ? $pgs->getDeadline()->format($this->getUserDateFormat()) : ''
            )
            ->withExpiryDate(
                $show_lp && $pgs->getValidityOfQualification() ? $pgs->getValidityOfQualification()->format($this->getUserDateFormat()) : ''
            )
            ->withValidity($show_lp ? $this->validToRepresent($pgs) : '')
            ->withRestartDate($ass->getRestartDate() ? $ass->getRestartDate()->format($this->getUserDateFormat()) : '')
        ;
        return $row;
    }

References ilPRGAssignment\getId(), ilObjStudyProgramme\getInstanceByObjId(), ilPRGAssignment\getLastChangeBy(), ilPRGAssignment\getProgressForNode(), ilPRGAssignment\getRestartDate(), ilPRGAssignment\getRootId(), ilPRGAssignment\getUserId(), ilPRGAssignment\getUserInformation(), ilPRGAssignment\isManuallyAssigned(), ILIAS\Repository\lng(), and ilStudyProgrammeSettings\MODE_LP_COMPLETED.

Here is the call graph for this function:

validToRepresent()

ilStudyProgrammeUserTable::validToRepresent

(

ilPRGProgress

$pgs

)

Definition at line 275 of file class.ilStudyProgrammeUserTable.php.

                                                        : string
    {
        if (!$pgs->isSuccessful()) {
            return '-';
        }
        return $pgs->isInvalidated() ? $this->lng->txt("prg_not_valid") : $this->lng->txt("prg_still_valid");
    }

References ilPRGProgress\isInvalidated(), ilPRGProgress\isSuccessful(), and ILIAS\Repository\lng().

Here is the call graph for this function:

Field Documentation

$assignment_repo

ilPRGAssignmentDBRepository ilStudyProgrammeUserTable::$assignment_repo

protected

Definition at line 73 of file class.ilStudyProgrammeUserTable.php.

Referenced by __construct().

$db

ilDBInterface ilStudyProgrammeUserTable::$db

protected

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

Referenced by __construct().

$export_fields_info

ilExportFieldsInfo ilStudyProgrammeUserTable::$export_fields_info

protected

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

Referenced by __construct().

$lng

ilLanguage ilStudyProgrammeUserTable::$lng

protected

Definition at line 70 of file class.ilStudyProgrammeUserTable.php.

Referenced by __construct().

$permissions

ilPRGPermissionsHelper ilStudyProgrammeUserTable::$permissions

protected

Definition at line 71 of file class.ilStudyProgrammeUserTable.php.

Referenced by __construct().

$skip_perm_check_on_user

ilStudyProgrammeUserTable::$skip_perm_check_on_user = false

protected

Definition at line 167 of file class.ilStudyProgrammeUserTable.php.

$user_ids_viewer_may_read_learning_progress_of

array ilStudyProgrammeUserTable::$user_ids_viewer_may_read_learning_progress_of

protected

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

OPTION_ALL

const ilStudyProgrammeUserTable::OPTION_ALL = -1

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

Referenced by ilPRGAssignmentFilter\getCleanedValues(), and ilPRGAssignmentFilter\getItemConfig().

OPTION_USR_ACTIVE

const ilStudyProgrammeUserTable::OPTION_USR_ACTIVE = 1

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

Referenced by ilPRGAssignmentFilter\getItemConfig(), and ilPRGAssignmentFilter\toConditions().

OPTION_USR_INACTIVE

const ilStudyProgrammeUserTable::OPTION_USR_INACTIVE = 2

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

Referenced by ilPRGAssignmentFilter\getItemConfig(), and ilPRGAssignmentFilter\toConditions().

ORDER_MAPPING

const ilStudyProgrammeUserTable::ORDER_MAPPING

private

Initial value:

= [
        'prg_status' => 'status',
        'prg_custom_plan' => 'custom_plan',
        'prg_belongs_to' => 'belongs_to',
        'prg_validity' => 'validity',
        'prg_orgus' => 'orgus',
        'prg_completion_by' => 'completion_by',
        'prg_completion_date' => 'completion_date',
        'prg_assign_date' => 'assign_date',
        'prg_assigned_by' => 'assigned_by',
        'prg_deadline' => 'deadline',
        'prg_expiry_date' => 'expiry_date',
        'pgs_id' => 'prgrs_id'
    ]

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

PRG_COLS

const ilStudyProgrammeUserTable::PRG_COLS

Initial value:

= [
        ['name', 'name', false, true, true],
        ['login', 'login', false, true, true],
        ['prg_orgus', 'prg_orgus', true, true, true],
        ['prg_status', 'prg_status', false, true, true],
        ['prg_completion_date', 'prg_completion_date', true, true, true],
        ['prg_completion_by', 'prg_completion_by', true, true, true],
        ['points', 'prg_points_reachable', false, true, false],
        ['points_required', 'prg_points_required', false, false, true],
        ['points_current', 'prg_points_current', false, false, true],
        ['prg_custom_plan', 'prg_custom_plan', true, true, true],
        ['prg_belongs_to', 'prg_belongs_to', true, true, true],
        ['prg_assign_date', 'prg_assign_date', false, true, true],
        ['prg_assigned_by', 'prg_assigned_by', true, true, true],
        ['prg_deadline', 'prg_deadline', true, true, true],
        ['prg_expiry_date', 'prg_expiry_date', true, true, true],
        ['prg_validity', 'prg_validity', true, true, true]
    ]

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

VALIDITY_OPTION_INVALID

const ilStudyProgrammeUserTable::VALIDITY_OPTION_INVALID = 3

Definition at line 30 of file class.ilStudyProgrammeUserTable.php.

Referenced by ilPRGAssignmentFilter\getItemConfig(), and ilPRGAssignmentFilter\toConditions().

VALIDITY_OPTION_VALID

const ilStudyProgrammeUserTable::VALIDITY_OPTION_VALID = 1

Definition at line 29 of file class.ilStudyProgrammeUserTable.php.

Referenced by ilPRGAssignmentFilter\getItemConfig(), and ilPRGAssignmentFilter\toConditions().

---

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

• Modules/StudyProgramme/classes/class.ilStudyProgrammeUserTable.php