Inheritance diagram for ILIAS\Mail\Folder\MailFolderTableUI:

Collaboration diagram for ILIAS\Mail\Folder\MailFolderTableUI:

Public Member Functions
	__construct (private readonly URLBuilder $url_builder, private readonly URLBuilderToken $action_token, private readonly URLBuilderToken $row_id_token, private readonly URLBuilderToken $folder_token, private readonly array $user_folders, private readonly MailFolderData $current_folder, private readonly MailFolderSearch $search, private readonly ilMail $mail, private readonly Factory $ui_factory, private readonly Renderer $ui_renderer, private readonly ilLanguage $lng, private readonly ServerRequestInterface $http_request, private readonly DataFactory $data_factory, private readonly Refinery $refinery, private readonly DateFormat $date_format, private readonly string $time_format, private readonly DateTimeZone $user_time_zone)

	getComponent ()

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

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

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

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

Data Fields
const string	ACTION_SHOW = 'show'

const string	ACTION_EDIT = 'edit'

const string	ACTION_REPLY = 'reply'

const string	ACTION_FORWARD = 'forward'

const string	ACTION_DOWNLOAD_ATTACHMENT = 'download'

const string	ACTION_PRINT = 'print'

const string	ACTION_PROFILE = 'profile'

const string	ACTION_MOVE_TO = 'moveTo'

const string	ACTION_DELETE = 'delete'

const string	ACTION_MARK_READ = 'markRead'

const string	ACTION_MARK_UNREAD = 'marUnread'

Private Member Functions
	getColumnDefinition ()

	getActions ()

	getTableTitle ()

	getAvatar (MailRecordData $record)

	getStatus (MailRecordData $record)

	getSender (MailRecordData $record)

	getRecipients (MailRecordData $record)

	getSubject (MailRecordData $record)

	getDate (MailRecordData $record)

	getAttachments (MailRecordData $record)

Private Attributes
array	$avatars = []

Detailed Description

Definition at line 47 of file MailFolderTableUI.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Mail\Folder\MailFolderTableUI::__construct	(	private readonly URLBuilder	$url_builder,
		private readonly URLBuilderToken	$action_token,
		private readonly URLBuilderToken	$row_id_token,
		private readonly URLBuilderToken	$folder_token,
		private readonly array	$user_folders,
		private readonly MailFolderData	$current_folder,
		private readonly MailFolderSearch	$search,
		private readonly ilMail	$mail,
		private readonly Factory	$ui_factory,
		private readonly Renderer	$ui_renderer,
		private readonly ilLanguage	$lng,
		private readonly ServerRequestInterface	$http_request,
		private readonly DataFactory	$data_factory,
		private readonly Refinery	$refinery,
		private readonly DateFormat	$date_format,
		private readonly string	$time_format,
		private readonly DateTimeZone	$user_time_zone
	)

Parameters

MailFolderData[] $user_folders

Definition at line 68 of file MailFolderTableUI.php.

86 {

87 }

Member Function Documentation

◆ getActions()

ILIAS\Mail\Folder\MailFolderTableUI::getActions ( )

private

Returns: array<string, TableAction>

Definition at line 174 of file MailFolderTableUI.php.

                                 : array
    {
        $actions = [
            self::ACTION_SHOW => $this->ui_factory->table()->action()->single(
                $this->lng->txt('view'),
                $this->url_builder->withParameter($this->action_token, self::ACTION_SHOW),
                $this->row_id_token
            ),
            self::ACTION_EDIT => $this->ui_factory->table()->action()->single(
                $this->lng->txt('edit'),
                $this->url_builder->withParameter($this->action_token, self::ACTION_EDIT),
                $this->row_id_token
            ),
            self::ACTION_REPLY => $this->ui_factory->table()->action()->single(
                $this->lng->txt('reply'),
                $this->url_builder->withParameter($this->action_token, self::ACTION_REPLY),
                $this->row_id_token
            ),
            self::ACTION_FORWARD => $this->ui_factory->table()->action()->single(
                $this->lng->txt('forward'),
                $this->url_builder->withParameter($this->action_token, self::ACTION_FORWARD),
                $this->row_id_token
            ),
            self::ACTION_DOWNLOAD_ATTACHMENT => $this->ui_factory->table()->action()->single(
                $this->lng->txt('mail_download_attachment'),
                $this->url_builder->withParameter($this->action_token, self::ACTION_DOWNLOAD_ATTACHMENT),
                $this->row_id_token
            ),
            self::ACTION_PRINT => $this->ui_factory->table()->action()->single(
                $this->lng->txt('print'),
                $this->url_builder->withParameter($this->action_token, self::ACTION_PRINT),
                $this->row_id_token
            ),
            self::ACTION_MARK_READ => $this->ui_factory->table()->action()->multi(
                $this->lng->txt('mail_mark_read'),
                $this->url_builder->withParameter($this->action_token, self::ACTION_MARK_READ),
                $this->row_id_token
            ),
            self::ACTION_MARK_UNREAD => $this->ui_factory->table()->action()->multi(
                $this->lng->txt('mail_mark_unread'),
                $this->url_builder->withParameter($this->action_token, self::ACTION_MARK_UNREAD),
                $this->row_id_token
            ),
            self::ACTION_DELETE => $this->ui_factory->table()->action()->standard(
                $this->lng->txt('delete'),
                $this->url_builder->withParameter($this->action_token, self::ACTION_DELETE),
                $this->row_id_token
            )->withAsync(), // for confirmation modal
        ];
 
        foreach ($this->user_folders as $target_folder) {
            if ($target_folder->getFolderId() !== $this->current_folder->getFolderId()) {
                $action_title = $this->lng->txt('mail_move_to') . ' ' . $target_folder->getTitle();
                if ($target_folder->isTrash()) {
                    $action_title .= ' (' . $this->lng->txt('delete') . ')';
                }
 
                $actions[self::ACTION_MOVE_TO . $target_folder->getFolderId()] = $this->ui_factory
                    ->table()
                    ->action()
                    ->multi(
                        $action_title,
                        $this->url_builder
                            ->withParameter($this->action_token, self::ACTION_MOVE_TO)
                            ->withParameter($this->folder_token, (string) $target_folder->getFolderId()),
                        $this->row_id_token
                    );
            }
        }
 
        if ($this->current_folder->isDrafts()) {
            unset($actions[self::ACTION_SHOW], $actions[self::ACTION_REPLY], $actions[self::ACTION_FORWARD]);
        } else {
            unset($actions[self::ACTION_EDIT]);
        }
 
        if ($this->current_folder->hasOutgoingMails()) {
            unset($actions[self::ACTION_MARK_READ], $actions[self::ACTION_MARK_UNREAD]);
        }
 
        if (!$this->current_folder->isTrash()) {
            unset($actions[self::ACTION_DELETE]);
        }
 
        return $actions;
    }

References ILIAS\Repository\lng().

Referenced by ILIAS\Mail\Folder\MailFolderTableUI\getComponent().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAttachments()

ILIAS\Mail\Folder\MailFolderTableUI::getAttachments ( MailRecordData $record )

private

Definition at line 436 of file MailFolderTableUI.php.

                                                           : string
    {
        return $record->hasAttachments()
            ? $this->ui_renderer->render($this->ui_factory->symbol()->glyph()->attachment())
            : '';
    }

References ILIAS\Mail\Message\MailRecordData\hasAttachments().

Here is the call graph for this function:

◆ getAvatar()

ILIAS\Mail\Folder\MailFolderTableUI::getAvatar ( MailRecordData $record )

private

Definition at line 356 of file MailFolderTableUI.php.

                                                      : string
    {
        if (!\array_key_exists($record->getSenderId(), $this->avatars)) {
            if ($record->getSenderId() === ANONYMOUS_USER_ID) {
                $avatar = $this->ui_factory->symbol()->avatar()->picture(
                    \ilUtil::getImagePath('logo/ilias_logo_centered.png'),
                    $this->getSender($record)
                );
            } else {
                $user = ilMailUserCache::getUserObjectById($record->getSenderId());
                $avatar = $user?->getAvatar();
            }
 
            $this->avatars[$record->getSenderId()] = $avatar
                ? $this->ui_renderer->render($avatar)
                : '';
        }
 
        return $this->avatars[$record->getSenderId()];
    }

References ANONYMOUS_USER_ID, ilUtil\getImagePath(), ILIAS\Mail\Message\MailRecordData\getSenderId(), and ilMailUserCache\getUserObjectById().

Here is the call graph for this function:

◆ getColumnDefinition()

ILIAS\Mail\Folder\MailFolderTableUI::getColumnDefinition ( )

private

Returns: array<string, TableColumn>

Definition at line 107 of file MailFolderTableUI.php.

                                          : array
    {
        if ((int) $this->time_format === \ilCalendarSettings::TIME_FORMAT_12) {
            $date_format = $this->data_factory->dateFormat()->withTime12($this->date_format);
        } else {
            $date_format = $this->data_factory->dateFormat()->withTime24($this->date_format);
        }
 
        $columns = [
            'status' => $this->ui_factory
                ->table()
                ->column()
                ->statusIcon($this->lng->txt('status'))
                ->withIsSortable(true),
 
            'avatar' => $this->ui_factory
                ->table()
                ->column()
                ->status($this->lng->txt('personal_picture'))
                ->withIsSortable(true),
 
            'sender' => $this->ui_factory
                ->table()
                ->column()
                ->text($this->lng->txt('sender'))
                ->withIsSortable(true),
 
            'recipients' => $this->ui_factory
                ->table()
                ->column()
                ->text($this->lng->txt('recipient'))
                ->withIsSortable(true),
 
            'subject' => $this->ui_factory
                ->table()
                ->column()
                ->link($this->lng->txt('subject'))
                ->withIsSortable(true),
 
            'attachments' => $this->ui_factory
                ->table()
                ->column()
                ->status($this->lng->txt('attachments'))
                ->withIsSortable(true),
 
            'date' => $this->ui_factory
                ->table()
                ->column()
                ->date(
                    $this->lng->txt('date'),
                    $date_format
                )
                ->withIsSortable(true),
        ];
 
        if ($this->current_folder->hasOutgoingMails()) {
            unset($columns['status'], $columns['avatar'], $columns['sender']);
        } else {
            unset($columns['recipients']);
        }
 
        return $columns;
    }

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

Referenced by ILIAS\Mail\Folder\MailFolderTableUI\getComponent().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getComponent()

ILIAS\Mail\Folder\MailFolderTableUI::getComponent ( )

Definition at line 89 of file MailFolderTableUI.php.

                                  : DataTable
    {
        return $this->ui_factory
            ->table()
            ->data(
                $this,
                $this->getTableTitle(),
                $this->getColumnDefinition(),
            )
            ->withId(self::class)
            ->withOrder(new Order('date', Order::DESC))
            ->withActions($this->getActions())
            ->withRequest($this->http_request);
    }

References ILIAS\Data\Order\DESC, ILIAS\Mail\Folder\MailFolderTableUI\getActions(), ILIAS\Mail\Folder\MailFolderTableUI\getColumnDefinition(), and ILIAS\Mail\Folder\MailFolderTableUI\getTableTitle().

Here is the call graph for this function:

◆ getDate()

ILIAS\Mail\Folder\MailFolderTableUI::getDate ( MailRecordData $record )

private

Definition at line 431 of file MailFolderTableUI.php.

                                                    : ?DateTimeImmutable
    {
        return empty($record->getSendTime()) ? null : $record->getSendTime()->setTimezone($this->user_time_zone);
    }

References ILIAS\Mail\Message\MailRecordData\getSendTime().

Here is the call graph for this function:

◆ getRecipients()

ILIAS\Mail\Folder\MailFolderTableUI::getRecipients ( MailRecordData $record )

private

Definition at line 410 of file MailFolderTableUI.php.

                                                          : string
    {
        return $this->refinery->encode()->htmlSpecialCharsAsEntities()->transform(
            $this->mail->formatNamesForOutput((string) $record->getRcpTo())
        );
    }

References ILIAS\Mail\Message\MailRecordData\getRcpTo(), and ILIAS\Repository\refinery().

Here is the call graph for this function:

◆ getRows()

ILIAS\Mail\Folder\MailFolderTableUI::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.

yield $row_builder->buildStandardRow($row_id, $record).

Parameters

string[] $visible_column_ids

Implements ILIAS\UI\Component\Table\DataRetrieval.

Definition at line 261 of file MailFolderTableUI.php.

     : \Generator {
        // mapping of table columns to allowed order columns of the mailbox query
        $order_columns = [
            'status' => MailBoxOrderColumn::STATUS,
            'subject' => MailBoxOrderColumn::SUBJECT,
            'sender' => MailBoxOrderColumn::FROM,
            'recipients' => MailBoxOrderColumn::RCP_TO,
            'date' => MailBoxOrderColumn::SEND_TIME,
            'attachments' => MailBoxOrderColumn::ATTACHMENTS
        ];
 
        [$order_column, $order_direction] = $order->join([], fn($ret, $key, $value) => [$key, $value]);
 
        $records = $this->search->getPagedRecords(
            $range->getLength(),
            $range->getStart(),
            $order_columns[$order_column] ?? null,
            $order_direction
        );
 
        // preload user objects for display of avatar and sender
        if ($this->current_folder->hasIncomingMails()) {
            $user_ids = [];
            foreach ($records as $record) {
                if ($record->hasPersonalSender()) {
                    $user_ids[$record->getSenderId()] = $record->getSenderId();
                }
            }
            ilMailUserCache::preloadUserObjects($user_ids);
        }
 
        foreach ($records as $record) {
            if ($this->current_folder->hasIncomingMails()) {
                $data = [
                    'status' => $this->getStatus($record),
                    'avatar' => $this->getAvatar($record),
                    'sender' => $this->getSender($record),
                    'subject' => $this->getSubject($record),
                    'attachments' => $this->getAttachments($record),
                    'date' => $this->getDate($record)
                ];
            } else {
                $data = [
                    'recipients' => $this->getRecipients($record),
                    'subject' => $this->getSubject($record),
                    'attachments' => $this->getAttachments($record),
                    'date' => $this->getDate($record)
                ];
            }
 
            yield $row_builder->buildDataRow(
                (string) $record->getMailId(),
                $data
            )->withDisabledAction(self::ACTION_REPLY, !$record->hasPersonalSender())->withDisabledAction(
                self::ACTION_DOWNLOAD_ATTACHMENT,
                !$record->hasAttachments()
            );
        }
    }

References ilMailUserCache\preloadUserObjects().

Here is the call graph for this function:

◆ getSender()

ILIAS\Mail\Folder\MailFolderTableUI::getSender ( MailRecordData $record )

private

Definition at line 384 of file MailFolderTableUI.php.

                                                      : string
    {
        if ($record->getSenderId() === ANONYMOUS_USER_ID) {
            return ilMail::_getIliasMailerName();
        }
 
        $user = ilMailUserCache::getUserObjectById($record->getSenderId());
        if ($user !== null) {
            if ($user->hasPublicProfile()) {
                return $this->ui_renderer->render(
                    $this->ui_factory->link()->standard(
                        $user->getPublicName(),
                        (string) $this->url_builder
                            ->withParameter($this->action_token, self::ACTION_PROFILE)
                            ->withParameter($this->row_id_token, (string) $record->getMailId())
                            ->buildURI()
                    )
                );
            }
 
            return $user->getPublicName();
        }
 
        return trim(($record->getImportName() ?? '') . ' (' . $this->lng->txt('user_deleted') . ')');
    }

References ilMail\_getIliasMailerName(), ANONYMOUS_USER_ID, ILIAS\Mail\Message\MailRecordData\getImportName(), ILIAS\Mail\Message\MailRecordData\getMailId(), ILIAS\Mail\Message\MailRecordData\getSenderId(), and ilMailUserCache\getUserObjectById().

Here is the call graph for this function:

◆ getStatus()

ILIAS\Mail\Folder\MailFolderTableUI::getStatus ( MailRecordData $record )

private

Definition at line 377 of file MailFolderTableUI.php.

                                                      : Icon
    {
        return $record->isRead()
            ? $this->ui_factory->symbol()->icon()->standard('mailr', $this->lng->txt('mailr'))
            : $this->ui_factory->symbol()->icon()->standard('mailu', $this->lng->txt('mailu'));
    }

References ILIAS\Mail\Message\MailRecordData\isRead(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ getSubject()

ILIAS\Mail\Folder\MailFolderTableUI::getSubject ( MailRecordData $record )

private

Definition at line 417 of file MailFolderTableUI.php.

                                                       : Link
    {
        return $this->ui_factory->link()->standard(
            $this->refinery->encode()->htmlSpecialCharsAsEntities()->transform($record->getSubject()),
            (string) $this->url_builder
                ->withParameter(
                    $this->action_token,
                    $this->current_folder->isDrafts() ? self::ACTION_EDIT : self::ACTION_SHOW
                )
                ->withParameter($this->row_id_token, (string) $record->getMailId())
                ->buildURI()
        );
    }

References ILIAS\Mail\Message\MailRecordData\getMailId(), ILIAS\Mail\Message\MailRecordData\getSubject(), and ILIAS\Repository\refinery().

Here is the call graph for this function:

◆ getTableTitle()

ILIAS\Mail\Folder\MailFolderTableUI::getTableTitle ( )

private

Definition at line 333 of file MailFolderTableUI.php.

                                    : string
    {
        if ($this->current_folder->hasIncomingMails() && $this->search->getUnread() > 0) {
            return \sprintf(
                '%s: %s (%s %s)',
                $this->current_folder->getTitle(),
                $this->search->getCount() === 1
                    ? $this->lng->txt('mail_1')
                    : \sprintf($this->lng->txt('mail_s'), $this->search->getCount()),
                $this->search->getUnread(),
                $this->lng->txt('unread')
            );
        }
 
        return \sprintf(
            '%s: %s',
            $this->current_folder->getTitle(),
            $this->search->getCount() === 1
                ? $this->lng->txt('mail_1')
                : \sprintf($this->lng->txt('mail_s'), $this->search->getCount()),
        );
    }

References ILIAS\Repository\lng().

Referenced by ILIAS\Mail\Folder\MailFolderTableUI\getComponent().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTotalRowCount()

ILIAS\Mail\Folder\MailFolderTableUI::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 328 of file MailFolderTableUI.php.

                                                                                        : ?int
    {
        return $this->search->getCount();
    }

References ILIAS\UI\examples\Symbol\Glyph\Search\search().

Here is the call graph for this function:

Field Documentation

◆ $avatars

array ILIAS\Mail\Folder\MailFolderTableUI::$avatars = []

private

Definition at line 63 of file MailFolderTableUI.php.

◆ ACTION_DELETE

const string ILIAS\Mail\Folder\MailFolderTableUI::ACTION_DELETE = 'delete'

Definition at line 58 of file MailFolderTableUI.php.

◆ ACTION_DOWNLOAD_ATTACHMENT

const string ILIAS\Mail\Folder\MailFolderTableUI::ACTION_DOWNLOAD_ATTACHMENT = 'download'

Definition at line 54 of file MailFolderTableUI.php.

◆ ACTION_EDIT

const string ILIAS\Mail\Folder\MailFolderTableUI::ACTION_EDIT = 'edit'

Definition at line 51 of file MailFolderTableUI.php.

◆ ACTION_FORWARD

const string ILIAS\Mail\Folder\MailFolderTableUI::ACTION_FORWARD = 'forward'

Definition at line 53 of file MailFolderTableUI.php.

◆ ACTION_MARK_READ

const string ILIAS\Mail\Folder\MailFolderTableUI::ACTION_MARK_READ = 'markRead'

Definition at line 59 of file MailFolderTableUI.php.

◆ ACTION_MARK_UNREAD

const string ILIAS\Mail\Folder\MailFolderTableUI::ACTION_MARK_UNREAD = 'marUnread'

Definition at line 60 of file MailFolderTableUI.php.

◆ ACTION_MOVE_TO

const string ILIAS\Mail\Folder\MailFolderTableUI::ACTION_MOVE_TO = 'moveTo'

Definition at line 57 of file MailFolderTableUI.php.

◆ ACTION_PRINT

const string ILIAS\Mail\Folder\MailFolderTableUI::ACTION_PRINT = 'print'

Definition at line 55 of file MailFolderTableUI.php.

◆ ACTION_PROFILE

const string ILIAS\Mail\Folder\MailFolderTableUI::ACTION_PROFILE = 'profile'

Definition at line 56 of file MailFolderTableUI.php.

◆ ACTION_REPLY

const string ILIAS\Mail\Folder\MailFolderTableUI::ACTION_REPLY = 'reply'

Definition at line 52 of file MailFolderTableUI.php.

◆ ACTION_SHOW

const string ILIAS\Mail\Folder\MailFolderTableUI::ACTION_SHOW = 'show'

Definition at line 50 of file MailFolderTableUI.php.

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

components/ILIAS/Mail/classes/Folder/MailFolderTableUI.php

Public Member Functions

Data Fields

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getActions()

◆ getAttachments()

◆ getAvatar()

◆ getColumnDefinition()

◆ getComponent()

◆ getDate()

◆ getRecipients()

◆ getRows()

◆ getSender()

◆ getStatus()

◆ getSubject()

◆ getTableTitle()

◆ getTotalRowCount()

Field Documentation

◆ $avatars

◆ ACTION_DELETE

◆ ACTION_DOWNLOAD_ATTACHMENT

◆ ACTION_EDIT

◆ ACTION_FORWARD

◆ ACTION_MARK_READ

◆ ACTION_MARK_UNREAD

◆ ACTION_MOVE_TO

◆ ACTION_PRINT

◆ ACTION_PROFILE

◆ ACTION_REPLY

◆ ACTION_SHOW