ilECSUser Class Reference

Stores relevant user data. More...

Collaboration diagram for ilECSUser:

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

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

Protected Attributes
	$source

Detailed Description

Stores relevant user data.

Author

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

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilECSUser::__construct

(

$a_data

)

Constructor.

Parameters

mixed

ilObjUser or encoded json string public

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

References loadFromGET(), loadFromJSON(), and loadFromObject().

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

Here is the call graph for this function:

Member Function Documentation

getEmail()

ilECSUser::getEmail

(

)

get email

public

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

References $email.

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

    {
        return $this->email;
    }

Here is the caller graph for this function:

getFirstname()

ilECSUser::getFirstname

(

)

get firstname

public

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

References $firstname.

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

    {
        return $this->firstname;
    }

Here is the caller graph for this function:

getImportId()

ilECSUser::getImportId

(

)

get Email

public

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

References $uid_hash.

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

    {
        return $this->uid_hash;
    }

Here is the caller graph for this function:

getInstitution()

ilECSUser::getInstitution

(

)

get institution

public

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

References $institution.

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

    {
        return $this->institution;
    }

Here is the caller graph for this function:

getLastname()

ilECSUser::getLastname

(

)

getLastname

public

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

References $lastname.

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

    {
        return $this->lastname;
    }

Here is the caller graph for this function:

getLogin()

ilECSUser::getLogin

(

)

get login

public

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

References $login.

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

    {
        return $this->login;
    }

Here is the caller graph for this function:

loadFromGET()

ilECSUser::loadFromGET

(

)

load user data from GET parameters

public

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

References $_GET, and ilUtil\stripSlashes().

Referenced by __construct().

    {
        $this->login = ilUtil::stripSlashes(urldecode($_GET['ecs_login']));
        $this->firstname = ilUtil::stripSlashes(urldecode($_GET['ecs_firstname']));
        $this->lastname = ilUtil::stripSlashes(urldecode($_GET['ecs_lastname']));
        $this->email = ilUtil::stripSlashes(urldecode($_GET['ecs_email']));
        $this->institution = ilUtil::stripSlashes(urldecode($_GET['ecs_institution']));
        
        if ($_GET['ecs_uid_hash']) {
            $this->uid_hash = ilUtil::stripSlashes(urldecode($_GET['ecs_uid_hash']));
        } elseif ($_GET['ecs_uid']) {
            $this->uid_hash = ilUtil::stripSlashes(urldecode($_GET['ecs_uid']));
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

loadFromJSON()

ilECSUser::loadFromJSON

(

)

load from json

public

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

Referenced by __construct().

    {
        $this->source = json_decode(urldecode($this->source));
        
        $this->login = $this->source->login();
        $this->firstname = $this->source->firstname();
        $this->lastname = $this->source->lastname();
        $this->email = $this->source->email();
        $this->institution = $this->source->institution();
        
        $this->uid_hash = $this->source->uid_hash;
    }

Here is the caller graph for this function:

loadFromObject()

ilECSUser::loadFromObject

(

)

load from object

public

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

References $DIC, and $ilSetting.

Referenced by __construct().

    {
        global $DIC;

        $ilSetting = $DIC['ilSetting'];
        
        $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();
        
        $this->uid_hash = 'il_' . $ilSetting->get('inst_id', 0) . '_usr_' . $this->source->getId();
    }

Here is the caller graph for this function:

toGET()

ilECSUser::toGET

(

)

get GET parameter string

public

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

    {
        return '&ecs_login=' . urlencode((string) $this->login) .
            '&ecs_firstname=' . urlencode((string) $this->firstname) .
            '&ecs_lastname=' . urlencode((string) $this->lastname) .
            '&ecs_email=' . urlencode((string) $this->email) .
            '&ecs_institution=' . urlencode((string) $this->institution) .
            '&ecs_uid_hash=' . urlencode((string) $this->uid_hash);
        '&ecs_uid=' . urlencode((string) $this->uid_hash);
    }

toJSON()

ilECSUser::toJSON

(

)

public

Parameters

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

    {
        return urlencode(json_encode($this));
    }

toREALM()

ilECSUser::toREALM

(

)

Concatenate all attributes to one string.

Returns

string

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

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

Field Documentation

$email

ilECSUser::$email

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

Referenced by getEmail().

$firstname

ilECSUser::$firstname

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

Referenced by getFirstname().

$institution

ilECSUser::$institution

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

Referenced by getInstitution().

$lastname

ilECSUser::$lastname

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

Referenced by getLastname().

$login

ilECSUser::$login

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

Referenced by getLogin().

$source

ilECSUser::$source

protected

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

$uid_hash

ilECSUser::$uid_hash

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

Referenced by getImportId().

---

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

• Services/WebServices/ECS/classes/class.ilECSUser.php