ilObjTestAccess Class Reference

Class ilObjTestAccess. More...

Inheritance diagram for ilObjTestAccess:

Collaboration diagram for ilObjTestAccess:

Public Member Functions
	canBeDelivered (ilWACPath $ilWACPath)
	_checkAccess (string $cmd, string $permission, int $ref_id, int $obj_id, ?int $user_id=null)
	Checks wether a user may invoke a command or not (this method is called by ilAccessHandler::checkAccess) More...
	showCertificateFor (int $user_id, int $obj_id)
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 ()
	Get possible conditions operators. More...
static	_getCommands ()
static	getBypassActivationCheckForPermissions ()
static	_getTestIDFromObjectID (int $object_id)
	Returns the ILIAS test id for a given object id. More...
static	_getRandomTestsForQuestionPool (int $qpl_id)
	Get all tests using a question pool for random selection. More...
static	_getParticipantData (int $active_id)
	Retrieves a participant name from active id. More...
static	_getParticipantId (int $active_id)
	Get user id for active id. More...
static	_checkGoto (string $target)
	check whether goto script will succeed More...
static	_isOffline (int $obj_id)
	returns the objects's OFFline status More...
static	visibleUserResultExists (int $test_obj_id, int $user_id)
static	_preloadData (array $obj_ids, array $ref_ids)
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...
Static Public Member Functions inherited from ilConditionHandling
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...

Private Member Functions
	findMatch (string $path, array $array)

Static Private Member Functions
static	lookupCreationComplete (int $a_obj_id)

Private Attributes
ilDBInterface	$db
ilObjUser	$user
ilLanguage	$lng
ilRbacSystem	$rbac_system
ilAccessHandler	$access

Static Private Attributes
static ilCertificateObjectsForUserPreloader	$certificate_preloader = null
static array	$settings_result_summaries_by_obj_id = []

Detailed Description

Class ilObjTestAccess.

This class contains methods that check object specific conditions for accessing test objects.

Author

Helmut Schottmueller helmu.nosp@m.t.sc.nosp@m.hottm.nosp@m.uell.nosp@m.er@ma.nosp@m.c.co.nosp@m.m

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version

$Id$

\

Definition at line 45 of file class.ilObjTestAccess.php.

Member Function Documentation

_checkAccess()

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

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.

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

References $user_id, ILIAS\Repository\access(), ilAccessInfo\IL_NO_OBJECT_ACCESS, ILIAS\Repository\lng(), lookupCreationComplete(), ilObject\lookupOfflineStatus(), and ILIAS\Repository\user().

                                                                                                                 : bool
    {
        if (is_null($user_id)) {
            $user_id = $this->user->getId();
        }

        $is_admin = $this->rbac_system->checkAccessOfUser($user_id, 'write', $ref_id)
            || $this->rbac_system->checkAccessOfUser($user_id, 'score_anon', $ref_id);

        $is_online = !ilObject::lookupOfflineStatus($obj_id);

        if (!$is_admin && !$is_online) {
            return false;
        }

        switch ($permission) {
            case "visible":
            case "read":
                if (!ilObjTestAccess::lookupCreationComplete($obj_id) &&
                    !$is_admin) {
                    $this->access->addInfoItem(ilAccessInfo::IL_NO_OBJECT_ACCESS, $this->lng->txt("tst_warning_test_not_complete"));
                    return false;
                }
                break;
        }

        switch ($cmd) {
            case "eval_stat":
                if (!ilObjTestAccess::lookupCreationComplete($obj_id)) {
                    $this->access->addInfoItem(ilAccessInfo::IL_NO_OBJECT_ACCESS, $this->lng->txt("tst_warning_test_not_complete"));
                    return false;
                }
                break;
        }

        return true;
    }

Here is the call graph for this function:

_checkGoto()

static ilObjTestAccess::_checkGoto ( string  $target )

static

check whether goto script will succeed

Definition at line 339 of file class.ilObjTestAccess.php.

References $DIC.

                                                     : bool
    {
        global $DIC;
        $ilAccess = $DIC['ilAccess'];

        $t_arr = explode("_", $target);

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

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

_getCommands()

static ilObjTestAccess::_getCommands ( )

static

Definition at line 174 of file class.ilObjTestAccess.php.

References $DIC.

Referenced by ilObjTestListGUI\init().

                                         : array
    {
        global $DIC;
        $DIC->language()->loadLanguageModule('assessment');

        return [
            ["permission" => "write", "cmd" => "questionsTabGateway", "lang_var" => "tst_edit_questions"],
            ["permission" => "write", "cmd" => "ILIAS\Test\Settings\MainSettings\SettingsMainGUI::showForm", "lang_var" => "settings"],
            ["permission" => "read", "cmd" => "ILIAS\Test\Presentation\TestScreenGUI::testScreen", "lang_var" => "tst_run", "default" => true],
            ["permission" => "score_anon", "cmd" => "ILIAS\Test\Scoring\Manual\TestScoringByQuestionGUI::showManScoringByQuestionParticipantsTable", "lang_var" => "manscoring", "default" => true],
        ];
    }

Here is the caller graph for this function:

_getParticipantData()

static ilObjTestAccess::_getParticipantData ( int  $active_id )

static

Retrieves a participant name from active id.

Parameters

integer

$active_id

Active ID of the participant

Returns

string The output name of the user public

Definition at line 272 of file class.ilObjTestAccess.php.

References $DIC, $ilDB, ilObjTest\_lookupAnonymity(), ilObjUser\_lookupName(), ANONYMOUS_USER_ID, null, and ilLanguage\txt().

Referenced by ilTestParticipantList\buildParticipantsFullname(), ilTestResultsToXML\exportActiveIDs(), ilTestParticipantData\getFormatedFullnameByActiveId(), and ilTestParticipantData\getOptionArray().

                                                              : string
    {
        global $DIC;
        $lng = $DIC['lng'];
        $ilDB = $DIC['ilDB'];

        $result_active = $ilDB->queryF(
            'SELECT * FROM tst_active WHERE active_id = %s',
            ['integer'],
            [$active_id]
        );
        $row_active = $ilDB->fetchAssoc($result_active);
        $importname = $row_active['importname'];

        if ($importname !== null
            && $importname !== '') {
            return $importname . ' (' . $lng->txt('imported') . ')';
        }

        if ($row_active['user_fi'] === ANONYMOUS_USER_ID) {
            return '';
        }

        $uname = ilObjUser::_lookupName($row_active['user_fi']);

        $result_test = $ilDB->queryF(
            "SELECT obj_fi FROM tst_tests WHERE test_id = %s",
            ["integer"],
            [$row_active['test_fi']]
        );
        $row_test = $ilDB->fetchAssoc($result_test);
        $obj_id = $row_test["obj_fi"];

        if (ilObjTest::_lookupAnonymity($obj_id)) {
            return $lng->txt("anonymous");
        }

        if ($uname['firstname'] . $uname['lastname'] === '') {
            return $lng->txt('deleted_user');
        }

        return trim($uname['lastname'] . ', ' . $uname['firstname']);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_getParticipantId()

static ilObjTestAccess::_getParticipantId ( int  $active_id )

static

Get user id for active id.

Parameters

int	active ID of the participant

Returns

int user id

Definition at line 322 of file class.ilObjTestAccess.php.

References $DIC, and $ilDB.

Referenced by ILIAS\Test\Scoring\Manual\TestScoringByQuestionGUI\saveManScoringByQuestion(), ILIAS\Test\Scoring\Manual\TestScoringByParticipantGUI\saveManScoringParticipantScreen(), and ilTestPassFinishTasks\updateLearningProgressAfterPassFinishedIsWritten().

                                                            : int
    {
        global $DIC;
        $ilDB = $DIC['ilDB'];

        $result = $ilDB->queryF(
            'SELECT user_fi FROM tst_active WHERE active_id = %s',
            ['integer'],
            [$active_id]
        );
        $row = $ilDB->fetchAssoc($result);
        return $row['user_fi'];
    }

Here is the caller graph for this function:

_getRandomTestsForQuestionPool()

static ilObjTestAccess::_getRandomTestsForQuestionPool ( int  $qpl_id )

static

Get all tests using a question pool for random selection.

Parameters

int	question pool id

Returns

array list if test obj ids public

Definition at line 242 of file class.ilObjTestAccess.php.

References $DIC, and $ilDB.

Referenced by ilMobStakeholder\checkAccessTestQuestion(), and ilObjMediaObjectAccess\checkAccessTestQuestion().

                                                                      : array
    {
        global $DIC;
        $ilDB = $DIC['ilDB'];

        $query = "
                        SELECT DISTINCT t.obj_fi
                        FROM tst_tests t
                        INNER JOIN tst_rnd_quest_set_qpls r
                        ON t.test_id = r.test_fi
                        WHERE r.pool_fi = %s
                ";

        $result = $ilDB->queryF($query, ['integer'], [$qpl_id]);

        $tests = [];
        while ($row = $ilDB->fetchAssoc($result)) {
            $tests[] = $row['obj_fi'];
        }

        return $tests;
    }

Here is the caller graph for this function:

_getTestIDFromObjectID()

static ilObjTestAccess::_getTestIDFromObjectID ( int  $object_id )

static

Returns the ILIAS test id for a given object id.

Parameters

integer

$object_id

The object id

Returns

mixed The ILIAS test id or FALSE if the query was not successful public

Definition at line 218 of file class.ilObjTestAccess.php.

References $DIC, and $ilDB.

Referenced by ilLPStatusTestFinished\getParticipants(), and ilSoapTestAdministration\getTestAccess().

                                                                 : int|false
    {
        global $DIC;
        $ilDB = $DIC['ilDB'];
        $test_id = false;
        $result = $ilDB->queryF(
            "SELECT test_id FROM tst_tests WHERE obj_fi = %s",
            ['integer'],
            [$object_id]
        );
        if ($result->numRows()) {
            $row = $ilDB->fetchAssoc($result);
            $test_id = $row["test_id"];
        }
        return $test_id;
    }

Here is the caller graph for this function:

_isOffline()

static ilObjTestAccess::_isOffline ( int  $obj_id )

static

returns the objects's OFFline status

Used in ListGUI and Learning Progress

Definition at line 362 of file class.ilObjTestAccess.php.

References ilObject\lookupOfflineStatus().

Referenced by ilLOEditorStatus\checkTestOnline().

                                                  : bool
    {
        return ilObject::lookupOfflineStatus($obj_id);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_preloadData()

static ilObjTestAccess::_preloadData ( array  $obj_ids, array  $ref_ids  )

static

Definition at line 386 of file class.ilObjTestAccess.php.

References $DIC, and ILIAS\Survey\Mode\getId().

                                                                       : void
    {
        global $DIC;
        if ((new ilCertificateActiveValidator())->validate()) {
            self::$certificate_preloader = new ilCertificateObjectsForUserPreloader(new ilUserCertificateRepository());
            self::$certificate_preloader->preLoad($DIC['ilUser']->getId(), $obj_ids);
            self::$settings_result_summaries_by_obj_id = (new ScoreSettingsDatabaseRepository($DIC['ilDB']))
                ->getSettingsResultSummaryByObjIds($obj_ids);
        }
    }

Here is the call graph for this function:

canBeDelivered()

ilObjTestAccess::canBeDelivered

(

ilWACPath

$ilWACPath

)

Implements ilWACCheckingClass.

Definition at line 67 of file class.ilObjTestAccess.php.

References ILIAS\Repository\access(), findMatch(), ilWACPath\getPath(), and ILIAS\Repository\user().

                                                        : bool
    {
        $readable = new Readable($this->access);

        $can_it = $this->findMatch($ilWACPath->getPath(), [
            new AccessFileUploadAnswer($this->user, $this->db, $readable),
            new AccessQuestionImage($readable),
            new AccessFileUploadPreview($this->db, $this->access),
        ]);

        return !$can_it->isOk() || $can_it->value();
    }

Here is the call graph for this function:

findMatch()

ilObjTestAccess::findMatch ( string  $path, array  $array  )

private

Definition at line 80 of file class.ilObjTestAccess.php.

References ILIAS\Data\Result\except(), and ILIAS\Test\Access\SimpleAccess\isPermitted().

Referenced by canBeDelivered().

                                                          : Result
    {
        return array_reduce($array, fn(Result $result, SimpleAccess $access) => $result->except(
            fn() => $access->isPermitted($path)
        ), new Error('Not a known path.'));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getBypassActivationCheckForPermissions()

static ilObjTestAccess::getBypassActivationCheckForPermissions ( )

static

Definition at line 191 of file class.ilObjTestAccess.php.

                                                                   : array
    {
        return [
            'write',
            'score_anon'
        ];
    }

getConditionOperators()

static ilObjTestAccess::getConditionOperators ( )

static

Get possible conditions operators.

Implements ilConditionHandling.

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

References ilConditionHandling\checkCondition(), ilConditionHandler\OPERATOR_FAILED, ilConditionHandler\OPERATOR_FINISHED, ilConditionHandler\OPERATOR_NOT_FINISHED, and ilConditionHandler\OPERATOR_PASSED.

                                                  : array
    {
        return [
            ilConditionHandler::OPERATOR_PASSED,
            ilConditionHandler::OPERATOR_FAILED,
            ilConditionHandler::OPERATOR_FINISHED,
            ilConditionHandler::OPERATOR_NOT_FINISHED
        ];
    }

Here is the call graph for this function:

lookupCreationComplete()

static ilObjTestAccess::lookupCreationComplete ( int  $a_obj_id )

staticprivate

Definition at line 199 of file class.ilObjTestAccess.php.

References $DIC, ilDBInterface\fetchAssoc(), and ilDBInterface\queryF().

Referenced by _checkAccess().

                                                                 : bool
    {
        global $DIC;
        $db = $DIC->database();
        $result = $db->queryF(
            "SELECT complete FROM tst_tests WHERE obj_fi=%s",
            ['integer'],
            [$a_obj_id]
        );
        return $result->numRows() > 0 && (bool) $db->fetchAssoc($result)['complete'];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showCertificateFor()

ilObjTestAccess::showCertificateFor	(	int	$user_id,
		int	$obj_id
	)

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

References null.

                                                                 : bool
    {
        if (self::$certificate_preloader === null
            || !self::$certificate_preloader->isPreloaded($user_id, $obj_id)
            || !isset(self::$settings_result_summaries_by_obj_id[$obj_id])
            || self::$settings_result_summaries_by_obj_id[$obj_id]->getScoreReporting()
                === ScoreReportingTypes::SCORE_REPORTING_DISABLED) {
            return false;
        }

        $score_reporting = self::$settings_result_summaries_by_obj_id[$obj_id]->getScoreReporting();
        if ($score_reporting === ScoreReportingTypes::SCORE_REPORTING_IMMIDIATLY) {
            return true;
        }

        if ($score_reporting === ScoreReportingTypes::SCORE_REPORTING_DATE
            && self::$settings_result_summaries_by_obj_id->getReportingDate() < new \DateTimeImmutable('now', new DateTimeZone('UTC'))) {
            return true;
        }

        return false;
    }

visibleUserResultExists()

static ilObjTestAccess::visibleUserResultExists ( int  $test_obj_id, int  $user_id  )

static

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

References $DIC, $ilDB, and ilObjectFactory\getInstanceByObjId().

Referenced by ilLOUtils\getTestResultLinkForUser().

                                                                                  : bool
    {
        global $DIC;
        $ilDB = $DIC['ilDB'];
        $ilUser = $DIC['ilUser'];

        $test_obj = ilObjectFactory::getInstanceByObjId($test_obj_id, false);

        if (!($test_obj instanceof ilObjTest)) {
            return false;
        }

        $test_session_factory = new ilTestSessionFactory($test_obj, $ilDB, $ilUser);
        $test_session = $test_session_factory->getSessionByUserId($user_id);

        return $test_obj->canShowTestResults($test_session);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$access

ilAccessHandler ilObjTestAccess::$access

private

Definition at line 51 of file class.ilObjTestAccess.php.

$certificate_preloader

ilCertificateObjectsForUserPreloader ilObjTestAccess::$certificate_preloader = null

staticprivate

Definition at line 53 of file class.ilObjTestAccess.php.

$db

ilDBInterface ilObjTestAccess::$db

private

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

$lng

ilLanguage ilObjTestAccess::$lng

private

Definition at line 49 of file class.ilObjTestAccess.php.

$rbac_system

ilRbacSystem ilObjTestAccess::$rbac_system

private

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

$settings_result_summaries_by_obj_id

array ilObjTestAccess::$settings_result_summaries_by_obj_id = []

staticprivate

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

$user

ilObjUser ilObjTestAccess::$user

private

Definition at line 48 of file class.ilObjTestAccess.php.

---

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

• components/ILIAS/Test/classes/class.ilObjTestAccess.php