FirstName.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
namespace ILIAS\User\Profile\Fields\Standard;
 
use ILIAS\User\Context;
use ILIAS\User\Profile\Fields\NoOverrides;
use ILIAS\User\Profile\Fields\FieldDefinition;
use ILIAS\User\Profile\Fields\AvailableSections;
use ILIAS\Language\Language;
 
class FirstName implements FieldDefinition
{
    use NoOverrides;
 
    public function getIdentifier(): string
    {
        return 'firstname';
    }
 
    public function getLabel(Language $lng): string
    {
        return $lng->txt($this->getIdentifier());
    }
 
    public function getSection(): AvailableSections
    {
        return AvailableSections::PersonalData;
    }
 
    public function visibleInRegistrationForcedTo(): ?bool
    {
        return true;
    }
 
    public function visibleToUserForcedTo(): ?bool
    {
        return true;
    }
 
    public function visibleInLocalUserAdministrationForcedTo(): ?bool
    {
        return true;
    }
 
    public function visibleInCoursesForcedTo(): ?bool
    {
        return true;
    }
 
    public function visibleInGroupsForcedTo(): ?bool
    {
        return true;
    }
 
    public function visibleInStudyProgrammesForcedTo(): ?bool
    {
        return true;
    }
 
    public function requiredForcedTo(): ?bool
    {
        return true;
    }
 
    public function availableInCertificatesForcedTo(): ?bool
    {
        return true;
    }
 
    public function getLegacyInput(
        Language $lng,
        Context $context,
        ?\ilObjUser $user = null
    ): \ilFormPropertyGUI {
        $input = new \ilTextInputGUI($this->getLabel($lng));
        $input->setMaxLength(128);
        if ($user === null) {
            return $input;
        }
        $input->setValue(
            $this->retrieveValueFromUser($user)
        );
        return $input;
    }
 
    public function addValueToUserObject(
        \ilObjUser $user,
        mixed $input,
        ?\ilPropertyFormGUI $form = null
    ): \ilObjUser {
        $user->setFirstname($input);
        return $user;
    }
 
    public function retrieveValueFromUser(\ilObjUser $user): string
    {
        return $user->getFirstname();
    }
}