MailAttachmentTableGUI.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\Mail\Attachments;

use ilStr;
use ilDatePresentation;
use ilUtil;
use ilDateTime;

class MailAttachmentTableGUI implements \ILIAS\UI\Component\Table\DataRetrieval
{
    private readonly \ILIAS\UI\URLBuilder $url_builder;
    private readonly \ILIAS\UI\URLBuilderToken $action_parameter_token;
    private readonly \ILIAS\UI\URLBuilderToken $row_id_token;
    private readonly \ILIAS\Data\Factory $data_factory;

    public function __construct(
        private readonly \ilMailAttachmentGUI $parent_gui,
        private readonly \ilObjUser $actor,
        private readonly array $records,
        private readonly \ILIAS\UI\Factory $ui_factory,
        private readonly \ILIAS\UI\Renderer $ui_renderer,
        private readonly \ilLanguage $lng,
        private readonly \ilCtrlInterface $ctrl,
        private readonly \Psr\Http\Message\ServerRequestInterface $http_request,
        private readonly \ILIAS\Data\Factory $df,
        private readonly string $parent_cmd,
        private readonly AttachmentManagement $mode
    ) {
        $form_action = $this->df->uri(
            \ilUtil::_getHttpPath() . '/' .
            $this->ctrl->getLinkTarget($this->parent_gui, $this->parent_cmd)
        );

        [
            $this->url_builder,
            $this->action_parameter_token,
            $this->row_id_token
        ] = (new \ILIAS\UI\URLBuilder($form_action))->acquireParameters(
            ['mail', 'attachments'],
            'table_action',
            'filename'
        );

        $this->data_factory = new \ILIAS\Data\Factory();
    }

    public function get(): \ILIAS\UI\Component\Table\Data
    {
        return $this->ui_factory
            ->table()
            ->data(
                $this,
                $this->lng->txt('attachment'),
                $this->getColumnDefinition(),
            )
            ->withId(self::class . '_' . $this->mode->name)
            ->withOrder(new \ILIAS\Data\Order('filename', \ILIAS\Data\Order::ASC))
            ->withActions($this->getActions())
            ->withRequest($this->http_request);
    }

    private function getColumnDefinition(): 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 [
            'filename' => $this->ui_factory
                ->table()
                ->column()
                ->text($this->lng->txt('mail_file_name'))
                ->withIsSortable(true),
            'filesize' => $this->ui_factory
                ->table()
                ->column()
                ->text($this->lng->txt('mail_file_size'))
                ->withIsSortable(true),
            'filecreatedate' => $this->ui_factory
                ->table()
                ->column()
                ->date($this->lng->txt('create_date'), $date_format)
                ->withIsSortable(true),
        ];
    }

    private function getActions(): array
    {
        $actions = [];

        if ($this->mode === AttachmentManagement::CONSUME) {
            $actions['saveAttachments'] = $this->ui_factory->table()->action()->multi(
                $this->lng->txt('adopt'),
                $this->url_builder->withParameter($this->action_parameter_token, 'saveAttachments'),
                $this->row_id_token
            );
        } else {
            $actions['deleteAttachments'] = $this->ui_factory->table()->action()->multi(
                $this->lng->txt('delete'),
                $this->url_builder->withParameter($this->action_parameter_token, 'deleteAttachments'),
                $this->row_id_token
            );
        }

        return $actions;
    }

    private function getRecords(\ILIAS\Data\Range $range, \ILIAS\Data\Order $order): array
    {
        $records = $this->records;

        [$order_field, $order_direction] = $order->join([], static fn($ret, $key, $value) => [$key, $value]);

        usort($records, static function (array $left, array $right) use ($order_field): int {
            if ($order_field === 'filename') {
                return ilStr::strCmp($left[$order_field], $right[$order_field]);
            }

            return $left[$order_field] <=> $right[$order_field];
        });

        if ($order_direction === 'DESC') {
            $records = array_reverse($records);
        }

        $records = \array_slice($records, $range->getStart(), $range->getLength());

        return $records;
    }

    public function 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
    ): \Generator {
        foreach ($this->getRecords($range, $order) as $item) {
            $record = [
                'filename' => $item['filename'],
                'filesize' => ilUtil::formatSize($item['filesize'], 'long'),
                'filecreatedate' => (new \DateTimeImmutable('@' . $item['filecreatedate']))->setTimezone(
                    new \DateTimeZone($this->actor->getTimeZone())
                )
            ];

            yield $row_builder
                ->buildDataRow(urlencode($record['filename']), $record);
        }
    }

    public function getTotalRowCount(?array $filter_data, ?array $additional_parameters): ?int
    {
        return \count($this->records);
    }
}