ilObjSurveyAccess Class Reference

Class ilObjSurveyAccess. More...

Inheritance diagram for ilObjSurveyAccess:

Collaboration diagram for ilObjSurveyAccess:

Public Member Functions
	_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)
	_getCommands ()
	get commands
	_lookupCreationComplete ($a_obj_id)
	checks wether all necessary parts of the survey are given
	_lookupEvaluationAccess ($a_obj_id)
	get evaluation access
	_isSurveyParticipant ($user_id, $survey_id)
	_lookupAnonymize ($a_obj_id)
	_hasEvaluationAccess ($a_obj_id, $user_id)
	_lookupOnline ($a_obj_id)
	get status
	_lookupFinished ($a_obj_id, $a_user_id="")
	get finished status
	_checkGoto ($a_target)
	check whether goto script will succeed
Public Member Functions inherited from ilObjectAccess
	_checkCondition ($a_obj_id, $a_operator, $a_value, $a_usr_id=0)
	check condition
	_preloadData ($a_obj_ids, $a_ref_ids)
	Preload data.

Additional Inherited Members
Static Public Member Functions inherited from ilObjectAccess
static	_isOffline ($a_obj_id)
	Type-specific implementation of general status, has to be overwritten.

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:

class.ilObjSurveyAccess.php 37934 2012-10-29 15:24:37Z jluetzen

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

Member Function Documentation

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

Reimplemented from ilObjectAccess.

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

References $lng, _hasEvaluationAccess(), _lookupCreationComplete(), _lookupOnline(), and IL_NO_OBJECT_ACCESS.

        {
                global $ilUser, $lng, $rbacsystem, $ilAccess;

                if ($a_user_id == "")
                {
                        $a_user_id = $ilUser->getId();
                }

                switch ($a_permission)
                {
                        case "visible":
                                $active = ilObjSurveyAccess::_lookupOnline($a_obj_id);                  
                                $admin = $rbacsystem->checkAccessOfUser($a_user_id,"write",$a_ref_id);
                                
                                if (!$admin && 
                                        !ilObjSurveyAccess::_lookupCreationComplete($a_obj_id))
                                {
                                        $ilAccess->addInfoItem(IL_NO_OBJECT_ACCESS, $lng->txt("warning_survey_not_complete"));
                                        return false;
                                }
                                                                
                                if(!$active)
                                {
                                        $ilAccess->addInfoItem(IL_NO_OBJECT_ACCESS, $lng->txt("offline"));
                                }
                                if (!$active && !$admin)
                                {
                                        return false;
                                }                                                               
                                break;
                                
                        case "read":    
                                if($rbacsystem->checkAccessOfUser($a_user_id,"write",$a_ref_id))
                                {
                                        return true;
                                }
                                if(!ilObjSurveyAccess::_lookupOnline($a_obj_id))
                                {
                                        return false;
                                }
                                break;
                }

                switch ($a_cmd)
                {
                        case "run":
                                if (!ilObjSurveyAccess::_lookupCreationComplete($a_obj_id)
                                        || !(ilObjSurveyAccess::_lookupOnline($a_obj_id) == 1))
                                {
                                        $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:

ilObjSurveyAccess::_checkGoto

(

$a_target

)

check whether goto script will succeed

Reimplemented from ilObjectAccess.

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

        {
                global $ilAccess;
                
                $t_arr = explode("_", $a_target);

                if ($t_arr[0] != "svy" || ((int) $t_arr[1]) <= 0)
                {
                        return false;
                }

                if ($ilAccess->checkAccess("read", "", $t_arr[1]))
                {
                        return true;
                }
                return false;
        }

ilObjSurveyAccess::_getCommands

(

)

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"), );

Reimplemented from ilObjectAccess.

Definition at line 143 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_evaluation")
                );
                
                return $commands;
        }

Here is the caller graph for this function:

ilObjSurveyAccess::_hasEvaluationAccess	(		$a_obj_id,
			$user_id
	)

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

References $ilDB, $result, $row, _isSurveyParticipant(), _lookupAnonymize(), and _lookupEvaluationAccess().

Referenced by _checkAccess(), ilSurveyEvaluationGUI\evaluation(), ilObjSurveyGUI\getTabs(), and ilObjSurveyGUI\infoScreen().

        {
                $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:
                                // 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 $ilDB;
                                $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;
                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilObjSurveyAccess::_isSurveyParticipant	(		$user_id,
			$survey_id
	)

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

References $ilDB, and $result.

Referenced by _hasEvaluationAccess().

        {
                global $ilDB;

                $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:

ilObjSurveyAccess::_lookupAnonymize

(

$a_obj_id

)

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

References $ilDB, $result, and $row.

Referenced by _hasEvaluationAccess().

        {
                global $ilDB;

                $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:

ilObjSurveyAccess::_lookupCreationComplete

(

$a_obj_id

)

checks wether all necessary parts of the survey are given

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

References $ilDB, $result, and $row.

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

        {
                global $ilDB;

                $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:

ilObjSurveyAccess::_lookupEvaluationAccess

(

$a_obj_id

)

get evaluation access

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

References $ilDB, $result, and $row.

Referenced by _hasEvaluationAccess().

        {
                global $ilDB;

                $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:

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

get finished status

Parameters

int

$a_obj_id

survey id

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

References $ilDB, $result, and $row.

Referenced by ilObjSurvey\_checkCondition(), ilObjSurveyListGUI\getProperties(), and ilCourseStart\isFullfilled().

        {
                global $ilDB, $ilUser;

                $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:

ilObjSurveyAccess::_lookupOnline

(

$a_obj_id

)

get status

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

References $ilDB, $result, and $row.

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

        {
                global $ilDB;

                $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["status"];
        }

Here is the caller graph for this function:

---

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

• Modules/Survey/classes/class.ilObjSurveyAccess.php