ILIAS\User\Profile\Fields\Field Class Reference

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

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

Public Member Functions
	__construct (private FieldDefinition $definition, private bool $visible_in_registration=false, private bool $visible_to_user=false, private bool $visible_in_local_user_administration=false, private bool $visible_in_courses=false, private bool $visible_in_groups=false, private bool $visible_in_study_programmes=false, private bool $changeable_by_user=false, private bool $changeable_in_local_user_administration=false, private bool $required=false, private bool $export=false, private bool $searchable=false, private bool $available_in_certificates=false)
	getIdentifier ()
	getDefinition ()
	getLabel (Language $lng)
	isCustom ()
	hiddenInLists ()
	isVisibleInRegistration ()
	isVisibleToUser ()
	isVisibleInLocalUserAdministration ()
	isVisibleInCourses ()
	isVisibleInGroups ()
	isVisibleInStudyProgrammes ()
	isChangeableByUser ()
	isChangeableInLocalUserAdministration ()
	isRequired ()
	export ()
	isSearchable ()
	isAvailableInCertificates ()
	getSection ()
	getTableRow (DataRowBuilder $row_builder, Language $lng, UIFactory $ui_factory, UIRenderer $ui_renderer)
	getEditForm (Language $lng, FieldFactory $ff, Refinery $refinery, array $custom_field_types, array $available_custom_fields)
	getHiddenForm (Language $lng, FieldFactory $ff, Refinery $refinery, array $custom_field_types, array $available_custom_fields)
	getCreateCustomFieldForm (Language $lng, FieldFactory $ff, Refinery $refinery, array $custom_field_types, array $available_custom_fields)
	getChangedAttributes (self $new_field)
	retrieveValueByPropertyAttribute (PropertyAttributes $attribute)
	getLegacyInput (Language $lng, Context $context, ?\ilObjUser $user=null)
	addValueToUserObject (\ilObjUser $user, Context $context, mixed $input, ?\ilPropertyFormGUI $form=null)
	retrieveValueFromUser (\ilObjUser $user)
	setPublishedOnUser (\ilObjUser $user, bool $value)
	isPublishedByUser (\ilObjUser $user)
	getIdentifier ()
	getLabel (Language $lng)
	getSection ()
	retrieveValueFromUser (\ilObjUser $user)

Private Member Functions
	buildAccessibilityListing (Language $lng, UIFactory $ui_factory)
	getCustomFieldInputs (Language $lng, FieldFactory $ff, Refinery $refinery, array $available_custom_fields)
	getBaseInputs (Language $lng, FieldFactory $ff, Refinery $refinery)
	getHiddenCustomFieldInputs (Language $lng, FieldFactory $ff, Refinery $refinery, array $available_custom_fields)
	getHiddenBaseInputs (FieldFactory $ff, Refinery $refinery)
	buildCustomTypeSelectionGroups (Language $lng, FieldFactory $ff, Refinery $refinery, array $custom_field_types)
	buildLabelConstraint (Language $lng, Refinery $refinery, array $available_custom_fields)
	buildRequiredMustByVisibleInRegistrationConstraint (Language $lng, Refinery $refinery)
	buildCreateFieldTransformation (Refinery $refinery, array $custom_field_types)

Detailed Description

Definition at line 44 of file Field.php.

Constructor & Destructor Documentation

__construct()

ILIAS\User\Profile\Fields\Field::__construct	(	private FieldDefinition	$definition,
		private bool	$visible_in_registration = false,
		private bool	$visible_to_user = false,
		private bool	$visible_in_local_user_administration = false,
		private bool	$visible_in_courses = false,
		private bool	$visible_in_groups = false,
		private bool	$visible_in_study_programmes = false,
		private bool	$changeable_by_user = false,
		private bool	$changeable_in_local_user_administration = false,
		private bool	$required = false,
		private bool	$export = false,
		private bool	$searchable = false,
		private bool	$available_in_certificates = false
	)

Definition at line 46 of file Field.php.

      {
    }

Member Function Documentation

addValueToUserObject()

ILIAS\User\Profile\Fields\Field::addValueToUserObject	(	\ilObjUser	$user,
		Context	$context,
		mixed	$input,
		?\ilPropertyFormGUI	$form = null
	)

Definition at line 329 of file Field.php.

     : \ilObjUser {
        if (!$context->isFieldChangeableInType($this, $user)) {
            throw new \Exception('It is not possible to Change this from here!');
        }
        return $this->definition->addValueToUserObject($user, $input, $form);
    }

buildAccessibilityListing()

ILIAS\User\Profile\Fields\Field::buildAccessibilityListing ( Language  $lng, UIFactory  $ui_factory  )

private

Definition at line 363 of file Field.php.

     : UnorderedListing {
        $granted_accesses = [];
        if ($this->isVisibleInRegistration()) {
            $granted_accesses[] = $lng->txt(
                PropertyAttributes::VisibleInRegistration->value
            );
        }
 
        if ($this->isVisibleToUser()) {
            $granted_accesses[] = $lng->txt(
                PropertyAttributes::VisibleToUser->value
            );
        }
 
        if ($this->isVisibleInLocalUserAdministration()) {
            $granted_accesses[] = $lng->txt(
                PropertyAttributes::VisibleInLocalUserAdministration->value
            );
        }
 
        if ($this->isVisibleInCourses()) {
            $granted_accesses[] = $lng->txt(
                PropertyAttributes::VisibleInCourses->value
            );
        }
 
        if ($this->isVisibleInGroups()) {
            $granted_accesses[] = $lng->txt(
                PropertyAttributes::VisibleInGroups->value
            );
        }
 
        if ($this->isVisibleInStudyProgrammes()) {
            $granted_accesses[] = $lng->txt(
                PropertyAttributes::VisibleInStudyProgrammes->value
            );
        }
 
        if ($this->isChangeableByUser()) {
            $granted_accesses[] = $lng->txt(
                PropertyAttributes::ChangeableByUser->value
            );
        }
 
        if ($this->isChangeableInLocalUserAdministration()) {
            $granted_accesses[] = $lng->txt(
                PropertyAttributes::ChangeableInLocalUserAdministration->value
            );
        }
 
        return $ui_factory->listing()->unordered($granted_accesses);
    }

References $lng.

buildCreateFieldTransformation()

ILIAS\User\Profile\Fields\Field::buildCreateFieldTransformation ( Refinery  $refinery, array  $custom_field_types  )

private

Definition at line 647 of file Field.php.

     : Transformation {
        $cts = array_map(
            static fn(CustomType $v): string => $v::class,
            $custom_field_types
        );
        return $refinery->custom()->transformation(
            function (array $vs) use ($cts, $custom_field_types): self {
                $access = $vs['configuration']['access'];
                $settings = $vs['configuration']['settings'];
                $clone = clone $this;
                $clone->visible_in_registration = $this->definition->requiredForcedTo() === true
                    ? true
                    : $access['visible_in_registration'];
                $clone->visible_to_user = $this->definition->visibleToUserForcedTo()
                    ?? $access['visible_in_personal_data'];
                $clone->visible_in_local_user_administration = $this->definition->visibleInLocalUserAdministrationForcedTo()
                    ?? $access['visible_in_local_user_administration'];
                $clone->visible_in_courses = $this->definition->visibleInCoursesForcedTo()
                    ?? $access['visible_in_courses'];
                $clone->visible_in_groups = $this->definition->visibleInGroupsForcedTo()
                    ?? $access['visible_in_groups'];
                $clone->visible_in_study_programmes = $this->definition->visibleInStudyProgrammesForcedTo()
                    ?? $access['visible_in_study_programmes'];
                $clone->changeable_by_user = $this->definition->changeableByUserForcedTo()
                    ?? $access['changeable_by_user'];
                $clone->changeable_in_local_user_administration = $this->definition->changeableInLocalUserAdministrationForcedTo()
                    ?? $access['changeable_in_local_user_administration'];
                $clone->required = $this->definition->requiredForcedTo()
                    ?? $settings['required'];
                $clone->export = $this->definition->exportForcedTo()
                    ?? $settings['export'];
                $clone->searchable = $this->definition->searchableForcedTo()
                    ?? $settings['searchable'];
                $clone->available_in_certificates = $this->definition->availableInCertificatesForcedTo()
                    ?? $settings['available_in_certificates'];
 
                if (!$clone->isCustom()) {
                    return $clone;
                }
 
                $definition = clone $this->definition
                    ->withLabel($vs['edit_field']['label'])
                    ->withSection(AvailableSections::tryFrom($vs['edit_field']['section']))
                    ->withAdditionalEditFormData(
                        $vs['edit_field']['data']
                            ?? $vs['edit_field']['type'][1]['data']
                            ?? null
                    );
                if ($definition->isUnspecific()
                    && ($field_type = array_search($vs['edit_field']['type'][0], $cts)) !== false) {
                    $definition = $definition->withType($custom_field_types[$field_type]);
                }
                $clone->definition = $definition;
                return $clone;
            }
        );
    }

References if.

buildCustomTypeSelectionGroups()

ILIAS\User\Profile\Fields\Field::buildCustomTypeSelectionGroups ( Language  $lng, FieldFactory  $ff, Refinery  $refinery, array  $custom_field_types  )

private

Definition at line 602 of file Field.php.

     : array {
        return array_reduce(
            $custom_field_types,
            function (array $c, Custom\Type $v) use ($lng, $ff, $refinery): array {
                $edit_inputs = $v->getAdditionalEditFormInputs($lng, $ff, $refinery, null);
                $c[$v::class] = $ff->group(
                    $edit_inputs === null ? [] : ['data' => $edit_inputs],
                    $v->getLabel($lng)
                );
                return $c;
            },
            []
        );
    }

buildLabelConstraint()

ILIAS\User\Profile\Fields\Field::buildLabelConstraint ( Language  $lng, Refinery  $refinery, array  $available_custom_fields  )

private

Definition at line 622 of file Field.php.

     : Constraint {
        return $refinery->custom()->constraint(
            fn(string $label): bool => array_filter(
                $available_custom_fields,
                fn(self $v) => $v->getLabel($lng) === $label
                    && $v->getIdentifier() !== $this->getIdentifier()
            ) === [],
            $lng->txt('udf_name_already_exists')
        );
    }

buildRequiredMustByVisibleInRegistrationConstraint()

ILIAS\User\Profile\Fields\Field::buildRequiredMustByVisibleInRegistrationConstraint ( Language  $lng, Refinery  $refinery  )

private

Definition at line 637 of file Field.php.

     : Constraint {
        return $refinery->custom()->constraint(
            static fn(array $vs): bool => !$vs['settings']['required'] || $vs['access']['visible_in_registration'],
            $lng->txt('invalid_visible_required_options_selected')
        );
    }

export()

ILIAS\User\Profile\Fields\Field::export

(

)

Definition at line 142 of file Field.php.

                            : bool
    {
        return $this->definition->exportForcedTo()
            ?? $this->export;
    }

Referenced by ILIAS\User\Profile\Fields\ConfigurationGUI\orderRows(), and ILIAS\User\Profile\Fields\ConfigurationRepository\storeConfiguration().

Here is the caller graph for this function:

getBaseInputs()

ILIAS\User\Profile\Fields\Field::getBaseInputs ( Language  $lng, FieldFactory  $ff, Refinery  $refinery  )

private

Definition at line 454 of file Field.php.

     : Section {
        return $ff->section(
            [
                'access' => $ff->section(
                    [
                        'visible_in_registration' => $ff->checkbox(
                            $lng->txt(PropertyAttributes::VisibleInRegistration->value)
                        )->withDisabled($this->definition->visibleInRegistrationForcedTo() !== null)
                            ->withValue($this->isVisibleInRegistration()),
                        'visible_in_personal_data' => $ff->checkbox(
                            $lng->txt(PropertyAttributes::VisibleToUser->value)
                        )->withDisabled($this->definition->visibleToUserForcedTo() !== null)
                            ->withValue($this->isVisibleToUser()),
                        'visible_in_local_user_administration' => $ff->checkbox(
                            $lng->txt(PropertyAttributes::VisibleInLocalUserAdministration->value)
                        )->withDisabled($this->definition->visibleInLocalUserAdministrationForcedTo() !== null)
                            ->withValue($this->isVisibleInLocalUserAdministration()),
                        'visible_in_courses' => $ff->checkbox(
                            $lng->txt(PropertyAttributes::VisibleInCourses->value)
                        )->withDisabled($this->definition->visibleInCoursesForcedTo() !== null)
                            ->withValue($this->isVisibleInCourses()),
                        'visible_in_groups' => $ff->checkbox(
                            $lng->txt(PropertyAttributes::VisibleInGroups->value)
                        )->withDisabled($this->definition->visibleInGroupsForcedTo() !== null)
                            ->withValue($this->isVisibleInGroups()),
                        'visible_in_study_programmes' => $ff->checkbox(
                            $lng->txt(PropertyAttributes::VisibleInStudyProgrammes->value)
                        )->withDisabled($this->definition->visibleInStudyProgrammesForcedTo() !== null)
                            ->withValue($this->isVisibleInStudyProgrammes()),
                        'changeable_by_user' => $ff->checkbox(
                            $lng->txt(PropertyAttributes::ChangeableByUser->value)
                        )->withDisabled($this->definition->changeableByUserForcedTo() !== null)
                            ->withValue($this->isChangeableByUser()),
                        'changeable_in_local_user_administration' => $ff->checkbox(
                            $lng->txt(PropertyAttributes::ChangeableInLocalUserAdministration->value)
                        )->withDisabled($this->definition->changeableInLocalUserAdministrationForcedTo() !== null)
                            ->withValue($this->isChangeableInLocalUserAdministration())
                    ],
                    $lng->txt('access')
                ),
                'settings' => $ff->section(
                    [
                        'required' => $ff->checkbox(
                            $lng->txt(PropertyAttributes::Required->value)
                        )->withDisabled($this->definition->requiredForcedTo() !== null)
                            ->withValue($this->isRequired()),
                        'export' => $ff->checkbox(
                            $lng->txt(PropertyAttributes::Export->value)
                        )->withDisabled($this->definition->exportForcedTo() !== null)
                            ->withValue($this->export()),
                        'searchable' => $ff->checkbox(
                            $lng->txt(PropertyAttributes::Searchable->value)
                        )->withDisabled($this->definition->searchableForcedTo() !== null)
                            ->withValue($this->isSearchable()),
                        'available_in_certificates' => $ff->checkbox(
                            $lng->txt(PropertyAttributes::AvailableInCertificates->value)
                        )->withDisabled($this->definition->availableInCertificatesForcedTo() !== null)
                            ->withValue($this->isAvailableInCertificates())
                    ],
                    $lng->txt('settings')
                )
            ],
            $lng->txt('configuration')
        )->withAdditionalTransformation(
            $this->buildRequiredMustByVisibleInRegistrationConstraint($lng, $refinery)
        );
    }

getChangedAttributes()

ILIAS\User\Profile\Fields\Field::getChangedAttributes

(

self

$new_field

)

Definition at line 279 of file Field.php.

                                                         : array
    {
        return array_reduce(
            PropertyAttributes::cases(),
            function (array $c, PropertyAttributes $v) use ($new_field): array {
                $old_value = $this->retrieveValueByPropertyAttribute($v);
                $new_value = $new_field->retrieveValueByPropertyAttribute($v);
                if ($old_value !== $new_value) {
                    $c[$v->value] = new ChangedUserFieldAttribute(
                        $v,
                        $old_value,
                        $new_value
                    );
                }
                return $c;
            },
            []
        );
    }

References $c.

getCreateCustomFieldForm()

ILIAS\User\Profile\Fields\Field::getCreateCustomFieldForm	(	Language	$lng,
		FieldFactory	$ff,
		Refinery	$refinery,
		array	$custom_field_types,
		array	$available_custom_fields
	)

Definition at line 234 of file Field.php.

     : array {
        return [
            'field' => $ff->group([
                'edit_field' => $ff->section(
                    [
                        'label' => $ff->text($lng->txt('field_name'))
                            ->withAdditionalTransformation(
                                $this->buildLabelConstraint($lng, $refinery, $available_custom_fields)
                            )->withRequired(true),
                        'type' => $ff->switchableGroup(
                            $this->buildCustomTypeSelectionGroups(
                                $lng,
                                $ff,
                                $refinery,
                                $custom_field_types
                            ),
                            $lng->txt('type')
                        )->withRequired(true),
                        'section' => $ff->select(
                            $lng->txt('profile_section'),
                            array_reduce(
                                AvailableSections::cases(),
                                static function (array $c, AvailableSections $v) use ($lng): array {
                                    $c[$v->value] = $lng->txt($v->value);
                                    return $c;
                                },
                                []
                            )
                        )->withRequired(true)
                    ],
                    $lng->txt('properties')
                ),
                'configuration' => $this->getBaseInputs($lng, $ff, $refinery)
            ])->withAdditionalTransformation(
                $this->buildCreateFieldTransformation($refinery, $custom_field_types)
            )
        ];
    }

getCustomFieldInputs()

ILIAS\User\Profile\Fields\Field::getCustomFieldInputs ( Language  $lng, FieldFactory  $ff, Refinery  $refinery, array  $available_custom_fields  )

private

Definition at line 419 of file Field.php.

     : array {
        return array_filter([
            'label' => $ff->text($lng->txt('field_name'))
                ->withAdditionalTransformation(
                    $this->buildLabelConstraint(
                        $lng,
                        $refinery,
                        $available_custom_fields
                    )
                )->withRequired(true)
                ->withValue($this->getLabel($lng)),
            'type' => $ff->select($lng->txt('type'), ['0' => $this->definition->getTypeLabel($lng)])
                ->withDisabled(true)
                ->withValue('0'),
            'data' => $this->definition->getAdditionalEditFormInputs($lng, $ff, $refinery),
            'section' => $ff->select(
                $lng->txt('profile_section'),
                array_reduce(
                    AvailableSections::cases(),
                    function (array $c, AvailableSections $v) use ($lng): array {
                        $c[$v->value] = $lng->txt($v->value);
                        return $c;
                    },
                    []
                )
            )->withRequired(true)
                ->withValue($this->definition->getSection()->value)
        ]);
    }

getDefinition()

ILIAS\User\Profile\Fields\Field::getDefinition

(

)

Definition at line 68 of file Field.php.

                                   : FieldDefinition
    {
        return $this->definition;
    }

Referenced by ILIAS\User\Profile\Fields\ConfigurationRepository\deleteCustomField(), and ILIAS\User\Profile\Fields\ConfigurationRepository\storeConfiguration().

Here is the caller graph for this function:

getEditForm()

ILIAS\User\Profile\Fields\Field::getEditForm	(	Language	$lng,
		FieldFactory	$ff,
		Refinery	$refinery,
		array	$custom_field_types,
		array	$available_custom_fields
	)

Definition at line 188 of file Field.php.

     : array {
        $fields = [];
        if ($this->definition instanceof CustomField) {
            $fields['edit_field'] = $ff->section(
                $this->getCustomFieldInputs($lng, $ff, $refinery, $available_custom_fields),
                $lng->txt('properties')
            );
        }
        $fields['configuration'] = $this->getBaseInputs($lng, $ff, $refinery);
        return [
            'field' => $ff->group($fields)
                ->withAdditionalTransformation(
                    $this->buildCreateFieldTransformation($refinery, $custom_field_types)
                )
        ];
    }

References $lng, and ILIAS\UI\examples\Layout\Page\Standard\$refinery.

getHiddenBaseInputs()

ILIAS\User\Profile\Fields\Field::getHiddenBaseInputs ( FieldFactory  $ff, Refinery  $refinery  )

private

Definition at line 542 of file Field.php.

     : Group {
        return $ff->group([
            'access' => $ff->group(
                [
                    'visible_in_registration' => $ff->hidden()
                        ->withDisabled($this->definition->requiredForcedTo() === true)
                        ->withAdditionalTransformation($refinery->kindlyTo()->bool())
                        ->withValue($this->isVisibleInRegistration() ? '1' : '0'),
                    'visible_in_personal_data' => $ff->hidden()
                        ->withDisabled($this->definition->visibleToUserForcedTo() !== null)
                        ->withAdditionalTransformation($refinery->kindlyTo()->bool())
                        ->withValue($this->isVisibleToUser() ? '1' : '0'),
                    'visible_in_local_user_administration' => $ff->hidden()
                        ->withDisabled($this->definition->visibleInLocalUserAdministrationForcedTo() !== null)
                        ->withAdditionalTransformation($refinery->kindlyTo()->bool())
                        ->withValue($this->isVisibleInLocalUserAdministration() ? '1' : '0'),
                    'visible_in_courses' => $ff->hidden()
                        ->withDisabled($this->definition->visibleInCoursesForcedTo() !== null)
                        ->withAdditionalTransformation($refinery->kindlyTo()->bool())
                        ->withValue($this->isVisibleInCourses() ? '1' : '0'),
                    'visible_in_groups' => $ff->hidden()
                        ->withDisabled($this->definition->visibleInGroupsForcedTo() !== null)
                        ->withAdditionalTransformation($refinery->kindlyTo()->bool())
                        ->withValue($this->isVisibleInGroups() ? '1' : '0'),
                    'visible_in_study_programmes' => $ff->hidden()
                        ->withDisabled($this->definition->visibleInStudyProgrammesForcedTo() !== null)
                        ->withAdditionalTransformation($refinery->kindlyTo()->bool())
                        ->withValue($this->isVisibleInStudyProgrammes() ? '1' : '0'),
                    'changeable_by_user' => $ff->hidden()
                        ->withDisabled($this->definition->changeableByUserForcedTo() !== null)
                        ->withAdditionalTransformation($refinery->kindlyTo()->bool())
                        ->withValue($this->isChangeableByUser() ? '1' : '0'),
                    'changeable_in_local_user_administration' => $ff->hidden()
                        ->withDisabled($this->definition->changeableInLocalUserAdministrationForcedTo() !== null)
                        ->withAdditionalTransformation($refinery->kindlyTo()->bool())
                        ->withValue($this->isChangeableInLocalUserAdministration() ? '1' : '0')
                ]
            ),
            'settings' => $ff->group(
                [
                    'required' => $ff->hidden()
                        ->withDisabled($this->definition->requiredForcedTo() !== null)
                        ->withAdditionalTransformation($refinery->kindlyTo()->bool())
                        ->withValue($this->isRequired() ? '1' : '0'),
                    'export' => $ff->hidden()
                        ->withDisabled($this->definition->exportForcedTo() !== null)
                        ->withAdditionalTransformation($refinery->kindlyTo()->bool())
                        ->withValue($this->export() ? '1' : '0'),
                    'searchable' => $ff->hidden()
                        ->withDisabled($this->definition->searchableForcedTo() !== null)
                        ->withAdditionalTransformation($refinery->kindlyTo()->bool())
                        ->withValue($this->isSearchable() ? '1' : '0'),
                ]
            )
        ]);
    }

getHiddenCustomFieldInputs()

ILIAS\User\Profile\Fields\Field::getHiddenCustomFieldInputs ( Language  $lng, FieldFactory  $ff, Refinery  $refinery, array  $available_custom_fields  )

private

Definition at line 526 of file Field.php.

     : array {
        return array_filter([
            'label' => $ff->hidden()
                ->withAdditionalTransformation(
                    $this->buildLabelConstraint($lng, $refinery, $available_custom_fields)
                )->withValue($this->getLabel($lng)),
            'data' => $ff->hidden()->withValue($this->definition->getAdditionalEditFormData()),
            'section' => $ff->hidden()->withValue($this->getSection())
        ]);
    }

getHiddenForm()

ILIAS\User\Profile\Fields\Field::getHiddenForm	(	Language	$lng,
		FieldFactory	$ff,
		Refinery	$refinery,
		array	$custom_field_types,
		array	$available_custom_fields
	)

Definition at line 211 of file Field.php.

     : array {
        $fields = [];
        if ($this->definition instanceof CustomField) {
            $fields['edit_field'] = $ff->section(
                $this->getHiddenCustomFieldInputs($lng, $ff, $refinery, $available_custom_fields),
                $lng->txt('properties')
            );
        }
        $fields['configuration'] = $this->getHiddenBaseInputs($ff, $refinery);
        return [
            'field' => $ff->group($fields)
                ->withAdditionalTransformation(
                    $this->buildCreateFieldTransformation($refinery, $custom_field_types)
                )
        ];
    }

References $lng, and ILIAS\UI\examples\Layout\Page\Standard\$refinery.

getIdentifier()

ILIAS\User\Profile\Fields\Field::getIdentifier

(

)

Implements ILIAS\User\Property.

Definition at line 63 of file Field.php.

                                   : string
    {
        return $this->definition->getIdentifier();
    }

Referenced by ILIAS\User\Profile\Fields\ConfigurationRepository\storeConfiguration().

Here is the caller graph for this function:

getLabel()

ILIAS\User\Profile\Fields\Field::getLabel

(

Language

$lng

)

Implements ILIAS\User\Property.

Definition at line 73 of file Field.php.

                                           : string
    {
        return $this->definition->getLabel($lng);
    }

References $lng.

Referenced by ilUserDefinedFieldsPlaceholderDescription\__construct(), and ILIAS\User\Profile\Fields\ConfigurationGUI\orderRows().

Here is the caller graph for this function:

getLegacyInput()

ILIAS\User\Profile\Fields\Field::getLegacyInput	(	Language	$lng,
		Context	$context,
		?\ilObjUser	$user = null
	)

Definition at line 318 of file Field.php.

     : \ilFormPropertyGUI {
        $input = $this->definition->getLegacyInput($lng, $context, $user);
        $input->setPostVar($this->definition->getIdentifier());
        $input->setRequired($this->required);
        return $input;
    }

getSection()

ILIAS\User\Profile\Fields\Field::getSection

(

)

Implements ILIAS\User\Property.

Definition at line 160 of file Field.php.

                                : AvailableSections
    {
        return $this->definition->getSection();
    }

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

Here is the caller graph for this function:

getTableRow()

ILIAS\User\Profile\Fields\Field::getTableRow	(	DataRowBuilder	$row_builder,
		Language	$lng,
		UIFactory	$ui_factory,
		UIRenderer	$ui_renderer
	)

Definition at line 165 of file Field.php.

     : DataRow {
        return $row_builder->buildDataRow(
            $this->definition->getIdentifier(),
            [
                'field' => $this->definition->getLabel($lng),
                'type' => $this->definition instanceof CustomField
                    ? "{$lng->txt('field_type_custom')}: {$this->definition->getTypeLabel($lng)}"
                    : $lng->txt('default'),
                'section' => $lng->txt($this->getSection()->value),
                'access' => $ui_renderer->render($this->buildAccessibilityListing($lng, $ui_factory)),
                'required' => $this->isRequired(),
                'export' => $this->export(),
                'searchable' => $this->isSearchable(),
                'available_in_certificates' => $this->isAvailableInCertificates()
            ]
        )->withDisabledAction('delete', !$this->isCustom());
    }

hiddenInLists()

ILIAS\User\Profile\Fields\Field::hiddenInLists

(

)

Definition at line 83 of file Field.php.

                                   : bool
    {
        return $this->definition->hiddenInLists();
    }

isAvailableInCertificates()

ILIAS\User\Profile\Fields\Field::isAvailableInCertificates

(

)

Definition at line 154 of file Field.php.

                                               : bool
    {
        return $this->definition->availableInCertificatesForcedTo()
            ?? $this->available_in_certificates;
    }

Referenced by ILIAS\User\Profile\Fields\ConfigurationGUI\orderRows(), and ILIAS\User\Profile\Fields\ConfigurationRepository\storeConfiguration().

Here is the caller graph for this function:

isChangeableByUser()

ILIAS\User\Profile\Fields\Field::isChangeableByUser

(

)

Definition at line 124 of file Field.php.

                                        : bool
    {
        return $this->definition->changeableByUserForcedTo()
            ?? $this->changeable_by_user;
    }

Referenced by ILIAS\User\Profile\Fields\ConfigurationRepository\storeConfiguration().

Here is the caller graph for this function:

isChangeableInLocalUserAdministration()

ILIAS\User\Profile\Fields\Field::isChangeableInLocalUserAdministration

(

)

Definition at line 130 of file Field.php.

                                                           : bool
    {
        return $this->definition->changeableInLocalUserAdministrationForcedTo()
            ?? $this->changeable_in_local_user_administration;
    }

Referenced by ILIAS\User\Profile\Fields\ConfigurationRepository\storeConfiguration().

Here is the caller graph for this function:

isCustom()

ILIAS\User\Profile\Fields\Field::isCustom

(

)

Definition at line 78 of file Field.php.

                              : bool
    {
        return $this->definition instanceof CustomField;
    }

Referenced by ILIAS\User\Profile\Fields\ConfigurationGUI\buildCreateModal(), ILIAS\User\Profile\Fields\ConfigurationGUI\orderRows(), and ILIAS\User\Profile\Fields\ConfigurationRepository\storeConfiguration().

Here is the caller graph for this function:

isPublishedByUser()

ILIAS\User\Profile\Fields\Field::isPublishedByUser

(

\ilObjUser

$user

)

Definition at line 357 of file Field.php.

                                                       : bool
    {
        return $this->isVisibleToUser()
            && $user->getPref("public_{$this->definition->getIdentifier()}") === 'y';
    }

References ilObjUser\getPref().

Here is the call graph for this function:

isRequired()

ILIAS\User\Profile\Fields\Field::isRequired

(

)

Definition at line 136 of file Field.php.

                                : bool
    {
        return $this->definition->requiredForcedTo()
            ?? $this->required;
    }

Referenced by ILIAS\User\Profile\Fields\ConfigurationGUI\orderRows(), and ILIAS\User\Profile\Fields\ConfigurationRepository\storeConfiguration().

Here is the caller graph for this function:

isSearchable()

ILIAS\User\Profile\Fields\Field::isSearchable

(

)

Definition at line 148 of file Field.php.

                                  : bool
    {
        return $this->definition->searchableForcedTo()
            ?? $this->searchable;
    }

Referenced by ILIAS\User\Profile\Fields\ConfigurationGUI\orderRows(), and ILIAS\User\Profile\Fields\ConfigurationRepository\storeConfiguration().

Here is the caller graph for this function:

isVisibleInCourses()

ILIAS\User\Profile\Fields\Field::isVisibleInCourses

(

)

Definition at line 106 of file Field.php.

                                        : bool
    {
        return $this->definition->visibleInCoursesForcedTo()
            ?? $this->visible_in_courses;
    }

Referenced by ILIAS\User\Profile\Fields\ConfigurationRepository\storeConfiguration().

Here is the caller graph for this function:

isVisibleInGroups()

ILIAS\User\Profile\Fields\Field::isVisibleInGroups

(

)

Definition at line 112 of file Field.php.

                                       : bool
    {
        return $this->definition->visibleInGroupsForcedTo()
            ?? $this->visible_in_groups;
    }

Referenced by ILIAS\User\Profile\Fields\ConfigurationRepository\storeConfiguration().

Here is the caller graph for this function:

isVisibleInLocalUserAdministration()

ILIAS\User\Profile\Fields\Field::isVisibleInLocalUserAdministration

(

)

Definition at line 100 of file Field.php.

                                                        : bool
    {
        return $this->definition->visibleInLocalUserAdministrationForcedTo()
            ?? $this->visible_in_local_user_administration;
    }

Referenced by ILIAS\User\Profile\Fields\ConfigurationRepository\storeConfiguration().

Here is the caller graph for this function:

isVisibleInRegistration()

ILIAS\User\Profile\Fields\Field::isVisibleInRegistration

(

)

Definition at line 88 of file Field.php.

                                             : bool
    {
        return $this->definition->visibleInRegistrationForcedTo()
            ?? $this->visible_in_registration;
    }

Referenced by ILIAS\User\Profile\Fields\ConfigurationRepository\storeConfiguration().

Here is the caller graph for this function:

isVisibleInStudyProgrammes()

ILIAS\User\Profile\Fields\Field::isVisibleInStudyProgrammes

(

)

Definition at line 118 of file Field.php.

                                                : bool
    {
        return $this->definition->visibleInStudyProgrammesForcedTo()
            ?? $this->visible_in_study_programmes;
    }

Referenced by ILIAS\User\Profile\Fields\ConfigurationRepository\storeConfiguration().

Here is the caller graph for this function:

isVisibleToUser()

ILIAS\User\Profile\Fields\Field::isVisibleToUser

(

)

Definition at line 94 of file Field.php.

                                     : bool
    {
        return $this->definition->visibleToUserForcedTo()
            ?? $this->visible_to_user;
    }

Referenced by ILIAS\User\Profile\Fields\ConfigurationRepository\storeConfiguration().

Here is the caller graph for this function:

retrieveValueByPropertyAttribute()

ILIAS\User\Profile\Fields\Field::retrieveValueByPropertyAttribute

(

PropertyAttributes

$attribute

)

Definition at line 299 of file Field.php.

     : bool {
        return match ($attribute) {
            PropertyAttributes::VisibleInRegistration => $this->isVisibleInRegistration(),
            PropertyAttributes::VisibleToUser => $this->isVisibleToUser(),
            PropertyAttributes::VisibleInLocalUserAdministration => $this->isVisibleInLocalUserAdministration(),
            PropertyAttributes::VisibleInCourses => $this->isVisibleInCourses(),
            PropertyAttributes::VisibleInGroups => $this->isVisibleInGroups(),
            PropertyAttributes::VisibleInStudyProgrammes => $this->isVisibleInStudyProgrammes(),
            PropertyAttributes::ChangeableByUser => $this->isChangeableByUser(),
            PropertyAttributes::ChangeableInLocalUserAdministration => $this->isChangeableInLocalUserAdministration(),
            PropertyAttributes::Required => $this->isRequired(),
            PropertyAttributes::Export => $this->export(),
            PropertyAttributes::Searchable => $this->isSearchable(),
            PropertyAttributes::AvailableInCertificates => $this->isAvailableInCertificates()
        };
    }

retrieveValueFromUser()

ILIAS\User\Profile\Fields\Field::retrieveValueFromUser

(

\ilObjUser

$user

)

Implements ILIAS\User\Property.

Definition at line 341 of file Field.php.

                                                           : mixed
    {
        return $this->definition->retrieveValueFromUser($user);
    }

setPublishedOnUser()

ILIAS\User\Profile\Fields\Field::setPublishedOnUser	(	\ilObjUser	$user,
		bool	$value
	)

Definition at line 346 of file Field.php.

     : \ilObjUser {
        $user->setPref(
            "public_{$this->definition->getIdentifier()}",
            $value ? 'y' : 'n'
        );
        return $user;
    }

---

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

• components/ILIAS/User/src/Profile/Fields/Field.php