ILIAS\Forum\Notification\ForumNotificationTable Class Reference

Inheritance diagram for ILIAS\Forum\Notification\ForumNotificationTable:

Collaboration diagram for ILIAS\Forum\Notification\ForumNotificationTable:

Public Member Functions
	__construct (private readonly ServerRequestInterface $http_request, private readonly ilLanguage $lng, private readonly UIFactory $ui_factory, private readonly DataFactory $data_factory, private readonly int $ref_id, private readonly ilParticipants $participants, private readonly ilForumNotification $forumNotificationObj, private readonly ilUIService $ui_service, private readonly string $action)
	getRows (DataRowBuilder $row_builder, array $visible_column_ids, Range $range, Order $order, mixed $additional_viewcontrol_data, mixed $filter_data, mixed $additional_parameters)
	initRecords (?array $filter_data)
	getComponents ()
	getTableComponent ()
	getFilterComponent ()
	getFilterFields (Factory $field_factory)
	getTotalRowCount (mixed $additional_viewcontrol_data, mixed $filter_data, mixed $additional_parameters)
	getFilteredUserIds (?array $filter_data)
	getActions (URLBuilder $url_builder, URLBuilderToken $action_parameter_token, URLBuilderToken $row_id_token)
	getRows (DataRowBuilder $row_builder, array $visible_column_ids, Range $range, Order $order, mixed $additional_viewcontrol_data, mixed $filter_data, mixed $additional_parameters)
	This is called by the table to retrieve rows; map data-records to rows using the $row_builder e.g. More...
	getTotalRowCount (mixed $additional_viewcontrol_data, mixed $filter_data, mixed $additional_parameters)
	Mainly for the purpose of pagination-support, it is important to know about the total number of records available. More...

Private Member Functions
	getRecords (Range $range, Order $order, ?array $filter_data)
	getUserNotificationTableData (array $user_ids)
	limitRecords (array $records, Range $range)
	orderRecords (array $records, Order $order)
	getColumns ()

Private Attributes
array	$records = null
FilterComponent	$filter_component
DataTable	$table_component

Detailed Description

Definition at line 49 of file ForumNotificationTable.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Forum\Notification\ForumNotificationTable::__construct	(	private readonly ServerRequestInterface	$http_request,
		private readonly ilLanguage	$lng,
		private readonly UIFactory	$ui_factory,
		private readonly DataFactory	$data_factory,
		private readonly int	$ref_id,
		private readonly ilParticipants	$participants,
		private readonly ilForumNotification	$forumNotificationObj,
		private readonly ilUIService	$ui_service,
		private readonly string	$action
	)

Definition at line 63 of file ForumNotificationTable.php.

      {
    }

Member Function Documentation

getActions()

ILIAS\Forum\Notification\ForumNotificationTable::getActions	(	URLBuilder	$url_builder,
		URLBuilderToken	$action_parameter_token,
		URLBuilderToken	$row_id_token
	)

Returns

array<string, Action>

Definition at line 333 of file ForumNotificationTable.php.

     : array {
        return [
            'enableHideUserToggleNoti' => $this->ui_factory->table()->action()->multi(
                $this->lng->txt('enable_hide_user_toggle'),
                $url_builder->withParameter($action_parameter_token, 'enableHideUserToggleNoti'),
                $row_id_token
            ),
            'disableHideUserToggleNoti' => $this->ui_factory->table()->action()->multi(
                $this->lng->txt('disable_hide_user_toggle'),
                $url_builder->withParameter($action_parameter_token, 'disableHideUserToggleNoti'),
                $row_id_token
            ),
            'notificationSettings' => $this->ui_factory->table()->action()->single(
                $this->lng->txt('notification_settings'),
                $url_builder->withParameter($action_parameter_token, 'notificationSettings'),
                $row_id_token
            )->withAsync(true),
        ];
    }

getColumns()

ILIAS\Forum\Notification\ForumNotificationTable::getColumns ( )

private

Returns

array<string, Column>

Definition at line 419 of file ForumNotificationTable.php.

                                 : array
    {
        return [
            'login' => $this->ui_factory->table()->column()->text($this->lng->txt('login')),
            'firstname' => $this->ui_factory->table()->column()->text($this->lng->txt('firstname')),
            'lastname' => $this->ui_factory->table()->column()->text($this->lng->txt('lastname')),
            'user_toggle_noti' => $this->ui_factory->table()->column()->statusIcon(
                $this->lng->txt('allow_user_toggle_noti')
            )
                ->withIsSortable(false),
            'role' => $this->ui_factory->table()->column()->text($this->lng->txt('role')),
        ];
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

getComponents()

ILIAS\Forum\Notification\ForumNotificationTable::getComponents

(

)

Returns

array{ 0: FilterComponent, 1: DataTable }

Definition at line 110 of file ForumNotificationTable.php.

                                   : array
    {
        return [$this->getFilterComponent(), $this->getTableComponent()];
    }

getFilterComponent()

ILIAS\Forum\Notification\ForumNotificationTable::getFilterComponent

(

)

Definition at line 152 of file ForumNotificationTable.php.

                                        : FilterComponent
    {
        if (!isset($this->filter_component)) {
            $filter_inputs = [];
            $is_input_initially_rendered = [];
            $field_factory = $this->ui_factory->input()->field();
 
            foreach ($this->getFilterFields($field_factory) as $filter_id => $filter) {
                [$filter_inputs[$filter_id], $is_input_initially_rendered[$filter_id]] = $filter;
            }
 
            $this->filter_component = $this->ui_service->filter()->standard(
                'forum_notification_filter',
                $this->action,
                $filter_inputs,
                $is_input_initially_rendered,
                true,
                true
            );
        }
 
        return $this->filter_component;
    }

getFilteredUserIds()

ILIAS\Forum\Notification\ForumNotificationTable::getFilteredUserIds

(

?array

$filter_data

)

Parameters

array{role

string}|null $filter_data

Returns

list<int>

Definition at line 213 of file ForumNotificationTable.php.

                                                           : array
    {
        $moderator_ids = ilForum::_getModerators($this->ref_id);
 
        $admin_ids = $this->participants->getAdmins();
        $member_ids = $this->participants->getMembers();
        $tutor_ids = $this->participants->getTutors();
 
        $filter = (string) ($filter_data['role'] ?? '');
        switch ($filter) {
            case 'member':
                $user_ids = $member_ids;
                break;
 
            case 'tutor':
                $user_ids = $tutor_ids;
                break;
 
            case 'admin':
                $user_ids = $admin_ids;
                break;
 
            case 'moderators':
                $user_ids = $moderator_ids;
                break;
 
            default:
                $user_ids = array_merge($admin_ids, $member_ids, $tutor_ids, $moderator_ids);
                break;
        }
 
        return array_unique($user_ids);
    }

References ilForum\_getModerators().

Here is the call graph for this function:

getFilterFields()

ILIAS\Forum\Notification\ForumNotificationTable::getFilterFields

(

Factory

$field_factory

)

Returns

array<string, array{0: FilterInput, 1: bool}>

Definition at line 179 of file ForumNotificationTable.php.

                                                           : array
    {
        $options = [
            'member' => $this->lng->txt('il_' . $this->participants->getType() . '_member'),
            'tutor' => $this->lng->txt('il_' . $this->participants->getType() . '_tutor'),
            'admin' => $this->lng->txt('il_' . $this->participants->getType() . '_admin'),
            'moderators' => $this->lng->txt('frm_moderators'),
        ];
 
        return [
            'role' => [
                $field_factory->select($this->lng->txt('roles'), $options),
                true
            ]
        ];
    }

References ILIAS\UI\Implementation\Component\Input\Field\$options, ILIAS\Repository\lng(), ILIAS\UI\Component\Input\Field\Factory\select(), and true.

Here is the call graph for this function:

getRecords()

ILIAS\Forum\Notification\ForumNotificationTable::getRecords ( Range  $range, Order  $order, ?array  $filter_data  )

private

Parameters

array{role

string}|null $filter_data

Returns

list<array{ 'user_id': int, 'login': string, 'firstname': string, 'lastname': string, 'user_toggle_noti': Icon, 'role': string, }>

Definition at line 258 of file ForumNotificationTable.php.

                                                                                : array
    {
        $this->initRecords($filter_data);
        $records = $this->records;
 
        if ($order) {
            $records = $this->orderRecords($records, $order);
        }
 
        if ($range) {
            $records = $this->limitRecords($records, $range);
        }
 
        return $records;
    }

References ILIAS\UI\Implementation\Component\Table\$range.

getRows()

ILIAS\Forum\Notification\ForumNotificationTable::getRows	(	DataRowBuilder	$row_builder,
		array	$visible_column_ids,
		Range	$range,
		Order	$order,
		mixed	$additional_viewcontrol_data,
		mixed	$filter_data,
		mixed	$additional_parameters
	)

Parameters

array{role

string}|null $filter_data

Implements ILIAS\UI\Component\Table\DataRetrieval.

Definition at line 79 of file ForumNotificationTable.php.

     : Generator {
        $records = $this->getRecords($range, $order, $filter_data);
        foreach ($records as $record) {
            yield $row_builder->buildDataRow((string) $record['user_id'], $record);
        }
    }

References ILIAS\UI\Component\Table\DataRowBuilder\buildDataRow().

Here is the call graph for this function:

getTableComponent()

ILIAS\Forum\Notification\ForumNotificationTable::getTableComponent

(

)

Definition at line 115 of file ForumNotificationTable.php.

                                       : DataTable
    {
        if (!isset($this->table_component)) {
            $query_params_namespace = ['frm', 'notifications', 'table'];
            $table_uri = $this->data_factory->uri(ilUtil::_getHttpPath() . '/' . $this->action);
            $url_builder = new URLBuilder($table_uri);
            [$url_builder, $action_parameter_token, $row_id_token] = $url_builder->acquireParameters(
                $query_params_namespace,
                'action',
                'usr_ids'
            );
 
            $this->table_component = $this->ui_factory->table()
                ->data(
                    $this,
                    $this->lng->txt(''),
                    $this->getColumns()
                )
                ->withFilter(
                    $this->ui_service->filter()->getData(
                        $this->getFilterComponent()
                    )
                )
                ->withActions(
                    $this->getActions(
                        $url_builder,
                        $action_parameter_token,
                        $row_id_token
                    )
                )
                ->withId('forum_notification_table')
                ->withRequest($this->http_request);
        }
 
        return $this->table_component;
    }

References ilUtil\_getHttpPath(), and ILIAS\Repository\lng().

Here is the call graph for this function:

getTotalRowCount()

ILIAS\Forum\Notification\ForumNotificationTable::getTotalRowCount	(	mixed	$additional_viewcontrol_data,
		mixed	$filter_data,
		mixed	$additional_parameters
	)

Parameters

array{role

string}|null $filter_data

Implements ILIAS\UI\Component\Table\DataRetrieval.

Definition at line 199 of file ForumNotificationTable.php.

     : ?int {
        $this->initRecords($filter_data);
 
        return \count((array) $this->records);
    }

getUserNotificationTableData()

ILIAS\Forum\Notification\ForumNotificationTable::getUserNotificationTableData ( array  $user_ids )

private

Parameters

int[]

$user_ids

Returns

list<array{ 'user_id': int, 'login': string, 'firstname': string, 'lastname': string, 'user_toggle_noti': Icon, 'role': string, }>

Definition at line 285 of file ForumNotificationTable.php.

                                                                  : array
    {
        $icons = [
            $this->ui_factory->symbol()->icon()->custom('assets/images/standard/icon_ok.svg', '', 'small'),
            $this->ui_factory->symbol()->icon()->custom('assets/images/standard/icon_not_ok.svg', '', 'small'),
        ];
 
        $counter = 0;
        $users = [];
        $moderator_ids = ilForum::_getModerators($this->ref_id);
        foreach ($user_ids as $user_id) {
            $forced_events = $this->forumNotificationObj->getForcedEventsObjectByUserId($user_id);
            $member_const = 'IL_' . strtoupper($this->participants->getType()) . '_MEMBER';
            $tutor_const = 'IL_' . strtoupper($this->participants->getType()) . '_TUTOR';
            $admin_const = 'IL_' . strtoupper($this->participants->getType()) . '_ADMIN';
            $member_id = $this->participants->getAutoGeneratedRoleId(ilParticipants::{$member_const});
            $tutor_id = $this->participants->getAutoGeneratedRoleId(ilParticipants::{$tutor_const});
            $admin_id = $this->participants->getAutoGeneratedRoleId(ilParticipants::{$admin_const});
 
            $types = implode(', ', array_map(function (int $role_id) use ($admin_id, $tutor_id, $member_id) {
                return match ($role_id) {
                    $member_id => $this->lng->txt('il_' . $this->participants->getType() . '_member'),
                    $tutor_id => $this->lng->txt('il_' . $this->participants->getType() . '_tutor'),
                    $admin_id => $this->lng->txt('il_' . $this->participants->getType() . '_admin'),
                    default => ''
                };
            }, $this->participants->getAssignedRoles($user_id)));
            if (\in_array($user_id, $moderator_ids, true)) {
                $types .= ', ' . $this->lng->txt('frm_moderators');
            }
 
            $users[$counter]['user_id'] = $user_id;
            $users[$counter]['login'] = ilObjUser::_lookupLogin($user_id);
            $name = ilObjUser::_lookupName($user_id);
            $users[$counter]['firstname'] = $name['firstname'];
            $users[$counter]['lastname'] = $name['lastname'];
            $users[$counter]['user_toggle_noti'] = $icons[(int) $forced_events->getUserToggle()];
            $users[$counter]['role'] = $types;
 
            $counter++;
        }
 
        return $users;
    }

References $counter, $user_id, ilForum\_getModerators(), ilObjUser\_lookupLogin(), ilObjUser\_lookupName(), ILIAS\Repository\int(), and ILIAS\Repository\lng().

Here is the call graph for this function:

initRecords()

ILIAS\Forum\Notification\ForumNotificationTable::initRecords

(

?array

$filter_data

)

Parameters

array{role

string}|null $filter_data

Definition at line 97 of file ForumNotificationTable.php.

                                                    : void
    {
        if ($this->records === null) {
            $this->records = $this->getUserNotificationTableData($this->getFilteredUserIds($filter_data));
        }
    }

limitRecords()

ILIAS\Forum\Notification\ForumNotificationTable::limitRecords ( array  $records, Range  $range  )

private

Parameters

list<array{

'user_id': int, 'login': string, 'firstname': string, 'lastname': string, 'user_toggle_noti': Icon, 'role': string, }> $records

Returns

list<array{ 'user_id': int, 'login': string, 'firstname': string, 'lastname': string, 'user_toggle_noti': Icon, 'role': string, }>>

Definition at line 375 of file ForumNotificationTable.php.

                                                               : array
    {
        return \array_slice($records, $range->getStart(), $range->getLength());
    }

References ILIAS\UI\Implementation\Component\Table\$range, ILIAS\Data\Range\getLength(), and ILIAS\Data\Range\getStart().

Here is the call graph for this function:

orderRecords()

ILIAS\Forum\Notification\ForumNotificationTable::orderRecords ( array  $records, Order  $order  )

private

Parameters

list<array{

'user_id': int, 'login': string, 'firstname': string, 'lastname': string, 'user_toggle_noti': Icon, 'role': string, }> $records

Returns

list<array{ 'user_id': int, 'login': string, 'firstname': string, 'lastname': string, 'user_toggle_noti': Icon, 'role': string, }>

Definition at line 398 of file ForumNotificationTable.php.

                                                               : array
    {
        [$order_field, $order_direction] = $order->join(
            [],
            fn($ret, $key, $value) => [$key, $value]
        );
        usort($records, static fn(array $left, array $right): int => ilStr::strCmp(
            $left[$order_field] ?? '',
            $right[$order_field] ?? ''
        ));
 
        if ($order_direction === Order::DESC) {
            $records = array_reverse($records);
        }
 
        return $records;
    }

References ILIAS\Data\Order\join(), and ilStr\strCmp().

Here is the call graph for this function:

Field Documentation

$filter_component

FilterComponent ILIAS\Forum\Notification\ForumNotificationTable::$filter_component

private

Definition at line 60 of file ForumNotificationTable.php.

$records

array ILIAS\Forum\Notification\ForumNotificationTable::$records = null

private

Definition at line 59 of file ForumNotificationTable.php.

$table_component

DataTable ILIAS\Forum\Notification\ForumNotificationTable::$table_component

private

Definition at line 61 of file ForumNotificationTable.php.

---

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

• components/ILIAS/Forum/classes/Notification/ForumNotificationTable.php