ILIAS\Mail\Attachments\MailAttachmentTableGUI Class Reference

Inheritance diagram for ILIAS\Mail\Attachments\MailAttachmentTableGUI:

Collaboration diagram for ILIAS\Mail\Attachments\MailAttachmentTableGUI:

Public Member Functions
	__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)
	get ()
	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)
	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
	getColumnDefinition ()
	getActions ()
	getRecords (\ILIAS\Data\Range $range, \ILIAS\Data\Order $order)

Private Attributes
readonly ILIAS UI URLBuilder	$url_builder
readonly ILIAS UI URLBuilderToken	$action_parameter_token
readonly ILIAS UI URLBuilderToken	$row_id_token
readonly ILIAS Data Factory	$data_factory

Detailed Description

Definition at line 28 of file MailAttachmentTableGUI.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Mail\Attachments\MailAttachmentTableGUI::__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
	)

Parameters

list<array{"filename"

string, "filesize": int, "filecreatedate": int}> $records

Definition at line 38 of file MailAttachmentTableGUI.php.

References ILIAS\Mail\Attachments\MailAttachmentTableGUI\$action_parameter_token, ILIAS\Mail\Attachments\MailAttachmentTableGUI\$row_id_token, ILIAS\Mail\Attachments\MailAttachmentTableGUI\$url_builder, ilUtil\_getHttpPath(), and ILIAS\Repository\ctrl().

      {
        $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();
    }

Here is the call graph for this function:

Member Function Documentation

get()

ILIAS\Mail\Attachments\MailAttachmentTableGUI::get

(

)

Definition at line 69 of file MailAttachmentTableGUI.php.

References ILIAS\Data\Order\ASC, ILIAS\Mail\Attachments\MailAttachmentTableGUI\getActions(), ILIAS\Mail\Attachments\MailAttachmentTableGUI\getColumnDefinition(), and ILIAS\Repository\lng().

                         : \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);
    }

Here is the call graph for this function:

getActions()

ILIAS\Mail\Attachments\MailAttachmentTableGUI::getActions ( )

private

Returns

array<string, >

Definition at line 117 of file MailAttachmentTableGUI.php.

References ILIAS\Mail\Attachments\MailAttachmentTableGUI\$row_id_token, ILIAS\Mail\Attachments\CONSUME, and ILIAS\Repository\lng().

Referenced by ILIAS\Mail\Attachments\MailAttachmentTableGUI\get().

                                 : 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;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getColumnDefinition()

ILIAS\Mail\Attachments\MailAttachmentTableGUI::getColumnDefinition ( )

private

Returns

array<string, >

Definition at line 87 of file MailAttachmentTableGUI.php.

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

Referenced by ILIAS\Mail\Attachments\MailAttachmentTableGUI\get().

                                          : 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),
        ];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getRecords()

ILIAS\Mail\Attachments\MailAttachmentTableGUI::getRecords ( \ILIAS\Data\Range  $range, \ILIAS\Data\Order  $order  )

private

Returns

list<array{"filename": string, "filesize": int, "filecreatedate": int}>

Definition at line 141 of file MailAttachmentTableGUI.php.

References ilStr\strCmp().

Referenced by ILIAS\Mail\Attachments\MailAttachmentTableGUI\getRows().

                                                                                   : array
    {
        $records = $this->records;

        [$order_field, $order_direction] = $order->join([], static function ($ret, $key, $value) {
            return [$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;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getRows()

ILIAS\Mail\Attachments\MailAttachmentTableGUI::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
	)

Definition at line 166 of file MailAttachmentTableGUI.php.

References ilUtil\formatSize(), and ILIAS\Mail\Attachments\MailAttachmentTableGUI\getRecords().

     : \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);
        }
    }

Here is the call graph for this function:

getTotalRowCount()

ILIAS\Mail\Attachments\MailAttachmentTableGUI::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 188 of file MailAttachmentTableGUI.php.

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

Field Documentation

$action_parameter_token

readonly ILIAS UI URLBuilderToken ILIAS\Mail\Attachments\MailAttachmentTableGUI::$action_parameter_token

private

Definition at line 31 of file MailAttachmentTableGUI.php.

Referenced by ILIAS\Mail\Attachments\MailAttachmentTableGUI\__construct().

$data_factory

readonly ILIAS Data Factory ILIAS\Mail\Attachments\MailAttachmentTableGUI::$data_factory

private

Definition at line 33 of file MailAttachmentTableGUI.php.

$row_id_token

readonly ILIAS UI URLBuilderToken ILIAS\Mail\Attachments\MailAttachmentTableGUI::$row_id_token

private

Definition at line 32 of file MailAttachmentTableGUI.php.

Referenced by ILIAS\Mail\Attachments\MailAttachmentTableGUI\__construct(), and ILIAS\Mail\Attachments\MailAttachmentTableGUI\getActions().

$url_builder

readonly ILIAS UI URLBuilder ILIAS\Mail\Attachments\MailAttachmentTableGUI::$url_builder

private

Definition at line 30 of file MailAttachmentTableGUI.php.

Referenced by ILIAS\Mail\Attachments\MailAttachmentTableGUI\__construct().

---

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

• components/ILIAS/Mail/classes/Attachments/MailAttachmentTableGUI.php