ilPRGUserInformation Class Reference

Additional information about a user, used in context of assignments. More...

Collaboration diagram for ilPRGUserInformation:

Public Member Functions
	__construct (protected array $user_data)
	getAvailableUserFields ()
	getUserData (string $field)
	getFirstname ()
	getLastname ()
	isActive ()
	getEmail ()
	getLogin ()
	getOrguRepresentation ()
	getFullname ()
	getGender ()
	getTitle ()

Data Fields
const	MANDATORY_FIELDS

Detailed Description

Additional information about a user, used in context of assignments.

Definition at line 24 of file ilPRGUserInformation.php.

Constructor & Destructor Documentation

__construct()

ilPRGUserInformation::__construct

(

protected array

$user_data

)

Definition at line 37 of file ilPRGUserInformation.php.

      {
    }

Member Function Documentation

getAvailableUserFields()

ilPRGUserInformation::getAvailableUserFields

(

)

Definition at line 42 of file ilPRGUserInformation.php.

                                            : array
    {
        return array_keys($this->user_data);
    }

getEmail()

ilPRGUserInformation::getEmail

(

)

Definition at line 64 of file ilPRGUserInformation.php.

                              : string
    {
        return $this->user_data['email'];
    }

getFirstname()

ilPRGUserInformation::getFirstname

(

)

Definition at line 52 of file ilPRGUserInformation.php.

                                  : string
    {
        return $this->user_data['firstname'];
    }

getFullname()

ilPRGUserInformation::getFullname

(

)

Definition at line 76 of file ilPRGUserInformation.php.

                                 : string
    {
        return $this->user_data['lastname'] . ', ' . $this->user_data['firstname'];
    }

getGender()

ilPRGUserInformation::getGender

(

)

Definition at line 80 of file ilPRGUserInformation.php.

                               : string
    {
        return $this->user_data['gender'];
    }

getLastname()

ilPRGUserInformation::getLastname

(

)

Definition at line 56 of file ilPRGUserInformation.php.

                                 : string
    {
        return $this->user_data['lastname'];
    }

getLogin()

ilPRGUserInformation::getLogin

(

)

Definition at line 68 of file ilPRGUserInformation.php.

                              : string
    {
        return $this->user_data['login'];
    }

getOrguRepresentation()

ilPRGUserInformation::getOrguRepresentation

(

)

Definition at line 72 of file ilPRGUserInformation.php.

                                           : string
    {
        return $this->user_data['org_units'];
    }

getTitle()

ilPRGUserInformation::getTitle

(

)

Definition at line 84 of file ilPRGUserInformation.php.

                              : string
    {
        return $this->user_data['title'];
    }

getUserData()

ilPRGUserInformation::getUserData

(

string

$field

)

Definition at line 47 of file ilPRGUserInformation.php.

    {
        return $this->user_data[$field];
    }

isActive()

ilPRGUserInformation::isActive

(

)

Definition at line 60 of file ilPRGUserInformation.php.

                              : bool
    {
        return (bool)$this->user_data['active'];
    }

Field Documentation

MANDATORY_FIELDS

const ilPRGUserInformation::MANDATORY_FIELDS

Initial value:

= [
        'firstname',
        'lastname',
        'login',
        'active',
        'email',
        'gender',
        'title',
        'org_units',
    ]

Definition at line 26 of file ilPRGUserInformation.php.

Referenced by ilPRGAssignmentDBRepository\__construct().

---

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

• Modules/StudyProgramme/classes/model/Assignments/ilPRGUserInformation.php