ILIAS\Test\Access\AccessFileUploadAnswer Class Reference

Inheritance diagram for ILIAS\Test\Access\AccessFileUploadAnswer:

Collaboration diagram for ILIAS\Test\Access\AccessFileUploadAnswer:

Public Member Functions
	__construct (private readonly ilObjUser $user, private readonly ilDBInterface $database, private readonly Readable $readable, $object_id_of_test_id=[ilObjTest::class, '_getObjectIDFromTestID'], $references_of=[ilObject::class, '_getAllReferences'], $session=[ilSession::class, 'get'], ?callable $checkResultsAccess=null, ?Incident $incident=null)
	isPermitted (string $path)

Private Member Functions
	isAnonymous ()
	accessCodeOk (string $file, int $test_id)
	userDidUpload (int $test_id, string $file, ?string $code=null)
	activeIdOfFile (string $file, int $test)
	roleBasedCheck (int $test_id, array $references, string $file)
	canAccessResults (int $test_id, array $references, string $file)
	pathAndTestId (string $path)

Private Attributes
readonly Closure	$object_id_of_test_id
readonly Closure	$references_of
readonly Closure	$session
readonly Closure	$checkResultsAccess
readonly Incident	$incident

Detailed Description

Definition at line 35 of file AccessFileUploadAnswer.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Test\Access\AccessFileUploadAnswer::__construct	(	private readonly ilObjUser	$user,
		private readonly ilDBInterface	$database,
		private readonly Readable	$readable,
			$object_id_of_test_id = [ilObjTest::class,
		'_getObjectIDFromTestID']	,
			$references_of = [ilObject::class,
		'_getAllReferences']	,
			$session = [ilSession::class,
		'get']	,
		?callable	$checkResultsAccess = null,
		?Incident	$incident = null
	)

Parameters

callable(int)	int $object_id_of_test_id
callable(int)	int[] $references_of
callable(string)	mixed $session
callable(int,int,int)	bool $checkResultsAccess

Definition at line 53 of file AccessFileUploadAnswer.php.

      {
        $this->incident = $incident ?? new Incident();
        $this->object_id_of_test_id = Closure::fromCallable($object_id_of_test_id);
        $this->references_of = Closure::fromCallable($references_of);
        $this->session = Closure::fromCallable($session);
        $checkResultsAccess = $checkResultsAccess ?? static function (int $reference, int $test_id, int $active_id): bool {
            $access = new ilTestAccess($reference);
            return $access->checkResultsAccessForActiveId($active_id, $test_id);
        };
        $this->checkResultsAccess = Closure::fromCallable($checkResultsAccess);
    }

Member Function Documentation

accessCodeOk()

ILIAS\Test\Access\AccessFileUploadAnswer::accessCodeOk ( string  $file, int  $test_id  )

private

Definition at line 100 of file AccessFileUploadAnswer.php.

References ILIAS\Test\Access\AccessFileUploadAnswer\$session, ilTestSession\ACCESS_CODE_SESSION_INDEX, and ILIAS\Test\Access\AccessFileUploadAnswer\userDidUpload().

Referenced by ILIAS\Test\Access\AccessFileUploadAnswer\roleBasedCheck().

                                                             : bool
    {
        $code = ($this->session)(ilTestSession::ACCESS_CODE_SESSION_INDEX)[$test_id] ?? false;

        return $code && $this->userDidUpload($test_id, $file, $code);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

activeIdOfFile()

ILIAS\Test\Access\AccessFileUploadAnswer::activeIdOfFile ( string  $file, int  $test  )

private

Definition at line 126 of file AccessFileUploadAnswer.php.

References null.

Referenced by ILIAS\Test\Access\AccessFileUploadAnswer\canAccessResults().

                                                            : ?int
    {
        $is_upload_question = 'EXISTS (SELECT 1 FROM qpl_qst_type INNER JOIN qpl_questions ON question_type_id = question_type_fi WHERE type_tag = %s AND tst_solutions.question_fi = qpl_questions.question_id)';
        $is_in_test = 'EXISTS (SELECT 1 FROM tst_active WHERE test_fi = %s AND active_id = active_fi)';

        $result = $this->database->queryF(
            "SELECT active_fi, value1 FROM tst_solutions WHERE $is_upload_question AND $is_in_test",
            ['text', 'integer'],
            ['assFileUpload', $test]
        );

        while (($row = $this->database->fetchAssoc($result))) {
            if ($row['value1'] === $file) {
                return (int) $row['active_fi'];
            }
        }

        return null;
    }

Here is the caller graph for this function:

canAccessResults()

ILIAS\Test\Access\AccessFileUploadAnswer::canAccessResults ( int  $test_id, array  $references, string  $file  )

private

Parameters

int	$test_id
	int[]	$references
string	$file

Returns

bool

Definition at line 165 of file AccessFileUploadAnswer.php.

References ILIAS\Test\Access\AccessFileUploadAnswer\activeIdOfFile().

Referenced by ILIAS\Test\Access\AccessFileUploadAnswer\roleBasedCheck().

                                                                                    : bool
    {
        $active_id = $this->activeIdOfFile($file, $test_id);
        if (!$active_id) {
            return false;
        }

        return $this->incident->any(fn(int $reference): bool => (
            ($this->checkResultsAccess)($reference, $test_id, $active_id)
        ), $references);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isAnonymous()

ILIAS\Test\Access\AccessFileUploadAnswer::isAnonymous ( )

private

Definition at line 95 of file AccessFileUploadAnswer.php.

References ILIAS\Repository\user().

Referenced by ILIAS\Test\Access\AccessFileUploadAnswer\roleBasedCheck().

                                  : bool
    {
        return $this->user->isAnonymous() || !$this->user->getId();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isPermitted()

ILIAS\Test\Access\AccessFileUploadAnswer::isPermitted

(

string

$path

)

Returns

Result<bool>

Implements ILIAS\Test\Access\SimpleAccess.

Definition at line 74 of file AccessFileUploadAnswer.php.

References ILIAS\Test\Access\AccessFileUploadAnswer\$references_of, ILIAS\Repository\int(), ILIAS\Test\Access\AccessFileUploadAnswer\pathAndTestId(), and ILIAS\Test\Access\AccessFileUploadAnswer\roleBasedCheck().

                                             : Result
    {
        $path_and_test = $this->pathAndTestId($path);

        if (!$path_and_test) {
            return new Error('Not a file upload path of test answers.');
        }
        if (!$path_and_test['test']) {
            return new Ok(false);
        }

        $object_id = (int) ($this->object_id_of_test_id)($path_and_test['test']);
        if (!$object_id) {
            return new Ok(false);
        }

        $references = ($this->references_of)($object_id);

        return new Ok($this->readable->references($references) && $this->roleBasedCheck($path_and_test['test'], $references, $path_and_test['path']));
    }

Here is the call graph for this function:

pathAndTestId()

ILIAS\Test\Access\AccessFileUploadAnswer::pathAndTestId ( string  $path )

private

Parameters

string

$path

Returns

null|array{test: int, path: string}

Definition at line 182 of file AccessFileUploadAnswer.php.

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

Referenced by ILIAS\Test\Access\AccessFileUploadAnswer\isPermitted().

                                                : ?array
    {
        $results = [];
        if (!preg_match(':/assessment/tst_(\d+)/.*/([^/]+)$:', $path, $results)) {
            return null;
        }

        return [
            'test' => (int) $results[1],
            'path' => $results[2],
        ];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

roleBasedCheck()

ILIAS\Test\Access\AccessFileUploadAnswer::roleBasedCheck ( int  $test_id, array  $references, string  $file  )

private

Parameters

int	$test_id
	int[]	$references
string	$file

Returns

bool

Definition at line 153 of file AccessFileUploadAnswer.php.

References ILIAS\Test\Access\AccessFileUploadAnswer\accessCodeOk(), ILIAS\Test\Access\AccessFileUploadAnswer\canAccessResults(), ILIAS\Test\Access\AccessFileUploadAnswer\isAnonymous(), and ILIAS\Test\Access\AccessFileUploadAnswer\userDidUpload().

Referenced by ILIAS\Test\Access\AccessFileUploadAnswer\isPermitted().

                                                                                  : bool
    {
        return $this->isAnonymous() ? $this->accessCodeOk($file, $test_id) : $this->canAccessResults($test_id, $references, $file) || $this->userDidUpload($test_id, $file);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

userDidUpload()

ILIAS\Test\Access\AccessFileUploadAnswer::userDidUpload ( int  $test_id, string  $file, ?string  $code = null  )

private

Definition at line 107 of file AccessFileUploadAnswer.php.

References null, and ILIAS\Repository\user().

Referenced by ILIAS\Test\Access\AccessFileUploadAnswer\accessCodeOk(), and ILIAS\Test\Access\AccessFileUploadAnswer\roleBasedCheck().

                                                                                    : bool
    {
        $where = [
            'active_id = active_fi',
            'user_fi = %s',
            'value1 = %s',
            'anonymous_id ' . (null === $code ? 'IS' : '=') . ' %s',
            'test_fi = %s',
        ];

        $result = $this->database->queryF(
            'SELECT 1 FROM tst_solutions WHERE EXISTS (SELECT 1 FROM tst_active WHERE ' . implode(' AND ', $where) . ')',
            ['integer', 'text', 'text', 'integer'],
            [$this->user->getId(), $file, $code, $test_id]
        );

        return (bool) $this->database->numRows($result);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$checkResultsAccess

readonly Closure ILIAS\Test\Access\AccessFileUploadAnswer::$checkResultsAccess

private

Definition at line 44 of file AccessFileUploadAnswer.php.

$incident

readonly Incident ILIAS\Test\Access\AccessFileUploadAnswer::$incident

private

Definition at line 45 of file AccessFileUploadAnswer.php.

$object_id_of_test_id

readonly Closure ILIAS\Test\Access\AccessFileUploadAnswer::$object_id_of_test_id

private

Definition at line 38 of file AccessFileUploadAnswer.php.

$references_of

readonly Closure ILIAS\Test\Access\AccessFileUploadAnswer::$references_of

private

Definition at line 40 of file AccessFileUploadAnswer.php.

Referenced by ILIAS\Test\Access\AccessFileUploadAnswer\isPermitted().

$session

readonly Closure ILIAS\Test\Access\AccessFileUploadAnswer::$session

private

Definition at line 42 of file AccessFileUploadAnswer.php.

Referenced by ILIAS\Test\Access\AccessFileUploadAnswer\accessCodeOk().

---

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

• components/ILIAS/Test/src/Access/AccessFileUploadAnswer.php