Inheritance diagram for ILIAS\Chatroom\Bans\BannedUsersTable:

Collaboration diagram for ILIAS\Chatroom\Bans\BannedUsersTable:

Public Member Functions
	__construct (private readonly \ilObjUser $actor, private readonly int $room_id, private readonly array $banned_users, private readonly ilCtrlInterface $ctrl, private readonly ilLanguage $lng, GlobalHttpState $http, private readonly \ILIAS\UI\Factory $ui_factory)

	getComponent ()

	getRows (UI\Component\Table\DataRowBuilder $row_builder, array $visible_column_ids, Data\Range $range, 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...

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...

Private Member Functions
	getColumns ()

	getActions ()

	initRecords ()

	sortedRecords (Data\Order $order)

	getRecords (Data\Range $range, Data\Order $order)

	limitRecords (array $records, Data\Range $range)

Private Attributes
readonly ServerRequestInterface	$request

readonly Data Factory	$data_factory

array	$records = null

Detailed Description

Definition at line 34 of file BannedUsersTable.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Chatroom\Bans\BannedUsersTable::__construct	(	private readonly \ilObjUser	$actor,
		private readonly int	$room_id,
		private readonly array	$banned_users,
		private readonly ilCtrlInterface	$ctrl,
		private readonly ilLanguage	$lng,
		GlobalHttpState	$http,
		private readonly \ILIAS\UI\Factory	$ui_factory
	)

Parameters

list<array<string,scalar|null>> $banned_users

Definition at line 44 of file BannedUsersTable.php.

References ILIAS\HTTP\GlobalHttpState\request().

       {
         $this->request = $http->request();
         $this->data_factory = new Data\Factory();
     }

Here is the call graph for this function:

Member Function Documentation

◆ getActions()

ILIAS\Chatroom\Bans\BannedUsersTable::getActions ( )

private

Returns: array<string, UI>

Definition at line 104 of file BannedUsersTable.php.

References ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Referenced by ILIAS\Chatroom\Bans\BannedUsersTable\getComponent().

                                  : array
     {
         $query_params_namespace = ['chat', 'ban', 'table'];
 
         $uri = $this->data_factory->uri(
             ILIAS_HTTP_PATH . '/' . $this->ctrl->getLinkTargetByClass(ilObjChatroomGUI::class, 'ban-handleTableActions')
         );
 
         $url_builder = new UI\URLBuilder($uri);
         [
             $url_builder,
             $action_parameter_token_copy,
             $row_id_token
         ] = $url_builder->acquireParameters(
             $query_params_namespace,
             'action',
             'user_ids'
         );
 
         return [
             'delete' => $this->ui_factory->table()->action()->multi(
                 $this->lng->txt('unban'),
                 $url_builder->withParameter($action_parameter_token_copy, 'delete'),
                 $row_id_token
             ),
         ];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getColumns()

ILIAS\Chatroom\Bans\BannedUsersTable::getColumns ( )

private

Returns: array<string, UI>

Definition at line 74 of file BannedUsersTable.php.

References ILIAS\Repository\lng(), and ilCalendarSettings\TIME_FORMAT_12.

Referenced by ILIAS\Chatroom\Bans\BannedUsersTable\getComponent().

                                  : array
     {
         if ((int) $this->actor->getTimeFormat() === \ilCalendarSettings::TIME_FORMAT_12) {
             $date_format = $this->data_factory->dateFormat()->withTime12($this->actor->getDateFormat());
         } else {
             $date_format = $this->data_factory->dateFormat()->withTime24($this->actor->getDateFormat());
         }
 
         return [
             'login' => $this->ui_factory
                 ->table()->column()->text($this->lng->txt('login'))
                 ->withIsSortable(true),
             'firstname' => $this->ui_factory
                 ->table()->column()->text($this->lng->txt('firstname'))
                 ->withIsSortable(true),
             'lastname' => $this->ui_factory
                 ->table()->column()->text($this->lng->txt('lastname'))
                 ->withIsSortable(true),
             'datetime' => $this->ui_factory
                 ->table()->column()->date($this->lng->txt('chtr_ban_ts_tbl_head'), $date_format)
                 ->withIsSortable(true),
             'actor' => $this->ui_factory
                 ->table()->column()->text($this->lng->txt('chtr_ban_actor_tbl_head'))
                 ->withIsSortable(true),
         ];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getComponent()

ILIAS\Chatroom\Bans\BannedUsersTable::getComponent ( )

Definition at line 57 of file BannedUsersTable.php.

References ILIAS\Data\Order\DESC, ILIAS\Chatroom\Bans\BannedUsersTable\getActions(), ILIAS\Chatroom\Bans\BannedUsersTable\getColumns(), and ILIAS\Repository\lng().

                                   : UI\Component\Table\Data
     {
         $columns = $this->getColumns();
         $actions = $this->getActions();
 
         return $this->ui_factory
             ->table()
             ->data($this->lng->txt('ban_table_title'), $columns, $this)
             ->withId(self::class . '_' . $this->room_id)
             ->withOrder(new \ILIAS\Data\Order('datetime', \ILIAS\Data\Order::DESC))
             ->withActions($actions)
             ->withRequest($this->request);
     }

Here is the call graph for this function:

◆ getRecords()

ILIAS\Chatroom\Bans\BannedUsersTable::getRecords	(	Data\Range	$range,
		Data\Order	$order
	)

private

Returns: list<array<string, mixed>>

Definition at line 202 of file BannedUsersTable.php.

References ILIAS\Chatroom\Bans\BannedUsersTable\initRecords(), ILIAS\Chatroom\Bans\BannedUsersTable\limitRecords(), and ILIAS\Chatroom\Bans\BannedUsersTable\sortedRecords().

Referenced by ILIAS\Chatroom\Bans\BannedUsersTable\getRows().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRows()

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

Definition at line 155 of file BannedUsersTable.php.

References ILIAS\Chatroom\Bans\BannedUsersTable\getRecords().

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

Here is the call graph for this function:

◆ getTotalRowCount()

ILIAS\Chatroom\Bans\BannedUsersTable::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 171 of file BannedUsersTable.php.

References ILIAS\Chatroom\Bans\BannedUsersTable\initRecords().

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

Here is the call graph for this function:

◆ initRecords()

ILIAS\Chatroom\Bans\BannedUsersTable::initRecords ( )

private

Definition at line 132 of file BannedUsersTable.php.

Referenced by ILIAS\Chatroom\Bans\BannedUsersTable\getRecords(), and ILIAS\Chatroom\Bans\BannedUsersTable\getTotalRowCount().

                                   : void
     {
         if ($this->records === null) {
             $this->records = [];
             $i = 0;
             $entries = $this->banned_users;
 
             foreach ($entries as $entry) {
                 $this->records[$i]['user_id'] = $entry['user_id'];
                 $this->records[$i]['login'] = $entry['login'];
                 $this->records[$i]['firstname'] = $entry['firstname'];
                 $this->records[$i]['lastname'] = $entry['lastname'];
                 $this->records[$i]['timestamp'] = $entry['timestamp'];
                 $this->records[$i]['datetime'] = (new \DateTimeImmutable('@' . $entry['timestamp']))->setTimezone(
                     new \DateTimeZone($this->actor->getTimeZone())
                 );
 
                 $this->records[$i]['actor'] = $entry['actor'];
                 ++$i;
             }
         }
     }

Here is the caller graph for this function:

◆ limitRecords()

ILIAS\Chatroom\Bans\BannedUsersTable::limitRecords	(	array	$records,
		Data\Range	$range
	)

private

Parameters

list<array<string,mixed>> $records

Returns: list<array<string, mixed>>

Definition at line 215 of file BannedUsersTable.php.

Referenced by ILIAS\Chatroom\Bans\BannedUsersTable\getRecords().

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

Here is the caller graph for this function:

◆ sortedRecords()

ILIAS\Chatroom\Bans\BannedUsersTable::sortedRecords ( Data\Order $order )

private

Returns: list<array<string, mixed>>

Definition at line 183 of file BannedUsersTable.php.

References ilArrayUtil\stableSortArray().

Referenced by ILIAS\Chatroom\Bans\BannedUsersTable\getRecords().

                                                      : array
     {
         [$order_field, $order_direction] = $order->join([], fn($ret, $key, $value) => [$key, $value]);
 
         if ($order_field === 'datetime') {
             $order_field = 'timestamp';
         }
 
         return ilArrayUtil::stableSortArray(
             $this->records,
             $order_field,
             strtolower($order_direction),
             $order_field === 'timestamp'
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $data_factory

readonly Data Factory ILIAS\Chatroom\Bans\BannedUsersTable::$data_factory

private

Definition at line 37 of file BannedUsersTable.php.

◆ $records

array ILIAS\Chatroom\Bans\BannedUsersTable::$records = null

private

Definition at line 39 of file BannedUsersTable.php.

◆ $request

readonly ServerRequestInterface ILIAS\Chatroom\Bans\BannedUsersTable::$request

private

Definition at line 36 of file BannedUsersTable.php.

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

components/ILIAS/Chatroom/classes/Bans/BannedUsersTable.php

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getActions()

◆ getColumns()

◆ getComponent()

◆ getRecords()

◆ getRows()

◆ getTotalRowCount()

◆ initRecords()

◆ limitRecords()

◆ sortedRecords()

Field Documentation

◆ $data_factory

◆ $records

◆ $request