ilCourseParticipantsGroupsTableDataRetrieval Class Reference

Inheritance diagram for ilCourseParticipantsGroupsTableDataRetrieval:

Collaboration diagram for ilCourseParticipantsGroupsTableDataRetrieval:

Public Member Functions
	__construct (protected ilCourseParticipantsGroupsGUI $parent_obj, protected ilTree $tree, protected ilAccess $access, protected ilUIServices $ui_services, protected int $ref_id)
	buildConfirmUnsubscribeActionId (int $group_ref_id)
	buildUnsubscribeActionId (int $group_ref_id)
	getAllConfirmUnsubscribeActionIds ()
	getAllUserIds ()
	getSelectableGroups ()
	getRows (\ILIAS\UI\Component\Table\DataRowBuilder $row_builder, array $visible_column_ids, \ILIAS\Data\Range $range, \ILIAS\Data\Order $order, ?array $filter_data, ?array $additional_parameters)
	getTotalRowCount (?array $filter_data, ?array $additional_parameters)
	Mainly for the purpose of pagination-support, it is important to know about the total number of records available. More...
	init ()
Public Member Functions inherited from ILIAS\UI\Component\Table\DataRetrieval
	getRows (DataRowBuilder $row_builder, array $visible_column_ids, Range $range, Order $order, ?array $filter_data, ?array $additional_parameters)
	This is called by the table to retrieve rows; map data-records to rows using the $row_builder e.g. More...
	getTotalRowCount (?array $filter_data, ?array $additional_parameters)
	Mainly for the purpose of pagination-support, it is important to know about the total number of records available. More...

Protected Attributes
const	TABLE_ACTION_CONFIRM_UNSUBSCRIBE_SUFFIX = '_confirm_unsubscribe'
const	TABLE_ACTION_UNSUBSCRIBE_SUFFIX = '_unsubscribe'
array	$data
int	$obj_id

Detailed Description

Definition at line 24 of file class.ilCourseParticipantsGroupsTableDataRetrieval.php.

Constructor & Destructor Documentation

__construct()

ilCourseParticipantsGroupsTableDataRetrieval::__construct	(	protected ilCourseParticipantsGroupsGUI	$parent_obj,
		protected ilTree	$tree,
		protected ilAccess	$access,
		protected ilUIServices	$ui_services,
		protected int	$ref_id
	)

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

      {
        $this->data = [];
        $this->obj_id = ilObject::_lookupObjId($ref_id);
    }

References $ref_id, and ilObject\_lookupObjId().

Here is the call graph for this function:

Member Function Documentation

buildConfirmUnsubscribeActionId()

ilCourseParticipantsGroupsTableDataRetrieval::buildConfirmUnsubscribeActionId

(

int

$group_ref_id

)

Definition at line 82 of file class.ilCourseParticipantsGroupsTableDataRetrieval.php.

     : string {
        return $group_ref_id . self::TABLE_ACTION_CONFIRM_UNSUBSCRIBE_SUFFIX;
    }

buildUnsubscribeActionId()

ilCourseParticipantsGroupsTableDataRetrieval::buildUnsubscribeActionId

(

int

$group_ref_id

)

Definition at line 88 of file class.ilCourseParticipantsGroupsTableDataRetrieval.php.

     : string {
        return $group_ref_id . self::TABLE_ACTION_UNSUBSCRIBE_SUFFIX;
    }

getAllConfirmUnsubscribeActionIds()

ilCourseParticipantsGroupsTableDataRetrieval::getAllConfirmUnsubscribeActionIds

(

)

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

                                                       : array
    {
        $ids = [];
        foreach ($this->getSelectableGroups() as $ref_id => $group) {
            $ids[] = $this->buildConfirmUnsubscribeActionId($ref_id);
        }
        return $ids;
    }

References $ref_id.

getAllUserIds()

ilCourseParticipantsGroupsTableDataRetrieval::getAllUserIds

(

)

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

                                   : array
    {
        # TODO: Filter
        $ids = [];
        foreach ($this->data['rows'] as $row) {
            $ids[] = (int) $row['usr_id'];
        }
        return $ids;
    }

References ILIAS\Repository\int().

Here is the call graph for this function:

getRows()

ilCourseParticipantsGroupsTableDataRetrieval::getRows	(	\ILIAS\UI\Component\Table\DataRowBuilder	$row_builder,
		array	$visible_column_ids,
		\ILIAS\Data\Range	$range,
		\ILIAS\Data\Order	$order,
		?array	$filter_data,
		?array	$additional_parameters
	)

Definition at line 124 of file class.ilCourseParticipantsGroupsTableDataRetrieval.php.

     : Generator {
        [$column_name, $direction] = $order->join([], fn($ret, $key, $value) => [$key, $value]);
        $rows = $this->applyFilter($filter_data);
        $groups_rights = $this->data['groups_rights'];
        $comparator = function (array $f1, array $f2) { return 0; };
        switch ($column_name) {
            case ilCourseParticipantsGroupsTableGUI::TABLE_COL_NAME:
                $comparator = function (array $f1, array $f2) {
                    return strcmp($f1['name'], $f2['name']);
                };
                break;
            case ilCourseParticipantsGroupsTableGUI::TABLE_COL_LOGIN:
                $comparator = function (array $f1, array $f2) {
                    return strcmp($f1['login'], $f2['login']);
                };
                break;
            case ilCourseParticipantsGroupsTableGUI::TABLE_COL_GROUP_NUMBER:
                $comparator = function (array $f1, array $f2) {
                    if ($f1['groups_number'] === $f2['groups_number']) {
                        return 0;
                    }
                    return $f1['groups_number'] > $f2['groups_number'] ? 1 : -1;
                };
                break;
            case ilCourseParticipantsGroupsTableGUI::TABLE_COL_GROUPS:
                $comparator = function (array $f1, array $f2) {
                    return strcmp($f1['group_info']['title'], $f2['group_info']['title']);
                };
                break;
        }
        uasort($rows, $comparator);
        if ($direction === "DESC") {
            $rows = array_reverse($rows, true);
        }
        $rows = array_slice($rows, $range->getStart(), $range->getLength(), true);
        foreach ($rows as $row) {
            $groups_str = '';
            $enabled_actions = [];
            foreach ($row['groups'] as $group_info) {
                $grp_id = $group_info['group_id'];
                $role = $group_info['role'];
                $title = $group_info['title'];
                if (
                    !($role == 'admin' && $groups_rights[$grp_id]['edit_permission']) &&
                    !($role == 'member' && $groups_rights[$grp_id]['manage_members'])
                ) {
                    continue;
                }
                $groups_str .= ($groups_str === '' ? $title : '<br>' . $title);
                $enabled_actions[] = $this->buildConfirmUnsubscribeActionId($grp_id);
            }
            $data_row = $row_builder->buildDataRow(
                $row['usr_id'] . '',
                [
                    ilCourseParticipantsGroupsTableGUI::TABLE_COL_NAME => $row['name'],
                    ilCourseParticipantsGroupsTableGUI::TABLE_COL_LOGIN => $row['login'],
                    ilCourseParticipantsGroupsTableGUI::TABLE_COL_GROUP_NUMBER => (int) $row['groups_number'],
                    ilCourseParticipantsGroupsTableGUI::TABLE_COL_GROUPS => $groups_str,
                ]
            );
            $disabled_actions = array_diff($this->getAllConfirmUnsubscribeActionIds(), $enabled_actions);
            foreach ($disabled_actions as $disabled_action) {
                $data_row = $data_row->withDisabledAction($disabled_action, true);
            }
            yield $data_row;
        }
    }

getSelectableGroups()

ilCourseParticipantsGroupsTableDataRetrieval::getSelectableGroups

(

)

Definition at line 113 of file class.ilCourseParticipantsGroupsTableDataRetrieval.php.

                                         : array
    {
        $selectable_group_ids = [];
        foreach ($this->data['groups'] as $ref_id => $something) {
            if ($this->data['groups_rights'][$ref_id]['manage_members']) {
                $selectable_group_ids[$ref_id] = $this->data['groups'][$ref_id];
            }
        }
        return $selectable_group_ids;
    }

References $ref_id.

getTotalRowCount()

ilCourseParticipantsGroupsTableDataRetrieval::getTotalRowCount	(	?array	$filter_data,
		?array	$additional_parameters
	)

Mainly for the purpose of pagination-support, it is important to know about the total number of records available.

Given the nature of a DataTable, which is, opposite to a PresentationTable, rather administrative than explorative, this information will increase user experience quite a bit. However, you may return null, if the call is to costly, but expect the View Control to look a little different in this case.

Make sure that potential filters or user restrictions are being applied to the count.

Implements ILIAS\UI\Component\Table\DataRetrieval.

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

     : ?int {
        return count($this->applyFilter($filter_data));
    }

init()

ilCourseParticipantsGroupsTableDataRetrieval::init

(

)

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

                          : void
    {
        $parent_node = $this->tree->getNodeData($this->ref_id);
        $groups = $this->tree->getSubTree($parent_node, true, ['grp']);
        if (
            !is_array($groups) ||
            !count($groups)
        ) {
            return;
        }
        $results_participants = [];
        $results_groups = [];
        $results_groups_rights = [];
        foreach ($groups as $idx => $group_data) {
            # check for group in group
            if (
                $group_data['parent'] != $this->ref_id &&
                $this->tree->checkForParentType(
                    $group_data['ref_id'],
                    'grp',
                    true
                )
            ) {
                unset($groups[$idx]);
                continue;
            }
            $results_groups[$group_data['ref_id']] = $group_data['title'];
            $results_groups_rights[$group_data['ref_id']]['manage_members'] = $this->access->checkRbacOrPositionPermissionAccess(
                'manage_members',
                'manage_members',
                $group_data['ref_id']
            );
            $results_groups_rights[$group_data['ref_id']]['edit_permission'] = $this->access->checkAccess(
                'edit_permission',
                '',
                $group_data['ref_id']
            );
            $gobj = ilGroupParticipants::_getInstanceByObjId($group_data['obj_id']);
            $members = $this->access->filterUserIdsByRbacOrPositionOfCurrentUser(
                'manage_members',
                'manage_members',
                $group_data['ref_id'],
                $gobj->getMembers()
            );
            $admins = $this->access->filterUserIdsByRbacOrPositionOfCurrentUser(
                'manage_members',
                'manage_members',
                $group_data['ref_id'],
                $gobj->getAdmins()
            );
            $results_participants[$group_data['ref_id']]['members'] = $members;
            $results_participants[$group_data['ref_id']]['admins'] = $admins;
        }
        $part = ilCourseParticipants::_getInstanceByObjId($this->obj_id);
        $members = $this->access->filterUserIdsByRbacOrPositionOfCurrentUser(
            'manage_members',
            'manage_members',
            $this->ref_id,
            $part->getMembers()
        );
        if ($members === []) {
            return;
        }
        $usr_data = [];
        foreach ($members as $usr_id) {
            $name = ilObjUser::_lookupName($usr_id);
            $membership_count = 0;
            $new_entry = [
                'usr_id' => $usr_id,
                'name' => $name['lastname'] . ', ' . $name['firstname'],
                'groups' => [],
                'login' => $name['login']
            ];
            foreach (array_keys($results_participants) as $group_id) {
                $group_info = [
                    'group_id' => $group_id,
                    'title' => $results_groups[$group_id],
                    'role' => ''
                ];
                if (in_array($usr_id, $results_participants[$group_id]['members'])) {
                    $group_info['role'] = 'member';
                }
                if (in_array($usr_id, $results_participants[$group_id]['admins'])) {
                    $group_info['role'] = 'admin';
                }
                if ($group_info['role'] === '') {
                    continue;
                }
                $new_entry['groups'][] = $group_info;
                $membership_count++;
            }
            $new_entry['groups_number'] = $membership_count;
            $usr_data[] = $new_entry;
        }
        $this->data['rows'] = $usr_data;
        $this->data['groups'] = $results_groups;
        $this->data['groups_rights'] = $results_groups_rights;
    }

References ilCourseParticipants\_getInstanceByObjId(), ilGroupParticipants\_getInstanceByObjId(), ilObjUser\_lookupName(), and ILIAS\Repository\access().

Here is the call graph for this function:

Field Documentation

$data

array ilCourseParticipantsGroupsTableDataRetrieval::$data

protected

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

$obj_id

int ilCourseParticipantsGroupsTableDataRetrieval::$obj_id

protected

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

TABLE_ACTION_CONFIRM_UNSUBSCRIBE_SUFFIX

const ilCourseParticipantsGroupsTableDataRetrieval::TABLE_ACTION_CONFIRM_UNSUBSCRIBE_SUFFIX = '_confirm_unsubscribe'

protected

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

TABLE_ACTION_UNSUBSCRIBE_SUFFIX

const ilCourseParticipantsGroupsTableDataRetrieval::TABLE_ACTION_UNSUBSCRIBE_SUFFIX = '_unsubscribe'

protected

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

---

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

• components/ILIAS/Course/classes/class.ilCourseParticipantsGroupsTableDataRetrieval.php