ilAssQuestionHint Class Reference

Collaboration diagram for ilAssQuestionHint:

Public Member Functions
	__construct ()
	Constructor. More...
	getId ()
	returns the hint id More...
	setId ($id)
	sets the passed hint id More...
	getQuestionId ()
	returns the question id the hint currently relates to More...
	setQuestionId ($questionId)
	sets the passed question id so hint relates to it More...
	getIndex ()
	returns the ordering index of hint More...
	setIndex ($index)
	sets the passed hint ordering index More...
	getPoints ()
	returns the points to ground-off for this hint More...
	setPoints ($points)
	sets the passed points to ground-off for this hint More...
	getText ()
	returns the hint text More...
	setText ($text)
	sets the passed hint text More...
	load ($id)
	loads the hint dataset with passed id from database and assigns it the to this hint object instance More...
	save ()
	saves the current hint object state to database. More...
	delete ()
	deletes the persisted hint object in database by deleting the hint dataset identified by hint id More...
	getPageObjectType ()

Static Public Member Functions
static	assignDbRow (self $questionHint, $hintDbRow)
	assigns the field elements of passed hint db row array to the corresponding hint object properties of passed hint object instance More...
static	deleteById ($hintId)
	deletes the persisted hint object in database by deleting the hint dataset identified by hint id More...
static	getInstanceById ($hintId)
	creates a hint object instance, loads the persisted hint dataset identified by passed hint id from database and assigns it as object state More...
static	getHintIndexLabel (ilLanguage $lng, $hintIndex)

Data Fields
const	PAGE_OBJECT_TYPE = 'qht'

Protected Member Functions
	getHtmlQuestionContentPurifier ()

Private Member Functions
	update ()
	persists the current object state to database by updating an existing dataset identified by hint id More...
	insert ()
	persists the current object state to database by inserting a new dataset with a new hint id fetched from primary key sequence More...

Private Attributes
	$id = null
	$questionId = null
	$index = null
	$points = null
	$text = null

Detailed Description

Definition at line 26 of file class.ilAssQuestionHint.php.

Constructor & Destructor Documentation

__construct()

ilAssQuestionHint::__construct

(

)

Constructor.

public

Definition at line 77 of file class.ilAssQuestionHint.php.

    {
    }

Member Function Documentation

assignDbRow()

static ilAssQuestionHint::assignDbRow ( self  $questionHint,   $hintDbRow  )

static

assigns the field elements of passed hint db row array to the corresponding hint object properties of passed hint object instance

public

Parameters

self	$questionHint
array	$hintDbRow

Definition at line 323 of file class.ilAssQuestionHint.php.

Referenced by ilAssQuestionHintList\getListByHintIds(), and ilAssQuestionHintList\getListByQuestionId().

                                                                      : void
    {
        foreach ($hintDbRow as $field => $value) {
            switch ($field) {
                case 'qht_hint_id':                     $questionHint->setId($value);
                    break;
                case 'qht_question_fi':         $questionHint->setQuestionId($value);
                    break;
                case 'qht_hint_index':          $questionHint->setIndex($value);
                    break;
                case 'qht_hint_points':         $questionHint->setPoints($value);
                    break;
                case 'qht_hint_text':           $questionHint->setText($value);
                    break;

                default:        throw new ilTestQuestionPoolException("invalid db field identifier ($field) given!");
            }
        }
    }

Here is the caller graph for this function:

delete()

ilAssQuestionHint::delete

(

)

deletes the persisted hint object in database by deleting the hint dataset identified by hint id

Returns

integer $affectedRows

Definition at line 309 of file class.ilAssQuestionHint.php.

References getId().

                            : int
    {
        return self::deleteById($this->getId());
    }

Here is the call graph for this function:

deleteById()

static ilAssQuestionHint::deleteById (   $hintId )

static

deletes the persisted hint object in database by deleting the hint dataset identified by hint id

public ilDBInterface $ilDB

Parameters

integer

$hintId

Returns

integer $affectedRows

Definition at line 353 of file class.ilAssQuestionHint.php.

References $DIC, and $ilDB.

                                              : int
    {
        global $DIC;
        $ilDB = $DIC['ilDB'];

        $query = "
                        DELETE FROM             qpl_hints
                        WHERE                   qht_hint_id = %s
                ";

        return $ilDB->manipulateF(
            $query,
            ['integer'],
            [$hintId]
        );
    }

getHintIndexLabel()

static ilAssQuestionHint::getHintIndexLabel ( ilLanguage  $lng,   $hintIndex  )

static

Definition at line 391 of file class.ilAssQuestionHint.php.

References ilLanguage\txt().

Referenced by ilAssQuestionHintPageObjectCommandForwarder\buildPreviewPresentationPageObjectGUI(), ilAssQuestionHintPageObjectCommandForwarder\buildRequestPresentationPageObjectGUI(), and ilAssQuestionHintsTableGUI\fillRow().

                                                                         : string
    {
        return sprintf($lng->txt('tst_question_hints_index_column_label'), $hintIndex);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getHtmlQuestionContentPurifier()

ilAssQuestionHint::getHtmlQuestionContentPurifier ( )

protected

Definition at line 396 of file class.ilAssQuestionHint.php.

References ilHtmlPurifierFactory\getInstanceByType().

Referenced by setText().

                                                       : ilAssHtmlUserSolutionPurifier
    {
        return ilHtmlPurifierFactory::getInstanceByType('qpl_usersolution');
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getId()

ilAssQuestionHint::getId

(

)

returns the hint id

public

Returns

integer $id

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

References $id.

Referenced by delete(), insert(), save(), ilAssQuestionPreviewHintTracking\storeRequest(), ilAssQuestionHintTracking\storeRequest(), and update().

                           : ?int
    {
        return $this->id;
    }

Here is the caller graph for this function:

getIndex()

ilAssQuestionHint::getIndex

(

)

returns the ordering index of hint

public

Returns

integer $index

Definition at line 131 of file class.ilAssQuestionHint.php.

References $index.

Referenced by insert(), and update().

                              : ?int
    {
        return $this->index;
    }

Here is the caller graph for this function:

getInstanceById()

static ilAssQuestionHint::getInstanceById (   $hintId )

static

creates a hint object instance, loads the persisted hint dataset identified by passed hint id from database and assigns it as object state

public

Parameters

integer

$hintId

Returns

self $hintInstance

Definition at line 379 of file class.ilAssQuestionHint.php.

References load().

Referenced by ilAssQuestionPreviewHintTracking\getNextRequestableHint(), ilAssQuestionHintTracking\getNextRequestableHint(), ilAssQuestionHintsGUI\initHintOrderingClipboardNotification(), ilAssQuestionHintsGUI\pasteFromOrderingClipboardAfterCmd(), ilAssQuestionHintsGUI\pasteFromOrderingClipboardBeforeCmd(), ilAssQuestionHintRequestGUI\showHintCmd(), and ilAssQuestionHintsGUI\showHintCmd().

                                                   : ilAssQuestionHint
    {
        $questionHint = new self();
        $questionHint->load($hintId);
        return $questionHint;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getPageObjectType()

ilAssQuestionHint::getPageObjectType

(

)

Definition at line 386 of file class.ilAssQuestionHint.php.

                                       : string
    {
        return self::PAGE_OBJECT_TYPE;
    }

getPoints()

ilAssQuestionHint::getPoints

(

)

returns the points to ground-off for this hint

public

Returns

float $points

Definition at line 153 of file class.ilAssQuestionHint.php.

References $points.

Referenced by insert(), and update().

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

Here is the caller graph for this function:

getQuestionId()

ilAssQuestionHint::getQuestionId

(

)

returns the question id the hint currently relates to

public

Returns

integer $questionId

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

References $questionId.

Referenced by insert(), and update().

                                   : ?int
    {
        return $this->questionId;
    }

Here is the caller graph for this function:

getText()

ilAssQuestionHint::getText

(

)

returns the hint text

public

Returns

string $text

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

References $text.

Referenced by insert(), and update().

                             : ?string
    {
        return $this->text;
    }

Here is the caller graph for this function:

insert()

ilAssQuestionHint::insert ( )

private

persists the current object state to database by inserting a new dataset with a new hint id fetched from primary key sequence

private ilDBInterface $ilDB

Returns

boolean $success

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

References $DIC, $ilDB, getId(), getIndex(), getPoints(), getQuestionId(), getText(), and setId().

Referenced by save().

                             : bool
    {
        global $DIC;
        $ilDB = $DIC['ilDB'];

        $this->setId($ilDB->nextId('qpl_hints'));

        return $ilDB->insert('qpl_hints', [
            'qht_hint_id' => ['integer', $this->getId()],
            'qht_question_fi' => ['integer', $this->getQuestionId()],
            'qht_hint_index' => ['integer', $this->getIndex()],
            'qht_hint_points' => ['float', $this->getPoints()],
            'qht_hint_text' => ['clob', $this->getText()]
        ]);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

load()

ilAssQuestionHint::load

(

$id

)

loads the hint dataset with passed id from database and assigns it the to this hint object instance

public ilDBInterface $ilDB

Parameters

integer

$id

Returns

boolean $success

Definition at line 202 of file class.ilAssQuestionHint.php.

References $DIC, $id, $ilDB, and $res.

Referenced by getInstanceById().

                             : bool
    {
        global $DIC;
        $ilDB = $DIC['ilDB'];

        $query = "
                        SELECT  qht_hint_id,
                                        qht_question_fi,
                                        qht_hint_index,
                                        qht_hint_points,
                                        qht_hint_text

                        FROM    qpl_hints

                        WHERE   qht_hint_id = %s
                ";

        $res = $ilDB->queryF(
            $query,
            ['integer'],
            [(int) $id]
        );

        while ($row = $ilDB->fetchAssoc($res)) {
            self::assignDbRow($this, $row);

            return true;
        }

        return false;
    }

Here is the caller graph for this function:

save()

ilAssQuestionHint::save

(

)

saves the current hint object state to database.

it performs an insert or update, depending on the current initialisation of the hint id property

a valid initialised id leads to an update, a non or invalid initialised id leads to an insert

public

Returns

boolean $success

Definition at line 243 of file class.ilAssQuestionHint.php.

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

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

Here is the call graph for this function:

setId()

ilAssQuestionHint::setId

(

$id

)

sets the passed hint id

public

Parameters

integer

$id

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

References $id, and ILIAS\Repository\int().

Referenced by insert().

                              : void
    {
        $this->id = (int) $id;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setIndex()

ilAssQuestionHint::setIndex

(

$index

)

sets the passed hint ordering index

public

Parameters

integer

$index

Definition at line 142 of file class.ilAssQuestionHint.php.

References $index, and ILIAS\Repository\int().

                                    : void
    {
        $this->index = (int) $index;
    }

Here is the call graph for this function:

setPoints()

ilAssQuestionHint::setPoints

(

$points

)

sets the passed points to ground-off for this hint

public

Parameters

float

$points

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

References $points.

                                      : void
    {
        $this->points = abs((float) $points);
    }

setQuestionId()

ilAssQuestionHint::setQuestionId

(

$questionId

)

sets the passed question id so hint relates to it

public

Parameters

integer

$questionId

Definition at line 120 of file class.ilAssQuestionHint.php.

References $questionId, and ILIAS\Repository\int().

                                              : void
    {
        $this->questionId = (int) $questionId;
    }

Here is the call graph for this function:

setText()

ilAssQuestionHint::setText

(

$text

)

sets the passed hint text

public

Parameters

string

$text

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

References $text, getHtmlQuestionContentPurifier(), and null.

                                  : void
    {
        if ($text !== null) {
            $this->text = $this->getHtmlQuestionContentPurifier()->purify($text);
        }
    }

Here is the call graph for this function:

update()

ilAssQuestionHint::update ( )

private

persists the current object state to database by updating an existing dataset identified by hint id

private ilDBInterface $ilDB

Returns

boolean $success

Definition at line 260 of file class.ilAssQuestionHint.php.

References $DIC, $ilDB, getId(), getIndex(), getPoints(), getQuestionId(), and getText().

Referenced by save().

                             : bool
    {
        global $DIC;
        $ilDB = $DIC['ilDB'];

        return $ilDB->update(
            'qpl_hints',
            [
                    'qht_question_fi' => ['integer', $this->getQuestionId()],
                    'qht_hint_index' => ['integer', $this->getIndex()],
                    'qht_hint_points' => ['float', $this->getPoints()],
                    'qht_hint_text' => ['clob', $this->getText()]
                ],
            [
                    'qht_hint_id' => ['integer', $this->getId()]
                ]
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$id

ilAssQuestionHint::$id = null

private

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

Referenced by getId(), load(), and setId().

$index

ilAssQuestionHint::$index = null

private

Definition at line 53 of file class.ilAssQuestionHint.php.

Referenced by getIndex(), and setIndex().

$points

ilAssQuestionHint::$points = null

private

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

Referenced by getPoints(), and setPoints().

$questionId

ilAssQuestionHint::$questionId = null

private

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

Referenced by getQuestionId(), and setQuestionId().

$text

ilAssQuestionHint::$text = null

private

Definition at line 70 of file class.ilAssQuestionHint.php.

Referenced by getText(), and setText().

PAGE_OBJECT_TYPE

const ilAssQuestionHint::PAGE_OBJECT_TYPE = 'qht'

Definition at line 28 of file class.ilAssQuestionHint.php.

---

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

• components/ILIAS/TestQuestionPool/classes/class.ilAssQuestionHint.php