Survey Run Note: The manager should get the current user id passed. More...

Collaboration diagram for ILIAS\Survey\Execution\RunManager:

Public Member Functions
	__construct (InternalRepoService $repo_service, InternalDomainService $domain_service, \ilObjSurvey $survey, int $current_user_id, int $appraisee_id=0)

	getCurrentRunId ()

	hasStarted (int $appraisee=0)

	hasFinished ()

	belongsToFinishedRun (string $code)
	Does code belong to current anonymous started, but not finished run? Note: this method acts on the current user, but accepts the passed code and does not retrieve the code from the session. More...

	getRunsForUser (int $user_id, string $code="")

	getById (int $run_id)

	start (int $appraisee_id=0)
	Starts the survey creating a new run. More...

	initSession (string $requested_code="")

	getCode ()
	Get current valid code. More...

	clearCode ()

	setStartTime (int $first_question)
	Set start time of run. More...

	setEndTime ()

	getPageEnter ()

	setPreviewData (int $question_id, array $data)

	getPreviewData (int $question_id)

	clearPreviewData (int $question_id)

	clearAllPreviewData ()

	setErrors (array $errors)

	getErrors ()

	clearErrors ()

	setPostData (array $data)

	getPostData ()

	clearPostData ()

Protected Member Functions
	codeNeeded ()

	checkUserParameters (int $user_id, string $code="")
	Check user parameters. More...

	getCurrentState ()

Protected Attributes
ilLanguage	$lng

ILIAS Survey Code CodeManager	$code_manager

RunSessionRepo	$session_repo

RunDBRepository	$repo

int	$survey_id

Mode FeatureConfig	$feature_config

InternalDomainService	$domain_service

ilObjSurvey	$survey

int	$current_user_id

int	$appraisee_id

Detailed Description

Survey Run Note: The manager should get the current user id passed.

The manager also receives the current access key (code) from the session manager automatically.

Author: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Definition at line 34 of file class.RunManager.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Survey\Execution\RunManager::__construct	(	InternalRepoService	$repo_service,
		InternalDomainService	$domain_service,
		\ilObjSurvey	$survey,
		int	$current_user_id,
		int	$appraisee_id = `0`
	)

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

      {
        $this->repo = $repo_service->execution()->run();
 
        $this->survey_id = $survey->getSurveyId();
        $this->survey = $survey;
        $this->feature_config = $domain_service->modeFeatureConfig($survey->getMode());
        $this->domain_service = $domain_service;
        $this->current_user_id = $current_user_id;
        $this->appraisee_id = $appraisee_id;
        $this->session_repo = $repo_service->execution()->runSession();
        $this->code_manager = $domain_service->code($survey, $current_user_id);
        $this->lng = $domain_service->lng();
    }

References ILIAS\Survey\Execution\RunManager\$appraisee_id, ILIAS\Survey\Execution\RunManager\$current_user_id, ILIAS\Survey\Execution\RunManager\$domain_service, ILIAS\Survey\Execution\RunManager\$survey, ILIAS\Survey\InternalDomainService\code(), ILIAS\Survey\InternalRepoService\execution(), ilObjSurvey\getMode(), ilObjSurvey\getSurveyId(), ILIAS\Repository\lng(), and ILIAS\Survey\InternalDomainService\modeFeatureConfig().

Here is the call graph for this function:

Member Function Documentation

◆ belongsToFinishedRun()

ILIAS\Survey\Execution\RunManager::belongsToFinishedRun ( string $code )

Does code belong to current anonymous started, but not finished run? Note: this method acts on the current user, but accepts the passed code and does not retrieve the code from the session.

Definition at line 145 of file class.RunManager.php.

     : bool {
        $repo = $this->repo;
        $code_manager = $this->domain_service->code($this->survey, $this->current_user_id);
 
        if ($code_manager->exists($code)) {
            $run_id = $repo->getCurrentRunId(
                $this->survey_id,
                $this->current_user_id,
                $code,
                $this->appraisee_id
            );
            if ($run_id > 0) {
                $state = $repo->getState($run_id);
                if ($state === RunDBRepository::FINISHED) {
                    return true;
                }
            }
        }
        return false;
    }

References ILIAS\Survey\Execution\RunDBRepository\FINISHED, ILIAS\Survey\Execution\RunDBRepository\getCurrentRunId(), and ILIAS\Survey\Execution\RunDBRepository\getState().

Here is the call graph for this function:

◆ checkUserParameters()

ILIAS\Survey\Execution\RunManager::checkUserParameters	(	int	$user_id,
		string	$code = `""`
	)

protected

Check user parameters.

Exceptions

ilSurveyException

Todo:: : somehow this does not belong here, maybe session manager instead?

Definition at line 95 of file class.RunManager.php.

     : void {
        if ($this->feature_config->usesAppraisees() && $this->appraisee_id === 0) {
            throw new \ilSurveyException("No appraisee specified");
        }
 
        if (!$this->feature_config->usesAppraisees() && $this->appraisee_id > 0) {
            // self eval currently uses current user as appraisee id
            if ($this->survey->getMode() !== \ilObjSurvey::MODE_SELF_EVAL || $user_id !== $this->appraisee_id) {
                throw new \ilSurveyException("Appraisee ID given, but appraisees not supported");
            }
        }
 
        /* this fails on the info screen
        if ($user_id === ANONYMOUS_USER_ID && $code === "") {
            throw new \ilSurveyException("Code missing for anonymous user.");
        }*/
    }

Referenced by ILIAS\Survey\Execution\RunManager\getCurrentRunId().

Here is the caller graph for this function:

◆ clearAllPreviewData()

ILIAS\Survey\Execution\RunManager::clearAllPreviewData ( )

Definition at line 314 of file class.RunManager.php.

                                         : void
    {
        $this->session_repo->clearAllPreviewData($this->survey_id);
    }

◆ clearCode()

ILIAS\Survey\Execution\RunManager::clearCode ( )

Definition at line 269 of file class.RunManager.php.

                               : void
    {
        $this->session_repo->clearCode($this->survey->getId());
    }

◆ clearErrors()

ILIAS\Survey\Execution\RunManager::clearErrors ( )

Definition at line 329 of file class.RunManager.php.

                                 : void
    {
        $this->session_repo->clearErrors();
    }

◆ clearPostData()

ILIAS\Survey\Execution\RunManager::clearPostData ( )

Definition at line 344 of file class.RunManager.php.

                                   : void
    {
        $this->session_repo->clearPostData();
    }

◆ clearPreviewData()

ILIAS\Survey\Execution\RunManager::clearPreviewData ( int $question_id )

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

                                                      : void
    {
        $this->session_repo->clearPreviewData($this->survey_id, $question_id);
    }

◆ codeNeeded()

ILIAS\Survey\Execution\RunManager::codeNeeded ( )

protected

Definition at line 67 of file class.RunManager.php.

                                   : bool
    {
        return !$this->survey->isAccessibleWithoutCode();
    }

Referenced by ILIAS\Survey\Execution\RunManager\getCurrentRunId().

Here is the caller graph for this function:

◆ getById()

ILIAS\Survey\Execution\RunManager::getById ( int $run_id )

Definition at line 178 of file class.RunManager.php.

                                        : ?Run
    {
        $run = $this->repo->getById($run_id);
        if (!is_null($run) && $run->getSurveyId() !== $this->survey->getSurveyId()) {
            throw new \ilSurveyException("Run survey id mismatch.");
        }
        return $run;
    }

◆ getCode()

ILIAS\Survey\Execution\RunManager::getCode ( )

Get current valid code.

Definition at line 264 of file class.RunManager.php.

                             : string
    {
        return $this->session_repo->getCode($this->survey->getId());
    }

Referenced by ILIAS\Survey\Execution\RunManager\getCurrentRunId().

Here is the caller graph for this function:

◆ getCurrentRunId()

ILIAS\Survey\Execution\RunManager::getCurrentRunId ( )

Definition at line 72 of file class.RunManager.php.

                                     : int
    {
        $repo = $this->repo;
        $survey_id = $this->survey_id;
        $user_id = $this->current_user_id;
        $code = $this->getCode();
 
        $this->checkUserParameters($user_id, $code);
 
        // code needed, no code given -> no run
        if ($code === "" && $this->codeNeeded()) {
            return 0;
        }
 
        $run_id = $repo->getCurrentRunId($survey_id, $user_id, $code, $this->appraisee_id);
        return (int) $run_id;
    }

References ILIAS\Survey\Execution\RunManager\$current_user_id, ILIAS\Survey\Execution\RunManager\$repo, ILIAS\Survey\Execution\RunManager\$survey_id, $user_id, ILIAS\Survey\Execution\RunManager\checkUserParameters(), ILIAS\Survey\Execution\RunManager\codeNeeded(), ILIAS\Survey\Execution\RunManager\getCode(), and ILIAS\Survey\Execution\RunDBRepository\getCurrentRunId().

Here is the call graph for this function:

◆ getCurrentState()

ILIAS\Survey\Execution\RunManager::getCurrentState ( )

protected

Definition at line 118 of file class.RunManager.php.

                                        : int
    {
        $repo = $this->repo;
        $run_id = $this->getCurrentRunId();
        return $repo->getState($run_id);
    }

References ILIAS\Survey\Execution\RunDBRepository\getState().

Here is the call graph for this function:

◆ getErrors()

ILIAS\Survey\Execution\RunManager::getErrors ( )

Definition at line 324 of file class.RunManager.php.

                               : array
    {
        return $this->session_repo->getErrors();
    }

◆ getPageEnter()

ILIAS\Survey\Execution\RunManager::getPageEnter ( )

Definition at line 294 of file class.RunManager.php.

                                  : int
    {
        return $this->session_repo->getPageEnter();
    }

◆ getPostData()

ILIAS\Survey\Execution\RunManager::getPostData ( )

Definition at line 339 of file class.RunManager.php.

                                 : array
    {
        return $this->session_repo->getPostData();
    }

◆ getPreviewData()

ILIAS\Survey\Execution\RunManager::getPreviewData ( int $question_id )

Definition at line 304 of file class.RunManager.php.

                                                    : array
    {
        return $this->session_repo->getPreviewData($this->survey_id, $question_id);
    }

◆ getRunsForUser()

ILIAS\Survey\Execution\RunManager::getRunsForUser	(	int	$user_id,
		string	$code = `""`
	)

Returns: Run[]

Definition at line 171 of file class.RunManager.php.

     : array {
        return $this->repo->getRunsForUser($this->survey->getSurveyId(), $user_id, $code);
    }

◆ hasFinished()

ILIAS\Survey\Execution\RunManager::hasFinished ( )

Definition at line 134 of file class.RunManager.php.

                                 : bool
    {
        return ($this->getCurrentState() ===
            RunDBRepository::FINISHED);
    }

References ILIAS\Survey\Execution\RunDBRepository\FINISHED.

◆ hasStarted()

ILIAS\Survey\Execution\RunManager::hasStarted ( int $appraisee = 0 )

Definition at line 125 of file class.RunManager.php.

                                                  : bool
    {
        return in_array(
            $this->getCurrentState(),
            [RunDBRepository::STARTED_NOT_FINISHED, RunDBRepository::FINISHED],
            true
        );
    }

References ILIAS\Survey\Execution\RunDBRepository\FINISHED, and ILIAS\Survey\Execution\RunDBRepository\STARTED_NOT_FINISHED.

◆ initSession()

ILIAS\Survey\Execution\RunManager::initSession ( string $requested_code = "" )

Definition at line 206 of file class.RunManager.php.

     : void {
        $user_id = $this->current_user_id;
        $survey = $this->survey;
        $session_repo = $this->session_repo;
        // validate incoming
        $code_input = false;
        // ->requested_code
        $anonymous_code = $requested_code;
        if ($anonymous_code !== "") {
            $code_input = true;
            if ($this->belongsToFinishedRun($anonymous_code)) { // #15031 - valid as long survey is not finished
                $anonymous_code = "";
            } else {
                // #15860
                // a user has used a valid code, we store this in table
                // svy_anonymous
                $this->code_manager->bindUser($anonymous_code, $user_id);
                $session_repo->setCode($survey->getId(), $anonymous_code);
            }
        }
        // now we try to get the code from the session
        if (!$anonymous_code) {
            $anonymous_code = $session_repo->getCode($survey->getId());
            if ($anonymous_code) {
                $code_input = true;     // ??
            }
        }
 
        // if the survey is anonymous, codes are stored for logged
        // in users in svy_finished. Here we get this code, if already stored
        if ($survey->getAnonymize() && !$anonymous_code) {
            $anonymous_code = $survey->findCodeForUser($user_id);
        }
 
        // get existing runs for current user, might generate code
        $execution_status = $survey->getUserSurveyExecutionStatus($anonymous_code);
        if ($execution_status) {
            $anonymous_code = (string) $execution_status["code"];
            $execution_status = $execution_status["runs"];
        }
 
        // (final) check for proper anonymous code
        if (!$survey->isAccessibleWithoutCode() &&
//          !$is_appraisee &&
            $code_input && // #11346
            (!$anonymous_code || !$this->code_manager->exists($anonymous_code))) {
            $anonymous_code = "";
            $this->clearCode();
            throw new \ilWrongSurveyCodeException($this->lng->txt("svy_wrong_or_expired_code"));
        }
        $this->session_repo->setCode($survey->getId(), $anonymous_code);
    }

References $user_id, and ILIAS\Survey\Execution\RunSessionRepo\setCode().

Here is the call graph for this function:

◆ setEndTime()

ILIAS\Survey\Execution\RunManager::setEndTime ( )

Definition at line 286 of file class.RunManager.php.

                                : void
    {
        $run_id = $this->getCurrentRunId();
        $time = time();
        $this->repo->updateTime($run_id, $time, $this->session_repo->getPageEnter());
        $this->session_repo->clearPageEnter();
    }

◆ setErrors()

ILIAS\Survey\Execution\RunManager::setErrors ( array $errors )

Definition at line 319 of file class.RunManager.php.

                                            : void
    {
        $this->session_repo->setErrors($errors);
    }

◆ setPostData()

ILIAS\Survey\Execution\RunManager::setPostData ( array $data )

Definition at line 334 of file class.RunManager.php.

                                            : void
    {
        $this->session_repo->setPostData($data);
    }

References $data.

◆ setPreviewData()

ILIAS\Survey\Execution\RunManager::setPreviewData	(	int	$question_id,
		array	$data
	)

Definition at line 299 of file class.RunManager.php.

                                                                 : void
    {
        $this->session_repo->setPreviewData($this->survey_id, $question_id, $data);
    }

References $data.

◆ setStartTime()

ILIAS\Survey\Execution\RunManager::setStartTime ( int $first_question )

Set start time of run.

Definition at line 277 of file class.RunManager.php.

     : void {
        $run_id = $this->getCurrentRunId();
        $time = time();
        $this->session_repo->setPageEnter($time);
        $this->repo->addTime($run_id, $time, $first_question);
    }

◆ start()

ILIAS\Survey\Execution\RunManager::start ( int $appraisee_id = 0 )

Starts the survey creating a new run.

Definition at line 190 of file class.RunManager.php.

     : void {
        $appraisee_id = ($appraisee_id > 0)
            ? $appraisee_id
            : $this->appraisee_id;
        $code = $this->getCode();
        $user_id = $this->current_user_id;
        $survey = $this->survey;
 
        if ($survey->getAnonymize() && $code === '') {
            return;
        }
        $this->repo->add($this->survey->getSurveyId(), $user_id, $code, $appraisee_id);
    }

Field Documentation

◆ $appraisee_id

int ILIAS\Survey\Execution\RunManager::$appraisee_id

protected

Definition at line 45 of file class.RunManager.php.

Referenced by ILIAS\Survey\Execution\RunManager\__construct().

◆ $code_manager

ILIAS Survey Code CodeManager ILIAS\Survey\Execution\RunManager::$code_manager

protected

Definition at line 37 of file class.RunManager.php.

◆ $current_user_id

int ILIAS\Survey\Execution\RunManager::$current_user_id

protected

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

Referenced by ILIAS\Survey\Execution\RunManager\__construct(), and ILIAS\Survey\Execution\RunManager\getCurrentRunId().

◆ $domain_service

InternalDomainService ILIAS\Survey\Execution\RunManager::$domain_service

protected

Definition at line 42 of file class.RunManager.php.

Referenced by ILIAS\Survey\Execution\RunManager\__construct().

◆ $feature_config

Mode FeatureConfig ILIAS\Survey\Execution\RunManager::$feature_config

protected

Definition at line 41 of file class.RunManager.php.

◆ $lng

ilLanguage ILIAS\Survey\Execution\RunManager::$lng

protected

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

◆ $repo

RunDBRepository ILIAS\Survey\Execution\RunManager::$repo

protected

Definition at line 39 of file class.RunManager.php.

Referenced by ILIAS\Survey\Execution\RunManager\getCurrentRunId().

◆ $session_repo

RunSessionRepo ILIAS\Survey\Execution\RunManager::$session_repo

protected

Definition at line 38 of file class.RunManager.php.

◆ $survey

ilObjSurvey ILIAS\Survey\Execution\RunManager::$survey

protected

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

Referenced by ILIAS\Survey\Execution\RunManager\__construct().

◆ $survey_id

int ILIAS\Survey\Execution\RunManager::$survey_id

protected

Definition at line 40 of file class.RunManager.php.

Referenced by ILIAS\Survey\Execution\RunManager\getCurrentRunId().

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

components/ILIAS/Survey/Execution/class.RunManager.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ belongsToFinishedRun()

◆ checkUserParameters()

◆ clearAllPreviewData()

◆ clearCode()

◆ clearErrors()

◆ clearPostData()

◆ clearPreviewData()

◆ codeNeeded()

◆ getById()

◆ getCode()

◆ getCurrentRunId()

◆ getCurrentState()

◆ getErrors()

◆ getPageEnter()

◆ getPostData()

◆ getPreviewData()

◆ getRunsForUser()

◆ hasFinished()

◆ hasStarted()

◆ initSession()

◆ setEndTime()

◆ setErrors()

◆ setPostData()

◆ setPreviewData()

◆ setStartTime()

◆ start()

Field Documentation

◆ $appraisee_id

◆ $code_manager

◆ $current_user_id

◆ $domain_service

◆ $feature_config

◆ $lng

◆ $repo

◆ $session_repo

◆ $survey

◆ $survey_id