ILIAS\Test\Logging\TestLogger Class Reference

Inheritance diagram for ILIAS\Test\Logging\TestLogger:

Collaboration diagram for ILIAS\Test\Logging\TestLogger:

Public Member Functions
	__construct (private readonly TestLoggingSettings $logging_settings, private readonly TestLoggingRepository $logging_repository, private readonly Factory $interaction_factory, private readonly AdditionalInformationGenerator $additional_information, private readonly \ilComponentLogger $component_logger,)
	isLoggingEnabled ()
	isIPLoggingEnabled ()
	testHasParticipantInteractions (int $ref_id)
	deleteParticipantInteractionsForTest (int $ref_id)
	logTestAdministrationInteraction (TestAdministrationInteraction $interaction)
	logQuestionAdministrationInteraction (TestQuestionAdministrationInteraction $interaction)
	logParticipantInteraction (TestParticipantInteraction $interaction)
	logScoringInteraction (TestScoringInteraction $interaction)
	emergency (string|\Stringable $message, array $context=[])
	alert (string|\Stringable $message, array $context=[])
	critical (string|\Stringable $message, array $context=[])
	error (string|\Stringable $message, array $context=[])
	warning (string|\Stringable $message, array $context=[])
	notice (string|\Stringable $message, array $context=[])
	info (string|\Stringable $message, array $context=[])
	debug (string|\Stringable $message, array $context=[])
	log ($level, string|\Stringable $message, mixed $context=[])
	getComponentLogger ()
	getInteractionFactory ()
	getAdditionalInformationGenerator ()
	getLogEntryTypes ()
	getInteractionTypes ()

Private Member Functions
	createTestErrorFromContext (array $context, string $message)

Private Attributes
const	LOG_ENTRY_TYPES

Detailed Description

Definition at line 27 of file TestLogger.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Test\Logging\TestLogger::__construct	(	private readonly TestLoggingSettings	$logging_settings,
		private readonly TestLoggingRepository	$logging_repository,
		private readonly Factory	$interaction_factory,
		private readonly AdditionalInformationGenerator	$additional_information,
		private readonly \ilComponentLogger	$component_logger
	)

Definition at line 36 of file TestLogger.php.

      {
    }

Member Function Documentation

alert()

ILIAS\Test\Logging\TestLogger::alert	(	string|\Stringable	$message,
		array	$context = []
	)

Definition at line 98 of file TestLogger.php.

References $context, and ILIAS\Test\Logging\TestLogger\createTestErrorFromContext().

                                                                           : void
    {
        $this->component_logger->alert($message, $context);

        if (!$this->logging_settings->isLoggingEnabled()
            || !isset($context['ref_id'])) {
            return;
        }

        $this->logging_repository->storeError(
            $this->createTestErrorFromContext($context, $message)
        );
    }

Here is the call graph for this function:

createTestErrorFromContext()

ILIAS\Test\Logging\TestLogger::createTestErrorFromContext ( array  $context, string  $message  )

private

Definition at line 206 of file TestLogger.php.

References ILIAS\Test\Logging\ERROR_ON_UNDEFINED_INTERACTION, and null.

Referenced by ILIAS\Test\Logging\TestLogger\alert(), ILIAS\Test\Logging\TestLogger\critical(), ILIAS\Test\Logging\TestLogger\emergency(), ILIAS\Test\Logging\TestLogger\error(), and ILIAS\Test\Logging\TestLogger\log().

                                                                                : TestError
    {
        return new TestError(
            $context['ref_id'],
            $context ['question_id'] ?? null,
            $context['administrator'] ?? null,
            $context['participant'] ?? null,
            $context['error_type'] ?? TestErrorTypes::ERROR_ON_UNDEFINED_INTERACTION,
            $context['timestamp'] ?? time(),
            $message
        );
    }

Here is the caller graph for this function:

critical()

ILIAS\Test\Logging\TestLogger::critical	(	string|\Stringable	$message,
		array	$context = []
	)

Definition at line 112 of file TestLogger.php.

References $context, and ILIAS\Test\Logging\TestLogger\createTestErrorFromContext().

                                                                              : void
    {
        $this->component_logger->critical($message, $context);

        if (!$this->logging_settings->isLoggingEnabled()
            || !isset($context['ref_id'])) {
            return;
        }

        $this->logging_repository->storeError(
            $this->createTestErrorFromContext($context, $message)
        );
    }

Here is the call graph for this function:

debug()

ILIAS\Test\Logging\TestLogger::debug	(	string|\Stringable	$message,
		array	$context = []
	)

Definition at line 154 of file TestLogger.php.

References $context.

                                                                           : void
    {
        $this->component_logger->debug($message, $context);
    }

deleteParticipantInteractionsForTest()

ILIAS\Test\Logging\TestLogger::deleteParticipantInteractionsForTest

(

int

$ref_id

)

Definition at line 60 of file TestLogger.php.

                                                                     : void
    {
        $this->logging_repository->deleteParticipantInteractionsForTest($ref_id);
    }

emergency()

ILIAS\Test\Logging\TestLogger::emergency	(	string|\Stringable	$message,
		array	$context = []
	)

Definition at line 85 of file TestLogger.php.

References $context, and ILIAS\Test\Logging\TestLogger\createTestErrorFromContext().

                                                                               : void
    {
        $this->component_logger->emergency($message, $context);

        if (!$this->logging_settings->isLoggingEnabled()
            || !isset($context['ref_id'])) {
            return;
        }

        $this->logging_repository->storeError(
            $this->createTestErrorFromContext($context, $message)
        );
    }

Here is the call graph for this function:

error()

ILIAS\Test\Logging\TestLogger::error	(	string|\Stringable	$message,
		array	$context = []
	)

Definition at line 125 of file TestLogger.php.

References $context, and ILIAS\Test\Logging\TestLogger\createTestErrorFromContext().

                                                                           : void
    {

        if (!$this->logging_settings->isLoggingEnabled()
            || !isset($context['ref_id'])) {
            return;
        }

        $this->logging_repository->storeError(
            $this->createTestErrorFromContext($context, $message)
        );
        $this->component_logger->error($message, $context);
    }

Here is the call graph for this function:

getAdditionalInformationGenerator()

ILIAS\Test\Logging\TestLogger::getAdditionalInformationGenerator

(

)

Definition at line 184 of file TestLogger.php.

                                                       : AdditionalInformationGenerator
    {
        return $this->additional_information;
    }

getComponentLogger()

ILIAS\Test\Logging\TestLogger::getComponentLogger

(

)

Definition at line 174 of file TestLogger.php.

                                        : \ilComponentLogger
    {
        return $this->component_logger;
    }

getInteractionFactory()

ILIAS\Test\Logging\TestLogger::getInteractionFactory

(

)

Definition at line 179 of file TestLogger.php.

                                           : Factory
    {
        return $this->interaction_factory;
    }

getInteractionTypes()

ILIAS\Test\Logging\TestLogger::getInteractionTypes

(

)

Definition at line 197 of file TestLogger.php.

                                         : array
    {
        $interaction_types = [];
        foreach (self::LOG_ENTRY_TYPES as $type => $enum_class) {
            $interaction_types[$type] = array_column($enum_class::cases(), 'value');
        }
        return $interaction_types;
    }

getLogEntryTypes()

ILIAS\Test\Logging\TestLogger::getLogEntryTypes

(

)

Returns

array<string>

Definition at line 192 of file TestLogger.php.

                                      : array
    {
        return array_keys(self::LOG_ENTRY_TYPES);
    }

info()

ILIAS\Test\Logging\TestLogger::info	(	string|\Stringable	$message,
		array	$context = []
	)

Definition at line 149 of file TestLogger.php.

References $context.

                                                                          : void
    {
        $this->component_logger->info($message, $context);
    }

isIPLoggingEnabled()

ILIAS\Test\Logging\TestLogger::isIPLoggingEnabled

(

)

Definition at line 50 of file TestLogger.php.

                                        : bool
    {
        return $this->logging_settings->isIPLoggingEnabled();
    }

isLoggingEnabled()

ILIAS\Test\Logging\TestLogger::isLoggingEnabled

(

)

Definition at line 45 of file TestLogger.php.

                                      : bool
    {
        return $this->logging_settings->isLoggingEnabled();
    }

log()

ILIAS\Test\Logging\TestLogger::log	(		$level,
		string|\Stringable	$message,
		mixed	$context = []
	)

Definition at line 159 of file TestLogger.php.

References $context, ILIAS\Test\Logging\TestLogger\createTestErrorFromContext(), and ilLogLevel\ERROR.

                                                                                 : void
    {
        $this->component_logger->log($message, $level, $context);

        if (!$this->logging_settings->isLoggingEnabled()
            || intval($level) < \ilLogLevel::ERROR
            || !isset($context['ref_id'])) {
            return;
        }

        $this->logging_repository->storeError(
            $this->createTestErrorFromContext($context, $message)
        );
    }

Here is the call graph for this function:

logParticipantInteraction()

ILIAS\Test\Logging\TestLogger::logParticipantInteraction

(

TestParticipantInteraction

$interaction

)

Definition at line 75 of file TestLogger.php.

                                                                                      : void
    {
        $this->logging_repository->storeParticipantInteraction($interaction);
    }

logQuestionAdministrationInteraction()

ILIAS\Test\Logging\TestLogger::logQuestionAdministrationInteraction

(

TestQuestionAdministrationInteraction

$interaction

)

Definition at line 70 of file TestLogger.php.

                                                                                                            : void
    {
        $this->logging_repository->storeQuestionAdministrationInteraction($interaction);
    }

logScoringInteraction()

ILIAS\Test\Logging\TestLogger::logScoringInteraction

(

TestScoringInteraction

$interaction

)

Definition at line 80 of file TestLogger.php.

                                                                              : void
    {
        $this->logging_repository->storeScoringInteraction($interaction);
    }

logTestAdministrationInteraction()

ILIAS\Test\Logging\TestLogger::logTestAdministrationInteraction

(

TestAdministrationInteraction

$interaction

)

Definition at line 65 of file TestLogger.php.

                                                                                                : void
    {
        $this->logging_repository->storeTestAdministrationInteraction($interaction);
    }

notice()

ILIAS\Test\Logging\TestLogger::notice	(	string|\Stringable	$message,
		array	$context = []
	)

Definition at line 144 of file TestLogger.php.

References $context.

                                                                            : void
    {
        $this->component_logger->notice($message, $context);
    }

testHasParticipantInteractions()

ILIAS\Test\Logging\TestLogger::testHasParticipantInteractions

(

int

$ref_id

)

Definition at line 55 of file TestLogger.php.

                                                               : bool
    {
        return $this->logging_repository->testHasParticipantInteractions($ref_id);
    }

warning()

ILIAS\Test\Logging\TestLogger::warning	(	string|\Stringable	$message,
		array	$context = []
	)

Definition at line 139 of file TestLogger.php.

References $context.

                                                                             : void
    {
        $this->component_logger->warning($message, $context);
    }

Field Documentation

LOG_ENTRY_TYPES

const ILIAS\Test\Logging\TestLogger::LOG_ENTRY_TYPES

private

Initial value:

= [
        TestAdministrationInteraction::IDENTIFIER => TestAdministrationInteractionTypes::class

Definition at line 29 of file TestLogger.php.

---

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

• components/ILIAS/Test/src/Logging/TestLogger.php