Inheritance diagram for ILIAS\Contact\MemberSearch\MailMemberSearchTable:

Collaboration diagram for ILIAS\Contact\MemberSearch\MailMemberSearchTable:

Public Member Functions
	__construct (private readonly int $ref_id, private readonly ilMailMemberSearchDataProvider $provider, private readonly ilCtrl $ctrl, private readonly ilLanguage $lng, private readonly \ILIAS\UI\Factory $ui_factory, \ILIAS\HTTP\GlobalHttpState $http)

	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 32 of file MailMemberSearchTable.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Contact\MemberSearch\MailMemberSearchTable::__construct	(	private readonly int	$ref_id,
		private readonly ilMailMemberSearchDataProvider	$provider,
		private readonly ilCtrl	$ctrl,
		private readonly ilLanguage	$lng,
		private readonly \ILIAS\UI\Factory	$ui_factory,
		\ILIAS\HTTP\GlobalHttpState	$http
	)

Definition at line 39 of file MailMemberSearchTable.php.

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

Member Function Documentation

◆ getActions()

ILIAS\Contact\MemberSearch\MailMemberSearchTable::getActions ( )

private

Returns: array<string, >

Definition at line 96 of file MailMemberSearchTable.php.

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

Referenced by ILIAS\Contact\MemberSearch\MailMemberSearchTable\getComponent().

                                  : array
     {
         $query_params_namespace = ['contact', 'search', 'members'];
 
         $uri = $this->data_factory->uri(
             ILIAS_HTTP_PATH . '/' . $this->ctrl->getLinkTargetByClass(
                 \ilMailMemberSearchGUI::class,
                 'handleSearchMembersActions'
             )
         );
 
         $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 [
             'sendMailToSelectedUsers' => $this->ui_factory->table()->action()->multi(
                 $this->lng->txt('mail_members'),
                 $url_builder->withParameter($action_parameter_token_copy, 'sendMailToSelectedUsers'),
                 $row_id_token
             ),
         ];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getColumns()

ILIAS\Contact\MemberSearch\MailMemberSearchTable::getColumns ( )

private

Returns: array<string, Column>

Definition at line 72 of file MailMemberSearchTable.php.

References ILIAS\Repository\lng().

Referenced by ILIAS\Contact\MemberSearch\MailMemberSearchTable\getComponent().

                                  : array
     {
         return [
             'login' => $this->ui_factory
                 ->table()
                 ->column()
                 ->text($this->lng->txt('login'))
                 ->withIsSortable(true),
             'name' => $this->ui_factory
                 ->table()
                 ->column()
                 ->text($this->lng->txt('name'))
                 ->withIsSortable(true),
             'role' => $this->ui_factory
                 ->table()
                 ->column()
                 ->text($this->lng->txt('role'))
                 ->withIsSortable(true),
         ];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getComponent()

ILIAS\Contact\MemberSearch\MailMemberSearchTable::getComponent ( )

Definition at line 51 of file MailMemberSearchTable.php.

References ILIAS\Contact\MemberSearch\MailMemberSearchTable\getActions(), ILIAS\Contact\MemberSearch\MailMemberSearchTable\getColumns(), and ILIAS\Repository\lng().

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

Here is the call graph for this function:

◆ getRecords()

ILIAS\Contact\MemberSearch\MailMemberSearchTable::getRecords	(	Data\Range	$range,
		Data\Order	$order
	)

private

Returns: list<array<string, mixed>>

Definition at line 184 of file MailMemberSearchTable.php.

References ILIAS\Contact\MemberSearch\MailMemberSearchTable\initRecords(), ILIAS\Contact\MemberSearch\MailMemberSearchTable\limitRecords(), and ILIAS\Contact\MemberSearch\MailMemberSearchTable\sortedRecords().

Referenced by ILIAS\Contact\MemberSearch\MailMemberSearchTable\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\Contact\MemberSearch\MailMemberSearchTable::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 145 of file MailMemberSearchTable.php.

References ILIAS\Contact\MemberSearch\MailMemberSearchTable\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\Contact\MemberSearch\MailMemberSearchTable::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 161 of file MailMemberSearchTable.php.

References ILIAS\Contact\MemberSearch\MailMemberSearchTable\initRecords().

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

Here is the call graph for this function:

◆ initRecords()

ILIAS\Contact\MemberSearch\MailMemberSearchTable::initRecords ( )

private

Definition at line 127 of file MailMemberSearchTable.php.

References ILIAS\Repository\int().

Referenced by ILIAS\Contact\MemberSearch\MailMemberSearchTable\getRecords(), and ILIAS\Contact\MemberSearch\MailMemberSearchTable\getTotalRowCount().

                                   : void
     {
         if ($this->records === null) {
             $this->records = [];
             $i = 0;
             $entries = $this->provider->getData();
             if ($entries !== []) {
                 foreach ($entries as $entry) {
                     $this->records[$i]['user_id'] = (int) $entry['user_id'];
                     $this->records[$i]['login'] = $entry['login'];
                     $this->records[$i]['name'] = $entry['name'];
                     $this->records[$i]['role'] = $entry['role'];
                     ++$i;
                 }
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ limitRecords()

ILIAS\Contact\MemberSearch\MailMemberSearchTable::limitRecords	(	array	$records,
		Data\Range	$range
	)

private

Parameters

list<array<string,mixed>> $records

Returns: list<array<string, mixed>>

Definition at line 197 of file MailMemberSearchTable.php.

Referenced by ILIAS\Contact\MemberSearch\MailMemberSearchTable\getRecords().

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

Here is the caller graph for this function:

◆ sortedRecords()

ILIAS\Contact\MemberSearch\MailMemberSearchTable::sortedRecords ( Data\Order $order )

private

Returns: list<array<string, mixed>>array

Definition at line 173 of file MailMemberSearchTable.php.

References ILIAS\Contact\MemberSearch\MailMemberSearchTable\$records, and ilArrayUtil\stableSortArray().

Referenced by ILIAS\Contact\MemberSearch\MailMemberSearchTable\getRecords().

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

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $data_factory

readonly Data Factory ILIAS\Contact\MemberSearch\MailMemberSearchTable::$data_factory

private

Definition at line 35 of file MailMemberSearchTable.php.

◆ $records

array ILIAS\Contact\MemberSearch\MailMemberSearchTable::$records = null

private

Definition at line 37 of file MailMemberSearchTable.php.

Referenced by ILIAS\Contact\MemberSearch\MailMemberSearchTable\sortedRecords().

◆ $request

readonly ServerRequestInterface ILIAS\Contact\MemberSearch\MailMemberSearchTable::$request

private

Definition at line 34 of file MailMemberSearchTable.php.

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

components/ILIAS/Contact/classes/MemberSearch/MailMemberSearchTable.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