Inheritance diagram for ilTestProcessLockerFile:

Collaboration diagram for ilTestProcessLockerFile:

Public Member Functions
	__construct (private readonly ilTestProcessLockFileStorage $lockFileStorage, private readonly ilLogger\|TestLogger $logger)
	ilTestProcessLockerFile constructor. More...

Public Member Functions inherited from ilTestProcessLocker
	executeTestStartLockOperation (callable $operation)

	executeRandomPassBuildOperation (callable $operation, $withTaxonomyTables=false)

	executeTestFinishOperation (callable $operation)

	executeNamedOperation (string $operationDescriptor, callable $operation)

Data Fields
const	PROCESS_NAME_TEST_START_LOCK_CHECK = 'testStartLockCheck'

const	PROCESS_NAME_RANDOM_PASS_BUILD = 'randomPassBuild'

const	PROCESS_NAME_TEST_FINISH = 'testFinish'

Protected Member Functions

onBeforeExecutingTestStartOperation ()

{} More...

onAfterExecutingTestStartOperation ()

{} More...

onBeforeExecutingRandomPassBuildOperation ($withTaxonomyTables=false)

{

Parameters

bool $withTaxonomyTables

} More...

onAfterExecutingRandomPassBuildOperation ($withTaxonomyTables=false)

{

Parameters

bool $withTaxonomyTables

} More...

onBeforeExecutingTestFinishOperation ()

{} More...

onAfterExecutingTestFinishOperation ()

{} More...

onBeforeExecutingNamedOperation (string $operationDescriptor)

onAfterExecutingNamedOperation (string $operationDescriptor)

Protected Member Functions inherited from ilTestProcessLocker

executeOperation (callable $operation)

onBeforeExecutingTestStartOperation ()

onAfterExecutingTestStartOperation ()

onBeforeExecutingRandomPassBuildOperation ($withTaxonomyTables=false)

onAfterExecutingRandomPassBuildOperation ($withTaxonomyTables=false)

onBeforeExecutingTestFinishOperation ()

onAfterExecutingTestFinishOperation ()

onBeforeExecutingNamedOperation (string $operationDescriptor)

onAfterExecutingNamedOperation (string $operationDescriptor)

Protected Attributes
	$lockFileHandles = []

Private Member Functions
	requestLock ($processName)

	getLockFilePath ($processName)

	releaseLock ($processName)

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilTestProcessLockerFile::__construct	(	private readonly ilTestProcessLockFileStorage	$lockFileStorage,
		private readonly ilLogger\|TestLogger	$logger
	)

ilTestProcessLockerFile constructor.

Parameters

ilTestProcessLockFileStorage $lockFileStorage

Definition at line 44 of file class.ilTestProcessLockerFile.php.

47 {

48 }

Member Function Documentation

◆ getLockFilePath()

ilTestProcessLockerFile::getLockFilePath ( $processName )

private

Definition at line 125 of file class.ilTestProcessLockerFile.php.

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

References $path.

Referenced by requestLock().

Here is the caller graph for this function:

◆ onAfterExecutingNamedOperation()

ilTestProcessLockerFile::onAfterExecutingNamedOperation ( string $operationDescriptor )

protected

Reimplemented from ilTestProcessLocker.

Definition at line 110 of file class.ilTestProcessLockerFile.php.

                                                                                  : void
    {
        $this->releaseLock($operationDescriptor);
        parent::onAfterExecutingNamedOperation($operationDescriptor);
    }

References releaseLock().

Here is the call graph for this function:

◆ onAfterExecutingRandomPassBuildOperation()

ilTestProcessLockerFile::onAfterExecutingRandomPassBuildOperation ( $withTaxonomyTables = false )

protected

{

Parameters

bool $withTaxonomyTables

}

Reimplemented from ilTestProcessLocker.

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

    {
        $this->releaseLock(self::PROCESS_NAME_RANDOM_PASS_BUILD);
        parent::onAfterExecutingRandomPassBuildOperation($withTaxonomyTables);
    }

References releaseLock().

Here is the call graph for this function:

◆ onAfterExecutingTestFinishOperation()

ilTestProcessLockerFile::onAfterExecutingTestFinishOperation ( )

protected

{}

Reimplemented from ilTestProcessLocker.

Definition at line 98 of file class.ilTestProcessLockerFile.php.

    {
        $this->releaseLock(self::PROCESS_NAME_TEST_FINISH);
        parent::onAfterExecutingTestStartOperation();
    }

References releaseLock().

Here is the call graph for this function:

◆ onAfterExecutingTestStartOperation()

ilTestProcessLockerFile::onAfterExecutingTestStartOperation ( )

protected

{}

Reimplemented from ilTestProcessLocker.

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

    {
        $this->releaseLock(self::PROCESS_NAME_TEST_START_LOCK_CHECK);
        parent::onAfterExecutingTestStartOperation();
    }

References releaseLock().

Here is the call graph for this function:

◆ onBeforeExecutingNamedOperation()

ilTestProcessLockerFile::onBeforeExecutingNamedOperation ( string $operationDescriptor )

protected

Reimplemented from ilTestProcessLocker.

Definition at line 104 of file class.ilTestProcessLockerFile.php.

                                                                                   : void
    {
        $this->requestLock($operationDescriptor);
        parent::onBeforeExecutingNamedOperation($operationDescriptor);
    }

References requestLock().

Here is the call graph for this function:

◆ onBeforeExecutingRandomPassBuildOperation()

ilTestProcessLockerFile::onBeforeExecutingRandomPassBuildOperation ( $withTaxonomyTables = false )

protected

{

Parameters

bool $withTaxonomyTables

}

Reimplemented from ilTestProcessLocker.

Definition at line 71 of file class.ilTestProcessLockerFile.php.

    {
        parent::onBeforeExecutingRandomPassBuildOperation($withTaxonomyTables);
        $this->requestLock(self::PROCESS_NAME_RANDOM_PASS_BUILD);
    }

References requestLock().

Here is the call graph for this function:

◆ onBeforeExecutingTestFinishOperation()

ilTestProcessLockerFile::onBeforeExecutingTestFinishOperation ( )

protected

{}

Reimplemented from ilTestProcessLocker.

Definition at line 89 of file class.ilTestProcessLockerFile.php.

    {
        parent::onBeforeExecutingTestStartOperation();
        $this->requestLock(self::PROCESS_NAME_TEST_FINISH);
    }

References requestLock().

Here is the call graph for this function:

◆ onBeforeExecutingTestStartOperation()

ilTestProcessLockerFile::onBeforeExecutingTestStartOperation ( )

protected

{}

Reimplemented from ilTestProcessLocker.

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

    {
        parent::onBeforeExecutingTestStartOperation();
        $this->requestLock(self::PROCESS_NAME_TEST_START_LOCK_CHECK);
    }

References requestLock().

Here is the call graph for this function:

◆ releaseLock()

ilTestProcessLockerFile::releaseLock ( $processName )

private

Definition at line 131 of file class.ilTestProcessLockerFile.php.

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

Referenced by onAfterExecutingNamedOperation(), onAfterExecutingRandomPassBuildOperation(), onAfterExecutingTestFinishOperation(), and onAfterExecutingTestStartOperation().

Here is the caller graph for this function:

◆ requestLock()

ilTestProcessLockerFile::requestLock ( $processName )

private

Definition at line 116 of file class.ilTestProcessLockerFile.php.

    {
        $lockFilePath = $this->getLockFilePath($processName);
        $this->lockFileHandles[$processName] = fopen($lockFilePath, 'w');
        if (!flock($this->lockFileHandles[$processName], LOCK_EX)) {
            $this->logger->error("Flock failed for {$lockFilePath}.");
        }
    }