ilMailTemplateTable Class Reference

Inheritance diagram for ilMailTemplateTable:

Collaboration diagram for ilMailTemplateTable:

Public Member Functions
	__construct (private readonly ServerRequestInterface $http_request, private readonly ilLanguage $lng, private readonly UIFactory $ui_factory, private readonly DataFactory $data_factory, private readonly ilMailTemplateService $service, private readonly bool $read_only=false,)
	getRows (ILIAS\UI\Component\Table\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...
	initRecords ()
	getComponent ()
	getContext (string $value, bool $default=false)
	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...
	getActions (URLBuilder $url_builder, URLBuilderToken $action_parameter_token, URLBuilderToken $row_id_token)

Protected Attributes
array	$contexts = []

Private Member Functions
	getRecords (Range $range, Order $order)
	limitRecords (array $records, Range $range)
	orderRecords (array $records, Order $order)
	getColumns ()

Private Attributes
array	$records = null

Detailed Description

Definition at line 32 of file class.ilMailTemplateTable.php.

Constructor & Destructor Documentation

__construct()

ilMailTemplateTable::__construct	(	private readonly ServerRequestInterface	$http_request,
		private readonly ilLanguage	$lng,
		private readonly UIFactory	$ui_factory,
		private readonly DataFactory	$data_factory,
		private readonly ilMailTemplateService	$service,
		private readonly bool	$read_only = false
	)

Definition at line 40 of file class.ilMailTemplateTable.php.

References ilMailTemplateContextService\getTemplateContexts().

      {
        $this->contexts = ilMailTemplateContextService::getTemplateContexts();
    }

Here is the call graph for this function:

Member Function Documentation

getActions()

ilMailTemplateTable::getActions	(	URLBuilder	$url_builder,
		URLBuilderToken	$action_parameter_token,
		URLBuilderToken	$row_id_token
	)

Returns

Action[]

Definition at line 159 of file class.ilMailTemplateTable.php.

References ILIAS\Repository\lng(), and ILIAS\UI\URLBuilder\withParameter().

Referenced by getComponent().

                                                                                                                               : array
    {
        $actions = [];
        if ($this->contexts !== []) {
            $actions['edit'] = $this->ui_factory->table()->action()->single(
                $this->lng->txt('edit'),
                $url_builder->withParameter($action_parameter_token, 'showEditTemplateForm'),
                $row_id_token
            );
        } else {
            $actions['view'] = $this->ui_factory->table()->action()->single(
                $this->lng->txt('view'),
                $url_builder->withParameter($action_parameter_token, 'showEditTemplateForm'),
                $row_id_token
            );
        }

        if (!$this->read_only) {
            $actions['delete'] = $this->ui_factory->table()->action()->standard(
                $this->lng->txt('delete'),
                $url_builder->withParameter($action_parameter_token, 'confirmDeleteTemplate'),
                $row_id_token
            );
        }

        $actions['unsetAsContextDefault'] = $this->ui_factory->table()->action()->single(
            $this->lng->txt('mail_template_unset_as_default'),
            $url_builder->withParameter($action_parameter_token, 'unsetAsContextDefault'),
            $row_id_token
        );

        $actions['setAsContextDefault'] = $this->ui_factory->table()->action()->single(
            $this->lng->txt('mail_template_set_as_default'),
            $url_builder->withParameter($action_parameter_token, 'setAsContextDefault'),
            $row_id_token
        );

        return $actions;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getColumns()

ilMailTemplateTable::getColumns ( )

private

Returns

array{ title: , context: }

Definition at line 236 of file class.ilMailTemplateTable.php.

References ILIAS\Repository\lng().

Referenced by getComponent().

                                 : array
    {
        return [
            'title' => $this->ui_factory->table()->column()
                ->text($this->lng->txt('title')),
            'context' => $this->ui_factory->table()->column()
                ->text($this->lng->txt('mail_template_context'))
        ];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getComponent()

ilMailTemplateTable::getComponent

(

)

Definition at line 88 of file class.ilMailTemplateTable.php.

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

                                  : DataTable
    {
        $query_params_namespace = ['mail', 'template'];
        $table_uri = $this->data_factory->uri($this->http_request->getUri()->__toString());
        $url_builder = new URLBuilder($table_uri);
        [$url_builder, $action_parameter_token, $row_id_token] = $url_builder->acquireParameters(
            $query_params_namespace,
            'table_action',
            'tpl_ids'
        );

        return $this->ui_factory->table()
            ->data(
                $this,
                $this->lng->txt('mail_templates'),
                $this->getColumns()
            )
            ->withActions($this->getActions($url_builder, $action_parameter_token, $row_id_token))
            ->withId(
                'mail_man_tpl'
            )
            ->withOrder(new Order('title', Order::ASC))
            ->withRequest($this->http_request);
    }

Here is the call graph for this function:

getContext()

ilMailTemplateTable::getContext	(	string	$value,
		bool	$default = false
	)

Definition at line 113 of file class.ilMailTemplateTable.php.

References ILIAS\GlobalScreen\Scope\Footer\Factory\getTitle(), and ILIAS\Repository\lng().

Referenced by initRecords().

                                                                    : string
    {
        if (isset($this->contexts[$value])) {
            $is_default_suffix = '';
            if ($default) {
                $is_default_suffix = $this->lng->txt('mail_template_default');
            }

            return implode('', [
                $this->contexts[$value]->getTitle(),
                $is_default_suffix,
            ]);
        }

        return $this->lng->txt('mail_template_orphaned_context');
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getRecords()

ilMailTemplateTable::getRecords ( Range  $range, Order  $order  )

private

Returns

list<array{tpl_id: int, title: string, context: string, is_default: bool}>

Definition at line 140 of file class.ilMailTemplateTable.php.

References $records, initRecords(), limitRecords(), and orderRecords().

Referenced by getRows().

                                                           : array
    {
        $this->initRecords();
        $records = $this->records;

        if ($order) {
            $records = $this->orderRecords($records, $order);
        }

        if ($range) {
            $records = $this->limitRecords($records, $range);
        }

        return $records;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getRows()

ilMailTemplateTable::getRows	(	ILIAS\UI\Component\Table\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 51 of file class.ilMailTemplateTable.php.

References getRecords().

     : Generator {
        $records = $this->getRecords($range, $order);
        foreach ($records as $record) {
            yield $row_builder->buildDataRow($record['tpl_id'], $record)
                ->withDisabledAction(
                    'setAsContextDefault',
                    isset($record['is_default']) && $record['is_default']
                )
                ->withDisabledAction(
                    'unsetAsContextDefault',
                    !isset($record['is_default']) || !$record['is_default']
                );
        }
    }

Here is the call graph for this function:

getTotalRowCount()

ilMailTemplateTable::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 130 of file class.ilMailTemplateTable.php.

References initRecords().

                                                                                        : ?int
    {
        $this->initRecords();

        return count((array) $this->records);
    }

Here is the call graph for this function:

initRecords()

ilMailTemplateTable::initRecords

(

)

Definition at line 73 of file class.ilMailTemplateTable.php.

References getContext(), and null.

Referenced by getRecords(), and getTotalRowCount().

                                 : void
    {
        if ($this->records === null) {
            $this->records = [];
            foreach ($this->service->listAllTemplatesAsArray() as $item) {
                $this->records[] = [
                    'tpl_id' => (string) $item['tpl_id'],
                    'title' => $item['title'],
                    'context' => $this->getContext($item['context'], $item['is_default'] ?? false),
                    'is_default' => $item['is_default'] ?? false,
                ];
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

limitRecords()

ilMailTemplateTable::limitRecords ( array  $records, Range  $range  )

private

Parameters

list<array{tpl_id

int, title: string, context: string, is_default: bool}> $records

Returns

list<array{tpl_id: int, title: string, context: string, is_default: bool}>

Definition at line 203 of file class.ilMailTemplateTable.php.

References ILIAS\Data\Range\getLength(), and ILIAS\Data\Range\getStart().

Referenced by getRecords().

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

Here is the call graph for this function:

Here is the caller graph for this function:

orderRecords()

ilMailTemplateTable::orderRecords ( array  $records, Order  $order  )

private

Parameters

list<array{tpl_id

int, title: string, context: string, is_default: bool}> $records

Returns

list<array{tpl_id: int, title: string, context: string, is_default: bool}>

Definition at line 212 of file class.ilMailTemplateTable.php.

References $records, ILIAS\Data\Order\join(), and ilStr\strCmp().

Referenced by getRecords().

                                                               : array
    {
        [$order_field, $order_direction] = $order->join(
            [],
            fn($ret, $key, $value) => [$key, $value]
        );
        usort($records, static fn(array $left, array $right): int => ilStr::strCmp(
            $left[$order_field] ?? '',
            $right[$order_field] ?? ''
        ));

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

        return $records;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$contexts

array ilMailTemplateTable::$contexts = []

protected

Definition at line 35 of file class.ilMailTemplateTable.php.

$records

array ilMailTemplateTable::$records = null

private

Definition at line 38 of file class.ilMailTemplateTable.php.

Referenced by getRecords(), and orderRecords().

---

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

• components/ILIAS/Mail/classes/class.ilMailTemplateTable.php