ilAssQuestionProcessLockerFile Class Reference

Inheritance diagram for ilAssQuestionProcessLockerFile:

Collaboration diagram for ilAssQuestionProcessLockerFile:

Public Member Functions
	__construct (ilAssQuestionProcessLockFileStorage $lockFileStorage)
Public Member Functions inherited from ilAssQuestionProcessLocker
	executePersistWorkingStateLockOperation (callable $operation)
	executeUserSolutionUpdateLockOperation (callable $operation)
	executeUserQuestionResultUpdateOperation (callable $operation)
	executeUserPassResultUpdateLockOperation (callable $operation)
	executeUserTestResultUpdateLockOperation (callable $operation)
	executeUserSolutionAdoptLockOperation (callable $operation)

Data Fields
const	PROCESS_NAME_QUESTION_WORKING_STATE_UPDATE = 'questionWorkingStateUpdate'

Protected Member Functions
	onBeforeExecutingPersistWorkingStateOperation ()
	{} More...
	onAfterExecutingPersistWorkingStateOperation ()
	{} More...
	onBeforeExecutingUserSolutionAdoptOperation ()
	{} More...
	onAfterExecutingUserSolutionAdoptOperation ()
	{} More...
Protected Member Functions inherited from ilAssQuestionProcessLocker
	executeOperation (callable $operation)
	onBeforeExecutingPersistWorkingStateOperation ()
	onAfterExecutingPersistWorkingStateOperation ()
	onBeforeExecutingUserSolutionUpdateOperation ()
	onBeforeExecutingUserQuestionResultUpdateOperation ()
	onAfterExecutingUserQuestionResultUpdateOperation ()
	onBeforeExecutingUserPassResultUpdateOperation ()
	onAfterExecutingUserPassResultUpdateOperation ()
	onBeforeExecutingUserTestResultUpdateOperation ()
	onAfterExecutingUserTestResultUpdateOperation ()
	onBeforeExecutingUserSolutionAdoptOperation ()
	onAfterExecutingUserSolutionAdoptOperation ()

Protected Attributes
ilAssQuestionProcessLockFileStorage	$lockFileStorage
	$lockFileHandles

Private Member Functions
	requestLock ($processName)
	getLockFilePath ($processName)
	releaseLock ($processName)

Detailed Description

Definition at line 25 of file class.ilAssQuestionProcessLockerFile.php.

Constructor & Destructor Documentation

__construct()

ilAssQuestionProcessLockerFile::__construct

(

ilAssQuestionProcessLockFileStorage

$lockFileStorage

)

Parameters

ilAssQuestionProcessLockFileStorage

$lockFileStorage

Definition at line 39 of file class.ilAssQuestionProcessLockerFile.php.

References $lockFileStorage.

    {
        $this->lockFileStorage = $lockFileStorage;
        $this->lockFileHandles = [];
    }

Member Function Documentation

getLockFilePath()

ilAssQuestionProcessLockerFile::getLockFilePath (   $processName )

private

Parameters

string

$processName

Returns

string

Definition at line 91 of file class.ilAssQuestionProcessLockerFile.php.

References $path.

Referenced by requestLock().

                                                  : string
    {
        $path = $this->lockFileStorage->getAbsolutePath();
        return $path . '/' . $processName . '.lock';
    }

Here is the caller graph for this function:

onAfterExecutingPersistWorkingStateOperation()

ilAssQuestionProcessLockerFile::onAfterExecutingPersistWorkingStateOperation ( )

protected

{}

Definition at line 56 of file class.ilAssQuestionProcessLockerFile.php.

References releaseLock().

                                                                     : void
    {
        $this->releaseLock(self::PROCESS_NAME_QUESTION_WORKING_STATE_UPDATE);
    }

Here is the call graph for this function:

onAfterExecutingUserSolutionAdoptOperation()

ilAssQuestionProcessLockerFile::onAfterExecutingUserSolutionAdoptOperation ( )

protected

{}

Definition at line 72 of file class.ilAssQuestionProcessLockerFile.php.

References releaseLock().

                                                                   : void
    {
        $this->releaseLock(self::PROCESS_NAME_QUESTION_WORKING_STATE_UPDATE);
    }

Here is the call graph for this function:

onBeforeExecutingPersistWorkingStateOperation()

ilAssQuestionProcessLockerFile::onBeforeExecutingPersistWorkingStateOperation ( )

protected

{}

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

References requestLock().

                                                                      : void
    {
        $this->requestLock(self::PROCESS_NAME_QUESTION_WORKING_STATE_UPDATE);
    }

Here is the call graph for this function:

onBeforeExecutingUserSolutionAdoptOperation()

ilAssQuestionProcessLockerFile::onBeforeExecutingUserSolutionAdoptOperation ( )

protected

{}

Definition at line 64 of file class.ilAssQuestionProcessLockerFile.php.

References requestLock().

                                                                    : void
    {
        $this->requestLock(self::PROCESS_NAME_QUESTION_WORKING_STATE_UPDATE);
    }

Here is the call graph for this function:

releaseLock()

ilAssQuestionProcessLockerFile::releaseLock (   $processName )

private

Parameters

string

$processName

Definition at line 100 of file class.ilAssQuestionProcessLockerFile.php.

Referenced by onAfterExecutingPersistWorkingStateOperation(), and onAfterExecutingUserSolutionAdoptOperation().

                                              : void
    {
        flock($this->lockFileHandles[$processName], LOCK_UN);
        fclose($this->lockFileHandles[$processName]);
    }

Here is the caller graph for this function:

requestLock()

ilAssQuestionProcessLockerFile::requestLock (   $processName )

private

Parameters

string

$processName

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

References getLockFilePath().

Referenced by onBeforeExecutingPersistWorkingStateOperation(), and onBeforeExecutingUserSolutionAdoptOperation().

                                              : void
    {
        $lockFilePath = $this->getLockFilePath($processName);
        $this->lockFileHandles[$processName] = fopen($lockFilePath, 'w');
        flock($this->lockFileHandles[$processName], LOCK_EX);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$lockFileHandles

ilAssQuestionProcessLockerFile::$lockFileHandles

protected

Definition at line 34 of file class.ilAssQuestionProcessLockerFile.php.

$lockFileStorage

ilAssQuestionProcessLockFileStorage ilAssQuestionProcessLockerFile::$lockFileStorage

protected

Definition at line 29 of file class.ilAssQuestionProcessLockerFile.php.

Referenced by __construct().

PROCESS_NAME_QUESTION_WORKING_STATE_UPDATE

const ilAssQuestionProcessLockerFile::PROCESS_NAME_QUESTION_WORKING_STATE_UPDATE = 'questionWorkingStateUpdate'

Definition at line 27 of file class.ilAssQuestionProcessLockerFile.php.

---

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

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