ilAssQuestionProcessLockFileStorage Class Reference

Inheritance diagram for ilAssQuestionProcessLockFileStorage:

Collaboration diagram for ilAssQuestionProcessLockFileStorage:

Public Member Functions
	__construct (int $question_id, int $user_id)
	getPath ()
	create ()
Public Member Functions inherited from ilFileSystemAbstractionStorage
	__construct (private int $storage_type, private bool $path_conversion, private int $container_id)
	Constructor. More...
	fileExists (string $a_absolute_path)
	getContainerId ()
	writeToFile (string $a_data, $a_absolute_path)
	copyFile (string $a_from, string $a_to)
	create ()
	getAbsolutePath ()
	Calculates the full path on the filesystem. More...
	delete ()
	deleteDirectory (string $a_abs_name)
	deleteFile (string $a_abs_name)
	appendToPath (string $a_appendix)
	getStorageType ()
	getPath ()

Protected Member Functions
	getPathPrefix ()
	Get path prefix. More...
	getPathPostfix ()
	Get directory name. More...
Protected Member Functions inherited from ilFileSystemAbstractionStorage
	getLegacyFullAbsolutePath (string $relative_path)
	getFileSystemService ()
	getPathPrefix ()
	Get path prefix. More...
	getPathPostfix ()
	Get directory name. More...
	getLegacyAbsolutePath ()
	Calculates the absolute filesystem storage location. More...
	init ()

Private Member Functions
	initSubPath (int $user_id)

Private Attributes
string	$sub_path

Additional Inherited Members
Static Public Member Functions inherited from ilFileSystemAbstractionStorage
static	createPathFromId (int $a_container_id, string $a_name)
static	_copyDirectory (string $a_sdir, string $a_tdir)
Data Fields inherited from ilFileSystemAbstractionStorage
const	STORAGE_WEB = 1
const	STORAGE_DATA = 2
const	STORAGE_SECURED = 3
Protected Attributes inherited from ilFileSystemAbstractionStorage
string	$path = null
Filesystems	$file_system_service

Detailed Description

Definition at line 24 of file class.ilAssQuestionProcessLockFileStorage.php.

Constructor & Destructor Documentation

__construct()

ilAssQuestionProcessLockFileStorage::__construct	(	int	$question_id,
		int	$user_id
	)

Definition at line 28 of file class.ilAssQuestionProcessLockFileStorage.php.

References ILIAS\GlobalScreen\Provider\__construct(), initSubPath(), and ilFileSystemAbstractionStorage\STORAGE_DATA.

    {
        parent::__construct(ilFileSystemAbstractionStorage::STORAGE_DATA, true, $question_id);

        $this->initSubPath($user_id);
    }

Here is the call graph for this function:

Member Function Documentation

create()

ilAssQuestionProcessLockFileStorage::create

(

)

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

References Vendor\Package\$e, $message, ilFileSystemAbstractionStorage\getFileSystemService(), getPath(), and ILIAS\GlobalScreen\has().

                            : void
    {
        set_error_handler(function ($severity, $message, $file, $line): void {
            throw new ErrorException($message, $severity, 0, $file, $line);
        });

        try {
            parent::create($this->getPath());
            restore_error_handler();
        } catch (Exception $e) {
            restore_error_handler();
        }

        if (!$this->getFileSystemService()->has($this->path)) {
            throw new ErrorException(sprintf('Could not find directory: %s', $this->getPath()));
        }
    }

Here is the call graph for this function:

getPath()

ilAssQuestionProcessLockFileStorage::getPath

(

)

Definition at line 62 of file class.ilAssQuestionProcessLockFileStorage.php.

References $sub_path.

Referenced by create().

                             : string
    {
        return parent::getPath() . '/' . $this->sub_path;
    }

Here is the caller graph for this function:

getPathPostfix()

ilAssQuestionProcessLockFileStorage::getPathPostfix ( )

protected

Get directory name.

E.g for files => file Only relative path, no trailing slash '_<obj_id>' will be appended automatically

protected

Returns

string directory name

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

                                       : string
    {
        return 'question';
    }

getPathPrefix()

ilAssQuestionProcessLockFileStorage::getPathPrefix ( )

protected

Get path prefix.

Prefix that will be prepended to the path No trailing slash. E.g ilFiles for files

protected

Returns

string path prefix e.g files

Definition at line 43 of file class.ilAssQuestionProcessLockFileStorage.php.

                                      : string
    {
        return 'ilAssQuestionProcessLocks';
    }

initSubPath()

ilAssQuestionProcessLockFileStorage::initSubPath ( int  $user_id )

private

Definition at line 85 of file class.ilAssQuestionProcessLockFileStorage.php.

References ilFileSystemAbstractionStorage\$path.

Referenced by __construct().

                                              : void
    {
        $user_id = (string) $user_id;

        $path = [];

        for ($i = 0, $max = strlen($user_id); $i < $max; $i++) {
            $path[] = substr($user_id, $i, 1);
        }

        $this->sub_path = implode('/', $path);
    }

Here is the caller graph for this function:

Field Documentation

$sub_path

string ilAssQuestionProcessLockFileStorage::$sub_path

private

Definition at line 26 of file class.ilAssQuestionProcessLockFileStorage.php.

Referenced by getPath().

---

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

• components/ILIAS/TestQuestionPool/classes/class.ilAssQuestionProcessLockFileStorage.php