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 ($a_id)
	Get a result by id. More...
static	getByKeys ($a_obj_id, $a_usr_id, $a_create=false)
	Get a result by object and user key. More...
static	getResultsForObject ($objId)

Data Fields
	$id
	$obj_id
	$usr_id
	$result

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

Detailed Description

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

Member Function Documentation

fillData()

ilLTIConsumerResult::fillData (   $data )

protected

Fill the properties with data from an array.

Parameters

array

assoc data

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

References $data.

Referenced by getById(), getByKeys(), and getResultsForObject().

    {
        $this->id = $data['id'];
        $this->obj_id = $data['obj_id'];
        $this->usr_id = $data['usr_id'];
        $this->result = $data['result'];
    }

Here is the caller graph for this function:

getById()

static ilLTIConsumerResult::getById (   $a_id )

static

Get a result by id.

Parameters

integer

id

Returns

LTIConsumerResult of null if not exists

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

References $DIC, $query, $res, and fillData().

    {
        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;
        }
    }

Here is the call graph for this function:

getByKeys()

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

static

Get a result by object and user key.

Parameters

integer	object id
integer	user id
boolean	save a new result object result if not exists

Returns

ilLTIConsumerResult

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

References $DIC, $query, $res, fillData(), and save().

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

    {
        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 call graph for this function:

Here is the caller graph for this function:

getId()

ilLTIConsumerResult::getId

(

)

Returns

int

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

References $id.

    {
        return $this->id;
    }

getObjId()

ilLTIConsumerResult::getObjId

(

)

Returns

int

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

References $obj_id.

    {
        return $this->obj_id;
    }

getResult()

ilLTIConsumerResult::getResult

(

)

Returns

float

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

References $result.

    {
        return $this->result;
    }

getResultsForObject()

static ilLTIConsumerResult::getResultsForObject (   $objId )

static

Parameters

$objId

Returns

ilLTIConsumerResult[]

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

References $DIC, $objId, $query, $res, $results, and fillData().

    {
        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;
    }

Here is the call graph for this function:

getUsrId()

ilLTIConsumerResult::getUsrId

(

)

Returns

int

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

References $usr_id.

    {
        return $this->usr_id;
    }

save()

ilLTIConsumerResult::save

(

)

Save a result object.

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

References $DIC.

Referenced by getByKeys().

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

        if (!isset($this->usr_id) or !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

ilLTIConsumerResult::$id

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

Referenced by getId().

$obj_id

ilLTIConsumerResult::$obj_id

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

Referenced by getObjId().

$result

ilLTIConsumerResult::$result

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

Referenced by getResult().

$usr_id

ilLTIConsumerResult::$usr_id

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

Referenced by getUsrId().

---

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

• Modules/LTIConsumer/classes/class.ilLTIConsumerResult.php