ilECSUser Class Reference

Stores relevant user data. More...

Collaboration diagram for ilECSUser:

Public Member Functions
	__construct ($a_data)
	getLogin ()
	get login More...
	getExternalAccount ()
	getFirstname ()
	get firstname More...
	getLastname ()
	getLastname More...
	getEmail ()
	get email More...
	getInstitution ()
	get institution More...
	getImportId ()
	get Email More...
	loadFromObject ()
	load from object More...
	loadFromGET ()
	load user data from GET parameters More...
	toJSON ()
	toGET (ilECSParticipantSetting $setting)
	get GET parameter string More...
	toREALM ()
	Concatenate all attributes to one string. More...

Data Fields
string	$login
string	$email
string	$firstname
string	$lastname
string	$institution
string	$uid_hash

Protected Attributes
string	$external_account = ''
string	$auth_mode = ''

Private Attributes
ilSetting	$setting
	$source

Detailed Description

Stores relevant user data.

Author

Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Definition at line 26 of file class.ilECSUser.php.

Constructor & Destructor Documentation

__construct()

ilECSUser::__construct

(

$a_data

)

Parameters

ilObjUser|array

ilObjUser or array containing user info

Definition at line 47 of file class.ilECSUser.php.

References $DIC, loadFromGET(), and loadFromObject().

    {
        global $DIC;

        $this->setting = $DIC->settings();

        $this->source = $a_data;
        if (is_object($a_data)) {
            $this->loadFromObject();
        } elseif (is_array($a_data)) {
            $this->loadFromGET();
        }
    }

Here is the call graph for this function:

Member Function Documentation

getEmail()

ilECSUser::getEmail

(

)

get email

Definition at line 95 of file class.ilECSUser.php.

References $email.

Referenced by ilAuthProviderECS\createUser(), and ilAuthProviderECS\updateUser().

                              : string
    {
        return $this->email;
    }

Here is the caller graph for this function:

getExternalAccount()

ilECSUser::getExternalAccount

(

)

Definition at line 69 of file class.ilECSUser.php.

References $external_account.

Referenced by toGET().

                                        : string
    {
        return $this->external_account;
    }

Here is the caller graph for this function:

getFirstname()

ilECSUser::getFirstname

(

)

get firstname

Definition at line 79 of file class.ilECSUser.php.

References $firstname.

Referenced by ilAuthProviderECS\createUser(), and ilAuthProviderECS\updateUser().

                                  : string
    {
        return $this->firstname;
    }

Here is the caller graph for this function:

getImportId()

ilECSUser::getImportId

(

)

get Email

Definition at line 110 of file class.ilECSUser.php.

References $uid_hash.

Referenced by ilAuthProviderECS\createUser(), and ilAuthProviderECS\updateUser().

                                 : string
    {
        return $this->uid_hash;
    }

Here is the caller graph for this function:

getInstitution()

ilECSUser::getInstitution

(

)

get institution

Definition at line 102 of file class.ilECSUser.php.

References $institution.

Referenced by ilAuthProviderECS\createUser(), and ilAuthProviderECS\updateUser().

                                    : string
    {
        return $this->institution;
    }

Here is the caller graph for this function:

getLastname()

ilECSUser::getLastname

(

)

getLastname

Definition at line 87 of file class.ilECSUser.php.

References $lastname.

Referenced by ilAuthProviderECS\createUser(), and ilAuthProviderECS\updateUser().

                                 : string
    {
        return $this->lastname;
    }

Here is the caller graph for this function:

getLogin()

ilECSUser::getLogin

(

)

get login

Definition at line 64 of file class.ilECSUser.php.

References $login.

Referenced by ilAuthProviderECS\createUser(), and toGET().

                              : string
    {
        return $this->login;
    }

Here is the caller graph for this function:

loadFromGET()

ilECSUser::loadFromGET

(

)

load user data from GET parameters

Definition at line 135 of file class.ilECSUser.php.

References ILIAS\UI\examples\Symbol\Glyph\Login\login(), and ilUtil\stripSlashes().

Referenced by __construct().

                                 : void
    {
        //TODO add proper testing for get parameters
        $this->login = ilUtil::stripSlashes(urldecode($this->source['ecs_login']));
        $this->firstname = ilUtil::stripSlashes(urldecode($this->source['ecs_firstname']));
        $this->lastname = ilUtil::stripSlashes(urldecode($this->source['ecs_lastname']));
        $this->email = ilUtil::stripSlashes(urldecode($this->source['ecs_email']));
        $this->institution = ilUtil::stripSlashes(urldecode($this->source['ecs_institution']));

        if ($this->source['ecs_uid_hash']) {
            $this->uid_hash = ilUtil::stripSlashes(urldecode($this->source['ecs_uid_hash']));
        } elseif ($this->source['ecs_uid']) {
            $this->uid_hash = ilUtil::stripSlashes(urldecode($this->source['ecs_uid']));
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

loadFromObject()

ilECSUser::loadFromObject

(

)

load from object

Definition at line 118 of file class.ilECSUser.php.

References ILIAS\UI\examples\Symbol\Glyph\Login\login().

Referenced by __construct().

                                    : void
    {
        $this->login = $this->source->getLogin();
        $this->firstname = $this->source->getFirstname();
        $this->lastname = $this->source->getLastname();
        $this->email = $this->source->getEmail();
        $this->institution = $this->source->getInstitution();
        if ($this->source instanceof ilObjUser) {
            $this->external_account = $this->source->getExternalAccount();
            $this->auth_mode = $this->source->getAuthMode();
        }
        $this->uid_hash = 'il_' . $this->setting->get('inst_id', "0") . '_usr_' . $this->source->getId();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

toGET()

ilECSUser::toGET

(

ilECSParticipantSetting

$setting

)

get GET parameter string

Definition at line 159 of file class.ilECSUser.php.

References ilECSParticipantSetting\EXTERNAL_ACCOUNT_PLACEHOLDER, getExternalAccount(), getLogin(), ilECSParticipantSetting\getOutgoingExternalAuthModes(), ilECSParticipantSetting\getOutgoingUsernamePlaceholderByAuthMode(), and ilECSParticipantSetting\LOGIN_PLACEHOLDER.

                                                           : string
    {
        $login = '';
        $external_account_info = '';

        // check for external auth mode
        $external_auth_modes = $setting->getOutgoingExternalAuthModes();
        if (in_array($this->auth_mode, $external_auth_modes)) {
            $placeholder = $setting->getOutgoingUsernamePlaceholderByAuthMode($this->auth_mode);
            if (stripos($placeholder, ilECSParticipantSetting::LOGIN_PLACEHOLDER) !== false) {
                $login = str_replace(
                    ilECSParticipantSetting::LOGIN_PLACEHOLDER,
                    $this->getLogin(),
                    $placeholder
                );
            }
            if (stripos($placeholder, ilECSParticipantSetting::EXTERNAL_ACCOUNT_PLACEHOLDER) !== false) {
                $login = str_replace(
                    ilECSParticipantSetting::EXTERNAL_ACCOUNT_PLACEHOLDER,
                    $this->getExternalAccount(),
                    $placeholder
                );
            }
            $external_account_info = '&ecs_external_account=1';
        } else {
            $login = $this->getLogin();
        }
        return '&ecs_login=' . urlencode((string) $login) .
            '&ecs_firstname=' . urlencode($this->firstname) .
            '&ecs_lastname=' . urlencode($this->lastname) .
            '&ecs_email=' . urlencode($this->email) .
            '&ecs_institution=' . urlencode($this->institution) .
            '&ecs_uid_hash=' . urlencode($this->uid_hash) .
            $external_account_info;
    }

Here is the call graph for this function:

toJSON()

ilECSUser::toJSON

(

)

Definition at line 151 of file class.ilECSUser.php.

                            : string
    {
        return urlencode(json_encode($this, JSON_THROW_ON_ERROR));
    }

toREALM()

ilECSUser::toREALM

(

)

Concatenate all attributes to one string.

Definition at line 198 of file class.ilECSUser.php.

References $uid_hash, and ILIAS\UI\examples\Symbol\Glyph\Login\login().

                             : string
    {
        return
            $this->login .
            $this->firstname .
            $this->lastname .
            $this->email .
            $this->institution .
            $this->uid_hash;
    }

Here is the call graph for this function:

Field Documentation

$auth_mode

string ilECSUser::$auth_mode = ''

protected

Definition at line 41 of file class.ilECSUser.php.

$email

string ilECSUser::$email

Definition at line 34 of file class.ilECSUser.php.

Referenced by getEmail().

$external_account

string ilECSUser::$external_account = ''

protected

Definition at line 40 of file class.ilECSUser.php.

Referenced by getExternalAccount().

$firstname

string ilECSUser::$firstname

Definition at line 35 of file class.ilECSUser.php.

Referenced by getFirstname().

$institution

string ilECSUser::$institution

Definition at line 37 of file class.ilECSUser.php.

Referenced by getInstitution().

$lastname

string ilECSUser::$lastname

Definition at line 36 of file class.ilECSUser.php.

Referenced by getLastname().

$login

string ilECSUser::$login

Definition at line 33 of file class.ilECSUser.php.

Referenced by getLogin().

$setting

ilSetting ilECSUser::$setting

private

Definition at line 28 of file class.ilECSUser.php.

$source

ilECSUser::$source

private

Definition at line 31 of file class.ilECSUser.php.

$uid_hash

string ilECSUser::$uid_hash

Definition at line 38 of file class.ilECSUser.php.

Referenced by getImportId(), and toREALM().

---

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

• components/ILIAS/WebServices/ECS/classes/class.ilECSUser.php