Inheritance diagram for ILIAS\User\Settings\ConfigurationGUI:

Collaboration diagram for ILIAS\User\Settings\ConfigurationGUI:

Public Member Functions
	__construct (private readonly \ILIAS\Language\Language $lng, private readonly \ilCtrl $ctrl, private readonly \ilAccess $access, private readonly \ilGlobalTemplateInterface $tpl, private readonly UIFactory $ui_factory, private readonly UIRenderer $ui_renderer, private readonly Refinery $refinery, private readonly ServerRequestInterface $request, private readonly RequestWrapper $request_wrapper, private readonly HttpService $http, private readonly Repository $user_settings_repository)

	executeCommand ()

	showCmd (?RoundTripModal $modal=null)

	actionCmd ()

	saveCmd ()

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

Private Member Functions
	buildTable ()

	getColumns ()

	buildEditModal ()

	retrieveIdentifierFromQuery ()

	sortRows (Order $order)

Private Attributes
readonly URLBuilder	$url_builder

readonly URLBuilderToken	$action_token

readonly URLBuilderToken	$setting_id_token

array	$available_settings

Detailed Description

Definition at line 43 of file class.ConfigurationGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\User\Settings\ConfigurationGUI::__construct	(	private readonly \ILIAS\Language\Language	$lng,
		private readonly \ilCtrl	$ctrl,
		private readonly \ilAccess	$access,
		private readonly \ilGlobalTemplateInterface	$tpl,
		private readonly UIFactory	$ui_factory,
		private readonly UIRenderer	$ui_renderer,
		private readonly Refinery	$refinery,
		private readonly ServerRequestInterface	$request,
		private readonly RequestWrapper	$request_wrapper,
		private readonly HttpService	$http,
		private readonly Repository	$user_settings_repository
	)

Definition at line 53 of file class.ConfigurationGUI.php.

      {
        $this->available_settings = $this->user_settings_repository->get();
 
        $url_builder = new URLBuilder(new URI(ILIAS_HTTP_PATH . '/' . $this->ctrl->getLinkTargetByClass(self::class, 'action')));
        [
            $this->url_builder,
            $this->action_token,
            $this->setting_id_token
        ] = $url_builder->acquireParameters(
            ['user', 'settings'],
            'table_action',
            'setting'
        );
    }

References ILIAS\User\Settings\ConfigurationGUI\$action_token, ILIAS\User\Settings\ConfigurationGUI\$setting_id_token, ILIAS\User\Settings\ConfigurationGUI\$url_builder, ILIAS\UI\URLBuilder\acquireParameters(), and ILIAS\Repository\ctrl().

Here is the call graph for this function:

Member Function Documentation

◆ actionCmd()

ILIAS\User\Settings\ConfigurationGUI::actionCmd ( )

Definition at line 102 of file class.ConfigurationGUI.php.

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

References ILIAS\FileDelivery\http(), and ILIAS\Filesystem\Stream\Streams\ofString().

Here is the call graph for this function:

◆ buildEditModal()

ILIAS\User\Settings\ConfigurationGUI::buildEditModal ( )

private

Definition at line 200 of file class.ConfigurationGUI.php.

                                     : RoundTripModal
    {
        $identifier = $this->retrieveIdentifierFromQuery();
        $this->ctrl->setParameterByClass(self::class, $this->setting_id_token->getName(), $identifier);
        return $this->ui_factory->modal()->roundtrip(
            $this->lng->txt('edit_setting'),
            null,
            $this->user_settings_repository->getByIdentifier(
                $identifier
            )->getForm(
                $this->lng,
                $this->ui_factory->input()->field(),
                $this->refinery
            ),
            $this->ctrl->getFormActionByClass(self::class, 'save')
        );
    }

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

Referenced by ILIAS\User\Settings\ConfigurationGUI\saveCmd().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildTable()

ILIAS\User\Settings\ConfigurationGUI::buildTable ( )

private

Definition at line 156 of file class.ConfigurationGUI.php.

                                 : DataTable
    {
        return $this->ui_factory->table()->data(
            $this,
            $this->lng->txt('user_settings'),
            $this->getColumns()
        )->withActions([
            $this->ui_factory->table()->action()->single(
                $this->lng->txt('edit_setting'),
                $this->url_builder,
                $this->setting_id_token
            )->withAsync(true)
        ])->withRequest($this->request);
    }

References ILIAS\Repository\lng().

Referenced by ILIAS\User\Settings\ConfigurationGUI\showCmd().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ILIAS\User\Settings\ConfigurationGUI::executeCommand ( )

Definition at line 80 of file class.ConfigurationGUI.php.

                                    : void
    {
        $this->redirectOnMissingWrite($this->access, $this->ctrl, $this->tpl, $this->lng);
        $cmd = $this->ctrl->getCmd() . 'Cmd';
        $this->$cmd();
    }

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

Here is the call graph for this function:

◆ getColumns()

ILIAS\User\Settings\ConfigurationGUI::getColumns ( )

private

Definition at line 171 of file class.ConfigurationGUI.php.

                                 : array
    {
        $cf = $this->ui_factory->table()->column();
        return [
            'field' => $cf->text($this->lng->txt('user_field'))->withIsSortable(true),
            'changeable_by_user' => $cf->boolean(
                $this->lng->txt(
                    PropertyAttributes::ChangeableByUser->value
                ),
                $this->ui_factory->symbol()->glyph()->checked(),
                $this->ui_factory->symbol()->glyph()->unchecked()
            )->withIsSortable(true),
            'changeable_in_local_user_administration' => $cf->boolean(
                $this->lng->txt(
                    PropertyAttributes::ChangeableInLocalUserAdministration->value
                ),
                $this->ui_factory->symbol()->glyph()->checked(),
                $this->ui_factory->symbol()->glyph()->unchecked()
            )->withIsSortable(true),
            'export' => $cf->boolean(
                $this->lng->txt(
                    PropertyAttributes::Export->value
                ),
                $this->ui_factory->symbol()->glyph()->checked(),
                $this->ui_factory->symbol()->glyph()->unchecked()
            )->withIsSortable(true)
        ];
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

◆ getRows()

ILIAS\User\Settings\ConfigurationGUI::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 132 of file class.ConfigurationGUI.php.

     : \Generator {
        $this->sortRows($order);
        foreach ($this->available_settings as $setting) {
            yield $setting->getTableRow(
                $row_builder,
                $this->lng
            );
        }
    }

References ILIAS\$setting, and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ getTotalRowCount()

ILIAS\User\Settings\ConfigurationGUI::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 149 of file class.ConfigurationGUI.php.

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

◆ retrieveIdentifierFromQuery()

ILIAS\User\Settings\ConfigurationGUI::retrieveIdentifierFromQuery ( )

private

Definition at line 218 of file class.ConfigurationGUI.php.

                                                  : string
    {
        $identifier = $this->request_wrapper->retrieve(
            $this->setting_id_token->getName(),
            $this->refinery->byTrying([
                $this->refinery->kindlyTo()->string(),
                $this->refinery->kindlyTo()->listOf(
                    $this->refinery->kindlyTo()->string()
                )
            ])
        );
 
        if (is_array($identifier)) {
            return $identifier[0];
        }
        return $identifier;
    }

◆ saveCmd()

ILIAS\User\Settings\ConfigurationGUI::saveCmd ( )

Definition at line 115 of file class.ConfigurationGUI.php.

                             : void
    {
        $modal = $this->buildEditModal()->withRequest($this->request);
        $data = $modal->getData();
        if ($data === null) {
            $this->showCmd(
                $modal->withOnLoad($modal->getShowSignal())
            );
            return;
        }
 
        $this->user_settings_repository->storeConfiguration($data['setting']);
        $this->available_settings = $this->user_settings_repository->get();
        $this->tpl->setOnScreenMessage('success', $this->lng->txt('usr_settings_saved'));
        $this->showCmd();
    }

References $data, ILIAS\User\Settings\ConfigurationGUI\buildEditModal(), ILIAS\Repository\lng(), and ILIAS\User\Settings\ConfigurationGUI\showCmd().

Here is the call graph for this function:

◆ showCmd()

ILIAS\User\Settings\ConfigurationGUI::showCmd ( ?RoundTripModal $modal = null )

Definition at line 87 of file class.ConfigurationGUI.php.

                                                          : void
    {
        $content = [
            $this->buildTable()
        ];
 
        if ($modal !== null) {
            $content[] = $modal;
        }
 
        $this->tpl->setContent(
            $this->ui_renderer->render($content)
        );
    }

References ILIAS\User\Settings\ConfigurationGUI\buildTable().

Referenced by ILIAS\User\Settings\ConfigurationGUI\saveCmd().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sortRows()

ILIAS\User\Settings\ConfigurationGUI::sortRows ( Order $order )

private

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

                                           : void
    {
        $order_array = $order->get();
        $key = array_key_first($order_array);
        $factor = array_shift($order_array) === 'ASC' ? 1 : -1;
        if ($key === 'field') {
            usort(
                $this->available_settings,
                fn(Setting $v1, Setting $v2): int =>
                    $factor * ($v1->getLabel($this->lng) <=> $v2->getLabel($this->lng))
            );
        }
 
        if ($key === 'export') {
            usort(
                $this->available_settings,
                fn(Setting $v1, Setting $v2): int =>
                    $factor * ($v1->export() <=> $v2->export())
            );
        }
 
        if ($key === 'changeable_by_user') {
            usort(
                $this->available_settings,
                fn(Setting $v1, Setting $v2): int =>
                    $factor * ($v1->isChangeableByUser() <=> $v2->isChangeableByUser())
            );
        }
 
        if ($key === 'changeable_in_local_user_administration') {
            usort(
                $this->available_settings,
                fn(Setting $v1, Setting $v2): int =>
                    $factor * ($v1->isChangeableInLocalUserAdministration() <=> $v2->isChangeableInLocalUserAdministration())
            );
        }
    }

References ILIAS\User\Settings\Setting\export(), ILIAS\Data\Order\get(), ILIAS\User\Settings\Setting\getLabel(), ILIAS\User\Settings\Setting\isChangeableByUser(), and ILIAS\User\Settings\Setting\isChangeableInLocalUserAdministration().

Here is the call graph for this function:

Field Documentation

◆ $action_token

readonly URLBuilderToken ILIAS\User\Settings\ConfigurationGUI::$action_token

private

Definition at line 48 of file class.ConfigurationGUI.php.

Referenced by ILIAS\User\Settings\ConfigurationGUI\__construct().

◆ $available_settings

array ILIAS\User\Settings\ConfigurationGUI::$available_settings

private

Definition at line 51 of file class.ConfigurationGUI.php.

◆ $setting_id_token

readonly URLBuilderToken ILIAS\User\Settings\ConfigurationGUI::$setting_id_token

private

Definition at line 49 of file class.ConfigurationGUI.php.

Referenced by ILIAS\User\Settings\ConfigurationGUI\__construct().

◆ $url_builder

readonly URLBuilder ILIAS\User\Settings\ConfigurationGUI::$url_builder

private

Definition at line 47 of file class.ConfigurationGUI.php.

Referenced by ILIAS\User\Settings\ConfigurationGUI\__construct().

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

components/ILIAS/User/src/Settings/class.ConfigurationGUI.php

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ actionCmd()

◆ buildEditModal()

◆ buildTable()

◆ executeCommand()

◆ getColumns()

◆ getRows()

◆ getTotalRowCount()

◆ retrieveIdentifierFromQuery()

◆ saveCmd()

◆ showCmd()

◆ sortRows()

Field Documentation

◆ $action_token

◆ $available_settings

◆ $setting_id_token

◆ $url_builder