DB repo for survey run. More...

Collaboration diagram for ILIAS\Survey\Execution\RunDBRepository:

Public Member Functions
	__construct (InternalDataService $data, \ilDBInterface $db=null)

	getFinishedSurveysOfUser (int $user_id)
	Get all finished surveys of a user. More...

	getUnfinishedSurveysOfUser (int $user_id)
	Get all unfinished surveys of a user. More...

	getFinishedAppraiseesForRater (int $rater_id)

	getCurrentRunId (int $survey_id, int $user_id, string $code="", int $appr_id=0)

	getState (int $run_id)

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

	getById (int $run_id)

	add (int $survey_id, int $user_id, string $code, int $appraisee_id=0)
	Add new run. More...

	addTime (int $run_id, int $time, int $first_question)
	Add time record. More...

	updateTime (int $run_id, int $time, int $entered_time)

Data Fields
const	NOT_STARTED = -1

const	STARTED_NOT_FINISHED = 0

const	FINISHED = 1

Protected Attributes
ilDBInterface	$db

InternalDataService	$data

Detailed Description

DB repo for survey run.

Table svy_finished. Please note that there are lots of accesses to svy_finished in other classes.

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

Definition at line 31 of file class.RunDBRepository.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Survey\Execution\RunDBRepository::__construct	(	InternalDataService	$data,
		\ilDBInterface	$db = `null`
	)

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

      {
        global $DIC;
 
        $this->data = $data;
        $this->db = (is_null($db))
            ? $DIC->database()
            : $db;
    }

References ILIAS\Survey\Execution\RunDBRepository\$data, ILIAS\Survey\Execution\RunDBRepository\$db, and $DIC.

Member Function Documentation

◆ add()

ILIAS\Survey\Execution\RunDBRepository::add	(	int	$survey_id,
		int	$user_id,
		string	$code,
		int	$appraisee_id = `0`
	)

Add new run.

Returns: int run id

Definition at line 234 of file class.RunDBRepository.php.

     : int {
        $db = $this->db;
 
        $next_id = $db->nextId('svy_finished');
        $affectedRows = $db->manipulateF(
            "INSERT INTO svy_finished (finished_id, survey_fi, user_fi, anonymous_id, state, tstamp, appr_id) " .
            "VALUES (%s, %s, %s, %s, %s, %s, %s)",
            array('integer','integer','integer','text','text','integer','integer'),
            array($next_id, $survey_id, $user_id, $code, 0, time(), $appraisee_id)
        );
 
        return $next_id;
    }

◆ addTime()

ILIAS\Survey\Execution\RunDBRepository::addTime	(	int	$run_id,
		int	$time,
		int	$first_question
	)

Add time record.

Definition at line 256 of file class.RunDBRepository.php.

                                                                        : void
    {
        $db = $this->db;
        $id = $db->nextId('svy_times');
        $db->manipulateF(
            "INSERT INTO svy_times (id, finished_fi, entered_page, left_page, first_question) VALUES (%s, %s, %s, %s,%s)",
            array('integer','integer', 'integer', 'integer', 'integer'),
            array($id, $run_id, $time, null, $first_question)
        );
    }

References $id.

◆ getById()

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

Definition at line 209 of file class.RunDBRepository.php.

     : ?Run {
        $db = $this->db;
 
        $sql = "SELECT * FROM svy_finished" .
            " WHERE finished_id = " . $db->quote($run_id, "integer");
        $set = $db->query($sql);
        while ($row = $db->fetchAssoc($set)) {
            return $this->data->run((int) $row["survey_fi"], (int) $row["user_fi"])
                ->withId((int) $row["finished_id"])
                ->withFinished((bool) $row["state"])
                ->withCode((string) $row["anonymous_id"])
                ->withTimestamp((int) $row["tstamp"])
                ->withAppraiseeId((int) $row["appr_id"])
                ->withLastPage((int) $row["lastpage"]);
        }
        return null;
    }

References ILIAS\Survey\Execution\Run\withId().

Here is the call graph for this function:

◆ getCurrentRunId()

ILIAS\Survey\Execution\RunDBRepository::getCurrentRunId	(	int	$survey_id,
		int	$user_id,
		string	$code = `""`,
		int	$appr_id = `0`
	)

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

     : ?int {
        $db = $this->db;
 
        if ($code !== "") { // #15031 - should not matter if code was used by registered or anonymous (each code must be unique)
            $set = $db->queryF(
                "SELECT * FROM svy_finished" .
                " WHERE survey_fi = %s AND anonymous_id = %s AND appr_id = %s",
                array('integer', 'text', 'integer'),
                array($survey_id, $code, $appr_id)
            );
        } else {
            $set = $db->queryF(
                "SELECT * FROM svy_finished" .
                " WHERE survey_fi = %s AND user_fi = %s AND appr_id = %s",
                array('integer', 'integer', 'integer'),
                array($survey_id, $user_id, $appr_id)
            );
        }
        if ($rec = $db->fetchAssoc($set)) {
            return (int) $rec["finished_id"];
        }
        return null;
    }

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

Here is the caller graph for this function:

◆ getFinishedAppraiseesForRater()

ILIAS\Survey\Execution\RunDBRepository::getFinishedAppraiseesForRater ( int $rater_id )

Parameters

int $rater_id

Returns: array{survey_id: int, appr_id: int}[]

Definition at line 101 of file class.RunDBRepository.php.

     : array {
        $db = $this->db;
 
        $set = $db->queryF(
            "SELECT survey_fi, appr_id FROM svy_finished " .
            " WHERE user_fi = %s AND state = %s",
            ["integer", "integer"],
            [$rater_id, 1]
        );
        $appraisee = [];
        while ($rec = $db->fetchAssoc($set)) {
            $appraisee[] = [
                "survey_id" => (int) $rec["survey_fi"],
                "appr_id" => (int) $rec["appr_id"]
            ];
        }
        return $appraisee;
    }

References ILIAS\Repository\int().

Here is the call graph for this function:

◆ getFinishedSurveysOfUser()

ILIAS\Survey\Execution\RunDBRepository::getFinishedSurveysOfUser ( int $user_id )

Get all finished surveys of a user.

Returns: int[] survey ids

Definition at line 57 of file class.RunDBRepository.php.

     : array {
        $db = $this->db;
 
        $set = $db->queryF(
            "SELECT survey_fi FROM svy_finished " .
            " WHERE user_fi = %s AND state = %s",
            ["integer", "integer"],
            [$user_id, 1]
        );
        $items = [];
        while ($rec = $db->fetchAssoc($set)) {
            $items[] = (int) $rec["survey_fi"];
        }
        return $items;
    }

References ILIAS\Repository\int().

Here is the call graph for this function:

◆ getRunsForUser()

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

Returns: Run[]

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

     : array {
        $db = $this->db;
 
        $sql = "SELECT * FROM svy_finished" .
            " WHERE survey_fi = " . $db->quote($survey_id, "integer");
        // if proper user id is given, use it or current code
        if ($user_id !== ANONYMOUS_USER_ID) {
            $sql .= " AND (user_fi = " . $db->quote($user_id, "integer");
            if ($code !== "") {
                $sql .= " OR anonymous_id = " . $db->quote($code, "text");
            }
            $sql .= ")";
        }
        // use anonymous code to find finished id(s)
        else {
            if ($code === "") {
                return [];
            }
            $sql .= " AND anonymous_id = " . $db->quote($code, "text");
        }
        $set = $db->query($sql);
        $runs = [];
        while ($row = $db->fetchAssoc($set)) {
            $runs[$row["finished_id"]] = $this->data->run($survey_id, $user_id)
                ->withId((int) $row["finished_id"])
                ->withFinished((bool) $row["state"])
                ->withCode((string) $row["anonymous_id"])
                ->withTimestamp((int) $row["tstamp"])
                ->withAppraiseeId((int) $row["appr_id"])
                ->withLastPage((int) $row["lastpage"]);
        }
        return $runs;
    }

◆ getState()

ILIAS\Survey\Execution\RunDBRepository::getState ( int $run_id )

Definition at line 151 of file class.RunDBRepository.php.

     : int {
        $db = $this->db;
 
        $set = $db->queryF(
            "SELECT * FROM svy_finished" .
            " WHERE finished_id = %s ",
            array('integer'),
            array($run_id)
        );
        if ($rec = $db->fetchAssoc($set)) {
            return (int) $rec["state"];
        }
        return self::NOT_STARTED;
    }

Referenced by ILIAS\Survey\Execution\RunManager\belongsToFinishedRun(), and ILIAS\Survey\Execution\RunManager\getCurrentState().

Here is the caller graph for this function:

◆ getUnfinishedSurveysOfUser()

ILIAS\Survey\Execution\RunDBRepository::getUnfinishedSurveysOfUser ( int $user_id )

Get all unfinished surveys of a user.

Returns: int[] survey ids

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

     : array {
        $db = $this->db;
 
        $set = $db->queryF(
            "SELECT survey_fi FROM svy_finished " .
            " WHERE user_fi = %s AND state = %s",
            ["integer", "integer"],
            [$user_id, 0]
        );
        $items = [];
        while ($rec = $db->fetchAssoc($set)) {
            $items[] = (int) $rec["survey_fi"];
        }
        return $items;
    }

References ILIAS\Repository\int().

Here is the call graph for this function:

◆ updateTime()

ILIAS\Survey\Execution\RunDBRepository::updateTime	(	int	$run_id,
		int	$time,
		int	$entered_time
	)

Definition at line 267 of file class.RunDBRepository.php.

                                                                         : void
    {
        $db = $this->db;
        $db->manipulateF(
            "UPDATE svy_times SET left_page = %s WHERE finished_fi = %s AND entered_page = %s",
            array('integer', 'integer', 'integer'),
            array($time, $run_id, $entered_time)
        );
    }

Field Documentation

◆ $data

InternalDataService ILIAS\Survey\Execution\RunDBRepository::$data

protected

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

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

◆ $db

ilDBInterface ILIAS\Survey\Execution\RunDBRepository::$db

protected

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

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

◆ FINISHED

const ILIAS\Survey\Execution\RunDBRepository::FINISHED = 1

Definition at line 35 of file class.RunDBRepository.php.

Referenced by ILIAS\Survey\Execution\RunManager\belongsToFinishedRun(), ILIAS\Survey\Execution\RunManager\hasFinished(), and ILIAS\Survey\Execution\RunManager\hasStarted().

◆ NOT_STARTED

const ILIAS\Survey\Execution\RunDBRepository::NOT_STARTED = -1

Definition at line 33 of file class.RunDBRepository.php.

◆ STARTED_NOT_FINISHED

const ILIAS\Survey\Execution\RunDBRepository::STARTED_NOT_FINISHED = 0

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

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

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

Modules/Survey/Execution/class.RunDBRepository.php

Public Member Functions

Data Fields

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ add()

◆ addTime()

◆ getById()

◆ getCurrentRunId()

◆ getFinishedAppraiseesForRater()

◆ getFinishedSurveysOfUser()

◆ getRunsForUser()

◆ getState()

◆ getUnfinishedSurveysOfUser()

◆ updateTime()

Field Documentation

◆ $data

◆ $db

◆ FINISHED

◆ NOT_STARTED

◆ STARTED_NOT_FINISHED