ILIAS\ILIASObject\Properties\Translations\TranslationsTable Class Reference

Inheritance diagram for ILIAS\ILIASObject\Properties\Translations\TranslationsTable:

Collaboration diagram for ILIAS\ILIASObject\Properties\Translations\TranslationsTable:

Public Member Functions
	__construct (private readonly UIFactory $ui_factory, private readonly UIRenderer $ui_renderer, private readonly SystemLanguage $lng, private readonly Refinery $refinery, private readonly \ilGlobalTemplateInterface $tpl, private readonly HTTPService $http, private readonly \ilCtrl $ctrl, private Translations $translations, private readonly ObjectProperties $object_properties, URI $here_uri)
	runAction ()
	getTable ()
	getRows (DataRowBuilder $row_builder, array $visible_column_ids, Range $range, Order $order, mixed $additional_viewcontrol_data, mixed $filter_data, mixed $additional_parameters)
	This is called by the table to retrieve rows; map data-records to rows using the $row_builder e.g. More...
	getTotalRowCount (mixed $additional_viewcontrol_data, mixed $filter_data, mixed $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, mixed $additional_viewcontrol_data, mixed $filter_data, mixed $additional_parameters)
	This is called by the table to retrieve rows; map data-records to rows using the $row_builder e.g. More...
	getTotalRowCount (mixed $additional_viewcontrol_data, mixed $filter_data, mixed $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	ACTION_EDIT = 'e'
const	ACTION_MAKE_DEFAULT = 'md'
const	ACTION_DELETE = 'd'

Private Member Functions
	getColumns ()
	getActions ()
	editTranslation ()
	makeDefault ()
	deleteTranslations ()
	buildEditLanguageModal (string $language_code)
	buildConfirmationModal (array $languages_to_delete)
	retrieveAffectedItemsFromQueryForDeletion ()
	retrieveAffectedItemsFromQuery ()
	sendAsync (UIComponent $response)
	orderLanguages (array $languages, Order $order)

Private Attributes
const	QUERY_PARAMETER_NAME_SPACE = ['obj', 'trans']
const	TOKEN_STRING_ACTION = 'a'
const	TOKEN_STRING_ROW_ID = 't'
const	TOKEN_STRING_ACTON_AFFECTED_ITEMS = 'ai'
URLBuilder	$url_builder
URLBuilderToken	$token_action
URLBuilderToken	$token_action_affected_items
URLBuilderToken	$token_row_id
RoundtripModal	$modal_with_error = null

Detailed Description

Definition at line 42 of file TranslationsTable.php.

Constructor & Destructor Documentation

__construct()

ILIAS\ILIASObject\Properties\Translations\TranslationsTable::__construct	(	private readonly UIFactory	$ui_factory,
		private readonly UIRenderer	$ui_renderer,
		private readonly SystemLanguage	$lng,
		private readonly Refinery	$refinery,
		private readonly \ilGlobalTemplateInterface	$tpl,
		private readonly HTTPService	$http,
		private readonly \ilCtrl	$ctrl,
		private Translations	$translations,
		private readonly ObjectProperties	$object_properties,
		URI	$here_uri
	)

Parameters

array<ILIAS

ILIASObject\Properties\Translations\Language> $languages

Definition at line 63 of file TranslationsTable.php.

      {
        [
            $this->url_builder,
            $this->token_action,
            $this->token_row_id,
            $this->token_action_affected_items
        ] = (new URLBuilder($here_uri))->acquireParameters(
            self::QUERY_PARAMETER_NAME_SPACE,
            self::TOKEN_STRING_ACTION,
            self::TOKEN_STRING_ROW_ID,
            self::TOKEN_STRING_ACTON_AFFECTED_ITEMS
        );
    }

References ILIAS\ILIASObject\Properties\Translations\TranslationsTable\$token_action, ILIAS\ILIASObject\Properties\Translations\TranslationsTable\$token_action_affected_items, ILIAS\ILIASObject\Properties\Translations\TranslationsTable\$token_row_id, and ILIAS\ILIASObject\Properties\Translations\TranslationsTable\$url_builder.

Member Function Documentation

buildConfirmationModal()

ILIAS\ILIASObject\Properties\Translations\TranslationsTable::buildConfirmationModal ( array  $languages_to_delete )

private

Definition at line 314 of file TranslationsTable.php.

                                                                       : InterruptiveModal
    {
        return $this->ui_factory->modal()->interruptive(
            $this->lng->txt('confirm'),
            $this->lng->txt('obj_conf_delete_lang'),
            $this->url_builder
                ->withParameter($this->token_action, self::ACTION_DELETE)
                ->withParameter($this->token_action_affected_items, $languages_to_delete)
                ->buildURI()->__toString()
        )->withAffectedItems(
            array_map(
                fn(string $v): InterruptiveItem => $this->ui_factory->modal()
                    ->interruptiveItem()->standard($v, $this->lng->txt("meta_l_{$v}")),
                $languages_to_delete
            )
        );
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

buildEditLanguageModal()

ILIAS\ILIASObject\Properties\Translations\TranslationsTable::buildEditLanguageModal ( string  $language_code )

private

Definition at line 295 of file TranslationsTable.php.

                                                                  : RoundtripModal
    {
        return $this->ui_factory->modal()->roundtrip(
            $this->lng->txt('edit_language'),
            null,
            $this->translations->getLaguageForCode(
                $language_code
            )->toForm(
                $this->lng,
                $this->ui_factory->input()->field(),
                $this->refinery
            ),
            $this->url_builder
                ->withParameter($this->token_action, self::ACTION_EDIT)
                ->withParameter($this->token_action_affected_items, $language_code)
                ->buildURI()->__toString()
        );
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

deleteTranslations()

ILIAS\ILIASObject\Properties\Translations\TranslationsTable::deleteTranslations ( )

private

Definition at line 261 of file TranslationsTable.php.

                                         : void
    {
        if ($this->http->wrapper()->query()->retrieve(
            $this->token_action_affected_items->getName(),
            $this->refinery->byTrying([
                $this->refinery->kindlyTo()->string(),
                $this->refinery->kindlyTo()->listOf(
                    $this->refinery->kindlyTo()->string()
                )
            ])
        ) === '') {
            $this->sendAsync(
                $this->buildConfirmationModal(
                    $this->retrieveAffectedItemsFromQueryForDeletion()
                )
            );
        }
 
        $this->object_properties->storePropertyTranslations(
            array_reduce(
                $this->http->wrapper()->post()->retrieve(
                    'interruptive_items',
                    $this->refinery->kindlyTo()->listOf(
                        $this->refinery->kindlyTo()->string()
                    )
                ),
                static fn(Translations $c, string $v): Translations => $c->withoutLanguage($v),
                $this->translations
            )
        );
        $this->tpl->setOnScreenMessage('success', $this->lng->txt('saved_successfully'), true);
        $this->ctrl->redirectByClass($this->ctrl->getCurrentClassPath());
    }

References Vendor\Package\$c, ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), and ILIAS\Repository\lng().

Referenced by ILIAS\ILIASObject\Properties\Translations\TranslationsTable\runAction().

Here is the call graph for this function:

Here is the caller graph for this function:

editTranslation()

ILIAS\ILIASObject\Properties\Translations\TranslationsTable::editTranslation ( )

private

Definition at line 211 of file TranslationsTable.php.

                                      : void
    {
        if ($this->http->wrapper()->query()->retrieve(
            $this->token_action_affected_items->getName(),
            $this->refinery->kindlyTo()->string()
        ) === '') {
            $this->sendAsync(
                $this->buildEditLanguageModal(
                    $this->retrieveAffectedItemsFromQuery()[0]
                )
            );
        }
 
        $modal = $this->buildEditLanguageModal(
            $this->http->wrapper()->query()->retrieve(
                $this->token_action_affected_items->getName(),
                $this->refinery->kindlyTo()->string()
            )
        )->withRequest($this->http->request());
        $data = $modal->getData();
        if ($data === null) {
            $this->modal_with_error = $modal->withOnLoad($modal->getShowSignal());
            return;
        }
 
        $this->translations = $this->translations->withLanguage($data[0]);
        $this->object_properties->storePropertyTranslations(
            $this->translations
        );
 
        $this->object_properties->storePropertyTranslations(
            $this->translations->withLanguage($data[0])
        );
        $this->tpl->setOnScreenMessage('success', $this->lng->txt('saved_successfully'), true);
        $this->ctrl->redirectByClass($this->ctrl->getCurrentClassPath());
    }

References $data, ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), and ILIAS\Repository\lng().

Referenced by ILIAS\ILIASObject\Properties\Translations\TranslationsTable\runAction().

Here is the call graph for this function:

Here is the caller graph for this function:

getActions()

ILIAS\ILIASObject\Properties\Translations\TranslationsTable::getActions ( )

private

Definition at line 178 of file TranslationsTable.php.

                                 : array
    {
        if ($this->translations->migrationMissing()) {
            return [];
        }
        return [
            self::ACTION_EDIT => $this->ui_factory->table()->action()->single(
                $this->lng->txt('edit'),
                $this->url_builder->withParameter(
                    $this->token_action,
                    self::ACTION_EDIT
                ),
                $this->token_row_id
            )->withAsync(),
            self::ACTION_MAKE_DEFAULT => $this->ui_factory->table()->action()->single(
                $this->lng->txt('make_default_language'),
                $this->url_builder->withParameter(
                    $this->token_action,
                    self::ACTION_MAKE_DEFAULT
                ),
                $this->token_row_id
            ),
            self::ACTION_DELETE => $this->ui_factory->table()->action()->standard(
                $this->lng->txt('delete'),
                $this->url_builder->withParameter(
                    $this->token_action,
                    self::ACTION_DELETE
                ),
                $this->token_row_id
            )->withAsync()
        ];
    }

References ILIAS\Repository\lng().

Referenced by ILIAS\ILIASObject\Properties\Translations\TranslationsTable\getTable().

Here is the call graph for this function:

Here is the caller graph for this function:

getColumns()

ILIAS\ILIASObject\Properties\Translations\TranslationsTable::getColumns ( )

private

Definition at line 152 of file TranslationsTable.php.

                                 : array
    {
        $cf = $this->ui_factory->table()->column();
        $columns = [
            Language::KEY_LANGUAGE => $cf->text($this->lng->txt('language')),
        ];
        if ($this->translations->getContentTranslationActivated()) {
            $columns[Language::KEY_BASE] = $cf->boolean(
                $this->lng->txt('obj_base_lang'),
                $this->ui_factory->symbol()->icon()->custom('assets/images/standard/icon_checked.svg', '', 'small'),
                $this->ui_factory->symbol()->icon()->custom('assets/images/standard/icon_unchecked.svg', '', 'small')
            );
        }
 
        return $columns + [
            Language::KEY_DEFAULT => $cf->boolean(
                $this->lng->txt('default'),
                $this->ui_factory->symbol()->icon()->custom('assets/images/standard/icon_checked.svg', '', 'small'),
                $this->ui_factory->symbol()->icon()->custom('assets/images/standard/icon_unchecked.svg', '', 'small')
            ),
            Language::KEY_TITLE => $cf->text($this->lng->txt('title')),
            Language::KEY_DESCRIPTION => $cf->text($this->lng->txt('description')),
        ];
 
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

getRows()

ILIAS\ILIASObject\Properties\Translations\TranslationsTable::getRows	(	DataRowBuilder	$row_builder,
		array	$visible_column_ids,
		Range	$range,
		Order	$order,
		mixed	$additional_viewcontrol_data,
		mixed	$filter_data,
		mixed	$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 126 of file TranslationsTable.php.

     : \Generator {
        foreach ($this->orderLanguages(
            $this->translations->getLanguages(),
            $order
        ) as $langauge) {
            yield $langauge->toRow($row_builder, $this->lng);
        }
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

getTable()

ILIAS\ILIASObject\Properties\Translations\TranslationsTable::getTable

(

)

Definition at line 109 of file TranslationsTable.php.

                              : array
    {
        $content = [];
        if ($this->modal_with_error !== null) {
            $content[] = $this->modal_with_error;
        }
 
        $content[] = $this->ui_factory->table()->data(
            $this,
            $this->lng->txt('available_languages'),
            $this->getColumns()
        )->withActions($this->getActions())
            ->withRequest($this->http->request());
 
        return $content;
    }

References ILIAS\ILIASObject\Properties\Translations\TranslationsTable\$modal_with_error, ILIAS\ILIASObject\Properties\Translations\TranslationsTable\getActions(), ILIAS\FileDelivery\http(), and ILIAS\Repository\lng().

Here is the call graph for this function:

getTotalRowCount()

ILIAS\ILIASObject\Properties\Translations\TranslationsTable::getTotalRowCount	(	mixed	$additional_viewcontrol_data,
		mixed	$filter_data,
		mixed	$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 143 of file TranslationsTable.php.

     : ?int {
        return count($this->translations->getLanguages());
    }

makeDefault()

ILIAS\ILIASObject\Properties\Translations\TranslationsTable::makeDefault ( )

private

Definition at line 248 of file TranslationsTable.php.

                                  : void
    {
        $this->translations = $this->translations->withDefaultLanguage(
            $this->retrieveAffectedItemsFromQuery()[0]
        );
        $this->object_properties->storePropertyTranslations(
            $this->translations
        );
 
        $this->tpl->setOnScreenMessage('success', $this->lng->txt('saved_successfully'), true);
        $this->ctrl->redirectByClass($this->ctrl->getCurrentClassPath());
    }

References ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Referenced by ILIAS\ILIASObject\Properties\Translations\TranslationsTable\runAction().

Here is the call graph for this function:

Here is the caller graph for this function:

orderLanguages()

ILIAS\ILIASObject\Properties\Translations\TranslationsTable::orderLanguages ( array  $languages, Order  $order  )

private

Definition at line 386 of file TranslationsTable.php.

     : array {
        return $order->join(
            $languages,
            function (array $langs, string $field, string $direction): array {
                usort(
                    $langs,
                    fn(Language $a, Language $b) => $a->getDisplayValueForKey($this->lng, $field)
                        <=> $b->getDisplayValueForKey($this->lng, $field)
                );
 
                if ($direction === 'DESC') {
                    return array_reverse($langs);
                }
 
                return $langs;
            }
        );
    }

retrieveAffectedItemsFromQuery()

ILIAS\ILIASObject\Properties\Translations\TranslationsTable::retrieveAffectedItemsFromQuery ( )

private

Definition at line 346 of file TranslationsTable.php.

                                                     : array
    {
        $affected_items = [];
        if ($this->http->wrapper()->query()->has($this->token_row_id->getName())) {
            $affected_items = $this->http->wrapper()->query()->retrieve(
                $this->token_row_id->getName(),
                $this->refinery->byTrying(
                    [
                        $this->refinery->container()->mapValues(
                            $this->refinery->kindlyTo()->string()
                        ),
                        $this->refinery->always([])
                    ]
                )
            );
        }
        if ($affected_items === []) {
            $this->sendAsync(
                $this->ui_factory->messageBox()->failure(
                    $this->lng->txt('no_checkbox')
                )
            );
        }
 
        return $affected_items;
    }

References ILIAS\FileDelivery\http().

Here is the call graph for this function:

retrieveAffectedItemsFromQueryForDeletion()

ILIAS\ILIASObject\Properties\Translations\TranslationsTable::retrieveAffectedItemsFromQueryForDeletion ( )

private

Definition at line 332 of file TranslationsTable.php.

                                                                : array
    {
        $affected_items = $this->retrieveAffectedItemsFromQuery();
        if (in_array($this->translations->getDefaultLanguage(), $affected_items)
            || in_array($this->translations->getBaseLanguage(), $affected_items)) {
            $this->sendAsync(
                $this->ui_factory->messageBox()->failure(
                    $this->lng->txt('default_base_lang_not_deletable')
                )
            );
        }
        return $affected_items;
    }

runAction()

ILIAS\ILIASObject\Properties\Translations\TranslationsTable::runAction

(

)

Definition at line 88 of file TranslationsTable.php.

                               : void
    {
        $action = $this->http->wrapper()->query()->retrieve(
            $this->token_action->getName(),
            $this->refinery->byTrying([
                $this->refinery->kindlyTo()->string(),
                $this->refinery->always('')
            ])
        );
 
        if ($action === '') {
            return;
        }
 
        match ($action) {
            self::ACTION_EDIT => $this->editTranslation(),
            self::ACTION_MAKE_DEFAULT => $this->makeDefault(),
            self::ACTION_DELETE => $this->deleteTranslations()
        };
    }

References ILIAS\ILIASObject\Properties\Translations\TranslationsTable\deleteTranslations(), ILIAS\ILIASObject\Properties\Translations\TranslationsTable\editTranslation(), ILIAS\FileDelivery\http(), and ILIAS\ILIASObject\Properties\Translations\TranslationsTable\makeDefault().

Here is the call graph for this function:

sendAsync()

ILIAS\ILIASObject\Properties\Translations\TranslationsTable::sendAsync ( UIComponent  $response )

private

Definition at line 373 of file TranslationsTable.php.

                                                     : void
    {
        $this->http->saveResponse(
            $this->http->response()->withBody(
                Streams::ofString(
                    $this->ui_renderer->renderAsync($response)
                )
            )
        );
        $this->http->sendResponse();
        $this->http->close();
    }

References $response, and ILIAS\FileDelivery\http().

Here is the call graph for this function:

Field Documentation

$modal_with_error

RoundtripModal ILIAS\ILIASObject\Properties\Translations\TranslationsTable::$modal_with_error = null

private

Definition at line 58 of file TranslationsTable.php.

Referenced by ILIAS\ILIASObject\Properties\Translations\TranslationsTable\getTable().

$token_action

URLBuilderToken ILIAS\ILIASObject\Properties\Translations\TranslationsTable::$token_action

private

Definition at line 54 of file TranslationsTable.php.

Referenced by ILIAS\ILIASObject\Properties\Translations\TranslationsTable\__construct().

$token_action_affected_items

URLBuilderToken ILIAS\ILIASObject\Properties\Translations\TranslationsTable::$token_action_affected_items

private

Definition at line 55 of file TranslationsTable.php.

Referenced by ILIAS\ILIASObject\Properties\Translations\TranslationsTable\__construct().

$token_row_id

URLBuilderToken ILIAS\ILIASObject\Properties\Translations\TranslationsTable::$token_row_id

private

Definition at line 56 of file TranslationsTable.php.

Referenced by ILIAS\ILIASObject\Properties\Translations\TranslationsTable\__construct().

$url_builder

URLBuilder ILIAS\ILIASObject\Properties\Translations\TranslationsTable::$url_builder

private

Definition at line 53 of file TranslationsTable.php.

Referenced by ILIAS\ILIASObject\Properties\Translations\TranslationsTable\__construct().

ACTION_DELETE

const ILIAS\ILIASObject\Properties\Translations\TranslationsTable::ACTION_DELETE = 'd'

Definition at line 51 of file TranslationsTable.php.

ACTION_EDIT

const ILIAS\ILIASObject\Properties\Translations\TranslationsTable::ACTION_EDIT = 'e'

Definition at line 49 of file TranslationsTable.php.

ACTION_MAKE_DEFAULT

const ILIAS\ILIASObject\Properties\Translations\TranslationsTable::ACTION_MAKE_DEFAULT = 'md'

Definition at line 50 of file TranslationsTable.php.

QUERY_PARAMETER_NAME_SPACE

const ILIAS\ILIASObject\Properties\Translations\TranslationsTable::QUERY_PARAMETER_NAME_SPACE = ['obj', 'trans']

private

Definition at line 44 of file TranslationsTable.php.

TOKEN_STRING_ACTION

const ILIAS\ILIASObject\Properties\Translations\TranslationsTable::TOKEN_STRING_ACTION = 'a'

private

Definition at line 45 of file TranslationsTable.php.

TOKEN_STRING_ACTON_AFFECTED_ITEMS

const ILIAS\ILIASObject\Properties\Translations\TranslationsTable::TOKEN_STRING_ACTON_AFFECTED_ITEMS = 'ai'

private

Definition at line 47 of file TranslationsTable.php.

TOKEN_STRING_ROW_ID

const ILIAS\ILIASObject\Properties\Translations\TranslationsTable::TOKEN_STRING_ROW_ID = 't'

private

Definition at line 46 of file TranslationsTable.php.

---

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

• components/ILIAS/ILIASObject/src/Properties/Translations/TranslationsTable.php