ilLTIConsumerResult Class Reference

Collaboration diagram for ilLTIConsumerResult:

Public Member Functions
	save ()
	Save a result object. More...
	getId ()
	getObjId ()
	getUsrId ()
	getResult ()

Static Public Member Functions
static	getById (int $a_id)
	Get a result by id. More...
static	getByKeys (int $a_obj_id, int $a_usr_id, ?bool $a_create=false)
	Get a result by object and user key. More...
static	getResultsForObject (int $objId)

Data Fields
int	$id
int	$obj_id
int	$usr_id
float	$result = null

Protected Member Functions
	fillData (array $data)
	Fill the properties with data from an array. More...

Detailed Description

Definition at line 29 of file class.ilLTIConsumerResult.php.

Member Function Documentation

fillData()

ilLTIConsumerResult::fillData ( array  $data )

protected

Fill the properties with data from an array.

Parameters

array

assoc data

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

References ILIAS\Repository\int().

                                            : void
    {
        $this->id = (int) $data['id'];
        $this->obj_id = (int) $data['obj_id'];
        $this->usr_id = (int) $data['usr_id'];
        $this->result = (float) $data['result'];
    }

Here is the call graph for this function:

getById()

static ilLTIConsumerResult::getById ( int  $a_id )

static

Get a result by id.

Definition at line 54 of file class.ilLTIConsumerResult.php.

References $DIC, $res, and null.

                                             : ?ilLTIConsumerResult
    {
        global $DIC;

        $query = 'SELECT * FROM lti_consumer_results'
            . ' WHERE id = ' . $DIC->database()->quote($a_id, 'integer');

        $res = $DIC->database()->query($query);
        if ($row = $DIC->database()->fetchAssoc($res)) {
            $resObj = new ilLTIConsumerResult();
            $resObj->fillData($row);
            return $resObj;
        } else {
            return null;
        }
    }

getByKeys()

static ilLTIConsumerResult::getByKeys ( int  $a_obj_id, int  $a_usr_id, ?bool  $a_create = false  )

static

Get a result by object and user key.

Returns

ilLTIConsumerResult

Definition at line 75 of file class.ilLTIConsumerResult.php.

References $DIC, $res, and null.

Referenced by ilObjLTIConsumer\buildLaunchParameters(), ilObjLTIConsumer\buildLaunchParametersLTI13(), ilLTIConsumerGradeServiceScores\checkScore(), ilLPStatusLtiOutcome\getLtiUserResult(), ilLTIConsumerPlaceholderValues\getReachedScore(), and ilLTIConsumerResultService\handleRequest().

                                                                                           : ?ilLTIConsumerResult
    {
        global $DIC;

        $query = 'SELECT * FROM lti_consumer_results'
            . ' WHERE obj_id = ' . $DIC->database()->quote($a_obj_id, 'integer')
            . ' AND usr_id = ' . $DIC->database()->quote($a_usr_id, 'integer');

        $res = $DIC->database()->query($query);
        if ($row = $DIC->database()->fetchAssoc($res)) {
            $resObj = new ilLTIConsumerResult();
            $resObj->fillData($row);
            return $resObj;
        } elseif ($a_create) {
            $resObj = new ilLTIConsumerResult();
            $resObj->obj_id = $a_obj_id;
            $resObj->usr_id = $a_usr_id;
            $resObj->result = null;
            $resObj->save();
            return $resObj;
        } else {
            return null;
        }
    }

Here is the caller graph for this function:

getId()

ilLTIConsumerResult::getId

(

)

Definition at line 139 of file class.ilLTIConsumerResult.php.

References $id.

                           : int
    {
        return $this->id;
    }

getObjId()

ilLTIConsumerResult::getObjId

(

)

Definition at line 144 of file class.ilLTIConsumerResult.php.

References $obj_id.

                              : int
    {
        return $this->obj_id;
    }

getResult()

ilLTIConsumerResult::getResult

(

)

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

References $result.

                               : ?float
    {
        return $this->result;
    }

getResultsForObject()

static ilLTIConsumerResult::getResultsForObject ( int  $objId )

static

Parameters

$objId

Returns

ilLTIConsumerResult[]

Definition at line 163 of file class.ilLTIConsumerResult.php.

References $DIC, $res, and $results.

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

        $query = 'SELECT * FROM lti_consumer_results'
            . ' WHERE obj_id = ' . $DIC->database()->quote($objId, 'integer');

        $res = $DIC->database()->query($query);

        $results = [];

        if ($row = $DIC->database()->fetchAssoc($res)) {
            $resObj = new ilLTIConsumerResult();
            $resObj->fillData($row);

            $results[$resObj->getUsrId()] = $resObj;
        }

        return $results;
    }

getUsrId()

ilLTIConsumerResult::getUsrId

(

)

Definition at line 149 of file class.ilLTIConsumerResult.php.

References $usr_id.

                              : int
    {
        return $this->usr_id;
    }

save()

ilLTIConsumerResult::save

(

)

Save a result object.

Definition at line 115 of file class.ilLTIConsumerResult.php.

References $DIC.

Referenced by ilLTIConsumerResultService\replaceResult().

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

        if (!isset($this->usr_id) || !isset($this->obj_id)) {
            return false;
        }
        if (!isset($this->id)) {
            $this->id = $DIC->database()->nextId('lti_consumer_results');
        }
        $DIC->database()->replace(
            'lti_consumer_results',
            array(
                'id' => array('integer', $this->id)
            ),
            array(
                'obj_id' => array('integer', $this->obj_id),
                'usr_id' => array('integer', $this->usr_id),
                'result' => array('float', $this->result)
            )
        );
        return true;
    }

Here is the caller graph for this function:

Field Documentation

$id

int ilLTIConsumerResult::$id

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

Referenced by getId().

$obj_id

int ilLTIConsumerResult::$obj_id

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

Referenced by getObjId().

$result

float ilLTIConsumerResult::$result = null

Definition at line 49 of file class.ilLTIConsumerResult.php.

Referenced by getResult().

$usr_id

int ilLTIConsumerResult::$usr_id

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

Referenced by getUsrId().

---

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

• components/ILIAS/LTIConsumer/classes/class.ilLTIConsumerResult.php