Class ilObjSurveyAccess. More...

Inheritance diagram for ilObjSurveyAccess:

Collaboration diagram for ilObjSurveyAccess:

Public Member Functions

__construct ()

Constructor. More...

_checkAccess ($a_cmd, $a_permission, $a_ref_id, $a_obj_id, $a_user_id="")

Checks wether a user may invoke a command or not (this method is called by ilAccessHandler::checkAccess) More...

Public Member Functions inherited from ilObjectAccess

_checkAccess ($a_cmd, $a_permission, $a_ref_id, $a_obj_id, $a_user_id="")

Checks wether a user may invoke a command or not (this method is called by ilAccessHandler::checkAccess) More...

_checkCondition ($a_obj_id, $a_operator, $a_value, $a_usr_id)

check condition More...

canBeDelivered (ilWACPath $ilWACPath)

Parameters

ilWACPath $ilWACPath

Returns: bool

More...

Static Public Member Functions
static	getConditionOperators ()
	Get possible conditions operators. More...

static	checkCondition ($a_svy_id, $a_operator, $a_value, $a_usr_id)
	check condition More...

static	_getCommands ()
	get commands More...

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

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

static	_isSurveyParticipant ($user_id, $survey_id)

static	_lookupAnonymize ($a_obj_id)

static	_hasEvaluationAccess ($a_obj_id, $user_id)

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

static	_lookupMode ($a_obj_id)
	Get survey mode. More...

static	_lookup360Mode ($a_obj_id)

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

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

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

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

static	_preloadData ($a_obj_ids, $a_ref_ids)
	Preload data. More...

Protected Attributes
	$user

	$lng

	$rbacsystem

	$access

Detailed Description

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

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilObjSurveyAccess::__construct ( )

Constructor.

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

References $DIC, and 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	(	$a_cmd,
		$a_permission,
		$a_ref_id,
		$a_obj_id,
		$a_user_id = `""`
	)

Checks wether a user may invoke a command or not (this method is called by ilAccessHandler::checkAccess)

Please do not check any preconditions handled by ilConditionHandler here.

Parameters

string	$a_cmd	command (not permission!)
string	$a_permission	permission
int	$a_ref_id	reference id
int	$a_obj_id	object id
int	$a_user_id	user id (if not provided, current user is taken)

Returns: boolean true, if everything is ok

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

References $access, $ilUser, $lng, $rbacsystem, $user, _hasEvaluationAccess(), _lookupCreationComplete(), and IL_NO_OBJECT_ACCESS.

     {
         $ilUser = $this->user;
         $lng = $this->lng;
         $rbacsystem = $this->rbacsystem;
         $ilAccess = $this->access;
 
         if ($a_user_id == "") {
             $a_user_id = $ilUser->getId();
         }
         
         $is_admin = $rbacsystem->checkAccessOfUser($a_user_id, 'write', $a_ref_id);
         
         switch ($a_permission) {
             case "visible":
             case "read":
                 if (!ilObjSurveyAccess::_lookupCreationComplete($a_obj_id) &&
                     !$is_admin) {
                     $ilAccess->addInfoItem(IL_NO_OBJECT_ACCESS, $lng->txt("warning_survey_not_complete"));
                     return false;
                 }
                 break;
         }
 
         switch ($a_cmd) {
             case "run":
                 if (!ilObjSurveyAccess::_lookupCreationComplete($a_obj_id)) {
                     $ilAccess->addInfoItem(IL_NO_OBJECT_ACCESS, $lng->txt("warning_survey_not_complete"));
                     return false;
                 }
                 break;
 
             case "evaluation":
                 if (!ilObjSurveyAccess::_lookupCreationComplete($a_obj_id)) {
                     $ilAccess->addInfoItem(IL_NO_OBJECT_ACCESS, $lng->txt("warning_survey_not_complete"));
                     return false;
                 }
                 if ($rbacsystem->checkAccess("write", $a_ref_id) || ilObjSurveyAccess::_hasEvaluationAccess($a_obj_id, $a_user_id)) {
                     return true;
                 } else {
                     $ilAccess->addInfoItem(IL_NO_OBJECT_ACCESS, $lng->txt("status_no_permission"));
                     return false;
                 }
                 break;
         }
 
         return true;
     }

Here is the call graph for this function:

◆ _checkGoto()

static ilObjSurveyAccess::_checkGoto ( $a_target )

static

check whether goto script will succeed

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

References $_GET, $DIC, and ilObjSurvey\validateExternalRaterCode().

     {
         global $DIC;
 
         $ilAccess = $DIC->access();
         
         $t_arr = explode("_", $a_target);
 
         if ($t_arr[0] != "svy" || ((int) $t_arr[1]) <= 0) {
             return false;
         }
         
         // 360° external raters
         if ($_GET["accesscode"]) {
             include_once "Modules/Survey/classes/class.ilObjSurvey.php";
             if (ilObjSurvey::validateExternalRaterCode($t_arr[1], $_GET["accesscode"])) {
                 return true;
             }
         }
 
         if ($ilAccess->checkAccess("visible", "", $t_arr[1]) ||
             $ilAccess->checkAccess("read", "", $t_arr[1])) {
             return true;
         }
         return false;
     }

Here is the call graph for this function:

◆ _getCommands()

static ilObjSurveyAccess::_getCommands ( )

static

get commands

this method returns an array of all possible commands/permission combinations

example: $commands = array ( array("permission" => "read", "cmd" => "view", "lang_var" => "show"), array("permission" => "write", "cmd" => "edit", "lang_var" => "edit"), );

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

Referenced by ilObjSurveyListGUI\init().

     {
         $commands = array(
             array("permission" => "read", "cmd" => "infoScreen", "lang_var" => "svy_run", "default" => true),
             array("permission" => "write", "cmd" => "questionsrepo", "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	(	$a_obj_id,
		$user_id
	)

static

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

References $DIC, $ilDB, $result, $row, _isSurveyParticipant(), _lookupAnonymize(), _lookupEvaluationAccess(), ilObjSurvey\MODE_360, ilObjSurvey\MODE_SELF_EVAL, ilObjSurvey\RESULTS_360_ALL, ilObjSurvey\RESULTS_360_NONE, ilObjSurvey\RESULTS_360_OWN, and ilObjSurvey\RESULTS_SELF_EVAL_NONE.

Referenced by _checkAccess(), ilSurveyEvaluationGUI\checkAnonymizedEvaluationAccess(), ilObjSurveyGUI\getTabs(), ilObjSurveyGUI\infoScreen(), and ilSurveyExecutionGUI\runShowFinishedPage().

     {
         $evaluation_access = ilObjSurveyAccess::_lookupEvaluationAccess($a_obj_id);
         switch ($evaluation_access) {
             case 0:
                 // no evaluation access
                 return false;
                 break;
             case 1:
                 // evaluation access for all registered users
                 if (($user_id > 0) && ($user_id != ANONYMOUS_USER_ID)) {
                     return true;
                 } else {
                     return false;
                 }
                 break;
             case 2:
                 $svy_mode = self::_lookupMode($a_obj_id);
                 switch ($svy_mode) {
                     case ilObjSurvey::MODE_360:
                         include_once "Modules/Survey/classes/class.ilObjSurvey.php";
                         $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_SELF_EVAL:
                         include_once "Modules/Survey/classes/class.ilObjSurvey.php";
                         $svy = new ilObjSurvey($a_obj_id, false);
                         $svy->read();
                         switch ($svy->getSelfEvaluationResults()) {
                             case ilObjSurvey::RESULTS_SELF_EVAL_NONE:
                                 return false;
                             default:
                                 return true;
                         }
                         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 (ilObjSurveyAccess::_lookupAnonymize($a_obj_id) == 1) {
                             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 (ilObjSurveyAccess::_isSurveyParticipant($user_id, $row["survey_id"])) {
                                 return true;
                             }
                         }
                         return false;
                         break;
                 }
                 break;
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _isSurveyParticipant()

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

static

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

References $DIC, $ilDB, and $result.

Referenced by _hasEvaluationAccess(), and ilLPStatusSurveyFinished\determineStatus().

     {
         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) ? true : false;
     }

Here is the caller graph for this function:

◆ _lookup360Mode()

static ilObjSurveyAccess::_lookup360Mode ( $a_obj_id )

static

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

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

Referenced by ilObjSurveyListGUI\getProperties().

     {
         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);
     }

Here is the caller graph for this function:

◆ _lookupAnonymize()

static ilObjSurveyAccess::_lookupAnonymize ( $a_obj_id )

static

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

References $DIC, $ilDB, $result, and $row.

Referenced by _hasEvaluationAccess(), and ilSurveyLP\isAnonymized().

     {
         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 $row["anonymize"];
         } else {
             return 0;
         }
     }

Here is the caller graph for this function:

◆ _lookupCreationComplete()

static ilObjSurveyAccess::_lookupCreationComplete ( $a_obj_id )

static

checks wether all necessary parts of the survey are given

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

References $DIC, $ilDB, $result, and $row.

Referenced by _checkAccess(), and ilObjSurveyListGUI\getProperties().

     {
         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);
         }
         if (!$row["complete"]) {
             return false;
         }
         return true;
     }

Here is the caller graph for this function:

◆ _lookupEvaluationAccess()

static ilObjSurveyAccess::_lookupEvaluationAccess ( $a_obj_id )

static

get evaluation access

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

References $DIC, $ilDB, $result, and $row.

Referenced by _hasEvaluationAccess().

     {
         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 $row["evaluation_access"];
     }

Here is the caller graph for this function:

◆ _lookupFinished()

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

static

get finished status

Parameters

int $a_obj_id survey id

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

References $DIC, $ilDB, $ilUser, $result, and $row.

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

     {
         global $DIC;
 
         $ilDB = $DIC->database();
         $ilUser = $DIC->user();
 
         $finished = "";
         if (!strlen($a_user_id)) {
             $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 ($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 caller graph for this function:

◆ _lookupMode()

static ilObjSurveyAccess::_lookupMode ( $a_obj_id )

static

Get survey mode.

Parameters

$a_obj_id

Returns: int

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

References $DIC, $ilDB, $result, and $row.

     {
         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 $row["mode"];
     }

◆ checkCondition()

static ilObjSurveyAccess::checkCondition	(	$a_svy_id,
		$a_operator,
		$a_value,
		$a_usr_id
	)

static

check condition

Parameters

type	$a_svy_id
type	$a_operator
type	$a_value
type	$a_usr_id

Returns: boolean

Implements ilConditionHandling.

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

References _lookupFinished(), and ilConditionHandler\OPERATOR_FINISHED.

     {
         switch ($a_operator) {
             case ilConditionHandler::OPERATOR_FINISHED:
                 include_once("./Modules/Survey/classes/class.ilObjSurveyAccess.php");
                 if (ilObjSurveyAccess::_lookupFinished($a_svy_id, $a_usr_id)) {
                     return true;
                 } else {
                     return false;
                 }
                 break;
 
             default:
                 return true;
         }
         return true;
     }

Here is the call graph for this function:

◆ getConditionOperators()

static ilObjSurveyAccess::getConditionOperators ( )

static

Get possible conditions operators.

Implements ilConditionHandling.

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

References ilConditionHandler\OPERATOR_FINISHED.

     {
         include_once './Services/Conditions/classes/class.ilConditionHandler.php';
         return array(
             ilConditionHandler::OPERATOR_FINISHED
         );
     }

Field Documentation

◆ $access

ilObjSurveyAccess::$access

protected

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

Referenced by _checkAccess().

◆ $lng

ilObjSurveyAccess::$lng

protected

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

Referenced by _checkAccess().

◆ $rbacsystem

ilObjSurveyAccess::$rbacsystem

protected

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

Referenced by _checkAccess().

◆ $user

ilObjSurveyAccess::$user

protected

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

Referenced by _checkAccess().

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

Modules/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