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 28 of file class.ilAssQuestionHint.php.

Constructor & Destructor Documentation

◆ __construct()

ilAssQuestionHint::__construct ( )

Constructor.

@access public

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

80 {

81 }

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

@access public

Parameters

self	$questionHint
array	$hintDbRow

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

                                                                      : 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!");
            }
        }
    }

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

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 311 of file class.ilAssQuestionHint.php.

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

References deleteById(), and 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

@access public

@global ilDBInterface $ilDB

Parameters

integer $hintId

Returns: integer $affectedRows

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

                                              : int
    {
        global $DIC;
        $ilDB = $DIC['ilDB'];
 
        $query = "
                        DELETE FROM             qpl_hints
                        WHERE                   qht_hint_id = %s
                ";
 
        return $ilDB->manipulateF(
            $query,
            array('integer'),
            array($hintId)
        );
    }

References $DIC, $ilDB, and $query.

Referenced by delete().

Here is the caller graph for this function:

◆ getHintIndexLabel()

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

static

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

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

References $lng.

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

Here is the caller graph for this function:

◆ getHtmlQuestionContentPurifier()

ilAssQuestionHint::getHtmlQuestionContentPurifier ( )

protected

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

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

References ilHtmlPurifierFactory\getInstanceByType().

Referenced by setText().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getId()

ilAssQuestionHint::getId ( )

returns the hint id

@access public

Returns: integer $id

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

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

References $id.

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

Here is the caller graph for this function:

◆ getIndex()

ilAssQuestionHint::getIndex ( )

returns the ordering index of hint

@access public

Returns: integer $index

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

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

References $index.

Referenced by insert(), and update().

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

@access public

Parameters

integer $hintId

Returns: self $hintInstance

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

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

References load().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPageObjectType()

ilAssQuestionHint::getPageObjectType ( )

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

                                       : string
    {
        return self::PAGE_OBJECT_TYPE;
    }

References PAGE_OBJECT_TYPE.

◆ getPoints()

ilAssQuestionHint::getPoints ( )

returns the points to ground-off for this hint

@access public

Returns: float $points

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

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

References $points.

Referenced by insert(), and update().

Here is the caller graph for this function:

◆ getQuestionId()

ilAssQuestionHint::getQuestionId ( )

returns the question id the hint currently relates to

@access public

Returns: integer $questionId

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

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

References $questionId.

Referenced by insert(), and update().

Here is the caller graph for this function:

◆ getText()

ilAssQuestionHint::getText ( )

returns the hint text

@access public

Returns: string $text

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

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

References $text.

Referenced by insert(), and update().

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

@access private @global ilDBInterface $ilDB

Returns: boolean $success

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

                             : bool
    {
        global $DIC;
        $ilDB = $DIC['ilDB'];
 
        $this->setId($ilDB->nextId('qpl_hints'));
 
        return $ilDB->insert('qpl_hints', array(
            'qht_hint_id' => array('integer', $this->getId()),
            'qht_question_fi' => array('integer', $this->getQuestionId()),
            'qht_hint_index' => array('integer', $this->getIndex()),
            'qht_hint_points' => array('float', $this->getPoints()),
            'qht_hint_text' => array('clob', $this->getText())
        ));
    }

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

Referenced by save().

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

@access public @global ilDBInterface $ilDB

Parameters

integer $id

Returns: boolean $success

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

                             : 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,
            array('integer'),
            array((int) $id)
        );
 
        while ($row = $ilDB->fetchAssoc($res)) {
            self::assignDbRow($this, $row);
 
            return true;
        }
 
        return false;
    }

References $DIC, $id, $ilDB, $query, $res, and assignDbRow().

Referenced by getInstanceById().

Here is the call graph for this function:

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

@access public

Returns: boolean $success

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

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

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

Here is the call graph for this function:

◆ setId()

ilAssQuestionHint::setId ( $id )

sets the passed hint id

@access public

Parameters

integer $id

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

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

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

Referenced by insert().

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

@access public

Parameters

integer $index

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

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

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

Here is the call graph for this function:

◆ setPoints()

ilAssQuestionHint::setPoints ( $points )

sets the passed points to ground-off for this hint

@access public

Parameters

float $points

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

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

References $points.

◆ setQuestionId()

ilAssQuestionHint::setQuestionId ( $questionId )

sets the passed question id so hint relates to it

@access public

Parameters

integer $questionId

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

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

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

Here is the call graph for this function:

◆ setText()

ilAssQuestionHint::setText ( $text )

sets the passed hint text

@access public

Parameters

string $text

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

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

References $text, and getHtmlQuestionContentPurifier().

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

@access private @global ilDBInterface $ilDB

Returns: boolean $success

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

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