MailMemberSearchTable.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
namespace ILIAS\Contact\MemberSearch;
 
use ILIAS\Data;
use ILIAS\UI;
use Psr\Http\Message\ServerRequestInterface;
use ilArrayUtil;
use ilLanguage;
use ilCtrl;
use ilMailMemberSearchDataProvider;
use ILIAS\UI\Component\Table\Column\Column;
 
class MailMemberSearchTable implements UI\Component\Table\DataRetrieval
{
    private readonly ServerRequestInterface $request;
    private readonly Data\Factory $data_factory;
    private ?array $records = null;
 
    public function __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
    ) {
        $this->request = $http->request();
        $this->data_factory = new Data\Factory();
    }
 
    public function getComponent(): UI\Component\Table\Data
    {
        $columns = $this->getColumns();
        $actions = $this->getActions();
 
        return $this->ui_factory
            ->table()
            ->data(
                $this,
                $this->lng->txt('members'),
                $columns,
            )
            ->withId(self::class . '_' . $this->ref_id)
            ->withOrder(new \ILIAS\Data\Order('login', \ILIAS\Data\Order::ASC))
            ->withActions($actions)
            ->withRequest($this->request);
    }
 
    private function getColumns(): 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),
        ];
    }
 
    private function getActions(): 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
            ),
        ];
    }
 
    private function initRecords(): 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;
                }
            }
        }
    }
 
    public function getRows(
        UI\Component\Table\DataRowBuilder $row_builder,
        array $visible_column_ids,
        Data\Range $range,
        Data\Order $order,
        ?array $filter_data,
        ?array $additional_parameters
    ): \Generator {
        $records = $this->getRecords($range, $order);
 
        foreach ($records as $record) {
            $row_id = (string) $record['user_id'];
            yield $row_builder->buildDataRow($row_id, $record);
        }
    }
 
    public function getTotalRowCount(
        ?array $filter_data,
        ?array $additional_parameters
    ): ?int {
        $this->initRecords();
 
        return \count($this->records);
    }
 
    private function sortedRecords(Data\Order $order): 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);
    }
 
    private function getRecords(Data\Range $range, Data\Order $order): array
    {
        $this->initRecords();
 
        $records = $this->sortedRecords($order);
 
        return $this->limitRecords($records, $range);
    }
 
    private function limitRecords(array $records, Data\Range $range): array
    {
        return \array_slice($records, $range->getStart(), $range->getLength());
    }
}