ilCmiXapiResult Class Reference

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 ($objId, $usrId)
static	getEmptyInstance ()
static	getResultsForObject ($objId)

Protected Member Functions
	update ()
	insert ()
	assignFromDbRow ($row)

Protected Attributes
	$id
	$objId
	$usrId
	$version
	$score
	$status
	$lastUpdate

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilCmiXapiResult::__construct

(

)

ilCmiXapiResult constructor.

Parameters

int	$id
int	$objId
int	$usrId
int	$version
float	$score
string	$status
string	$lastUpdate

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

    {
        $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 (   $row )

protected

Parameters

ilCmiXapiResult	$result
	$row

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

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

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

Here is the call graph for this function:

getEmptyInstance()

static ilCmiXapiResult::getEmptyInstance ( )

static

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

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

    {
        return new self();
    }

Here is the caller graph for this function:

getId()

ilCmiXapiResult::getId

(

)

Returns

int

Definition at line 76 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 (   $objId,   $usrId  )

static

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

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

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

    {
        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

(

)

Returns

string

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

References $lastUpdate.

                                    : string
    {
        return $this->lastUpdate;
    }

getObjId()

ilCmiXapiResult::getObjId

(

)

Returns

int

Definition at line 92 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 (   $objId )

static

Parameters

$objId

Returns

ilCmiXapiResult[]

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

References $DIC, $objId, $query, $res, $result, and $results.

Referenced by ilLPStatusCmiXapiAbstract\loadStatusInfo().

    {
        global $DIC;
        
        $query = 'SELECT * FROM cmix_results'
            . ' WHERE obj_id = ' . $DIC->database()->quote($objId, 'integer');
        
        $res = $DIC->database()->query($query);
        
        $results = [];
        
        if ($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

(

)

Returns

float

Definition at line 140 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

(

)

Returns

string

Definition at line 156 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

(

)

Returns

int

Definition at line 108 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

(

)

Returns

int

Definition at line 124 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 210 of file class.ilCmiXapiResult.php.

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

Referenced by save().

    {
        global $DIC; /* @var \ILIAS\DI\Container $DIC */
        
        $this->setId($DIC->database()->nextId('cmix_results'));
        
        $DIC->database()->insert('cmix_results', array(
            'id' => array('intger', $this->getId()),
            '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())
        ));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

save()

ilCmiXapiResult::save

(

)

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

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

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

Here is the call graph for this function:

setId()

ilCmiXapiResult::setId

(

int

$id

)

Parameters

int

$id

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

References $id.

Referenced by assignFromDbRow(), and insert().

    {
        $this->id = $id;
    }

Here is the caller graph for this function:

setLastUpdate()

ilCmiXapiResult::setLastUpdate

(

string

$lastUpdate

)

Parameters

string

$lastUpdate

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

References $lastUpdate.

Referenced by assignFromDbRow().

    {
        $this->lastUpdate = $lastUpdate;
    }

Here is the caller graph for this function:

setObjId()

ilCmiXapiResult::setObjId

(

int

$objId

)

Parameters

int

$objId

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

References $objId.

Referenced by assignFromDbRow().

    {
        $this->objId = $objId;
    }

Here is the caller graph for this function:

setScore()

ilCmiXapiResult::setScore

(

float

$score

)

Parameters

float

$score

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

References $score.

Referenced by assignFromDbRow().

    {
        $this->score = $score;
    }

Here is the caller graph for this function:

setStatus()

ilCmiXapiResult::setStatus

(

string

$status

)

Parameters

string

$status

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

References $status.

Referenced by assignFromDbRow().

    {
        $this->status = $status;
    }

Here is the caller graph for this function:

setUsrId()

ilCmiXapiResult::setUsrId

(

int

$usrId

)

Parameters

int

$usrId

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

References $usrId.

Referenced by assignFromDbRow().

    {
        $this->usrId = $usrId;
    }

Here is the caller graph for this function:

setVersion()

ilCmiXapiResult::setVersion

(

int

$version

)

Parameters

int

$version

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

References $version.

Referenced by assignFromDbRow().

    {
        $this->version = $version;
    }

Here is the caller graph for this function:

update()

ilCmiXapiResult::update ( )

protected

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

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

Referenced by save().

    {
        global $DIC; /* @var \ILIAS\DI\Container $DIC */
        
        $DIC->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

$id

ilCmiXapiResult::$id

protected

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

Referenced by getId(), and setId().

$lastUpdate

ilCmiXapiResult::$lastUpdate

protected

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

Referenced by getLastUpdate(), and setLastUpdate().

$objId

ilCmiXapiResult::$objId

protected

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

Referenced by getInstanceByObjIdAndUsrId(), getObjId(), getResultsForObject(), and setObjId().

$score

ilCmiXapiResult::$score

protected

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

Referenced by getScore(), and setScore().

$status

ilCmiXapiResult::$status

protected

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

Referenced by getStatus(), and setStatus().

$usrId

ilCmiXapiResult::$usrId

protected

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

Referenced by getInstanceByObjIdAndUsrId(), getUsrId(), and setUsrId().

$version

ilCmiXapiResult::$version

protected

Definition at line 35 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