ILIAS\User\Profile\Fields\ConfigurationGUI Class Reference

Inheritance diagram for ILIAS\User\Profile\Fields\ConfigurationGUI:

Collaboration diagram for ILIAS\User\Profile\Fields\ConfigurationGUI:

Public Member Functions
	__construct (private readonly Language $lng, private readonly \ilCtrl $ctrl, private readonly \ilAppEventHandler $event, private readonly \ilAccess $access, private readonly \ilToolbarGUI $toolbar, 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 RequestWrapper $post_wrapper, private readonly HttpService $http, private readonly array $available_change_listeners, private readonly ConfigurationRepository $repository)
	executeCommand ()
	showCmd (?RoundTripModal $modal=null)
	actionCmd ()
	saveCmd ()
	createCmd ()
	saveAfterListenerConfirmationCmd ()
	deleteCmd ()
	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...

Private Member Functions
	buildTable ()
	getColumns ()
	getActions ()
	orderRows (Order $order)
	buildActionModal (?string $action)
	buildEditModal (Field $field)
	buildCreateModal ()
	showChangeListenerConfirmationModal (array $listeners_to_notify, Field $new)
	buildChangeListenerConfirmationModal (array $listeners_to_notify, Field $field)
	buildDeleteConfirmationModal (Field $field)
	retrieveIdentifierFromQuery ()
	buildListingOfListeners (array $listeners_to_notify, string $field_name)
	getListenersToNotifyByChangedValues (Field $old_field, Field $new_field)
	getListenersToNotifyByInterests (Field $field, array $attributes)
	setChangedAttributesParameter (array $listeners_to_notify)
	retrieveChangedAttributesFromQuery ()
	storeField (Field $field)

Private Attributes
const string	CHANGED_ATTRIBUTES_PARAMETER = 'ca'
const string	DEFAULT_CMD = 'show'
const string	CMD_SAVE = 'save'
const string	CMD_CREATE = 'create'
const string	CMD_SAVE_AFTER_LISTENER_CONFIRMATION = 'saveAfterListenerConfirmation'
const string	CMD_DELETE = 'delete'
const string	CMD_PERFORM_TABLE_ACTION = 'action'
const string	ACTION_EDIT = 'edit'
const string	ACTION_DELETE = 'delete'
readonly URLBuilder	$url_builder
readonly URLBuilderToken	$action_token
readonly URLBuilderToken	$field_id_token
array	$available_fields

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ILIAS\User\Profile\Fields\ConfigurationGUI::__construct	(	private readonly Language	$lng,
		private readonly \ilCtrl	$ctrl,
		private readonly \ilAppEventHandler	$event,
		private readonly \ilAccess	$access,
		private readonly \ilToolbarGUI	$toolbar,
		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 RequestWrapper	$post_wrapper,
		private readonly HttpService	$http,
		private readonly array	$available_change_listeners,
		private readonly ConfigurationRepository	$repository
	)

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

      {
        $this->available_fields = $this->repository->get();
 
        $url_builder = new URLBuilder(
            new URI(
                ILIAS_HTTP_PATH . '/' . $this->ctrl->getLinkTargetByClass(
                    [\ilAdministrationGUI::class, \ilObjUserFolderGUI::class, self::class],
                    self::CMD_PERFORM_TABLE_ACTION
                )
            )
        );
        [
            $this->url_builder,
            $this->action_token,
            $this->field_id_token
        ] = $url_builder->acquireParameters(
            ['profile', 'fields'],
            'table_action',
            'field'
        );
    }

References ILIAS\User\Profile\Fields\ConfigurationGUI\$action_token, ILIAS\User\Profile\Fields\ConfigurationGUI\$field_id_token, ILIAS\User\Profile\Fields\ConfigurationGUI\$url_builder, ILIAS\UI\URLBuilder\acquireParameters(), ILIAS\Repository\ctrl(), and ILIAS\UI\examples\Deck\repository().

Here is the call graph for this function:

Member Function Documentation

actionCmd()

ILIAS\User\Profile\Fields\ConfigurationGUI::actionCmd

(

)

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

                               : void
    {
        $action = $this->request_wrapper->retrieve(
            $this->action_token->getName(),
            $this->refinery->kindlyTo()->string()
        );
        $this->http->saveResponse(
            $this->http->response()->withBody(
                Streams::ofString(
                    $this->ui_renderer->renderAsync(
                        $this->buildActionModal($action)
                    )
                )
            )
        );
        $this->http->sendResponse();
        $this->http->close();
    }

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

Here is the call graph for this function:

buildActionModal()

ILIAS\User\Profile\Fields\ConfigurationGUI::buildActionModal ( ?string  $action )

private

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

     : Modal|MessageBox {
        $field = $this->repository->getByIdentifier(
            $this->retrieveIdentifierFromQuery()
        );
        return match ($action) {
            self::ACTION_EDIT => $this->buildEditModal($field),
            self::ACTION_DELETE => $this->buildDeleteConfirmationModal($field),
            default => $this->ui_factory->messageBox()->failure(
                $this->lng->txt('msg_cancel')
            )
        };
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

buildChangeListenerConfirmationModal()

ILIAS\User\Profile\Fields\ConfigurationGUI::buildChangeListenerConfirmationModal ( array  $listeners_to_notify, Field  $field  )

private

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

     : RoundTripModal {
        return $this->ui_factory->modal()->roundtrip(
            $this->lng->txt('usr_field_change_components_listening'),
            $this->ui_factory->messageBox()->confirmation(
                $this->ui_renderer->render(
                    $this->buildListingOfListeners($listeners_to_notify, $field->getLabel($this->lng))
                )
            ),
            $field->getHiddenForm(
                $this->lng,
                $this->ui_factory->input()->field(),
                $this->refinery,
                $this->repository->getCustomFieldTypes(),
                array_filter(
                    $this->available_fields,
                    static fn(Field $v): bool => $v->isCustom()
                )
            ),
            $this->ctrl->getFormActionByClass(
                [\ilAdministrationGUI::class, \ilObjUserFolderGUI::class, self::class],
                self::CMD_SAVE_AFTER_LISTENER_CONFIRMATION
            )
        );
    }

Referenced by ILIAS\User\Profile\Fields\ConfigurationGUI\saveAfterListenerConfirmationCmd().

Here is the caller graph for this function:

buildCreateModal()

ILIAS\User\Profile\Fields\ConfigurationGUI::buildCreateModal ( )

private

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

                                       : RoundTripModal
    {
        return $this->ui_factory->modal()->roundtrip(
            $this->lng->txt('add_user_defined_field'),
            null,
            $this->repository->getUnspecifiedCustomField()->getCreateCustomFieldForm(
                $this->lng,
                $this->ui_factory->input()->field(),
                $this->refinery,
                $this->repository->getCustomFieldTypes(),
                array_filter(
                    $this->available_fields,
                    static fn(Field $v): bool => $v->isCustom()
                )
            ),
            $this->ctrl->getFormActionByClass(
                [\ilAdministrationGUI::class, \ilObjUserFolderGUI::class, self::class],
                self::CMD_CREATE
            )
        );
    }

References ILIAS\User\Profile\Fields\Field\isCustom(), and ILIAS\Repository\lng().

Referenced by ILIAS\User\Profile\Fields\ConfigurationGUI\createCmd(), and ILIAS\User\Profile\Fields\ConfigurationGUI\showCmd().

Here is the call graph for this function:

Here is the caller graph for this function:

buildDeleteConfirmationModal()

ILIAS\User\Profile\Fields\ConfigurationGUI::buildDeleteConfirmationModal ( Field  $field )

private

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

     : InterruptiveModal {
        return $this->ui_factory->modal()->interruptive(
            $this->lng->txt('confirm'),
            $this->lng->txt('udf_delete_sure'),
            $this->ctrl->getFormActionByClass(
                [\ilAdministrationGUI::class, \ilObjUserFolderGUI::class, self::class],
                self::CMD_DELETE
            )
        )->withAffectedItems([
            $this->ui_factory->modal()->interruptiveItem()->standard(
                $field->getIdentifier(),
                $field->getLabel($this->lng)
            )
        ]);
    }

buildEditModal()

ILIAS\User\Profile\Fields\ConfigurationGUI::buildEditModal ( Field  $field )

private

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

     : RoundTripModal {
        $identifier = $this->retrieveIdentifierFromQuery();
        $this->ctrl->setParameterByClass(self::class, $this->field_id_token->getName(), $identifier);
        return $this->ui_factory->modal()->roundtrip(
            "{$this->lng->txt('edit_field')}: {$field->getLabel($this->lng)}",
            null,
            $field->getEditForm(
                $this->lng,
                $this->ui_factory->input()->field(),
                $this->refinery,
                $this->repository->getCustomFieldTypes(),
                array_filter(
                    $this->available_fields,
                    static fn(Field $v): bool => $v->isCustom()
                )
            ),
            $this->ctrl->getFormActionByClass(
                [\ilAdministrationGUI::class, \ilObjUserFolderGUI::class, self::class],
                self::CMD_SAVE
            )
        );
    }

Referenced by ILIAS\User\Profile\Fields\ConfigurationGUI\saveCmd().

Here is the caller graph for this function:

buildListingOfListeners()

ILIAS\User\Profile\Fields\ConfigurationGUI::buildListingOfListeners ( array  $listeners_to_notify, string  $field_name  )

private

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

     : DescriptiveListing {
        return $this->ui_factory->listing()->descriptive(
            array_reduce(
                $listeners_to_notify,
                function (array $c, UserFieldAttributesChangeListener $v) use ($field_name): array {
                    $c[$v->getComponentName()] = $v->getDescriptionForField(
                        $this->lng,
                        $field_name,
                        $this->lng->txt($v->isInterestedInAttribute()->value)
                    );
                    return $c;
                },
                []
            )
        );
    }

buildTable()

ILIAS\User\Profile\Fields\ConfigurationGUI::buildTable ( )

private

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

                                 : DataTable
    {
        return $this->ui_factory->table()->data(
            $this,
            $this->lng->txt('profile_fields'),
            $this->getColumns()
        )->withActions(
            $this->getActions()
        )->withRequest($this->request);
    }

References ILIAS\Repository\lng().

Referenced by ILIAS\User\Profile\Fields\ConfigurationGUI\showCmd().

Here is the call graph for this function:

Here is the caller graph for this function:

createCmd()

ILIAS\User\Profile\Fields\ConfigurationGUI::createCmd

(

)

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

                               : void
    {
        $modal = $this->buildCreateModal()->withRequest($this->request);
        $data = $modal->getData();
        if ($data === null) {
            $this->showCmd($modal->withOnLoad($modal->getShowSignal()));
            return;
        }
 
        $listeners_to_notify = $this->getListenersToNotifyByChangedValues(
            $this->repository->getUnspecifiedCustomField(),
            $data['field']
        );
 
        if ($listeners_to_notify !== []) {
            $this->showChangeListenerConfirmationModal($listeners_to_notify, $data['field']);
            return;
        }
 
        $this->storeField($data['field']);
        $this->ctrl->redirectByClass(
            [\ilAdministrationGUI::class, \ilObjUserFolderGUI::class, self::class],
            self::DEFAULT_CMD
        );
    }

References $data, ILIAS\User\Profile\Fields\ConfigurationGUI\buildCreateModal(), ILIAS\Repository\ctrl(), ILIAS\User\Profile\Fields\ConfigurationGUI\getListenersToNotifyByChangedValues(), ILIAS\UI\examples\Deck\repository(), ILIAS\User\Profile\Fields\ConfigurationGUI\showChangeListenerConfirmationModal(), ILIAS\User\Profile\Fields\ConfigurationGUI\showCmd(), and ILIAS\User\Profile\Fields\ConfigurationGUI\storeField().

Here is the call graph for this function:

deleteCmd()

ILIAS\User\Profile\Fields\ConfigurationGUI::deleteCmd

(

)

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

                               : void
    {
        $identifier = $this->post_wrapper->retrieve(
            'interruptive_items',
            $this->refinery->byTrying([
                $this->refinery->kindlyTo()->listOf(
                    $this->refinery->kindlyTo()->string()
                ),
                $this->refinery->always(null)
            ])
        );
        if ($identifier === null) {
            $this->showCmd();
        }
        $this->repository->deleteCustomField(
            $this->repository->getByIdentifier($identifier[0])
        );
        $this->available_fields = $this->repository->get();
        $this->tpl->setOnScreenMessage('success', $this->lng->txt('udf_field_deleted'), true);
        $this->ctrl->redirectByClass(
            [\ilAdministrationGUI::class, \ilObjUserFolderGUI::class, self::class],
            self::DEFAULT_CMD
        );
    }

References ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), ILIAS\UI\examples\Deck\repository(), and ILIAS\User\Profile\Fields\ConfigurationGUI\showCmd().

Here is the call graph for this function:

executeCommand()

ILIAS\User\Profile\Fields\ConfigurationGUI::executeCommand

(

)

Definition at line 108 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:

getActions()

ILIAS\User\Profile\Fields\ConfigurationGUI::getActions ( )

private

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

                                 : array
    {
        return [
            self::ACTION_EDIT => $this->ui_factory->table()->action()->single(
                $this->lng->txt('edit_field'),
                $this->url_builder->withParameter(
                    $this->action_token,
                    self::ACTION_EDIT
                ),
                $this->field_id_token
            )->withAsync(true),
            self::ACTION_DELETE => $this->ui_factory->table()->action()->single(
                $this->lng->txt('delete'),
                $this->url_builder->withParameter(
                    $this->action_token,
                    self::ACTION_DELETE
                ),
                $this->field_id_token
            )->withAsync(true)
        ];
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

getColumns()

ILIAS\User\Profile\Fields\ConfigurationGUI::getColumns ( )

private

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

                                 : array
    {
        $cf = $this->ui_factory->table()->column();
        $icon_checked = $this->ui_factory->symbol()->icon()
            ->custom('assets/images/standard/icon_checked.svg', '', 'small');
        $icon_unchecked = $this->ui_factory->symbol()->icon()
            ->custom('assets/images/standard/icon_unchecked.svg', '', 'small');
        return [
            'field' => $cf->text($this->lng->txt('user_field'))->withIsSortable(true),
            'type' => $cf->text($this->lng->txt('type'))
                ->withIsOptional(true, true)
                ->withIsSortable(true),
            'section' => $cf->text($this->lng->txt('profile_section'))
                ->withIsOptional(true, false)
                ->withIsSortable(true),
            'access' => $cf->text($this->lng->txt('access'))->withIsSortable(false),
            'required' => $cf->boolean(
                $this->lng->txt(
                    PropertyAttributes::Required->value
                ),
                $icon_checked,
                $icon_unchecked
            )->withIsSortable(true),
            'export' => $cf->boolean(
                $this->lng->txt(
                    PropertyAttributes::Export->value
                ),
                $icon_checked,
                $icon_unchecked
            )->withIsSortable(true),
            'searchable' => $cf->boolean(
                $this->lng->txt(
                    PropertyAttributes::Searchable->value
                ),
                $icon_checked,
                $icon_unchecked
            )->withIsSortable(true),
            'available_in_certificates' => $cf->boolean(
                $this->lng->txt(
                    PropertyAttributes::AvailableInCertificates->value
                ),
                $icon_checked,
                $icon_unchecked
            )->withIsSortable(true)
        ];
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

getListenersToNotifyByChangedValues()

ILIAS\User\Profile\Fields\ConfigurationGUI::getListenersToNotifyByChangedValues ( Field  $old_field, Field  $new_field  )

private

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

     : array {
        return array_reduce(
            $this->available_change_listeners,
            static function (
                array $c,
                string $listener_class
            ) use ($old_field, $new_field): array {
                $listener = new $listener_class();
                $field_definition_class = $listener->isInterestedInField();
 
                if ($old_field->getIdentifier() === (new $field_definition_class())->getIdentifier()
                    && $old_field->retrieveValueByPropertyAttribute($listener->isInterestedInAttribute())
                        !== $new_field->retrieveValueByPropertyAttribute($listener->isInterestedInAttribute())) {
                    $c[] = $listener;
                }
 
                return $c;
            },
            []
        );
    }

References $c.

Referenced by ILIAS\User\Profile\Fields\ConfigurationGUI\createCmd(), and ILIAS\User\Profile\Fields\ConfigurationGUI\saveCmd().

Here is the caller graph for this function:

getListenersToNotifyByInterests()

ILIAS\User\Profile\Fields\ConfigurationGUI::getListenersToNotifyByInterests ( Field  $field, array  $attributes  )

private

Parameters

array<PropertyAttributes>

$attribute

Returns

array<UserFieldAttributesChangeListener>

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

     : array {
        return array_reduce(
            $this->available_change_listeners,
            function (
                array $c,
                string $listener_class
            ) use ($field, $attributes): array {
                $listener = new $listener_class();
                if ($field->getIdentifier() === $this->repository->getByClass(
                    $listener->isInterestedInField()
                )->getIdentifier()
                    && in_array($listener->isInterestedInAttribute(), $attributes)) {
                    $c[] = $listener;
                }
 
                return $c;
            },
            []
        );
    }

References $c.

Referenced by ILIAS\User\Profile\Fields\ConfigurationGUI\saveAfterListenerConfirmationCmd().

Here is the caller graph for this function:

getRows()

ILIAS\User\Profile\Fields\ConfigurationGUI::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 266 of file class.ConfigurationGUI.php.

     : \Generator {
        $this->orderRows($order);
        foreach ($this->available_fields as $field) {
            yield $field->getTableRow(
                $row_builder,
                $this->lng,
                $this->ui_factory,
                $this->ui_renderer
            );
        }
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

getTotalRowCount()

ILIAS\User\Profile\Fields\ConfigurationGUI::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 286 of file class.ConfigurationGUI.php.

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

orderRows()

ILIAS\User\Profile\Fields\ConfigurationGUI::orderRows ( Order  $order )

private

Definition at line 374 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_fields,
                fn(Field $v1, Field $v2): int =>
                    $factor * ($this->lng->txt($v1->getLabel($this->lng)) <=> $this->lng->txt($v2->getLabel($this->lng)))
            );
            return;
        }
 
        if ($key === 'type') {
            usort(
                $this->available_fields,
                fn(Field $v1, Field $v2): int =>
                    $factor * ($this->lng->txt($v1->isCustom() ? 'custom' : 'default') <=> $this->lng->txt($v2->isCustom() ? 'custom' : 'default'))
            );
            return;
        }
 
        if ($key === 'section') {
            usort(
                $this->available_fields,
                fn(Field $v1, Field $v2): int =>
                    $factor * ($this->lng->txt($v1->getSection()->value) <=> $this->lng->txt($v2->getSection()->value))
            );
            return;
        }
 
        if ($key === 'export') {
            usort(
                $this->available_fields,
                fn(Field $v1, Field $v2): int =>
                    $factor * ($v1->export() <=> $v2->export())
            );
            return;
        }
 
        if ($key === 'required') {
            usort(
                $this->available_fields,
                fn(Field $v1, Field $v2): int =>
                    $factor * ($v1->isRequired() <=> $v2->isRequired())
            );
            return;
        }
 
        if ($key === 'searchable') {
            usort(
                $this->available_fields,
                fn(Field $v1, Field $v2): int =>
                    $factor * ($v1->isSearchable() <=> $v2->isSearchable())
            );
            return;
        }
 
        if ($key === 'available_in_certificates') {
            usort(
                $this->available_fields,
                fn(Field $v1, Field $v2): int =>
                    $factor * ($v1->isAvailableInCertificates() <=> $v2->isAvailableInCertificates())
            );
            return;
        }
    }

References ILIAS\User\Profile\Fields\Field\export(), ILIAS\Data\Order\get(), ILIAS\User\Profile\Fields\Field\getLabel(), ILIAS\User\Profile\Fields\Field\getSection(), ILIAS\User\Profile\Fields\Field\isAvailableInCertificates(), ILIAS\User\Profile\Fields\Field\isCustom(), ILIAS\User\Profile\Fields\Field\isRequired(), ILIAS\User\Profile\Fields\Field\isSearchable(), and ILIAS\Repository\lng().

Here is the call graph for this function:

retrieveChangedAttributesFromQuery()

ILIAS\User\Profile\Fields\ConfigurationGUI::retrieveChangedAttributesFromQuery ( )

private

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

                                                         : array
    {
        if (!$this->request_wrapper->has(self::CHANGED_ATTRIBUTES_PARAMETER)) {
            return [];
        }
 
        return $this->request_wrapper->retrieve(
            self::CHANGED_ATTRIBUTES_PARAMETER,
            $this->refinery->custom()->transformation(
                fn(string $v): array => array_reduce(
                    explode(',', $v),
                    static function (array $c, string $v): array {
                        $a = PropertyAttributes::tryFrom($v);
                        if ($a !== null) {
                            $c[] = $a;
                        }
                        return $c;
                    },
                    []
                )
            )
        );
    }

References Vendor\Package\$a, $c, and ILIAS\Repository\refinery().

Referenced by ILIAS\User\Profile\Fields\ConfigurationGUI\saveAfterListenerConfirmationCmd().

Here is the call graph for this function:

Here is the caller graph for this function:

retrieveIdentifierFromQuery()

ILIAS\User\Profile\Fields\ConfigurationGUI::retrieveIdentifierFromQuery ( )

private

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

                                                  : string
    {
        $identifier = $this->request_wrapper->retrieve(
            $this->field_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;
    }

Referenced by ILIAS\User\Profile\Fields\ConfigurationGUI\saveAfterListenerConfirmationCmd(), and ILIAS\User\Profile\Fields\ConfigurationGUI\saveCmd().

Here is the caller graph for this function:

saveAfterListenerConfirmationCmd()

ILIAS\User\Profile\Fields\ConfigurationGUI::saveAfterListenerConfirmationCmd

(

)

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

                                                      : void
    {
        $field = $this->repository->getByIdentifier(
            $this->retrieveIdentifierFromQuery()
        );
 
        $data = $this->buildChangeListenerConfirmationModal(
            $this->getListenersToNotifyByInterests(
                $field,
                $this->retrieveChangedAttributesFromQuery()
            ),
            $field,
        )->withRequest($this->request)->getData();
 
        if ($data === null || $data['field']->isRequired() && !$data['field']->isVisibleInRegistration()) {
            $this->showCmd();
            return;
        }
 
        $this->storeField($data['field']);
        $this->event->raise(
            'components/ILIAS/User',
            'onUserFieldAttributesChanged',
            $field->getChangedAttributes($data['field'])
        );
        $this->showCmd();
    }

References $data, ILIAS\User\Profile\Fields\ConfigurationGUI\buildChangeListenerConfirmationModal(), ILIAS\User\Profile\Fields\ConfigurationGUI\getListenersToNotifyByInterests(), ILIAS\UI\examples\Deck\repository(), ILIAS\User\Profile\Fields\ConfigurationGUI\retrieveChangedAttributesFromQuery(), ILIAS\User\Profile\Fields\ConfigurationGUI\retrieveIdentifierFromQuery(), ILIAS\User\Profile\Fields\ConfigurationGUI\showCmd(), and ILIAS\User\Profile\Fields\ConfigurationGUI\storeField().

Here is the call graph for this function:

saveCmd()

ILIAS\User\Profile\Fields\ConfigurationGUI::saveCmd

(

)

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

                             : void
    {
        $field = $this->repository->getByIdentifier(
            $this->retrieveIdentifierFromQuery()
        );
        $modal = $this->buildEditModal($field)->withRequest($this->request);
        $data = $modal->getData();
        if ($data === null) {
            $this->showCmd($modal->withOnLoad($modal->getShowSignal()));
            return;
        }
 
        $listeners_to_notify = $this->getListenersToNotifyByChangedValues($field, $data['field']);
        if ($listeners_to_notify !== []) {
            $this->showChangeListenerConfirmationModal($listeners_to_notify, $data['field']);
            return;
        }
 
        $this->storeField($data['field']);
        $this->ctrl->redirectByClass(
            [\ilAdministrationGUI::class, \ilObjUserFolderGUI::class, self::class],
            self::DEFAULT_CMD
        );
    }

References $data, ILIAS\User\Profile\Fields\ConfigurationGUI\buildEditModal(), ILIAS\Repository\ctrl(), ILIAS\User\Profile\Fields\ConfigurationGUI\getListenersToNotifyByChangedValues(), ILIAS\UI\examples\Deck\repository(), ILIAS\User\Profile\Fields\ConfigurationGUI\retrieveIdentifierFromQuery(), ILIAS\User\Profile\Fields\ConfigurationGUI\showChangeListenerConfirmationModal(), ILIAS\User\Profile\Fields\ConfigurationGUI\showCmd(), and ILIAS\User\Profile\Fields\ConfigurationGUI\storeField().

Here is the call graph for this function:

setChangedAttributesParameter()

ILIAS\User\Profile\Fields\ConfigurationGUI::setChangedAttributesParameter ( array  $listeners_to_notify )

private

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

                                                                              : void
    {
        $this->ctrl->setParameterByClass(
            self::class,
            self::CHANGED_ATTRIBUTES_PARAMETER,
            implode(
                ',',
                array_map(
                    fn(UserFieldAttributesChangeListener $v): string => $v->isInterestedInAttribute()->value,
                    $listeners_to_notify
                )
            )
        );
    }

References ILIAS\Repository\ctrl(), and ILIAS\User\Profile\ChangeListeners\UserFieldAttributesChangeListener\isInterestedInAttribute().

Here is the call graph for this function:

showChangeListenerConfirmationModal()

ILIAS\User\Profile\Fields\ConfigurationGUI::showChangeListenerConfirmationModal ( array  $listeners_to_notify, Field  $new  )

private

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

     : void {
        $this->setChangedAttributesParameter($listeners_to_notify);
        $modal = $this->buildChangeListenerConfirmationModal(
            $listeners_to_notify,
            $new
        );
        $this->showCmd($modal->withOnLoad($modal->getShowSignal()));
    }

Referenced by ILIAS\User\Profile\Fields\ConfigurationGUI\createCmd(), and ILIAS\User\Profile\Fields\ConfigurationGUI\saveCmd().

Here is the caller graph for this function:

showCmd()

ILIAS\User\Profile\Fields\ConfigurationGUI::showCmd

(

?RoundTripModal

$modal = null

)

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

                                                          : void
    {
        if (!$this->repository->hasMigrationBeenRun()) {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt('missing_migration'));
            return;
        }
 
        $create_modal = $this->buildCreateModal();
        $this->toolbar->addComponent(
            $this->ui_factory->button()->standard(
                $this->lng->txt('add_user_defined_field'),
                $create_modal->getShowSignal()
            )
        );
        $content = [
            $create_modal,
            $this->buildTable()
        ];
 
        if ($modal !== null) {
            $content[] = $modal;
        }
 
        $this->tpl->setContent(
            $this->ui_renderer->render($content)
        );
    }

References ILIAS\User\Profile\Fields\ConfigurationGUI\buildCreateModal(), ILIAS\User\Profile\Fields\ConfigurationGUI\buildTable(), ILIAS\Repository\lng(), ILIAS\UI\examples\Deck\repository(), and ILIAS\Repository\toolbar().

Referenced by ILIAS\User\Profile\Fields\ConfigurationGUI\createCmd(), ILIAS\User\Profile\Fields\ConfigurationGUI\deleteCmd(), ILIAS\User\Profile\Fields\ConfigurationGUI\saveAfterListenerConfirmationCmd(), and ILIAS\User\Profile\Fields\ConfigurationGUI\saveCmd().

Here is the call graph for this function:

Here is the caller graph for this function:

storeField()

ILIAS\User\Profile\Fields\ConfigurationGUI::storeField ( Field  $field )

private

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

                                             : void
    {
        $this->repository->storeConfiguration($field);
        $this->available_fields = $this->repository->get();
        \ilMemberAgreement::_reset();
        $this->tpl->setOnScreenMessage('success', $this->lng->txt('usr_settings_saved'), true);
    }

References ilMemberAgreement\_reset(), ILIAS\Repository\lng(), and ILIAS\UI\examples\Deck\repository().

Referenced by ILIAS\User\Profile\Fields\ConfigurationGUI\createCmd(), ILIAS\User\Profile\Fields\ConfigurationGUI\saveAfterListenerConfirmationCmd(), and ILIAS\User\Profile\Fields\ConfigurationGUI\saveCmd().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$action_token

readonly URLBuilderToken ILIAS\User\Profile\Fields\ConfigurationGUI::$action_token

private

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

Referenced by ILIAS\User\Profile\Fields\ConfigurationGUI\__construct().

$available_fields

array ILIAS\User\Profile\Fields\ConfigurationGUI::$available_fields

private

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

$field_id_token

readonly URLBuilderToken ILIAS\User\Profile\Fields\ConfigurationGUI::$field_id_token

private

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

Referenced by ILIAS\User\Profile\Fields\ConfigurationGUI\__construct().

$url_builder

readonly URLBuilder ILIAS\User\Profile\Fields\ConfigurationGUI::$url_builder

private

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

Referenced by ILIAS\User\Profile\Fields\ConfigurationGUI\__construct().

ACTION_DELETE

const string ILIAS\User\Profile\Fields\ConfigurationGUI::ACTION_DELETE = 'delete'

private

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

ACTION_EDIT

const string ILIAS\User\Profile\Fields\ConfigurationGUI::ACTION_EDIT = 'edit'

private

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

CHANGED_ATTRIBUTES_PARAMETER

const string ILIAS\User\Profile\Fields\ConfigurationGUI::CHANGED_ATTRIBUTES_PARAMETER = 'ca'

private

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

CMD_CREATE

const string ILIAS\User\Profile\Fields\ConfigurationGUI::CMD_CREATE = 'create'

private

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

CMD_DELETE

const string ILIAS\User\Profile\Fields\ConfigurationGUI::CMD_DELETE = 'delete'

private

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

CMD_PERFORM_TABLE_ACTION

const string ILIAS\User\Profile\Fields\ConfigurationGUI::CMD_PERFORM_TABLE_ACTION = 'action'

private

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

CMD_SAVE

const string ILIAS\User\Profile\Fields\ConfigurationGUI::CMD_SAVE = 'save'

private

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

CMD_SAVE_AFTER_LISTENER_CONFIRMATION

const string ILIAS\User\Profile\Fields\ConfigurationGUI::CMD_SAVE_AFTER_LISTENER_CONFIRMATION = 'saveAfterListenerConfirmation'

private

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

DEFAULT_CMD

const string ILIAS\User\Profile\Fields\ConfigurationGUI::DEFAULT_CMD = 'show'

private

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

---

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

• components/ILIAS/User/src/Profile/Fields/class.ConfigurationGUI.php