DB survey codes (table. More...

Collaboration diagram for ILIAS\Survey\Code\CodeDBRepo:

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

	deleteAll (int $survey_id)
	Delete all codes of a survey. More...

	delete (int $survey_id, string $code)
	Delete single code. More...

	exists (int $survey_id, string $code)
	Does code exist in survey? More...

	add (int $survey_id, string $code="", int $user_id=0, string $email="", string $last_name="", string $first_name="", int $sent=0, int $tstamp=0)
	Saves a survey access code for a registered user to the database. More...

	addCodes (int $survey_id, int $nr)
	Add multiple codes. More...

	updateExternalData (int $code_id, string $email, string $last_name, string $first_name, int $sent)
	Update external data of a code. More...

	getAll (int $survey_id)
	Get all access keys of a survey. More...

	getAllData (int $survey_id)
	Get all codes of a survey. More...

	getByUserKey (int $survey_id, string $survey_key)

	bindUser (int $survey_id, string $code, int $user_id)
	Bind registered user to a code. More...

	getByUserId (int $survey_id, int $user_id)
	Get code for a registered user. More...

	getByCodeId (int $survey_id, int $code_id)

Protected Member Functions
	getNew (int $survey_id)
	Get a new unique code. More...

	getUserKey (int $user_id)
	Get user key for id. More...

Protected Attributes
ilDBInterface	$db

InternalDataService	$data

Detailed Description

DB survey codes (table.

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

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

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Survey\Code\CodeDBRepo::__construct	(	InternalDataService	$data,
		\ilDBInterface	$db
	)

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

References ILIAS\Survey\Code\CodeDBRepo\$data, and ILIAS\Survey\Code\CodeDBRepo\$db.

       {
         $this->db = $db;
         $this->data = $data;
     }

Member Function Documentation

◆ add()

ILIAS\Survey\Code\CodeDBRepo::add	(	int	$survey_id,
		string	$code = `""`,
		int	$user_id = `0`,
		string	$email = `""`,
		string	$last_name = `""`,
		string	$first_name = `""`,
		int	$sent = `0`,
		int	$tstamp = `0`
	)

Saves a survey access code for a registered user to the database.

Returns: int new id

Exceptions

Definition at line 128 of file class.CodeDBRepo.php.

References ILIAS\Survey\Code\CodeDBRepo\$db, ILIAS\Survey\Code\CodeDBRepo\exists(), ILIAS\Survey\Code\CodeDBRepo\getNew(), ILIAS\Survey\Code\CodeDBRepo\getUserKey(), and ILIAS\Survey\Code\CodeDBRepo\updateExternalData().

Referenced by ILIAS\Survey\Code\CodeManager\add(), and ILIAS\Survey\Code\CodeDBRepo\addCodes().

      : int {
         $db = $this->db;
 
         if ($code === "") {
             $code = $this->getNew($survey_id);
         }
         if ($this->exists($survey_id, $code)) {
             throw new \ilSurveyException("Code $code already exists.");
         }
 
         $user_key = $this->getUserKey($user_id);
 
         if ($tstamp === 0) {
             $tstamp = time();
         }
 
         $next_id = $db->nextId('svy_anonymous');
 
         $db->insert("svy_anonymous", [
             "anonymous_id" => ["integer", $next_id],
             "survey_key" => ["text", $code],
             "survey_fi" => ["integer", $survey_id],
             "user_key" => ["text", $user_key],
             "tstamp" => ["integer", $tstamp],
             "sent" => ["integer", $sent]
         ]);
 
         if ($email !== "" || $last_name !== "" || $first_name !== "") {
             $this->updateExternalData(
                 $next_id,
                 $email,
                 $last_name,
                 $first_name,
                 $sent
             );
         }
         return $next_id;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addCodes()

ILIAS\Survey\Code\CodeDBRepo::addCodes	(	int	$survey_id,
		int	$nr
	)

Add multiple codes.

Parameters

int $nr number of codes that should be generated/added

Returns: int[]

Exceptions

Definition at line 182 of file class.CodeDBRepo.php.

References ILIAS\Survey\Code\CodeDBRepo\add().

      : array {
         $ids = [];
         while ($nr-- > 0) {
             $ids[] = $this->add($survey_id);
         }
         return $ids;
     }

Here is the call graph for this function:

◆ bindUser()

ILIAS\Survey\Code\CodeDBRepo::bindUser	(	int	$survey_id,
		string	$code,
		int	$user_id
	)

Bind registered user to a code.

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

References ILIAS\Survey\Code\CodeDBRepo\$db, and ILIAS\Survey\Code\CodeDBRepo\getUserKey().

      : void {
         $db = $this->db;
 
         $user_key = $this->getUserKey($user_id);
 
         $db->update(
             "svy_anonymous",
             [
             "user_key" => ["text", $user_key]
         ],
             [    // where
                 "survey_fi" => ["integer", $survey_id],
                 "survey_key" => ["text", $code]
             ]
         );
     }

Here is the call graph for this function:

◆ delete()

ILIAS\Survey\Code\CodeDBRepo::delete	(	int	$survey_id,
		string	$code
	)

Delete single code.

Definition at line 61 of file class.CodeDBRepo.php.

References ILIAS\Survey\Code\CodeDBRepo\$db, and ilDBInterface\manipulateF().

Referenced by ILIAS\Survey\Code\CodeManager\delete().

                                                         : void
     {
         $db = $this->db;
 
         if ($code !== "") {
             $db->manipulateF(
                 "DELETE FROM svy_anonymous WHERE " .
                 " survey_fi = %s AND survey_key = %s",
                 ["integer", "text"],
                 [$survey_id, $code]
             );
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deleteAll()

ILIAS\Survey\Code\CodeDBRepo::deleteAll ( int $survey_id )

Delete all codes of a survey.

Definition at line 46 of file class.CodeDBRepo.php.

References ILIAS\Survey\Code\CodeDBRepo\$db, and ilDBInterface\manipulateF().

Referenced by ILIAS\Survey\Code\CodeManager\deleteAll().

                                              : void
     {
         $db = $this->db;
 
         $db->manipulateF(
             "DELETE FROM svy_anonymous WHERE " .
             " survey_fi = %s",
             ["integer"],
             [$survey_id]
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ exists()

ILIAS\Survey\Code\CodeDBRepo::exists	(	int	$survey_id,
		string	$code
	)

Does code exist in survey?

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

References ILIAS\Survey\Code\CodeDBRepo\$db, and ilDBInterface\queryF().

Referenced by ILIAS\Survey\Code\CodeDBRepo\add(), ILIAS\Survey\Code\CodeManager\exists(), and ILIAS\Survey\Code\CodeDBRepo\getNew().

      : bool {
         $db = $this->db;
         $set = $db->queryF(
             "SELECT anonymous_id FROM svy_anonymous " .
             " WHERE survey_fi = %s AND survey_key = %s ",
             ["integer", "text"],
             [$survey_id, $code]
         );
         return ($set->numRows() > 0);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAll()

ILIAS\Survey\Code\CodeDBRepo::getAll ( int $survey_id )

Get all access keys of a survey.

Returns: string[]

Definition at line 233 of file class.CodeDBRepo.php.

References ILIAS\Survey\Code\CodeDBRepo\$db, and ilDBInterface\queryF().

      : array {
         $db = $this->db;
 
         $set = $db->queryF(
             "SELECT survey_key FROM svy_anonymous " .
             " WHERE survey_fi = %s ",
             ["integer"],
             [$survey_id]
         );
         $codes = [];
         while ($rec = $db->fetchAssoc($set)) {
             $codes[] = $rec["survey_key"];
         }
         return $codes;
     }

Here is the call graph for this function:

◆ getAllData()

ILIAS\Survey\Code\CodeDBRepo::getAllData ( int $survey_id )

Get all codes of a survey.

Returns: Code[]

Definition at line 255 of file class.CodeDBRepo.php.

References ILIAS\Survey\Code\CodeDBRepo\$db, and ilDBInterface\queryF().

      : array {
         $db = $this->db;
 
         $set = $db->queryF(
             "SELECT * FROM svy_anonymous " .
             " WHERE survey_fi = %s ",
             ["integer"],
             [$survey_id]
         );
         $codes = [];
         while ($rec = $db->fetchAssoc($set)) {
             $codes[] = $this->data->code($rec["survey_key"])
                 ->withId((int) $rec["anonymous_id"])
                 ->withSurveyId((int) $rec["survey_fi"])
                 ->withUserKey((string) $rec["user_key"])
                 ->withTimestamp((int) $rec["tstamp"])
                 ->withSent((int) $rec["sent"])
                 ->withEmail((string) $rec["email"])
                 ->withFirstName((string) $rec["firstname"])
                 ->withLastName((string) $rec["lastname"]);
         }
 
         return $codes;
     }

Here is the call graph for this function:

◆ getByCodeId()

ILIAS\Survey\Code\CodeDBRepo::getByCodeId	(	int	$survey_id,
		int	$code_id
	)

Definition at line 356 of file class.CodeDBRepo.php.

References ILIAS\Survey\Code\CodeDBRepo\$db, and ilDBInterface\queryF().

      : string {
         $db = $this->db;
 
         $set = $db->queryF(
             "SELECT survey_key FROM svy_anonymous " .
             " WHERE survey_fi = %s AND anonymous_id = %s ",
             ["integer", "integer"],
             [$survey_id, $code_id]
         );
         $rec = $db->fetchAssoc($set);
         return $rec["survey_key"] ?? "";
     }

Here is the call graph for this function:

◆ getByUserId()

ILIAS\Survey\Code\CodeDBRepo::getByUserId	(	int	$survey_id,
		int	$user_id
	)

Get code for a registered user.

Definition at line 338 of file class.CodeDBRepo.php.

References ILIAS\Survey\Code\CodeDBRepo\$db, and ILIAS\Survey\Code\CodeDBRepo\getUserKey().

      : string {
         $db = $this->db;
 
         $user_key = $this->getUserKey($user_id);
 
         $set = $db->queryF(
             "SELECT survey_key FROM svy_anonymous " .
             " WHERE survey_fi = %s AND user_key = %s ",
             ["integer", "string"],
             [$survey_id, $user_key]
         );
         $rec = $db->fetchAssoc($set);
         return $rec["survey_key"] ?? "";
     }

Here is the call graph for this function:

◆ getByUserKey()

ILIAS\Survey\Code\CodeDBRepo::getByUserKey	(	int	$survey_id,
		string	$survey_key
	)

Definition at line 282 of file class.CodeDBRepo.php.

References ILIAS\Survey\Code\CodeDBRepo\$db, and ilDBInterface\queryF().

      : ?Code {
         $db = $this->db;
 
         $set = $db->queryF(
             "SELECT * FROM svy_anonymous " .
             " WHERE survey_fi = %s AND survey_key = %s",
             ["integer", "string"],
             [$survey_id, $survey_key]
         );
 
         if ($rec = $db->fetchAssoc($set)) {
             $ext_data = unserialize((string) $rec["externaldata"], ["allowed_classes" => false]);
             return $this->data->code($rec["survey_key"])
                                   ->withId((int) $rec["anonymous_id"])
                                   ->withSurveyId((int) $rec["survey_fi"])
                                   ->withUserKey((string) $rec["user_key"])
                                   ->withTimestamp((int) $rec["tstamp"])
                                   ->withSent((int) $rec["sent"])
                                   ->withEmail((string) ($ext_data["email"] ?? ""))
                                   ->withFirstName((string) ($ext_data["firstname"] ?? ""))
                                   ->withLastName((string) ($ext_data["lastname"] ?? ""));
         }
 
         return null;
     }

Here is the call graph for this function:

◆ getNew()

ILIAS\Survey\Code\CodeDBRepo::getNew ( int $survey_id )

protected

Get a new unique code.

Definition at line 78 of file class.CodeDBRepo.php.

References ILIAS\Survey\Code\CodeDBRepo\exists().

Referenced by ILIAS\Survey\Code\CodeDBRepo\add().

                                              : string
     {
         // create a 5 character code
         $codestring = "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ";
         mt_srand();
         $code = "";
         for ($i = 1; $i <= 5; $i++) {
             $index = random_int(0, strlen($codestring) - 1);
             $code .= substr($codestring, $index, 1);
         }
         // uniqueness
         while ($this->exists($survey_id, $code)) {
             $code = $this->getNew($survey_id);
         }
         return $code;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getUserKey()

ILIAS\Survey\Code\CodeDBRepo::getUserKey ( int $user_id )

protected

Get user key for id.

Definition at line 115 of file class.CodeDBRepo.php.

Referenced by ILIAS\Survey\Code\CodeDBRepo\add(), ILIAS\Survey\Code\CodeDBRepo\bindUser(), and ILIAS\Survey\Code\CodeDBRepo\getByUserId().

                                                : ?string
     {
         $user_key = ($user_id > 0)
             ? md5((string) $user_id)
             : null;
         return $user_key;
     }

Here is the caller graph for this function:

◆ updateExternalData()

ILIAS\Survey\Code\CodeDBRepo::updateExternalData	(	int	$code_id,
		string	$email,
		string	$last_name,
		string	$first_name,
		int	$sent
	)

Update external data of a code.

Definition at line 196 of file class.CodeDBRepo.php.

References ILIAS\Survey\Code\CodeDBRepo\$db, $ilDB, and ilUtil\is_email().

Referenced by ILIAS\Survey\Code\CodeDBRepo\add().

      : bool {
         $ilDB = $this->db;
 
         $email = trim($email);
 
         if ($email === "" || ($email && !\ilUtil::is_email($email))) {
             return false;
         }
 
         $data = array("email" => $email,
                       "lastname" => trim($last_name),
                       "firstname" => trim($first_name));
 
         $fields = array(
             "externaldata" => array("text", serialize($data)),
             "sent" => array("integer", $sent)
         );
 
         $ilDB->update(
             "svy_anonymous",
             $fields,
             array("anonymous_id" => array("integer", $code_id))
         );
 
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $data

InternalDataService ILIAS\Survey\Code\CodeDBRepo::$data

protected

Definition at line 32 of file class.CodeDBRepo.php.

Referenced by ILIAS\Survey\Code\CodeDBRepo\__construct().

◆ $db

ilDBInterface ILIAS\Survey\Code\CodeDBRepo::$db

protected

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

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

Modules/Survey/Code/class.CodeDBRepo.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ add()

◆ addCodes()

◆ bindUser()

◆ delete()

◆ deleteAll()

◆ exists()

◆ getAll()

◆ getAllData()

◆ getByCodeId()

◆ getByUserId()

◆ getByUserKey()

◆ getNew()

◆ getUserKey()

◆ updateExternalData()

Field Documentation

◆ $data

◆ $db