Inheritance diagram for ILIAS\User\Profile\ProfileImplementation:

Collaboration diagram for ILIAS\User\Profile\ProfileImplementation:

Public Member Functions
	__construct (private readonly Language $lng, private readonly FieldsConfigurationRepository $profile_fields_repository, private readonly DataRepository $profile_data_repository)

	getFields (array $sections_to_skip=[], array $fields_to_skip=[])

	getVisibleFields (Context $context, ?\ilObjUser $user=null, array $sections_to_skip=[], array $fields_to_skip=[])

	getFieldByIdentifier (string $identifier)

	getFieldByClass (string $class)

	addFieldsToForm (\ilPropertyFormGUI $form, Context $context, bool $do_require, ?\ilObjUser $user, array $fields_to_skip=[])

	addFormValuesToUser (\ilPropertyFormGUI $form, Context $context, \ilObjUser $user, array $skip_fields=[])

	getDataFor (int $usr_id)

	getDataForMultiple (array $usr_ids)

	isProfileIncomplete (\ilObjUser $user)

	userFieldVisibleToUser (string $setting_identifier)

	userFieldEditableByUser (string $setting)

	getIgnorableRequiredFields ()

	getAllUserDefinedFields ()

	getVisibleUserDefinedFields (Context $context)

	tempStorePicture (\ilPropertyFormGUI $form)

Public Member Functions inherited from ILIAS\User\Profile\Profile
	getFields (array $sections_to_skip=[], array $fields_to_skip=[])

	getVisibleFields (Context $context, ?\ilObjUser $user=null, array $sections_to_skip=[], array $fields_to_skip=[])

	getFieldByIdentifier (string $identifier)

	addFieldsToForm (\ilPropertyFormGUI $form, Context $context, bool $do_require, ?\ilObjUser $current_user, array $fields_to_skip=[])

	addFormValuesToUser (\ilPropertyFormGUI $form, Context $context, \ilObjUser $current_user)

	getDataFor (int $usr_id)

	getDataForMultiple (array $usr_ids)

	isProfileIncomplete (\ilObjUser $user)

	userFieldVisibleToUser (string $definition_class)

	userFieldEditableByUser (string $definition_class)

	getIgnorableRequiredFields ()

	getAllUserDefinedFields ()

	getVisibleUserDefinedFields (Context $context)

	tempStorePicture (\ilPropertyFormGUI $form)

Private Member Functions
	getVisibleFieldsBySection (Context $context, ?\ilObjUser $user, array $fields_to_skip=[])

	addSectionFieldsToForm (\ilPropertyFormGUI $form, Context $context, bool $do_require, ?\ilObjUser $user, array $fields)

Private Attributes
array	$user_fields

Detailed Description

Definition at line 30 of file ProfileImplementation.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\User\Profile\ProfileImplementation::__construct	(	private readonly Language	$lng,
		private readonly FieldsConfigurationRepository	$profile_fields_repository,
		private readonly DataRepository	$profile_data_repository
	)

Definition at line 37 of file ProfileImplementation.php.

      {
        $this->user_fields = $this->profile_fields_repository->get();
    }

Member Function Documentation

◆ addFieldsToForm()

ILIAS\User\Profile\ProfileImplementation::addFieldsToForm	(	\ilPropertyFormGUI	$form,
		Context	$context,
		bool	$do_require,
		?\ilObjUser	$current_user,
		array	$fields_to_skip = `[]`
	)

Parameters

list<class-string<

ILIAS\User\Profile\Fields\FieldDefinition>> $fields_to_skip

Implements ILIAS\User\Profile\Profile.

Definition at line 87 of file ProfileImplementation.php.

     : \ilPropertyFormGUI {
        return array_reduce(
            $this->getVisibleFieldsBySection($context, $user, $fields_to_skip),
            function (\ilPropertyFormGUI $c, array $v) use ($context, $user, $do_require): \ilPropertyFormGUI {
                $section_header = new \ilFormSectionHeaderGUI();
                $section_header->setTitle($this->lng->txt($v[0]->getSection()->value));
                $c->addItem($section_header);
                return $this->addSectionFieldsToForm($c, $context, $do_require, $user, $v);
            },
            $form
        );
    }

◆ addFormValuesToUser()

ILIAS\User\Profile\ProfileImplementation::addFormValuesToUser	(	\ilPropertyFormGUI	$form,
		Context	$context,
		\ilObjUser	$user,
		array	$skip_fields = `[]`
	)

Definition at line 106 of file ProfileImplementation.php.

     : \ilObjUser {
        return array_reduce(
            $this->getVisibleFields($context, $user, [], $skip_fields),
            static function (\ilObjUser $c, ProfileField $v) use ($form, $context, $user): \ilObjUser {
                if ($form->getItemByPostVar($v->getIdentifier())->getDisabled()) {
                    return $c;
                }
                return $v->addValueToUserObject(
                    $c,
                    $context,
                    $form->getInput($v->getIdentifier()),
                    $form
                );
            },
            $user
        );
    }

References $c.

◆ addSectionFieldsToForm()

ILIAS\User\Profile\ProfileImplementation::addSectionFieldsToForm	(	\ilPropertyFormGUI	$form,
		Context	$context,
		bool	$do_require,
		?\ilObjUser	$user,
		array	$fields
	)

private

Definition at line 259 of file ProfileImplementation.php.

     : \ilPropertyFormGUI {
        return array_reduce(
            $fields,
            function (\ilPropertyFormGUI $form, ProfileField $v) use ($context, $user, $do_require): \ilPropertyFormGUI {
                $input = $v->getLegacyInput($this->lng, $context, $user);
                $input->setDisabled(!$context->isFieldChangeable($v, $user));
                $input->setRequired($do_require && $input->getRequired());
                $form->addItem($input);
                return $form;
            },
            $form
        );
    }

◆ getAllUserDefinedFields()

ILIAS\User\Profile\ProfileImplementation::getAllUserDefinedFields ( )

Deprecated:: since version 11 will be removed with 13

Returns: array<string, ProfileField>

Implements ILIAS\User\Profile\Profile.

Definition at line 193 of file ProfileImplementation.php.

                                             : array
    {
        return array_reduce(
            $this->user_fields,
            static function (array $c, ProfileField $v): array {
                if ($v->isCustom()) {
                    $c[$v->getIdentifier()] = $v;
                }
                return $c;
            },
            []
        );
    }

References $c.

◆ getDataFor()

ILIAS\User\Profile\ProfileImplementation::getDataFor ( int $usr_id )

Implements ILIAS\User\Profile\Profile.

Definition at line 129 of file ProfileImplementation.php.

                                           : Data
    {
        return $this->profile_data_repository->getSingle($usr_id);
    }

◆ getDataForMultiple()

ILIAS\User\Profile\ProfileImplementation::getDataForMultiple ( array $usr_ids )

Parameters

array $usr_ids

Returns: \Generator<int, Data>

Implements ILIAS\User\Profile\Profile.

Definition at line 134 of file ProfileImplementation.php.

     : \Generator {
        return $this->profile_data_repository->getMultiple($usr_ids);
    }

◆ getFieldByClass()

ILIAS\User\Profile\ProfileImplementation::getFieldByClass ( string $class )

Definition at line 82 of file ProfileImplementation.php.

                                                  : ?ProfileField
    {
        return $this->profile_fields_repository->getByClass($class);
    }

◆ getFieldByIdentifier()

ILIAS\User\Profile\ProfileImplementation::getFieldByIdentifier ( string $identifier )

Implements ILIAS\User\Profile\Profile.

Definition at line 77 of file ProfileImplementation.php.

                                                            : ?ProfileField
    {
        return $this->profile_fields_repository->getByIdentifier($identifier);
    }

◆ getFields()

ILIAS\User\Profile\ProfileImplementation::getFields	(	array	$sections_to_skip = `[]`,
		array	$fields_to_skip = `[]`
	)

Parameters

list<

ILIAS\User\Profile\Fields\AvailableSections> $fields_to_skip

Parameters

list<class-string<

ILIAS\User\Profile\Fields\FieldDefinition>> $fields_to_skip

Returns: array<string, ProfileField>

Implements ILIAS\User\Profile\Profile.

Definition at line 45 of file ProfileImplementation.php.

     : array {
        return array_reduce(
            $this->user_fields,
            static function (array $c, ProfileField $v) use ($sections_to_skip, $fields_to_skip): array {
                if (!in_array($v->getSection(), $sections_to_skip)
                    && !in_array(get_class($v->getDefinition()), $fields_to_skip)) {
                    $c[$v->getIdentifier()] = $v;
                }
                return $c;
            },
            []
        );
    }

References $c.

◆ getIgnorableRequiredFields()

ILIAS\User\Profile\ProfileImplementation::getIgnorableRequiredFields ( )

Returns: list<ProfileField>

Implements ILIAS\User\Profile\Profile.

Definition at line 175 of file ProfileImplementation.php.

                                                : array
    {
        return array_reduce(
            $this->user_fields,
            static function (array $c, ProfileField $v): array {
                if ($v->getIdentifier() === 'username'
                    || $v->getIdentifier() === 'password'
                    || $v->isRequired()
                    || !$v->isChangeableByUser()) {
                    return $c;
                }
                $c[] = $v;
                return $c;
            },
            []
        );
    }

References $c.

◆ getVisibleFields()

ILIAS\User\Profile\ProfileImplementation::getVisibleFields	(	Context	$context,
		?\ilObjUser	$user = `null`,
		array	$sections_to_skip = `[]`,
		array	$fields_to_skip = `[]`
	)

Parameters

list<

ILIAS\User\Profile\Fields\AvailableSections> $fields_to_skip

Parameters

list<class-string<

ILIAS\User\Profile\Fields\FieldDefinition>> $fields_to_skip

Returns: array<int, ProfileField>

Implements ILIAS\User\Profile\Profile.

Definition at line 62 of file ProfileImplementation.php.

     : array {
        return array_filter(
            $this->user_fields,
            static fn(ProfileField $v) => !in_array($v->getSection(), $sections_to_skip)
                    && !in_array($v->getDefinition()::class, $fields_to_skip)
                    && $context->isFieldVisible($v, $user)
                ? true : false
        );
    }

◆ getVisibleFieldsBySection()

ILIAS\User\Profile\ProfileImplementation::getVisibleFieldsBySection	(	Context	$context,
		?\ilObjUser	$user,
		array	$fields_to_skip = `[]`
	)

private

Returns: array<value-of<AvailableSections>, array<int, ProfileField>>

Definition at line 235 of file ProfileImplementation.php.

     : array {
        return array_filter(
            array_reduce(
                $this->getVisibleFields($context, $user, [], $fields_to_skip),
                static function (array $c, ProfileField $v): array {
                    $c[$v->getSection()->value][] = $v;
                    return $c;
                },
                array_reduce(
                    AvailableProfileSections::cases(),
                    static function (array $c, AvailableProfileSections $v): array {
                        $c[$v->value] = [];
                        return $c;
                    },
                    []
                )
            )
        );
    }

◆ getVisibleUserDefinedFields()

ILIAS\User\Profile\ProfileImplementation::getVisibleUserDefinedFields ( Context $context )

Deprecated:: since version 11 will be removed with 13

Returns: array<string, ProfileField>

Implements ILIAS\User\Profile\Profile.

Definition at line 207 of file ProfileImplementation.php.

     : array {
        return array_reduce(
            $this->getVisibleFields($context),
            static function (array $c, ProfileField $v): array {
                if ($v->isCustom()) {
                    $c[$v->getIdentifier()] = $v;
                }
                return $c;
            },
            []
        );
    }

References $c.

◆ isProfileIncomplete()

ILIAS\User\Profile\ProfileImplementation::isProfileIncomplete ( \ilObjUser $user )

Implements ILIAS\User\Profile\Profile.

Definition at line 140 of file ProfileImplementation.php.

                                                         : bool
    {
        foreach ($this->user_fields as $field) {
            if (!$field->isVisibleToUser()) {
                continue;
            }
 
            if ($field->isRequired() && empty($field->retrieveValueFromUser($user))) {
                return true;
            }
        }
 
        return false;
    }

◆ tempStorePicture()

ILIAS\User\Profile\ProfileImplementation::tempStorePicture ( \ilPropertyFormGUI $form )

Deprecated:: since version 11 will be removed asap

Implements ILIAS\User\Profile\Profile.

Definition at line 225 of file ProfileImplementation.php.

     : \ilPropertyFormGUI {
        return $this->profile_fields_repository->getByClass(Fields\Standard\Avatar::class)
            ->getDefinition()->tempStorePicture($form);
    }

◆ userFieldEditableByUser()

ILIAS\User\Profile\ProfileImplementation::userFieldEditableByUser ( string $setting )

Implements ILIAS\User\Profile\Profile.

Definition at line 166 of file ProfileImplementation.php.

                                                            : bool
    {
        $field = $this->profile_fields_repository->getByIdentifier($setting);
        if ($field === null) {
            return false;
        }
        return $field->isVisibleToUser() && $field->isChangeableByUser();
    }

◆ userFieldVisibleToUser()

ILIAS\User\Profile\ProfileImplementation::userFieldVisibleToUser ( string $setting_identifier )

Implements ILIAS\User\Profile\Profile.

Definition at line 155 of file ProfileImplementation.php.

     : bool {
        $field = $this->profile_fields_repository->getByIdentifier($setting_identifier);
        if ($field === null) {
            return false;
        }
 
        return $field->isVisibleToUser();
    }

Field Documentation

◆ $user_fields

array ILIAS\User\Profile\ProfileImplementation::$user_fields

private

Definition at line 35 of file ProfileImplementation.php.

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

components/ILIAS/User/src/Profile/ProfileImplementation.php

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addFieldsToForm()

◆ addFormValuesToUser()

◆ addSectionFieldsToForm()

◆ getAllUserDefinedFields()

◆ getDataFor()

◆ getDataForMultiple()

◆ getFieldByClass()

◆ getFieldByIdentifier()

◆ getFields()

◆ getIgnorableRequiredFields()

◆ getVisibleFields()

◆ getVisibleFieldsBySection()

◆ getVisibleUserDefinedFields()

◆ isProfileIncomplete()

◆ tempStorePicture()

◆ userFieldEditableByUser()

◆ userFieldVisibleToUser()

Field Documentation

◆ $user_fields