Collaboration diagram for ilCmiXapiResult:

Public Member Functions
	__construct ()
	ilCmiXapiResult constructor. More...

	getId ()

	setId (int $id)

	getObjId ()

	setObjId (int $objId)

	getUsrId ()

	setUsrId (int $usrId)

	getVersion ()

	setVersion (int $version)

	getScore ()

	setScore (float $score)

	getStatus ()

	setStatus (string $status)

	getLastUpdate ()

	setLastUpdate (string $lastUpdate)

	save ()

Static Public Member Functions
static	getInstanceByObjIdAndUsrId (int $objId, int $usrId)

static	getEmptyInstance ()

static	getResultsForObject (int $objId)

Protected Member Functions
	update ()

	insert ()

	assignFromDbRow (array $row)

Protected Attributes
int	$id

int	$objId

int	$usrId

int	$version

float	$score

string	$status

string	$lastUpdate

Private Attributes
ilDBInterface	$database

Detailed Description

Definition at line 30 of file class.ilCmiXapiResult.php.

Constructor & Destructor Documentation

◆ __construct()

ilCmiXapiResult::__construct ( )

ilCmiXapiResult constructor.

Definition at line 51 of file class.ilCmiXapiResult.php.

References $DIC.

     {
         global $DIC;
         $this->database = $DIC->database();
         $this->id = 0;
         $this->objId = 0;
         $this->usrId = 0;
         $this->version = 0;
         $this->score = 0.0;
         $this->status = '';
         $this->lastUpdate = '';
     }

Member Function Documentation

◆ assignFromDbRow()

ilCmiXapiResult::assignFromDbRow ( array $row )

protected

Definition at line 172 of file class.ilCmiXapiResult.php.

References setId(), setLastUpdate(), setObjId(), setScore(), setStatus(), setUsrId(), and setVersion().

                                                   : void
     {
         $this->setId((int) $row['id']);
         $this->setObjId((int) $row['obj_id']);
         $this->setUsrId((int) $row['usr_id']);
         $this->setVersion((int) $row['version']);
         $this->setScore((float) $row['score']);
         $this->setStatus((string) $row['status']);
         $this->setLastUpdate((string) $row['last_update']);
     }

Here is the call graph for this function:

◆ getEmptyInstance()

static ilCmiXapiResult::getEmptyInstance ( )

static

Definition at line 208 of file class.ilCmiXapiResult.php.

Referenced by ilCmiXapiPlaceholderValues\getReachedScore(), and ilXapiStatementEvaluation\getUserResult().

                                              : \ilCmiXapiResult
     {
         return new self();
     }

Here is the caller graph for this function:

◆ getId()

ilCmiXapiResult::getId ( )

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

References $id.

Referenced by insert(), save(), and update().

                            : int
     {
         return $this->id;
     }

Here is the caller graph for this function:

◆ getInstanceByObjIdAndUsrId()

static ilCmiXapiResult::getInstanceByObjIdAndUsrId	(	int	$objId,
		int	$usrId
	)

static

Exceptions

ilCmiXapiException

Definition at line 186 of file class.ilCmiXapiResult.php.

References $DIC, and $res.

Referenced by ilLPStatusCmiXapiAbstract\getCmixUserResult(), ilCmiXapiPlaceholderValues\getReachedScore(), and ilXapiStatementEvaluation\getUserResult().

                                                                              : \ilCmiXapiResult
     {
         global $DIC; /* @var \ILIAS\DI\Container $DIC */
         $query = "
                         SELECT * FROM cmix_results
                         WHERE obj_id = %s AND usr_id = %s
                 ";
 
         $res = $DIC->database()->queryF($query, array('integer', 'integer'), array($objId, $usrId));
 
         while ($row = $DIC->database()->fetchAssoc($res)) {
             $result = new self();
             $result->assignFromDbRow($row);
 
             return $result;
         }
 
         throw new ilCmiXapiException(
             "no result record exists for: usr=$usrId obj=$objId"
         );
     }

Here is the caller graph for this function:

◆ getLastUpdate()

ilCmiXapiResult::getLastUpdate ( )

Definition at line 124 of file class.ilCmiXapiResult.php.

References $lastUpdate.

                                    : string
     {
         return $this->lastUpdate;
     }

◆ getObjId()

ilCmiXapiResult::getObjId ( )

Definition at line 74 of file class.ilCmiXapiResult.php.

References $objId.

Referenced by insert(), and update().

                               : int
     {
         return $this->objId;
     }

Here is the caller graph for this function:

◆ getResultsForObject()

static ilCmiXapiResult::getResultsForObject ( int $objId )

static

Returns: ilCmiXapiResult[]

Definition at line 216 of file class.ilCmiXapiResult.php.

References $DIC, $res, and $results.

Referenced by ilLPStatusCmiXapiAbstract\loadStatusInfo().

                                                           : array
     {
         global $DIC;
 
         $query = 'SELECT * FROM cmix_results'
             . ' WHERE obj_id = ' . $DIC->database()->quote($objId, 'integer');
 
         $res = $DIC->database()->query($query);
 
         $results = [];
 
         while ($row = $DIC->database()->fetchAssoc($res)) {
             $result = new self();
             $result->assignFromDbRow($row);
 
             $results[$result->getUsrId()] = $result;
         }
 
         return $results;
     }

Here is the caller graph for this function:

◆ getScore()

ilCmiXapiResult::getScore ( )

Definition at line 104 of file class.ilCmiXapiResult.php.

References $score.

Referenced by insert(), and update().

                               : float
     {
         return $this->score;
     }

Here is the caller graph for this function:

◆ getStatus()

ilCmiXapiResult::getStatus ( )

Definition at line 114 of file class.ilCmiXapiResult.php.

References $status.

Referenced by insert(), ilLPStatusCmiXapiCompletedOrPassed\resultSatisfyCompleted(), ilLPStatusCmiXapiPassed\resultSatisfyCompleted(), ilLPStatusCmiXapiCompleted\resultSatisfyCompleted(), ilLPStatusCmiXapiCompletedOrPassedWithFailed\resultSatisfyFailed(), ilLPStatusCmiXapiPassedWithFailed\resultSatisfyFailed(), ilLPStatusCmiXapiCompletedWithFailed\resultSatisfyFailed(), and update().

                                : string
     {
         return $this->status;
     }

Here is the caller graph for this function:

◆ getUsrId()

ilCmiXapiResult::getUsrId ( )

Definition at line 84 of file class.ilCmiXapiResult.php.

References $usrId.

Referenced by insert(), and update().

                               : int
     {
         return $this->usrId;
     }

Here is the caller graph for this function:

◆ getVersion()

ilCmiXapiResult::getVersion ( )

Definition at line 94 of file class.ilCmiXapiResult.php.

References $version.

Referenced by insert(), and update().

                                 : int
     {
         return $this->version;
     }

Here is the caller graph for this function:

◆ insert()

ilCmiXapiResult::insert ( )

protected

Definition at line 157 of file class.ilCmiXapiResult.php.

References getId(), getObjId(), getScore(), getStatus(), getUsrId(), getVersion(), ilCmiXapiAuthToken\selectCurrentTimestamp(), and setId().

Referenced by save().

                                : void
     {
         $this->setId($this->database->nextId('cmix_results'));
 
         $this->database->insert('cmix_results', array(
             'id' => array('integer', $this->getId()),
             'obj_id' => array('integer', $this->getObjId()),
             'usr_id' => array('integer', $this->getUsrId()),
             'version' => array('integer', $this->getVersion()),
             'score' => array('float', $this->getScore()),
             'status' => array('text', $this->getStatus()),
             'last_update' => array('timestamp', ilCmiXapiAuthToken::selectCurrentTimestamp())
         ));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ save()

ilCmiXapiResult::save ( )

Definition at line 134 of file class.ilCmiXapiResult.php.

References getId(), insert(), and update().

                           : void
     {
         if ($this->getId()) {
             $this->update();
         } else {
             $this->insert();
         }
     }

Here is the call graph for this function:

◆ setId()

ilCmiXapiResult::setId ( int $id )

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

References $id.

Referenced by assignFromDbRow(), and insert().

                                   : void
     {
         $this->id = $id;
     }

Here is the caller graph for this function:

◆ setLastUpdate()

ilCmiXapiResult::setLastUpdate ( string $lastUpdate )

Definition at line 129 of file class.ilCmiXapiResult.php.

References $lastUpdate.

Referenced by assignFromDbRow().

                                                      : void
     {
         $this->lastUpdate = $lastUpdate;
     }

Here is the caller graph for this function:

◆ setObjId()

ilCmiXapiResult::setObjId ( int $objId )

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

References $objId.

Referenced by assignFromDbRow().

                                         : void
     {
         $this->objId = $objId;
     }

Here is the caller graph for this function:

◆ setScore()

ilCmiXapiResult::setScore ( float $score )

Definition at line 109 of file class.ilCmiXapiResult.php.

References $score.

Referenced by assignFromDbRow().

                                           : void
     {
         $this->score = $score;
     }

Here is the caller graph for this function:

◆ setStatus()

ilCmiXapiResult::setStatus ( string $status )

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

References $status.

Referenced by assignFromDbRow().

                                              : void
     {
         $this->status = $status;
     }

Here is the caller graph for this function:

◆ setUsrId()

ilCmiXapiResult::setUsrId ( int $usrId )

Definition at line 89 of file class.ilCmiXapiResult.php.

References $usrId.

Referenced by assignFromDbRow().

                                         : void
     {
         $this->usrId = $usrId;
     }

Here is the caller graph for this function:

◆ setVersion()

ilCmiXapiResult::setVersion ( int $version )

Definition at line 99 of file class.ilCmiXapiResult.php.

References $version.

Referenced by assignFromDbRow().

                                             : void
     {
         $this->version = $version;
     }

Here is the caller graph for this function:

◆ update()

ilCmiXapiResult::update ( )

protected

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

References getId(), getObjId(), getScore(), getStatus(), getUsrId(), getVersion(), and ilCmiXapiAuthToken\selectCurrentTimestamp().

Referenced by save().

                                : void
     {
         $this->database->update('cmix_results', array(
                 'obj_id' => array('intger', $this->getObjId()),
                 'usr_id' => array('intger', $this->getUsrId()),
                 'version' => array('intger', $this->getVersion()),
                 'score' => array('float', $this->getScore()),
                 'status' => array('text', $this->getStatus()),
                 'last_update' => array('timestamp', ilCmiXapiAuthToken::selectCurrentTimestamp())
             ), array(
                 'id' => array('intger', $this->getId())
         ));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $database

ilDBInterface ilCmiXapiResult::$database

private

Definition at line 46 of file class.ilCmiXapiResult.php.

◆ $id

int ilCmiXapiResult::$id

protected

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

Referenced by getId(), and setId().

◆ $lastUpdate

string ilCmiXapiResult::$lastUpdate

protected

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

Referenced by getLastUpdate(), and setLastUpdate().

◆ $objId

int ilCmiXapiResult::$objId

protected

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

Referenced by getObjId(), and setObjId().

◆ $score

float ilCmiXapiResult::$score

protected

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

Referenced by getScore(), and setScore().

◆ $status

string ilCmiXapiResult::$status

protected

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

Referenced by getStatus(), and setStatus().

◆ $usrId

int ilCmiXapiResult::$usrId

protected

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

Referenced by getUsrId(), and setUsrId().

◆ $version

int ilCmiXapiResult::$version

protected

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

Referenced by getVersion(), and setVersion().

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

Modules/CmiXapi/classes/class.ilCmiXapiResult.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ assignFromDbRow()

◆ getEmptyInstance()

◆ getId()

◆ getInstanceByObjIdAndUsrId()

◆ getLastUpdate()

◆ getObjId()

◆ getResultsForObject()

◆ getScore()

◆ getStatus()

◆ getUsrId()

◆ getVersion()

◆ insert()

◆ save()

◆ setId()

◆ setLastUpdate()

◆ setObjId()

◆ setScore()

◆ setStatus()

◆ setUsrId()

◆ setVersion()

◆ update()

Field Documentation

◆ $database

◆ $id

◆ $lastUpdate

◆ $objId

◆ $score

◆ $status

◆ $usrId

◆ $version