ilCmiXapiUser Class Reference

Collaboration diagram for ilCmiXapiUser:

Public Member Functions
	__construct ($objId=null, $usrId=null, $privacyIdent=null)
	getObjId ()
	setObjId ($objId)
	getPrivacyIdent ()
	setPrivacyIdent ($privacyIdent)
	getUsrId ()
	setUsrId ($usrId)
	getUsrIdent ()
	setUsrIdent (string $usrIdent)
	getRegistration ()
	setRegistration (string $registration)
	hasProxySuccess ()
	setProxySuccess ($proxySuccess)
	setSatisfied ($satisfied)
	getSatisfied ()
	getFetchUntil ()
	setFetchUntil (ilCmiXapiDateTime $fetchUntil)
	load ()
	assignFromDbRow ($dbRow)
	save ()

Static Public Member Functions
static	getIliasUuid ()
static	getInstancesByObjectIdAndUsrId ($objId, $usrId)
static	getInstanceByObjectIdAndUsrIdent ($objId, $usrIdent)
static	saveProxySuccess ($objId, $usrId, $privacyIdent)
static	getIdent ($userIdentMode, ilObjUser $user)
static	getIdentAsId ($userIdentMode, ilObjUser $user)
static	getName ($userNameMode, ilObjUser $user)
static	getUsersForObject ($objId, $asUsrId=false)
static	getUserIdents ($objId, $usrId)
static	deleteUsersForObject (int $objId, ?array $users=[])
static	exists ($objId, $usrId, $privacyIdent=999)
static	getCmixObjectsHavingUsersMissingProxySuccess ()
static	updateFetchedUntilForObjects (ilCmiXapiDateTime $fetchedUntil, $objectIds)
static	lookupObjectIds ($usrId, $type='')
static	getUserObjectUniqueId ($length=32)
static	getUUID ($length=32)
static	generateCMI5Registration ($objId, $usrId)
static	generateRegistration (ilObjCmiXapi $obj, ilObjUser $user)
static	getCMI5RegistrationFromAuthToken (ilCmiXapiAuthToken $authToken)
static	getRegistrationFromAuthToken (ilCmiXapiAuthToken $authToken)

Data Fields
const	DB_TABLE_NAME = 'cmix_users'

Static Protected Member Functions
static	buildPseudoEmail ($mbox, $domain)

Protected Attributes
	$objId
	$usrId
	$privacyIdent
	$proxySuccess
	$satisfied
	$fetchUntil
	$usrIdent
	$registration

Static Private Member Functions
static	userObjectUniqueIdExists ($id)

Detailed Description

Definition at line 15 of file class.ilCmiXapiUser.php.

Constructor & Destructor Documentation

__construct()

ilCmiXapiUser::__construct	(		$objId = null,
			$usrId = null,
			$privacyIdent = null
	)

Definition at line 60 of file class.ilCmiXapiUser.php.

References $objId, $privacyIdent, $usrId, IL_CAL_UNIX, and load().

    {
        $this->objId = $objId;
        $this->usrId = $usrId;
        $this->privacyIdent = $privacyIdent;
        $this->proxySuccess = false;
        $this->satisfied = false;
        $this->fetchUntil = new ilCmiXapiDateTime(0, IL_CAL_UNIX);
        $this->usrIdent = '';
        $this->registration = '';
        
        if ($objId !== null && $usrId !== null && $privacyIdent !== null) {
            $this->load();
        }
    }

Here is the call graph for this function:

Member Function Documentation

assignFromDbRow()

ilCmiXapiUser::assignFromDbRow

(

$dbRow

)

Definition at line 235 of file class.ilCmiXapiUser.php.

References IL_CAL_DATETIME, setFetchUntil(), setObjId(), setPrivacyIdent(), setProxySuccess(), setRegistration(), setSatisfied(), setUsrId(), and setUsrIdent().

Referenced by load().

    {
        $this->setObjId((int) $dbRow['obj_id']);
        $this->setUsrId((int) $dbRow['usr_id']);
        $this->setProxySuccess((bool) $dbRow['proxy_success']);
        $this->setSatisfied((bool) $dbRow['satisfied']);
        $this->setFetchUntil(new ilCmiXapiDateTime($dbRow['fetched_until'], IL_CAL_DATETIME));
        $this->setUsrIdent((string) $dbRow['usr_ident']);
        $this->setPrivacyIdent((int) $dbRow['privacy_ident']);
        $this->setRegistration((string) $dbRow['registration']);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

buildPseudoEmail()

static ilCmiXapiUser::buildPseudoEmail (   $mbox,   $domain  )

staticprotected

Parameters

string	$mbox
string	$domain

Returns

string

Definition at line 428 of file class.ilCmiXapiUser.php.

    {
        return "{$mbox}@{$domain}.ilias";
    }

deleteUsersForObject()

static ilCmiXapiUser::deleteUsersForObject ( int  $objId, ?array  $users = []  )

static

Parameters

int	$objId
	int[]	$users

Definition at line 519 of file class.ilCmiXapiUser.php.

References $DIC, and $query.

    {
        global $DIC; /* @var \ILIAS\DI\Container $DIC */
        $query = "DELETE FROM " . self::DB_TABLE_NAME . " WHERE obj_id = " . $DIC->database()->quote($objId, 'integer');
        if (count($users) == 0) {
            $DIC->database()->manipulate($query);
        } else {
            $DIC->database()->manipulateF(
                $query . " AND usr_id = %s",
                array('integer'),
                $users
            );
        }
    }

exists()

static ilCmiXapiUser::exists (   $objId,   $usrId,   $privacyIdent = 999  )

static

Definition at line 535 of file class.ilCmiXapiUser.php.

References $DIC, $objId, $privacyIdent, $query, $res, and $usrId.

Referenced by ilLPStatusCmiXapiAbstract\determineStatus(), and ilObjCmiXapiGUI\initInfoScreenToolbar().

    {
        global $DIC; /* @var \ILIAS\DI\Container $DIC */
        if ($privacyIdent == 999) {
            $query = "SELECT count(*) cnt FROM " . self::DB_TABLE_NAME . " WHERE obj_id = %s AND usr_id = %s";
            $res = $DIC->database()->queryF(
                $query,
                array('integer', 'integer'),
                array($objId, $usrId)
            );
        } else {
            $query = "SELECT count(*) cnt FROM " . self::DB_TABLE_NAME . " WHERE obj_id = %s AND usr_id = %s AND privacy_ident = %s";
            $res = $DIC->database()->queryF(
                $query,
                array('integer', 'integer', 'integer'),
                array($objId, $usrId, $privacyIdent)
            );
        }
        
        while ($row = $DIC->database()->fetchAssoc($res)) {
            return (bool) $row['cnt'];
        }

        return false;
    }

Here is the caller graph for this function:

generateCMI5Registration()

static ilCmiXapiUser::generateCMI5Registration (   $objId,   $usrId  )

static

Definition at line 688 of file class.ilCmiXapiUser.php.

References $objId, and $usrId.

Referenced by ilCmiXapiLaunchGUI\initCmixUser().

    {
        return (new \Ramsey\Uuid\UuidFactory())->uuid3(self::getIliasUuid(), $objId . '-' . $usrId);
    }

Here is the caller graph for this function:

generateRegistration()

static ilCmiXapiUser::generateRegistration ( ilObjCmiXapi  $obj, ilObjUser  $user  )

static

Definition at line 693 of file class.ilCmiXapiUser.php.

References ilObject\getId(), and ilObject2\getRefId().

Referenced by ilCmiXapiLaunchGUI\CMI5preLaunch(), and ilCmiXapiLaunchGUI\getLaunchParameters().

    {
        return (new \Ramsey\Uuid\UuidFactory())->uuid3(self::getIliasUuid(), $obj->getRefId() . '-' . $user->getId());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getCMI5RegistrationFromAuthToken()

static ilCmiXapiUser::getCMI5RegistrationFromAuthToken ( ilCmiXapiAuthToken  $authToken )

static

Definition at line 698 of file class.ilCmiXapiUser.php.

References ilCmiXapiAuthToken\getObjId(), and ilCmiXapiAuthToken\getUsrId().

Referenced by XapiProxy\XapiProxyRequest\handleGetStatementsRequest().

                                                                                           : \Ramsey\Uuid\UuidInterface
    {
        return (new \Ramsey\Uuid\UuidFactory())->uuid3(self::getIliasUuid(), $authToken->getObjId() . '-' . $authToken->getUsrId());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getCmixObjectsHavingUsersMissingProxySuccess()

static ilCmiXapiUser::getCmixObjectsHavingUsersMissingProxySuccess ( )

static

Definition at line 561 of file class.ilCmiXapiUser.php.

References $DIC, $query, and $res.

Referenced by ilXapiResultsCronjob\getObjectsToBeReported().

    {
        global $DIC; /* @var \ILIAS\DI\Container $DIC */
        
        $query = "
                        SELECT DISTINCT cu.obj_id
                        FROM " . self::DB_TABLE_NAME . " cu
                        INNER JOIN object_data od
                        ON od.obj_id = cu.obj_id
                        AND od.type = 'cmix'
                        WHERE cu.proxy_success != %s
                ";
        
        $res = $DIC->database()->queryF($query, array('integer'), array(1));
        
        $objects = array();
        
        while ($row = $DIC->database()->fetchAssoc($res)) {
            $objects[] = $row['obj_id'];
        }
        
        return $objects;
    }

Here is the caller graph for this function:

getFetchUntil()

ilCmiXapiUser::getFetchUntil

(

)

Returns

ilCmiXapiDateTime

Definition at line 207 of file class.ilCmiXapiUser.php.

References $fetchUntil.

Referenced by ilObjCmiXapiGUI\fetchXapiStatements(), save(), and ilObjCmiXapiGUI\sendLastFetchInfo().

                                    : ilCmiXapiDateTime
    {
        return $this->fetchUntil;
    }

Here is the caller graph for this function:

getIdent()

static ilCmiXapiUser::getIdent (   $userIdentMode, ilObjUser  $user  )

static

Parameters

string	$userIdentMode
ilObjUser	$user

Returns

string

Definition at line 333 of file class.ilCmiXapiUser.php.

References $_SERVER, ilObjUser\_isAnonymous(), ilObject\getCreateDate(), ilObjUser\getEmail(), ilObjUser\getExternalAccount(), ilObject\getId(), ilObjUser\getLogin(), ilUtil\is_email(), ilObjCmiXapi\PRIVACY_IDENT_IL_UUID_EXT_ACCOUNT, ilObjCmiXapi\PRIVACY_IDENT_IL_UUID_LOGIN, ilObjCmiXapi\PRIVACY_IDENT_IL_UUID_RANDOM, ilObjCmiXapi\PRIVACY_IDENT_IL_UUID_SHA256, ilObjCmiXapi\PRIVACY_IDENT_IL_UUID_SHA256URL, ilObjCmiXapi\PRIVACY_IDENT_IL_UUID_USER_ID, and ilObjCmiXapi\PRIVACY_IDENT_REAL_EMAIL.

Referenced by ilLTIConsumerContentGUI\getStartButtonTxt11(), ilCmiXapiLaunchGUI\initCmixUser(), and ilLTIConsumerContentGUI\initCmixUser().

    {
        if (ilObjUser::_isAnonymous($user->getId())) {
            return self::buildPseudoEmail(hash("sha256", (string) microtime()), self::getIliasUuid());
        }
        switch ($userIdentMode) {
            case ilObjCmiXapi::PRIVACY_IDENT_IL_UUID_USER_ID:
                
                return self::buildPseudoEmail($user->getId(), self::getIliasUuid());
                
            case ilObjCmiXapi::PRIVACY_IDENT_IL_UUID_LOGIN:

                if (!ilUtil::is_email($user->getLogin())) {
                    return self::buildPseudoEmail($user->getLogin(), self::getIliasUuid());
                } else {
                    return $user->getLogin();
                }
                
                // no break
            case ilObjCmiXapi::PRIVACY_IDENT_IL_UUID_EXT_ACCOUNT:
                
                return self::buildPseudoEmail($user->getExternalAccount(), self::getIliasUuid());

            case ilObjCmiXapi::PRIVACY_IDENT_IL_UUID_SHA256:

                return self::buildPseudoEmail(hash("sha256", '' . $user->getId() . $user->getCreateDate()), self::getIliasUuid());

            case ilObjCmiXapi::PRIVACY_IDENT_IL_UUID_SHA256URL:
                $tmpHash = hash("sha256", '' . $user->getId() . $user->getCreateDate()) . '@' . str_replace('www.', '', $_SERVER['HTTP_HOST']);
                if (strlen($tmpHash) > 80) {
                    $tmpHash = substr($tmpHash, strlen($tmpHash) - 80);
                }
                return $tmpHash;

            case ilObjCmiXapi::PRIVACY_IDENT_IL_UUID_RANDOM:

                return self::buildPseudoEmail(self::getUserObjectUniqueId(), self::getIliasUuid());

            case ilObjCmiXapi::PRIVACY_IDENT_REAL_EMAIL:
                
                return $user->getEmail();
        }
        
        return '';
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getIdentAsId()

static ilCmiXapiUser::getIdentAsId (   $userIdentMode, ilObjUser  $user  )

static

Parameters

string	$userIdentMode
ilObjUser	$user

Returns

integer/string

Definition at line 384 of file class.ilCmiXapiUser.php.

References $_SERVER, ilObject\getCreateDate(), ilObjUser\getExternalAccount(), ilObject\getId(), ilObjUser\getLogin(), ilObjCmiXapi\PRIVACY_IDENT_IL_UUID_EXT_ACCOUNT, ilObjCmiXapi\PRIVACY_IDENT_IL_UUID_LOGIN, ilObjCmiXapi\PRIVACY_IDENT_IL_UUID_RANDOM, ilObjCmiXapi\PRIVACY_IDENT_IL_UUID_SHA256, ilObjCmiXapi\PRIVACY_IDENT_IL_UUID_SHA256URL, ilObjCmiXapi\PRIVACY_IDENT_IL_UUID_USER_ID, and ilObjCmiXapi\PRIVACY_IDENT_REAL_EMAIL.

Referenced by ilObjLTIConsumer\buildLaunchParameters().

    {
        switch ($userIdentMode) {
            case ilObjCmiXapi::PRIVACY_IDENT_IL_UUID_USER_ID:
                
                return $user->getId();
                
            case ilObjCmiXapi::PRIVACY_IDENT_IL_UUID_LOGIN:
                
                return $user->getLogin();
                
            case ilObjCmiXapi::PRIVACY_IDENT_IL_UUID_EXT_ACCOUNT:
                
                return $user->getExternalAccount();

            case ilObjCmiXapi::PRIVACY_IDENT_IL_UUID_SHA256:

                return hash("sha256", '' . $user->getId() . $user->getCreateDate());

            case ilObjCmiXapi::PRIVACY_IDENT_IL_UUID_SHA256URL:
                $tmpHash = hash("sha256", '' . $user->getId() . $user->getCreateDate());
                $tmpHost = '@' . str_replace('www.', '', $_SERVER['HTTP_HOST']);
                if (strlen($tmpHash . $tmpHost) > 80) {
                    $tmpHash = substr($tmpHash, strlen($tmpHash) - (80 - strlen($tmpHost)));
                }
                return $tmpHash;

            case ilObjCmiXapi::PRIVACY_IDENT_IL_UUID_RANDOM:

                return self::getUserObjectUniqueId();

            case ilObjCmiXapi::PRIVACY_IDENT_REAL_EMAIL:
                
                return 'realemail' . $user->getId();
        }
        
        return '';
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getIliasUuid()

static ilCmiXapiUser::getIliasUuid ( )

static

Returns

string

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

Referenced by ilCmiXapiSettingsGUI\buildForm(), ilObjCmiXapiAdministrationGUI\buildLrsTypeForm(), ilCmiXapiContentUploadImporter\generateActivityId(), and ilLTIConsumeProviderFormGUI\initForm().

                                          : string
    {
        $setting = new ilSetting('cmix');
        // Fallback
        if (!$setting->get('ilias_uuid', false)) {
            // $uuid = (new \Ramsey\Uuid\UuidFactory())->uuid4()->toString();
            $uuid = self::getUUID(32);
            $setting->set('ilias_uuid', $uuid);
        }
        $ilUuid = $setting->get('ilias_uuid');
        return $ilUuid;
    }

Here is the caller graph for this function:

getInstanceByObjectIdAndUsrIdent()

static ilCmiXapiUser::getInstanceByObjectIdAndUsrIdent (   $objId,   $usrIdent  )

static

Definition at line 287 of file class.ilCmiXapiUser.php.

References $DIC, $objId, $res, and $usrIdent.

Referenced by ilXapiStatementEvaluation\getCmixUser().

    {
        global $DIC; /* @var \ILIAS\DI\Container $DIC */
        
        $res = $DIC->database()->queryF(
            "SELECT * FROM " . self::DB_TABLE_NAME . " WHERE obj_id = %s AND usr_ident = %s",
            array('integer', 'text'),
            array($objId, $usrIdent)
        );
        
        $cmixUser = new self();
        
        while ($row = $DIC->database()->fetchAssoc($res)) {
            $cmixUser->assignFromDbRow($row);
        }
        
        return $cmixUser;
    }

Here is the caller graph for this function:

getInstancesByObjectIdAndUsrId()

static ilCmiXapiUser::getInstancesByObjectIdAndUsrId (   $objId,   $usrId  )

static

Definition at line 270 of file class.ilCmiXapiUser.php.

References $DIC, $objId, $res, and $usrId.

    {
        global $DIC; /* @var \ILIAS\DI\Container $DIC */
        $res = $DIC->database()->queryF(
            "SELECT * FROM " . self::DB_TABLE_NAME . " WHERE obj_id = %s AND usr_id = %s",
            array('integer', 'integer'),
            array($objId, $usrId)
        );
        $cmixUsers = array();
        while ($row = $DIC->database()->fetchAssoc($res)) {
            $cmixUser = new self();
            $cmixUser->assignFromDbRow($row);
            $cmixUsers[] = $cmixUser;
        }
        return $cmixUsers;
    }

getName()

static ilCmiXapiUser::getName (   $userNameMode, ilObjUser  $user  )

static

Parameters

string	$userNameMode
ilObjUser	$user

Returns

string|null

Definition at line 438 of file class.ilCmiXapiUser.php.

References ilObjUser\getFirstname(), ilObjUser\getFullname(), ilObjUser\getLastname(), ilObjUser\getUTitle(), ilObjCmiXapi\PRIVACY_NAME_FIRSTNAME, ilObjCmiXapi\PRIVACY_NAME_FULLNAME, ilObjCmiXapi\PRIVACY_NAME_LASTNAME, and ilObjCmiXapi\PRIVACY_NAME_NONE.

Referenced by ilObjCmiXapi\getStatementActor().

    {
        switch ($userNameMode) {
            case ilObjCmiXapi::PRIVACY_NAME_FIRSTNAME:
                $usrName = $user->getFirstname();
                break;
            
            case ilObjCmiXapi::PRIVACY_NAME_LASTNAME:
                $usrName = $user->getUTitle() ? $user->getUTitle() . ' ' : '';
                $usrName .= $user->getLastname();
                break;
            
            case ilObjCmiXapi::PRIVACY_NAME_FULLNAME:
                $usrName = $user->getFullname();
                break;
            
            case ilObjCmiXapi::PRIVACY_NAME_NONE:
            default:
                $usrName = '-';
                break;
        }
        return $usrName;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getObjId()

ilCmiXapiUser::getObjId

(

)

Returns

int

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

References $objId.

Referenced by load(), and save().

    {
        return $this->objId;
    }

Here is the caller graph for this function:

getPrivacyIdent()

ilCmiXapiUser::getPrivacyIdent

(

)

Returns

int

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

References $privacyIdent.

Referenced by load(), and save().

    {
        return $this->privacyIdent;
    }

Here is the caller graph for this function:

getRegistration()

ilCmiXapiUser::getRegistration

(

)

Returns

string

Definition at line 143 of file class.ilCmiXapiUser.php.

References $registration.

Referenced by save().

                                      : string
    {
        return $this->registration;
    }

Here is the caller graph for this function:

getRegistrationFromAuthToken()

static ilCmiXapiUser::getRegistrationFromAuthToken ( ilCmiXapiAuthToken  $authToken )

static

Definition at line 703 of file class.ilCmiXapiUser.php.

References ilCmiXapiAuthToken\getRefId(), and ilCmiXapiAuthToken\getUsrId().

Referenced by XapiProxy\XapiProxyRequest\handleGetStatementsRequest().

                                                                                       : \Ramsey\Uuid\UuidInterface
    {
        return (new \Ramsey\Uuid\UuidFactory())->uuid3(self::getIliasUuid(), $authToken->getRefId() . '-' . $authToken->getUsrId());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getSatisfied()

ilCmiXapiUser::getSatisfied

(

)

Returns

bool $satisfied

Definition at line 199 of file class.ilCmiXapiUser.php.

References $satisfied.

Referenced by save().

    {
        return $this->satisfied;
    }

Here is the caller graph for this function:

getUserIdents()

static ilCmiXapiUser::getUserIdents (   $objId,   $usrId  )

static

Parameters

int	$objId
int	$usrId

Returns

string[] $usrIdents

Definition at line 498 of file class.ilCmiXapiUser.php.

References $DIC, $objId, $res, and $usrId.

Referenced by ilCmiXapiStatementsReportLinkBuilder\buildFilterStage().

                                                         : array
    {
        global $DIC; /* @var \ILIAS\DI\Container $DIC */
        
        $res = $DIC->database()->queryF(
            "SELECT usr_ident FROM " . self::DB_TABLE_NAME . " WHERE obj_id = %s AND usr_id = %s",
            array('integer','integer'),
            array($objId,$usrId)
        );
        
        $usrIdents = [];
        while ($row = $DIC->database()->fetchAssoc($res)) {
            $usrIdents[] = $row['usr_ident'];
        }
        return $usrIdents;
    }

Here is the caller graph for this function:

getUserObjectUniqueId()

static ilCmiXapiUser::getUserObjectUniqueId (   $length = 32 )

static

Parameters

int

$length

Returns

string

Definition at line 630 of file class.ilCmiXapiUser.php.

    {
        // $storedId = self::readUserObjectUniqueId();
        // if( (bool)strlen($storedId) ) {
        // return strstr($storedId,'@', true);
        // }

        // $getId = function( $length ) {
        // $multiplier = floor($length/8) * 2;
        // $uid = str_shuffle(str_repeat(uniqid(), $multiplier));

        // try {
        // $ident = bin2hex(random_bytes($length));
        // } catch (Exception $e) {
        // $ident = $uid;
        // }

        // $start = rand(0, strlen($ident) - $length - 1);
        // return substr($ident, $start, $length);
        // };

        $id = self::getUUID($length);//$getId($length);
        $exists = self::userObjectUniqueIdExists($id);
        while ($exists) {
            $id = self::getUUID($length);//$getId($length);
            $exists = self::userObjectUniqueIdExists($id);
        }

        return $id;
    }

getUsersForObject()

static ilCmiXapiUser::getUsersForObject (   $objId,   $asUsrId = false  )

static

Parameters

int

$object

Returns

ilCmiXapiUser[]

Definition at line 466 of file class.ilCmiXapiUser.php.

References $DIC, $objId, and $res.

Referenced by ilCmiXapiHighscoreReport\__construct(), ilCmiXapiStatementsReport\__construct(), ilCmiXapiStatementsReportLinkBuilder\buildFilterStage(), ilCmiXapiHighscoreReportLinkBuilder\getUsersStack(), ilCmiXapiStatementsGUI\initTableData(), and ilLPStatusCmiXapiAbstract\loadStatusInfo().

                                                                       : array
    {
        global $DIC; /* @var \ILIAS\DI\Container $DIC */
        
        $res = $DIC->database()->queryF(
            "SELECT * FROM " . self::DB_TABLE_NAME . " WHERE obj_id = %s",
            array('integer'),
            array($objId)
        );
        
        $users = [];
        
        if ($asUsrId === false) {
            while ($row = $DIC->database()->fetchAssoc($res)) {
                $cmixUser = new self();
                $cmixUser->assignFromDbRow($row);
                
                $users[] = $cmixUser;
            }
        } else {
            while ($row = $DIC->database()->fetchAssoc($res)) {
                $users[] = $row['usr_id'];
            }
        }
        return $users;
    }

Here is the caller graph for this function:

getUsrId()

ilCmiXapiUser::getUsrId

(

)

Returns

int

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

References $usrId.

Referenced by ilCmiXapiStatementsTableGUI\getUsername(), load(), and save().

    {
        return $this->usrId;
    }

Here is the caller graph for this function:

getUsrIdent()

ilCmiXapiUser::getUsrIdent

(

)

Returns

string

Definition at line 127 of file class.ilCmiXapiUser.php.

References $usrIdent.

Referenced by ilObjLTIConsumer\buildLaunchParameters(), ilCmiXapiLaunchGUI\initCmixUser(), ilLTIConsumerContentGUI\initCmixUser(), and save().

                                  : string
    {
        return $this->usrIdent;
    }

Here is the caller graph for this function:

getUUID()

static ilCmiXapiUser::getUUID (   $length = 32 )

static

Definition at line 661 of file class.ilCmiXapiUser.php.

References Vendor\Package\$e.

    {
        $multiplier = floor($length / 8) * 2;
        $uid = str_shuffle(str_repeat(uniqid(), $multiplier));

        try {
            $ident = bin2hex(random_bytes($length));
        } catch (Exception $e) {
            $ident = $uid;
        }

        $start = rand(0, strlen($ident) - $length - 1);
        return substr($ident, $start, $length);
    }

hasProxySuccess()

ilCmiXapiUser::hasProxySuccess

(

)

Returns

bool

Definition at line 175 of file class.ilCmiXapiUser.php.

References $proxySuccess.

Referenced by ilObjCmiXapiGUI\isFetchXapiStatementsRequired(), and save().

    {
        return $this->proxySuccess;
    }

Here is the caller graph for this function:

load()

ilCmiXapiUser::load

(

)

Definition at line 220 of file class.ilCmiXapiUser.php.

References $DIC, $res, assignFromDbRow(), getObjId(), getPrivacyIdent(), and getUsrId().

Referenced by __construct().

    {
        global $DIC; /* @var \ILIAS\DI\Container $DIC */
        
        $res = $DIC->database()->queryF(
            "SELECT * FROM " . self::DB_TABLE_NAME . " WHERE obj_id = %s AND usr_id = %s AND privacy_ident = %s",
            array('integer', 'integer', 'integer'),
            array($this->getObjId(), $this->getUsrId(), $this->getPrivacyIdent())
        );
        
        while ($row = $DIC->database()->fetchAssoc($res)) {
            $this->assignFromDbRow($row);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

lookupObjectIds()

static ilCmiXapiUser::lookupObjectIds (   $usrId,   $type = ''  )

static

Definition at line 595 of file class.ilCmiXapiUser.php.

References $DIC, $query, $res, and $type.

    {
        global $DIC; /* @var \ILIAS\DI\Container $DIC */
        
        $TYPE_JOIN = '';
        
        if (strlen($type)) {
            $TYPE_JOIN = "
                                INNER JOIN object_data od
                                ON od.obj_id = cu.obj_id
                                AND od.type = {$DIC->database()->quote($type, 'text')}
                        ";
        }
        
        $query = "
                        SELECT cu.obj_id
                        FROM " . self::DB_TABLE_NAME . " cu
                        {$TYPE_JOIN}
                        WHERE cu.usr_id = {$DIC->database()->quote($usrId, 'integer')}
                ";
        
        $res = $DIC->database()->query($query);
        
        $objIds = [];
        
        while ($row = $DIC->database()->fetchAssoc($res)) {
            $objIds[] = $row['obj_id'];
        }
        
        return $objIds;
    }

save()

ilCmiXapiUser::save

(

)

Definition at line 247 of file class.ilCmiXapiUser.php.

References $DIC, ilObjUser\_isAnonymous(), getFetchUntil(), getObjId(), getPrivacyIdent(), getRegistration(), getSatisfied(), getUsrId(), getUsrIdent(), hasProxySuccess(), and IL_CAL_DATETIME.

    {
        global $DIC; /* @var \ILIAS\DI\Container $DIC */
        if (!ilObjUser::_isAnonymous($this->getUsrId())) {
            $DIC->database()->replace(
                self::DB_TABLE_NAME,
                array(
                    'obj_id' => array('integer', (int) $this->getObjId()),
                    'usr_id' => array('integer', (int) $this->getUsrId()),
                    'privacy_ident' => array('integer', (int) $this->getPrivacyIdent())
                ),
                array(
                    'proxy_success' => array('integer', (int) $this->hasProxySuccess()),
                    'fetched_until' => array('timestamp', $this->getFetchUntil()->get(IL_CAL_DATETIME)),
                    'usr_ident' => array('text', $this->getUsrIdent()),
                    'registration' => array('text', $this->getRegistration()),
                    'satisfied' => array('integer', (int) $this->getSatisfied())
                )
            );
        }
    }

Here is the call graph for this function:

saveProxySuccess()

static ilCmiXapiUser::saveProxySuccess (   $objId,   $usrId,   $privacyIdent  )

static

Parameters

int	$objId
int	$usrId
int	$privacyIdent

Definition at line 311 of file class.ilCmiXapiUser.php.

References $DIC, $objId, $privacyIdent, and $usrId.

Referenced by XapiProxy\XapiProxyPolyFill\getLrsType().

    {
        global $DIC; /* @var \ILIAS\DI\Container $DIC */
        
        $DIC->database()->update(
            self::DB_TABLE_NAME,
            array(
                'proxy_success' => array('integer', 1)
            ),
            array(
                'obj_id' => array('integer', (int) $objId),
                'usr_id' => array('integer', (int) $usrId),
                'privacy_ident' => array('integer', (int) $privacyIdent)
            )
        );
    }

Here is the caller graph for this function:

setFetchUntil()

ilCmiXapiUser::setFetchUntil

(

ilCmiXapiDateTime

$fetchUntil

)

Parameters

ilCmiXapiDateTime

$fetchUntil

Definition at line 215 of file class.ilCmiXapiUser.php.

References $fetchUntil.

Referenced by assignFromDbRow().

    {
        $this->fetchUntil = $fetchUntil;
    }

Here is the caller graph for this function:

setObjId()

ilCmiXapiUser::setObjId

(

$objId

)

Parameters

int

$objId

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

References $objId.

Referenced by assignFromDbRow().

    {
        $this->objId = $objId;
    }

Here is the caller graph for this function:

setPrivacyIdent()

ilCmiXapiUser::setPrivacyIdent

(

$privacyIdent

)

Parameters

int

$privacyIdent

Definition at line 103 of file class.ilCmiXapiUser.php.

References $privacyIdent.

Referenced by assignFromDbRow().

    {
        $this->privacyIdent = $privacyIdent;
    }

Here is the caller graph for this function:

setProxySuccess()

ilCmiXapiUser::setProxySuccess

(

$proxySuccess

)

Parameters

bool

$proxySuccess

Definition at line 183 of file class.ilCmiXapiUser.php.

References $proxySuccess.

Referenced by assignFromDbRow().

    {
        $this->proxySuccess = $proxySuccess;
    }

Here is the caller graph for this function:

setRegistration()

ilCmiXapiUser::setRegistration

(

string

$registration

)

Parameters

string

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

References $registration.

Referenced by assignFromDbRow().

    {
        $this->registration = $registration;
    }

Here is the caller graph for this function:

setSatisfied()

ilCmiXapiUser::setSatisfied

(

$satisfied

)

Parameters

bool

$satisfied

Definition at line 191 of file class.ilCmiXapiUser.php.

References $satisfied.

Referenced by assignFromDbRow().

    {
        $this->satisfied = $satisfied;
    }

Here is the caller graph for this function:

setUsrId()

ilCmiXapiUser::setUsrId

(

$usrId

)

Parameters

int

$usrId

Definition at line 119 of file class.ilCmiXapiUser.php.

References $usrId.

Referenced by assignFromDbRow().

    {
        $this->usrId = $usrId;
    }

Here is the caller graph for this function:

setUsrIdent()

ilCmiXapiUser::setUsrIdent

(

string

$usrIdent

)

Parameters

string

$usrIdent

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

References $usrIdent.

Referenced by assignFromDbRow().

    {
        $this->usrIdent = $usrIdent;
    }

Here is the caller graph for this function:

updateFetchedUntilForObjects()

static ilCmiXapiUser::updateFetchedUntilForObjects ( ilCmiXapiDateTime  $fetchedUntil,   $objectIds  )

static

Definition at line 585 of file class.ilCmiXapiUser.php.

References $DIC, $query, ilDateTime\get(), and IL_CAL_DATETIME.

Referenced by ilXapiResultsCronjob\run().

    {
        global $DIC; /* @var \ILIAS\DI\Container $DIC */
        
        $IN_objIds = $DIC->database()->in('obj_id', $objectIds, false, 'integer');
        
        $query = "UPDATE " . self::DB_TABLE_NAME . " SET fetched_until = %s WHERE $IN_objIds";
        $DIC->database()->manipulateF($query, array('timestamp'), array($fetchedUntil->get(IL_CAL_DATETIME)));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

userObjectUniqueIdExists()

static ilCmiXapiUser::userObjectUniqueIdExists (   $id )

staticprivate

Definition at line 676 of file class.ilCmiXapiUser.php.

References $DIC, $query, and $result.

    {
        global $DIC; /* @var \ILIAS\DI\Container $DIC */

        $query = "SELECT usr_ident FROM " . self::DB_TABLE_NAME . " WHERE " . $DIC->database()->like('usr_ident', 'text', $id . '@%');
        $result = $DIC->database()->query($query);
        if ($result->numRows() == 0) {
            return false;
        }
        return true;
    }

Field Documentation

$fetchUntil

ilCmiXapiUser::$fetchUntil

protected

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

Referenced by getFetchUntil(), and setFetchUntil().

$objId

ilCmiXapiUser::$objId

protected

Definition at line 22 of file class.ilCmiXapiUser.php.

Referenced by __construct(), exists(), generateCMI5Registration(), getInstanceByObjectIdAndUsrIdent(), getInstancesByObjectIdAndUsrId(), getObjId(), getUserIdents(), getUsersForObject(), saveProxySuccess(), and setObjId().

$privacyIdent

ilCmiXapiUser::$privacyIdent

protected

Definition at line 32 of file class.ilCmiXapiUser.php.

Referenced by __construct(), exists(), getPrivacyIdent(), saveProxySuccess(), and setPrivacyIdent().

$proxySuccess

ilCmiXapiUser::$proxySuccess

protected

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

Referenced by hasProxySuccess(), and setProxySuccess().

$registration

ilCmiXapiUser::$registration

protected

Definition at line 57 of file class.ilCmiXapiUser.php.

Referenced by getRegistration(), and setRegistration().

$satisfied

ilCmiXapiUser::$satisfied

protected

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

Referenced by getSatisfied(), and setSatisfied().

$usrId

ilCmiXapiUser::$usrId

protected

Definition at line 27 of file class.ilCmiXapiUser.php.

Referenced by __construct(), exists(), generateCMI5Registration(), getInstancesByObjectIdAndUsrId(), getUserIdents(), getUsrId(), saveProxySuccess(), and setUsrId().

$usrIdent

ilCmiXapiUser::$usrIdent

protected

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

Referenced by getInstanceByObjectIdAndUsrIdent(), getUsrIdent(), and setUsrIdent().

DB_TABLE_NAME

const ilCmiXapiUser::DB_TABLE_NAME = 'cmix_users'

Definition at line 17 of file class.ilCmiXapiUser.php.

---

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

• Modules/CmiXapi/classes/class.ilCmiXapiUser.php