class.ilAssQuestionPreviewSession.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2013 ILIAS open source, Extended GPL, see docs/LICENSE */


class ilAssQuestionPreviewSession
{
        const SESSION_BASEINDEX = 'ilAssQuestionPreviewSessions';
        
        const SESSION_SUBINDEX_INSTANT_RESPONSE_ACTIVE = 'instantResponseActive';
        const SESSION_SUBINDEX_PARTICIPANT_SOLUTION = 'participantSolution';
        const SESSION_SUBINDEX_REQUESTED_HINTS = 'requestedHints';
        const SESSION_SUBINDEX_RANDOMIZER_SEED = 'randomizerSeed';

        private $userId;
        private $questionId;
        
        public function __construct($userId, $questionId)
        {
                $this->userId = $userId;
                $this->questionId = $questionId;
        }
        
        public function init()
        {
                $this->ensureSessionStructureExists();
        }
        
        public function getUserId()
        {
                return $this->userId;
        }
        
        public function getQuestionId()
        {
                return $this->questionId;
        }
        
        private function getSessionContextIndex()
        {
                return "u{$this->userId}::q{$this->questionId}";
        }
        
        private function saveSessionValue($subIndex, $value)
        {
                $_SESSION[self::SESSION_BASEINDEX][$this->getSessionContextIndex()][$subIndex] = $value;
        }
        
        private function readSessionValue($subIndex)
        {
                return $_SESSION[self::SESSION_BASEINDEX][$this->getSessionContextIndex()][$subIndex];
        }

        public function setInstantResponseActive($instantResponseActive)
        {
                $this->saveSessionValue(self::SESSION_SUBINDEX_INSTANT_RESPONSE_ACTIVE, $instantResponseActive);
        }
        
        public function isInstantResponseActive()
        {
                return $this->readSessionValue(self::SESSION_SUBINDEX_INSTANT_RESPONSE_ACTIVE);
        }
        
        public function setParticipantsSolution($participantSolution)
        {
                $this->saveSessionValue(self::SESSION_SUBINDEX_PARTICIPANT_SOLUTION, $participantSolution);
        }

        public function getParticipantsSolution()
        {
                return $this->readSessionValue(self::SESSION_SUBINDEX_PARTICIPANT_SOLUTION);
        }
        
        public function getNumRequestedHints()
        {
                return count($this->readSessionValue(self::SESSION_SUBINDEX_REQUESTED_HINTS));
        }
        
        public function isHintRequested($hintId)
        {
                $requestedHints = $this->readSessionValue(self::SESSION_SUBINDEX_REQUESTED_HINTS);
                return isset($requestedHints[$hintId]);
        }
        
        public function addRequestedHint($hintId)
        {
                $requestedHints = $this->readSessionValue(self::SESSION_SUBINDEX_REQUESTED_HINTS);
                $requestedHints[$hintId] = $hintId;
                $this->saveSessionValue(self::SESSION_SUBINDEX_REQUESTED_HINTS, $requestedHints);
        }
        
        public function getRequestedHints()
        {
                return $this->readSessionValue(self::SESSION_SUBINDEX_REQUESTED_HINTS);
        }
        
        public function resetRequestedHints()
        {
                $this->saveSessionValue(self::SESSION_SUBINDEX_REQUESTED_HINTS, array());
        }
        
        public function setRandomizerSeed($seed)
        {
                $this->saveSessionValue(self::SESSION_SUBINDEX_RANDOMIZER_SEED, $seed);
        }
        
        public function getRandomizerSeed()
        {
                return $this->readSessionValue(self::SESSION_SUBINDEX_RANDOMIZER_SEED);
        }

        public function randomizerSeedExists()
        {
                return ($this->getRandomizerSeed() !== null);
        }

        private function ensureSessionStructureExists()
        {
                if(!isset($_SESSION[self::SESSION_BASEINDEX]) || !is_array($_SESSION[self::SESSION_BASEINDEX]))
                {
                        $_SESSION[self::SESSION_BASEINDEX] = array();
                }

                $baseSession = &$_SESSION[self::SESSION_BASEINDEX];

                if(!isset($baseSession[$this->getSessionContextIndex()]))
                {
                        $baseSession[$this->getSessionContextIndex()] = array();
                }

                $contextSession = &$baseSession[$this->getSessionContextIndex()];

                if(!isset($contextSession[self::SESSION_SUBINDEX_INSTANT_RESPONSE_ACTIVE]))
                {
                        $contextSession[self::SESSION_SUBINDEX_INSTANT_RESPONSE_ACTIVE] = 0;
                }

                if(!isset($contextSession[self::SESSION_SUBINDEX_PARTICIPANT_SOLUTION]))
                {
                        $contextSession[self::SESSION_SUBINDEX_PARTICIPANT_SOLUTION] = null;
                }

                if(!isset($contextSession[self::SESSION_SUBINDEX_RANDOMIZER_SEED]))
                {
                        $contextSession[self::SESSION_SUBINDEX_RANDOMIZER_SEED] = null;
                }
        }
}