ILIAS\User Class Reference

Inheritance diagram for ILIAS\User:

Collaboration diagram for ILIAS\User:

Public Types
enum	Context { isFieldVisible }
enum	PropertyAttributes : string { getSettingsAccessPrefix }

Public Member Functions
	init (array|\ArrayAccess &$define, array|\ArrayAccess &$implement, array|\ArrayAccess &$use, array|\ArrayAccess &$contribute, array|\ArrayAccess &$seek, array|\ArrayAccess &$provide, array|\ArrayAccess &$pull, array|\ArrayAccess &$internal,)
	init (array|\ArrayAccess &$define, array|\ArrayAccess &$implement, array|\ArrayAccess &$use, array|\ArrayAccess &$contribute, array|\ArrayAccess &$seek, array|\ArrayAccess &$provide, array|\ArrayAccess &$pull, array|\ArrayAccess &$internal,)

Detailed Description

Definition at line 33 of file User.php.

Member Enumeration Documentation

Context

enum ILIAS::User::Context

Enumerator
isFieldVisible

Definition at line 26 of file Context.php.

{
    case Registration;
    case User;
    case UserAdministration;
    case LocalUserAdministration;
    case Certificate;
    case Course;
    case Group;
    case LearningSequence;
    case StudyProgramme;
    case Search;
    case Export;
 
    public function isFieldVisible(
        Field $field,
        ?\ilObjUser $user
    ): bool {
        return match($this) {
            self::Registration => $field->isVisibleInRegistration(),
            self::User => $field->isVisibleToUser()
                || $field->isRequired() && ($user === null || empty($field->retrieveValueFromUser($user))),
            self::LocalUserAdministration => $field->isVisibleInLocalUserAdministration()
                || $field->isRequired() && ($user === null || empty($field->retrieveValueFromUser($user))),
            self::Certificate => $field->isAvailableInCertificates(),
            self::Course => $field->isVisibleInCourses(),
            self::Group => $field->isVisibleInGroups(),
            self::StudyProgramme => $field->isVisibleInStudyProgrammes(),
            self::Search => $field->isSearchable(),
            self::Export => $field->export(),
            self::UserAdministration => true,
            default => false
        };
    }
 
    public function isFieldChangeable(
        Field $field,
        ?\ilObjUser $user
    ): bool {
        return match($this) {
            self::Registration => $field->isVisibleInRegistration(),
            self::User => $field->isChangeableByUser()
                || $field->isRequired() && ($user === null || empty($field->retrieveValueFromUser($user))),
            self::LocalUserAdministration => $field->isChangeableInLocalUserAdministration()
                || $field->isRequired() && ($user === null || empty($field->retrieveValueFromUser($user))),
            self::UserAdministration => true,
            default => false
        };
    }
 
    public function isSettingAvailable(
        Setting $setting
    ): bool {
        return match($this) {
            self::UserAdministration => true,
            self::LocalUserAdministration => $setting->isChangeableInLocalUserAdministration(),
            self::User => $setting->isChangeableByUser(),
            self::Export => $setting->export(),
            default => false
        };
    }
 
    public static function buildFromObjectType(string $type): ?self
    {
        return match($type) {
            'crs' => self::Course,
            'grp' => self::Group,
            'prg' => self::StudyProgramme,
            'lso' => self::LearningSequence,
            default => null
        };
    }
}

PropertyAttributes

enum ILIAS::User::PropertyAttributes : string

Enumerator
getSettingsAccessPrefix

Definition at line 21 of file PropertyAttributes.php.

{
    private const string SETTINGS_ACCESS_PREFIX_CHANGEABLE_BY_USER = 'usr_settings_changeable_by_user';
    private const string SETTINGS_ACCESS_PREFIX_CHANGEABLE_IN_LUA = 'usr_settings_changeable_lua';
    private const string SETTINGS_ACCESS_PREFIX_EXPORT = 'usr_settings_export';
 
    case VisibleInRegistration = 'header_visible_registration';
    case VisibleToUser = 'user_visible_in_profile';
    case VisibleInLocalUserAdministration = 'usr_settings_visib_lua';
    case VisibleInCourses = 'course_export';
    case VisibleInGroups = 'group_export';
    case VisibleInStudyProgrammes = 'prg_export';
    case ChangeableByUser = 'changeable';
    case ChangeableInLocalUserAdministration = 'usr_settings_changeable_lua';
    case Required = 'required_field';
    case Export = 'export';
    case Searchable = 'header_searchable';
    case AvailableInCertificates = 'certificate';
 
    public function getSettingsAccessPrefix(): string
    {
        return match($this) {
            self::ChangeableByUser => self::SETTINGS_ACCESS_PREFIX_CHANGEABLE_BY_USER,
            self::ChangeableInLocalUserAdministration => self::SETTINGS_ACCESS_PREFIX_CHANGEABLE_IN_LUA,
            self::Export => self::SETTINGS_ACCESS_PREFIX_EXPORT,
            default => throw new \Exception('Not a valid setting!')
        };
    }
}

Member Function Documentation

init()

ILIAS\User::init	(	array|\ArrayAccess &	$define,
		array|\ArrayAccess &	$implement,
		array|\ArrayAccess &	$use,
		array|\ArrayAccess &	$contribute,
		array|\ArrayAccess &	$seek,
		array|\ArrayAccess &	$provide,
		array|\ArrayAccess &	$pull,
		array|\ArrayAccess &	$internal
	)

Implements ILIAS\Component\Component.

Definition at line 35 of file User.php.

     : void {
        $contribute[SetupAgent::class] = fn() =>
            new Agent(
                $seek[UserSettings::class],
                $seek[CustomProfileFieldType::class],
                $seek[UserFieldAttributesChangeListener::class]
            );
        $contribute[UserSettings::class] = fn() =>
            new SettingsOfUser();
        $contribute[CustomProfileFieldType::class] = fn() =>
            new CustomTypeText();
        $contribute[CustomProfileFieldType::class] = fn() =>
            new CustomTypeTextArea();
        $contribute[CustomProfileFieldType::class] = fn() =>
            new CustomTypeSelect();
    }

---

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

• components/ILIAS/User/User.php
• components/ILIAS/User/src/Context.php
• components/ILIAS/User/src/PropertyAttributes.php