Public Member Functions

ilObjSurveyAccess Class Reference

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
 _lookupStatus ($a_obj_id)
 get status
 _lookupFinished ($a_obj_id, $a_user_id="")
 get finished status

Detailed Description

Definition at line 35 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 52 of file class.ilObjSurveyAccess.php.

References $ilAccess, $ilUser, $lng, $rbacsystem, _lookupCreationComplete(), _lookupEvaluationAccess(), and _lookupStatus().

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

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

                switch ($a_permission)
                {
                        case "visible":
                                if (!ilObjSurveyAccess::_lookupCreationComplete($a_obj_id) &&
                                        (!$rbacsystem->checkAccess('write', $a_ref_id)))
                                {
                                        $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)
                                        || !(ilObjSurveyAccess::_lookupStatus($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;
                                }
                                // maybe an additional evaluation permission would be suitable
                                if (!$rbacsystem->checkAccess('write',$a_ref_id) &&
                                        !ilObjSurveyAccess::_lookupEvaluationAccess($a_obj_id))
                                {
                                        $ilAccess->addInfoItem(IL_NO_OBJECT_ACCESS, $lng->txt("no_permission"));
                                        return false;
                                }
                                break;
                }

                return true;
        }

Here is the call graph for this function:

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 116 of file class.ilObjSurveyAccess.php.

Referenced by ilObjSurveyListGUI::init().

        {
                $commands = array
                (
                        array("permission" => "read", "cmd" => "run", "lang_var" => "svy_run",
                                "default" => true),
                        array("permission" => "write", "cmd" => "", "lang_var" => "edit"),
                        array("permission" => "read", "cmd" => "evaluation", "lang_var" => "svy_evaluation")
                );
                
                return $commands;
        }

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 136 of file class.ilObjSurveyAccess.php.

References $q, $result, and $row.

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

        {
                global $ilDB;

                $q = sprintf("SELECT * FROM survey_survey WHERE obj_fi=%s",
                        $ilDB->quote($a_obj_id)
                );
                $result = $ilDB->query($q);

                if ($result->numRows() == 1)
                {
                        $row = $result->fetchRow(DB_FETCHMODE_OBJECT);
                }
                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 160 of file class.ilObjSurveyAccess.php.

References $q, $result, and $row.

Referenced by _checkAccess().

        {
                global $ilDB;

                $q = sprintf("SELECT * FROM survey_survey WHERE obj_fi=%s",
                        $ilDB->quote($a_obj_id)
                );
                $result = $ilDB->query($q);
                if ($result->numRows() == 1)
                {
                        $row = $result->fetchRow(DB_FETCHMODE_OBJECT);
                }

                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 199 of file class.ilObjSurveyAccess.php.

References $ilUser, $q, $result, and $row.

Referenced by ilObjSurveyListGUI::getProperties().

        {
                global $ilDB, $ilUser;

                $finished = "";
                if (!strlen($a_user_id))
                        $a_user_id = $ilUser->id;

                $q = sprintf("SELECT * FROM survey_survey WHERE obj_fi=%s",
                                $ilDB->quote($a_obj_id)
                        );
                $result = $ilDB->query($q);
                if ($result->numRows() == 1)
                {
                        $row = $result->fetchRow(DB_FETCHMODE_OBJECT);
                        if ($row->anonymize == 1)
                        {
                                $q = sprintf("SELECT * FROM survey_finished WHERE survey_fi = %s AND anonymous_id = %s",
                                        $ilDB->quote($row->survey_id),
                                        $ilDB->quote(md5($a_user_id . $row->survey_id) . "")
                                );
                        }
                        else
                        {
                                $q = sprintf("SELECT * FROM survey_finished WHERE survey_fi = %s AND user_fi = %s",
                                        $ilDB->quote($row->survey_id),
                                        $ilDB->quote($a_user_id)
                                );
                        }
                        $result = $ilDB->query($q);
                        if ($result->numRows() == 1)
                        {
                                $row = $result->fetchRow(DB_FETCHMODE_OBJECT);
                                $finished = (int)$row->state;
                        }
                }

                return $finished;
        }

Here is the caller graph for this function:

ilObjSurveyAccess::_lookupStatus ( a_obj_id  ) 

get status

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

References $q, $result, and $row.

Referenced by _checkAccess().

        {
                global $ilDB;

                $q = sprintf("SELECT * FROM survey_survey WHERE obj_fi=%s",
                        $ilDB->quote($a_obj_id)
                );
                $result = $ilDB->query($q);
                if ($result->numRows() == 1) {
                        $row = $result->fetchRow(DB_FETCHMODE_OBJECT);
                }

                return $row->status;
        }

Here is the caller graph for this function:


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