ilAssQuestionHintsOrderingClipboard Class Reference

Collaboration diagram for ilAssQuestionHintsOrderingClipboard:

Public Member Functions
	__construct (assQuestion $questionOBJ)
	Constructor. More...
	resetStored ()
	resets the clipboard by ensuring no hint is stored More...
	setStored ($hintId)
	sets the passed hint id, so relating hint is deemed to be cut to clipboard More...
	getStored ()
	returns the hint id currently stored in clipboard More...
	isStored ($hintId)
	returns the fact wether the hint relating to the passed hint id is stored in clipboard or not More...
	hasStored ()
	returns the fact wether any hint is stored in clipboard currently or not More...

Private Attributes
	$questionId = null

Detailed Description

Definition at line 13 of file class.ilAssQuestionHintsOrderingClipboard.php.

Constructor & Destructor Documentation

__construct()

ilAssQuestionHintsOrderingClipboard::__construct

(

assQuestion

$questionOBJ

)

Constructor.

@access public

Parameters

assQuestion

$questionOBJ

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

    {
        $this->questionId = $questionOBJ->getId();
        
        if (!isset($_SESSION[__CLASS__])) {
            $_SESSION[__CLASS__] = array();
        }
        
        if (!isset($_SESSION[__CLASS__][$this->questionId])) {
            $_SESSION[__CLASS__][$this->questionId] = null;
        }
    }

References $_SESSION, $questionId, and assQuestion\getId().

Here is the call graph for this function:

Member Function Documentation

getStored()

ilAssQuestionHintsOrderingClipboard::getStored

(

)

returns the hint id currently stored in clipboard

@access public

Returns

integer $hintId

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

    {
        return $_SESSION[__CLASS__][$this->questionId];
    }

References $_SESSION, and $questionId.

hasStored()

ilAssQuestionHintsOrderingClipboard::hasStored

(

)

returns the fact wether any hint is stored in clipboard currently or not

@access public

Returns

boolean $hasStored

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

    {
        if ($_SESSION[__CLASS__][$this->questionId] !== null) {
            return true;
        }
        
        return false;
    }

References $_SESSION.

isStored()

ilAssQuestionHintsOrderingClipboard::isStored

(

$hintId

)

returns the fact wether the hint relating to the passed hint id is stored in clipboard or not

@access public

Parameters

integer

$hintId

Returns

boolean $isStored

Definition at line 83 of file class.ilAssQuestionHintsOrderingClipboard.php.

    {
        if ($_SESSION[__CLASS__][$this->questionId] === $hintId) {
            return true;
        }
        
        return false;
    }

References $_SESSION.

resetStored()

ilAssQuestionHintsOrderingClipboard::resetStored

(

)

resets the clipboard by ensuring no hint is stored

@access public

Definition at line 47 of file class.ilAssQuestionHintsOrderingClipboard.php.

    {
        $_SESSION[__CLASS__][$this->questionId] = null;
    }

References $_SESSION, and $questionId.

setStored()

ilAssQuestionHintsOrderingClipboard::setStored

(

$hintId

)

sets the passed hint id, so relating hint is deemed to be cut to clipboard

@access public

Parameters

integer

$hintId

Definition at line 59 of file class.ilAssQuestionHintsOrderingClipboard.php.

    {
        $_SESSION[__CLASS__][$this->questionId] = $hintId;
    }

References $_SESSION, and $questionId.

Field Documentation

$questionId

ilAssQuestionHintsOrderingClipboard::$questionId = null

private

Definition at line 21 of file class.ilAssQuestionHintsOrderingClipboard.php.

Referenced by __construct(), getStored(), resetStored(), and setStored().

---

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

• Modules/TestQuestionPool/classes/class.ilAssQuestionHintsOrderingClipboard.php