This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilObjSurveyAccess:

Collaboration diagram for ilObjSurveyAccess:

Public Member Functions
	__construct ()

	_checkAccess (string $cmd, string $permission, int $ref_id, int $obj_id, ?int $user_id=null)

Public Member Functions inherited from ilObjectAccess
	_checkAccess (string $cmd, string $permission, int $ref_id, int $obj_id, ?int $user_id=null)
	Checks whether a user may invoke a command or not (this method is called by ilAccessHandler::checkAccess) More...

	canBeDelivered (ilWACPath $ilWACPath)

Static Public Member Functions
static	getConditionOperators ()
	Returns an array with valid operators for the specific object type. More...

static	checkCondition (int $a_trigger_obj_id, string $a_operator, string $a_value, int $a_usr_id)
	check condition for a specific user and object More...

static	_getCommands ()

static	_lookupCreationComplete (int $a_obj_id)
	checks whether all necessary parts of the survey are given More...

static	_lookupEvaluationAccess (int $a_obj_id)
	get evaluation access More...

static	_isSurveyParticipant (int $user_id, int $survey_id)

static	_lookupAnonymize (int $a_obj_id)

static	_hasEvaluationAccess (int $a_obj_id, int $user_id)

static	_lookupFinished (int $a_obj_id, int $a_user_id=0)
	get finished status More...

static	_lookupMode (int $a_obj_id)
	Get survey mode (see ilObjSurvey::MODE_... More...

static	_lookup360Mode (int $a_obj_id)

static	_checkGoto (string $target)
	check whether goto script will succeed More...

Static Public Member Functions inherited from ilObjectAccess
static	_getCommands ()
	get commands More...

static	_checkGoto (string $target)
	check whether goto script will succeed More...

static	_isOffline (int $obj_id)
	Type-specific implementation of general status, has to be overwritten if object type does not support centralized offline handling. More...

static	_preloadData (array $obj_ids, array $ref_ids)
	Preload data. More...

Protected Attributes
ilObjUser	$user

ilLanguage	$lng

ilRbacSystem	$rbacsystem

ilAccessHandler	$access

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Class ilObjSurveyAccess

Author: Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e; Helmut Schottmüller helmu.nosp@m.t.sc.nosp@m.hottm.nosp@m.uell.nosp@m.er@ma.nosp@m.c.co.nosp@m.m

Definition at line 25 of file class.ilObjSurveyAccess.php.

Constructor & Destructor Documentation

◆ __construct()

ilObjSurveyAccess::__construct ( )

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

References $DIC, ILIAS\Repository\access(), ILIAS\Repository\lng(), and ILIAS\Repository\user().

     {
         global $DIC;
 
         $this->user = $DIC->user();
         $this->lng = $DIC->language();
         $this->rbacsystem = $DIC->rbac()->system();
         $this->access = $DIC->access();
     }

Here is the call graph for this function:

Member Function Documentation

◆ _checkAccess()

ilObjSurveyAccess::_checkAccess	(	string	$cmd,
		string	$permission,
		int	$ref_id,
		int	$obj_id,
		?int	$user_id = `null`
	)

Definition at line 66 of file class.ilObjSurveyAccess.php.

References $access, $lng, $rbacsystem, $user, $user_id, ilRbacSystem\checkAccess(), ilRbacSystem\checkAccessOfUser(), ilAccessInfo\IL_NO_OBJECT_ACCESS, and ilLanguage\txt().

                                                                                                                  : bool
     {
         $ilUser = $this->user;
         $lng = $this->lng;
         $rbacsystem = $this->rbacsystem;
         $ilAccess = $this->access;
 
         if (is_null($user_id)) {
             $user_id = $ilUser->getId();
         }
 
         $is_admin = $rbacsystem->checkAccessOfUser($user_id, 'write', $ref_id);
 
         switch ($permission) {
             case "visible":
             case "read":
                 if (!self::_lookupCreationComplete($obj_id) &&
                     !$is_admin) {
                     $ilAccess->addInfoItem(ilAccessInfo::IL_NO_OBJECT_ACCESS, $lng->txt("warning_survey_not_complete"));
                     return false;
                 }
                 break;
         }
 
         switch ($cmd) {
             case "run":
                 if (!self::_lookupCreationComplete($obj_id) &&
                     !$is_admin) {
                     $ilAccess->addInfoItem(ilAccessInfo::IL_NO_OBJECT_ACCESS, $lng->txt("warning_survey_not_complete"));
                     return false;
                 }
                 break;
 
             case "evaluation":
                 if (!self::_lookupCreationComplete($obj_id)) {
                     $ilAccess->addInfoItem(ilAccessInfo::IL_NO_OBJECT_ACCESS, $lng->txt("warning_survey_not_complete"));
                     return false;
                 }
                 if ($rbacsystem->checkAccess("write", $ref_id) || self::_hasEvaluationAccess($obj_id, $user_id)) {
                     return true;
                 } else {
                     $ilAccess->addInfoItem(ilAccessInfo::IL_NO_OBJECT_ACCESS, $lng->txt("status_no_permission"));
                     return false;
                 }
         }
 
         return true;
     }

Here is the call graph for this function:

◆ _checkGoto()

static ilObjSurveyAccess::_checkGoto ( string $target )

static

check whether goto script will succeed

Definition at line 416 of file class.ilObjSurveyAccess.php.

References $DIC, and Vendor\Package\$e.

                                                      : bool
     {
         global $DIC;
 
         $request = $DIC->survey()
             ->internal()
             ->gui()
             ->execution()
             ->request();
 
         $ilAccess = $DIC->access();
 
         $t_arr = explode("_", $target);
         if ($t_arr[0] !== "svy" || ((int) $t_arr[1]) <= 0) {
             return false;
         }
 
         // 360° external raters
         $access_code = ($request->getAccessCode() !== "")
             ? $request->getAccessCode()
             : ($t_arr[2] ?? "");
         if ($access_code !== "") {
             $survey = new ilObjSurvey((int) $t_arr[1]);
             $run_manager = $DIC->survey()->internal()->domain()->execution()->run($survey, $DIC->user()->getId());
             try {
                 $run_manager->initSession($access_code);
             } catch (Exception $e) {
                 return false;
             }
             if (ilObjSurvey::validateExternalRaterCode((int) $t_arr[1], $access_code)) {
                 return true;
             }
         }
 
         if ($ilAccess->checkAccess("visible", "", $t_arr[1]) ||
             $ilAccess->checkAccess("read", "", $t_arr[1])) {
             return true;
         }
         return false;
     }

◆ _getCommands()

static ilObjSurveyAccess::_getCommands ( )

static

Definition at line 116 of file class.ilObjSurveyAccess.php.

Referenced by ilObjSurveyListGUI\init().

                                          : array
     {
         $commands = array(
             array("permission" => "read", "cmd" => "run", "lang_var" => "svy_run", "default" => true),
             array("permission" => "write", "cmd" => "questions", "lang_var" => "edit_questions"),
             array("permission" => "write", "cmd" => "properties", "lang_var" => "settings"),
             array("permission" => "read", "cmd" => "evaluation", "lang_var" => "svy_results")
         );
 
         return $commands;
     }

Here is the caller graph for this function:

◆ _hasEvaluationAccess()

static ilObjSurveyAccess::_hasEvaluationAccess	(	int	$a_obj_id,
		int	$user_id
	)

static

Definition at line 214 of file class.ilObjSurveyAccess.php.

References $DIC, $ilDB, ANONYMOUS_USER_ID, ilObjSurvey\MODE_360, ilObjSurvey\MODE_IND_FEEDB, ilObjSurvey\MODE_SELF_EVAL, ilObjSurvey\RESULTS_360_ALL, ilObjSurvey\RESULTS_360_NONE, ilObjSurvey\RESULTS_360_OWN, and ilObjSurvey\RESULTS_SELF_EVAL_NONE.

Referenced by ILIAS\Survey\Access\AccessManager\canAccessEvaluation(), ilSurveyEvaluationGUI\checkAnonymizedEvaluationAccess(), ilObjSurveyGUI\executeCommand(), and ilSurveyExecutionGUI\runShowFinishedPage().

      : bool {
         $evaluation_access = self::_lookupEvaluationAccess($a_obj_id);
         $svy_mode = self::_lookupMode($a_obj_id);
         if ($svy_mode === ilObjSurvey::MODE_IND_FEEDB) {
             $svy = new ilObjSurvey($a_obj_id, false);
             $svy->read();
             switch ($svy->get360Results()) {
                 case ilObjSurvey::RESULTS_360_ALL:
                 case ilObjSurvey::RESULTS_360_NONE:
                     return false;
 
                 case ilObjSurvey::RESULTS_360_OWN:
                     return true;
 
                     // not applicable
             }
         }
 
         switch ($evaluation_access) {
             case 0:
                 // no evaluation access
                 return false;
             case 1:
                 // evaluation access for all registered users
                 return ($user_id > 0) && ($user_id !== ANONYMOUS_USER_ID);
             case 2:
                 switch ($svy_mode) {
                     case ilObjSurvey::MODE_360:
                         $svy = new ilObjSurvey($a_obj_id, false);
                         $svy->read();
                         switch ($svy->get360Results()) {
                             case ilObjSurvey::RESULTS_360_NONE:
                                 return false;
 
                             case ilObjSurvey::RESULTS_360_OWN:
                                 return $svy->isAppraiseeClosed($user_id);
 
                             case ilObjSurvey::RESULTS_360_ALL:
                                 return $svy->isAppraisee($user_id);
                         }
                         break;
 
                     case ilObjSurvey::MODE_IND_FEEDB:
                         $svy = new ilObjSurvey($a_obj_id, false);
                         $svy->read();
                         switch ($svy->get360Results()) {
                             case ilObjSurvey::RESULTS_360_NONE:
                                 return false;
 
                             case ilObjSurvey::RESULTS_360_OWN:
                                 return true;
 
                             case ilObjSurvey::RESULTS_360_ALL:
                                 return $svy->isAppraisee($user_id);
                         }
                         break;
 
                     case ilObjSurvey::MODE_SELF_EVAL:
                         $svy = new ilObjSurvey($a_obj_id, false);
                         $svy->read();
                         switch ($svy->getSelfEvaluationResults()) {
                             case ilObjSurvey::RESULTS_SELF_EVAL_NONE:
                                 return false;
                             default:
                                 global $DIC;
                                 $run_manager = $DIC->survey()->internal()->domain()
                                                    ->execution()->run($svy, $user_id);
                                 return $run_manager->hasFinished();
                         }
 
                         // no break
                     default:
                         // evaluation access for participants
                         // check if the user with the given id is a survey participant
 
                         // show the evaluation button for anonymized surveys for all users
                         // access is only granted with the survey access code
                         if (self::_lookupAnonymize($a_obj_id)) {
                             return true;
                         }
 
                         global $DIC;
 
                         $ilDB = $DIC->database();
                         $result = $ilDB->queryF(
                             "SELECT survey_id FROM svy_svy WHERE obj_fi = %s",
                             array('integer'),
                             array($a_obj_id)
                         );
                         if ($result->numRows() === 1) {
                             $row = $ilDB->fetchAssoc($result);
 
                             if (self::_isSurveyParticipant($user_id, $row["survey_id"])) {
                                 $survey = new ilObjSurvey($a_obj_id, false);
                                 $run_manager = $DIC->survey()->internal()->domain()
                                     ->execution()->run($survey, $user_id);
                                 return $run_manager->hasFinished();
                             }
                         }
                         return false;
                 }
         }
         return false;
     }

Here is the caller graph for this function:

◆ _isSurveyParticipant()

static ilObjSurveyAccess::_isSurveyParticipant	(	int	$user_id,
		int	$survey_id
	)

static

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

References $DIC, and $ilDB.

Referenced by ilLPStatusSurveyFinished\determineStatus().

      : bool {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $result = $ilDB->queryF(
             "SELECT finished_id FROM svy_finished WHERE user_fi = %s AND survey_fi = %s",
             array('integer','integer'),
             array($user_id, $survey_id)
         );
         return $result->numRows() === 1;
     }

Here is the caller graph for this function:

◆ _lookup360Mode()

static ilObjSurveyAccess::_lookup360Mode ( int $a_obj_id )

static

Definition at line 397 of file class.ilObjSurveyAccess.php.

References $DIC, $ilDB, and ilObjSurvey\MODE_360.

      : bool {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $result = $ilDB->queryF(
             "SELECT mode FROM svy_svy" .
             " WHERE obj_fi = %s AND mode = %s",
             array('integer','integer'),
             array($a_obj_id, ilObjSurvey::MODE_360)
         );
         return (bool) $ilDB->numRows($result);
     }

◆ _lookupAnonymize()

static ilObjSurveyAccess::_lookupAnonymize ( int $a_obj_id )

static

Definition at line 194 of file class.ilObjSurveyAccess.php.

References $DIC, and $ilDB.

Referenced by ilSurveyLP\isAnonymized().

      : bool {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $result = $ilDB->queryF(
             "SELECT anonymize FROM svy_svy WHERE obj_fi = %s",
             array('integer'),
             array($a_obj_id)
         );
         if ($result->numRows() === 1) {
             $row = $ilDB->fetchAssoc($result);
             return (bool) $row["anonymize"];
         } else {
             return false;
         }
     }

Here is the caller graph for this function:

◆ _lookupCreationComplete()

static ilObjSurveyAccess::_lookupCreationComplete ( int $a_obj_id )

static

checks whether all necessary parts of the survey are given

Definition at line 135 of file class.ilObjSurveyAccess.php.

References $DIC, $ilDB, and null.

Referenced by ilObjSurveyListGUI\getProperties().

                                                                  : bool
     {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $result = $ilDB->queryF(
             "SELECT * FROM svy_svy WHERE obj_fi=%s",
             array('integer'),
             array($a_obj_id)
         );
 
         $row = null;
         if ($result->numRows() === 1) {
             $row = $ilDB->fetchAssoc($result);
         }
         if (is_null($row) || !$row["complete"]) {
             return false;
         }
         return true;
     }

Here is the caller graph for this function:

◆ _lookupEvaluationAccess()

static ilObjSurveyAccess::_lookupEvaluationAccess ( int $a_obj_id )

static

get evaluation access

Definition at line 160 of file class.ilObjSurveyAccess.php.

References $DIC, and $ilDB.

                                                                  : int
     {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $result = $ilDB->queryF(
             "SELECT * FROM svy_svy WHERE obj_fi=%s",
             array('integer'),
             array($a_obj_id)
         );
         if ($result->numRows() === 1) {
             $row = $ilDB->fetchAssoc($result);
             return (int) $row["evaluation_access"];
         }
         return 0;
     }

◆ _lookupFinished()

static ilObjSurveyAccess::_lookupFinished	(	int	$a_obj_id,
		int	$a_user_id = `0`
	)

static

get finished status

Parameters

int $a_obj_id survey id

Definition at line 328 of file class.ilObjSurveyAccess.php.

References $DIC, $ilDB, ILIAS\Repository\int(), and null.

Referenced by ilLPStatusSurveyFinished\determineStatus(), ilObjSurveyListGUI\getProperties(), ilCourseStart\isFullfilled(), and ilContainerStartObjects\isFullfilled().

      : ?int {
         global $DIC;
 
         $ilDB = $DIC->database();
         $ilUser = $DIC->user();
 
         $finished = null;
         if ($a_user_id === 0) {
             $a_user_id = $ilUser->getId();
         }
 
         $result = $ilDB->queryF(
             "SELECT * FROM svy_svy WHERE obj_fi = %s",
             array('integer'),
             array($a_obj_id)
         );
         if ($result->numRows() === 1) {
             $row = $ilDB->fetchObject($result);
             if ((int) $row->anonymize === 1) {
                 $result = $ilDB->queryF(
                     "SELECT * FROM svy_finished, svy_anonymous WHERE svy_finished.survey_fi = %s " .
                     "AND svy_finished.survey_fi = svy_anonymous.survey_fi AND svy_anonymous.user_key = %s " .
                     "AND svy_anonymous.survey_key = svy_finished.anonymous_id",
                     array('integer','text'),
                     array($row->survey_id, md5($a_user_id))
                 );
             } else {
                 $result = $ilDB->queryF(
                     "SELECT * FROM svy_finished WHERE survey_fi = %s AND user_fi = %s",
                     array('integer','integer'),
                     array($row->survey_id, $a_user_id)
                 );
             }
             if ($result->numRows() === 1) {
                 $foundrow = $ilDB->fetchAssoc($result);
                 $finished = (int) $foundrow["state"];
             }
         }
 
         return $finished;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _lookupMode()

static ilObjSurveyAccess::_lookupMode ( int $a_obj_id )

static

Get survey mode (see ilObjSurvey::MODE_...

constants)

Definition at line 376 of file class.ilObjSurveyAccess.php.

References $DIC, and $ilDB.

Referenced by ilObjSurveyListGUI\getProperties().

      : int {
         global $DIC;
         $ilDB = $DIC->database();
 
         $result = $ilDB->queryF(
             "SELECT mode FROM svy_svy" .
             " WHERE obj_fi = %s",
             array('integer'),
             array($a_obj_id)
         );
 
         if ($result->numRows() === 1) {
             $row = $ilDB->fetchAssoc($result);
             return (int) $row["mode"];
         }
 
         return 0;
     }

Here is the caller graph for this function:

◆ checkCondition()

static ilObjSurveyAccess::checkCondition	(	int	$a_trigger_obj_id,
		string	$a_operator,
		string	$a_value,
		int	$a_usr_id
	)

static

check condition for a specific user and object

Implements ilConditionHandling.

Definition at line 50 of file class.ilObjSurveyAccess.php.

References ilConditionHandler\OPERATOR_FINISHED.

                                                                                                                     : bool
     {
         switch ($a_operator) {
             case ilConditionHandler::OPERATOR_FINISHED:
                 if (self::_lookupFinished($a_trigger_obj_id, $a_usr_id)) {
                     return true;
                 } else {
                     return false;
                 }
 
                 // no break
             default:
                 return true;
         }
     }

◆ getConditionOperators()

static ilObjSurveyAccess::getConditionOperators ( )

static

Returns an array with valid operators for the specific object type.

Returns: string[]

Implements ilConditionHandling.

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

References ilConditionHandler\OPERATOR_FINISHED.

                                                   : array
     {
         return array(
             ilConditionHandler::OPERATOR_FINISHED
         );
     }

Field Documentation

◆ $access

ilAccessHandler ilObjSurveyAccess::$access

protected

Definition at line 30 of file class.ilObjSurveyAccess.php.

Referenced by _checkAccess().

◆ $lng

ilLanguage ilObjSurveyAccess::$lng

protected

Definition at line 28 of file class.ilObjSurveyAccess.php.

Referenced by _checkAccess().

◆ $rbacsystem

ilRbacSystem ilObjSurveyAccess::$rbacsystem

protected

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

Referenced by _checkAccess().

◆ $user

ilObjUser ilObjSurveyAccess::$user

protected

Definition at line 27 of file class.ilObjSurveyAccess.php.

Referenced by _checkAccess().

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

components/ILIAS/Survey/classes/class.ilObjSurveyAccess.php

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _checkAccess()

◆ _checkGoto()

◆ _getCommands()

◆ _hasEvaluationAccess()

◆ _isSurveyParticipant()

◆ _lookup360Mode()

◆ _lookupAnonymize()

◆ _lookupCreationComplete()

◆ _lookupEvaluationAccess()

◆ _lookupFinished()

◆ _lookupMode()

◆ checkCondition()

◆ getConditionOperators()

Field Documentation

◆ $access

◆ $lng

◆ $rbacsystem

◆ $user