Inheritance diagram for ILIAS\Test\Logging\TestError:

Collaboration diagram for ILIAS\Test\Logging\TestError:

Public Member Functions
	__construct (private readonly int $test_ref_id, private readonly ?int $question_id, private readonly ?int $admin_id, private readonly ?int $pax_id, private readonly TestErrorTypes $interaction_type, private readonly int $modification_timestamp, private readonly string $error_message)

	getUniqueIdentifier ()

	withId (int $id)

	getLogEntryAsDataTableRow (\ilLanguage $lng, TitleColumnsBuilder $title_builder, DataRowBuilder $row_builder, array $environment)

	getLogEntryAsExportRow (\ilLanguage $lng, TitleColumnsBuilder $title_builder, AdditionalInformationGenerator $additional_info, array $environment)

	getParsedAdditionalInformation (AdditionalInformationGenerator $additional_info, UIFactory $ui_factory, array $environment)

	toStorage ()

Data Fields
const	IDENTIFIER = 'te'

Data Fields inherited from ILIAS\Test\Logging\TestUserInteraction
const	LANG_VAR_PREFIX = 'logs_'

Private Member Functions
	getUserForPresentation (?int $user_id)

Private Attributes
int	$id

Detailed Description

Definition at line 30 of file TestError.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Test\Logging\TestError::__construct	(	private readonly int	$test_ref_id,
		private readonly ?int	$question_id,
		private readonly ?int	$admin_id,
		private readonly ?int	$pax_id,
		private readonly TestErrorTypes	$interaction_type,
		private readonly int	$modification_timestamp,
		private readonly string	$error_message
	)

Definition at line 36 of file TestError.php.

       {
 
     }

Member Function Documentation

◆ getLogEntryAsDataTableRow()

ILIAS\Test\Logging\TestError::getLogEntryAsDataTableRow	(	\ilLanguage	$lng,
		TitleColumnsBuilder	$title_builder,
		DataRowBuilder	$row_builder,
		array	$environment
	)

Implements ILIAS\Test\Logging\TestUserInteraction.

Definition at line 60 of file TestError.php.

References ILIAS\UI\Component\Table\DataRowBuilder\buildDataRow(), ILIAS\Test\Utilities\TitleColumnsBuilder\buildQuestionTitleAsLink(), ILIAS\Test\Utilities\TitleColumnsBuilder\buildTestTitleAsLink(), ILIAS\Test\Logging\TestError\getUniqueIdentifier(), ILIAS\Test\Logging\TestError\getUserForPresentation(), and ilLanguage\txt().

      : DataRow {
         $admin = $this->getUserForPresentation($this->admin_id);
         $pax = $this->getUserForPresentation($this->pax_id);
 
         $values = [
             'date_and_time' => \DateTimeImmutable::createFromFormat('U', (string) $this->modification_timestamp)
                 ->setTimezone($environment['timezone']),
             'corresponding_test' => $title_builder->buildTestTitleAsLink(
                 $this->test_ref_id
             ),
             'admin' => $admin,
             'participant' => $pax,
             'log_entry_type' => $lng->txt(self::LANG_VAR_PREFIX . self::IDENTIFIER),
             'interaction_type' => $lng->txt(self::LANG_VAR_PREFIX . $this->interaction_type->value)
         ];
 
         if ($this->question_id !== null) {
             $values['question'] = $title_builder->buildQuestionTitleAsLink(
                 $this->question_id,
                 $this->test_ref_id
             );
         }
 
         return $row_builder->buildDataRow(
             $this->getUniqueIdentifier(),
             $values
         );
     }

Here is the call graph for this function:

◆ getLogEntryAsExportRow()

ILIAS\Test\Logging\TestError::getLogEntryAsExportRow	(	\ilLanguage	$lng,
		TitleColumnsBuilder	$title_builder,
		AdditionalInformationGenerator	$additional_info,
		array	$environment
	)

Implements ILIAS\Test\Logging\TestUserInteraction.

Definition at line 94 of file TestError.php.

References ILIAS\Test\Utilities\TitleColumnsBuilder\buildQuestionTitleAsText(), ILIAS\Test\Utilities\TitleColumnsBuilder\buildTestTitleAsText(), ILIAS\Test\Logging\TestError\getUserForPresentation(), and ilLanguage\txt().

      : array {
         $admin = $this->getUserForPresentation($this->admin_id);
         $pax = $this->getUserForPresentation($this->pax_id);
 
         return  [
             \DateTimeImmutable::createFromFormat('U', (string) $this->modification_timestamp)
                 ->setTimezone($environment['timezone'])
                 ->format($environment['date_format']),
             $title_builder->buildTestTitleAsText($this->test_ref_id),
             $admin,
             $pax,
             '',
             $title_builder->buildQuestionTitleAsText($this->question_id),
             $lng->txt(self::LANG_VAR_PREFIX . self::IDENTIFIER),
             $lng->txt(self::LANG_VAR_PREFIX . $this->interaction_type->value),
             $this->error_message
         ];
     }

Here is the call graph for this function:

◆ getParsedAdditionalInformation()

ILIAS\Test\Logging\TestError::getParsedAdditionalInformation	(	AdditionalInformationGenerator	$additional_info,
		UIFactory	$ui_factory,
		array	$environment
	)

Implements ILIAS\Test\Logging\TestUserInteraction.

Definition at line 118 of file TestError.php.

      : Legacy {
         return $ui_factory->legacy($this->error_message);
     }

◆ getUniqueIdentifier()

ILIAS\Test\Logging\TestError::getUniqueIdentifier ( )

Implements ILIAS\Test\Logging\TestUserInteraction.

Definition at line 48 of file TestError.php.

References ILIAS\Test\Logging\TestError\$id.

Referenced by ILIAS\Test\Logging\TestError\getLogEntryAsDataTableRow().

                                          : ?string
     {
         return self::IDENTIFIER . '_' . $this->id;
     }

Here is the caller graph for this function:

◆ getUserForPresentation()

ILIAS\Test\Logging\TestError::getUserForPresentation ( ?int $user_id )

private

Definition at line 139 of file TestError.php.

Referenced by ILIAS\Test\Logging\TestError\getLogEntryAsDataTableRow(), and ILIAS\Test\Logging\TestError\getLogEntryAsExportRow().

                                                           : string
     {
         if ($user_id === null) {
             return '';
         }
         return \ilUserUtil::getNamePresentation(
             $user_id,
             false,
             false,
             '',
             true
         );
     }

Here is the caller graph for this function:

◆ toStorage()

ILIAS\Test\Logging\TestError::toStorage ( )

Implements ILIAS\Test\Logging\TestUserInteraction.

Definition at line 126 of file TestError.php.

References ilDBConstants\T_INTEGER, and ilDBConstants\T_TEXT.

Referenced by ILIAS\Test\Logging\TestLoggingDatabaseRepository\storeError().

                                : array
     {
         return [
             'ref_id' => [\ilDBConstants::T_INTEGER , $this->test_ref_id],
             'qst_id' => [\ilDBConstants::T_INTEGER , $this->question_id],
             'admin_id' => [\ilDBConstants::T_INTEGER , $this->admin_id],
             'pax_id' => [\ilDBConstants::T_INTEGER , $this->pax_id],
             'interaction_type' => [\ilDBConstants::T_TEXT , $this->interaction_type->value],
             'modification_ts' => [\ilDBConstants::T_INTEGER , $this->modification_timestamp],
             'error_message' => [\ilDBConstants::T_TEXT , $this->error_message]
         ];
     }

Here is the caller graph for this function:

◆ withId()

ILIAS\Test\Logging\TestError::withId ( int $id )

Implements ILIAS\Test\Logging\TestUserInteraction.

Definition at line 53 of file TestError.php.

References ILIAS\Test\Logging\TestError\$id.

                                    : self
     {
         $clone = clone $this;
         $clone->id = $id;
         return $clone;
     }

Field Documentation

◆ $id

int ILIAS\Test\Logging\TestError::$id

private

Definition at line 34 of file TestError.php.

Referenced by ILIAS\Test\Logging\TestError\getUniqueIdentifier(), and ILIAS\Test\Logging\TestError\withId().

◆ IDENTIFIER

const ILIAS\Test\Logging\TestError::IDENTIFIER = 'te'

Definition at line 32 of file TestError.php.

Referenced by ILIAS\Test\Logging\TestLoggingDatabaseRepository\buildUserInteractionForUniqueIdentifier(), ILIAS\Test\Logging\TestLoggingDatabaseRepository\fetchInteractionForResult(), and ILIAS\Test\Logging\TestLoggingDatabaseRepository\getTableNameForTypeIdentifier().

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

components/ILIAS/Test/src/Logging/TestError.php

Public Member Functions

Data Fields

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getLogEntryAsDataTableRow()

◆ getLogEntryAsExportRow()

◆ getParsedAdditionalInformation()

◆ getUniqueIdentifier()

◆ getUserForPresentation()

◆ toStorage()

◆ withId()

Field Documentation

◆ $id

◆ IDENTIFIER