ILIAS\Test\Logging\TestAdministrationInteraction Class Reference

Inheritance diagram for ILIAS\Test\Logging\TestAdministrationInteraction:

Collaboration diagram for ILIAS\Test\Logging\TestAdministrationInteraction:

Public Member Functions
	__construct (private readonly int $test_ref_id, private readonly int $admin_id, private readonly TestAdministrationInteractionTypes $interaction_type, private readonly int $modification_timestamp, private readonly array $additional_data)
	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 = 'tai'
Data Fields inherited from ILIAS\Test\Logging\TestUserInteraction
const	LANG_VAR_PREFIX = 'logs_'

Private Attributes
int	$id

Detailed Description

Definition at line 30 of file TestAdministrationInteraction.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Test\Logging\TestAdministrationInteraction::__construct	(	private readonly int	$test_ref_id,
		private readonly int	$admin_id,
		private readonly TestAdministrationInteractionTypes	$interaction_type,
		private readonly int	$modification_timestamp,
		private readonly array	$additional_data
	)

Parameters

array<string

label_lang_var => mixed value> $additional_data

Definition at line 39 of file TestAdministrationInteraction.php.

      {

    }

Member Function Documentation

getLogEntryAsDataTableRow()

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

Implements ILIAS\Test\Logging\TestUserInteraction.

Definition at line 61 of file TestAdministrationInteraction.php.

References ILIAS\Test\Logging\LogTable\ACTION_ID_SHOW_ADDITIONAL_INFO, ILIAS\UI\Component\Table\DataRowBuilder\buildDataRow(), ILIAS\Test\Utilities\TitleColumnsBuilder\buildTestTitleAsLink(), ilUserUtil\getNamePresentation(), ILIAS\Test\Logging\TestAdministrationInteraction\getUniqueIdentifier(), and ilLanguage\txt().

     : DataRow {
        return $row_builder->buildDataRow(
            $this->getUniqueIdentifier(),
            [
                'date_and_time' => \DateTimeImmutable::createFromFormat('U', (string) $this->modification_timestamp)
                    ->setTimezone($environment['timezone']),
                'corresponding_test' => $title_builder->buildTestTitleAsLink(
                    $this->test_ref_id
                ),
                'admin' => \ilUserUtil::getNamePresentation(
                    $this->admin_id,
                    false,
                    false,
                    '',
                    true
                ),
                'log_entry_type' => $lng->txt(self::LANG_VAR_PREFIX . self::IDENTIFIER),
                'interaction_type' => $lng->txt(self::LANG_VAR_PREFIX . $this->interaction_type->value)
            ]
        )->withDisabledAction(
            LogTable::ACTION_ID_SHOW_ADDITIONAL_INFO,
            $this->additional_data === []
        );
    }

Here is the call graph for this function:

getLogEntryAsExportRow()

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

Implements ILIAS\Test\Logging\TestUserInteraction.

Definition at line 91 of file TestAdministrationInteraction.php.

References ILIAS\Test\Utilities\TitleColumnsBuilder\buildTestTitleAsText(), ilUserUtil\getNamePresentation(), ILIAS\Test\Logging\AdditionalInformationGenerator\parseForExport(), and ilLanguage\txt().

     : array {
        return [
            \DateTimeImmutable::createFromFormat('U', (string) $this->modification_timestamp)
                ->setTimezone($environment['timezone'])
                ->format($environment['date_format']),
            $title_builder->buildTestTitleAsText($this->test_ref_id),
            \ilUserUtil::getNamePresentation(
                $this->admin_id,
                false,
                false,
                '',
                true
            ),
            '',
            '',
            '',
            $lng->txt(self::LANG_VAR_PREFIX . self::IDENTIFIER),
            $lng->txt(self::LANG_VAR_PREFIX . $this->interaction_type->value),
            $additional_info->parseForExport($this->additional_data, $environment)
        ];
    }

Here is the call graph for this function:

getParsedAdditionalInformation()

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

Implements ILIAS\Test\Logging\TestUserInteraction.

Definition at line 118 of file TestAdministrationInteraction.php.

References ILIAS\Test\Logging\AdditionalInformationGenerator\parseForTable().

     : DescriptiveListing {
        return $additional_info->parseForTable($this->additional_data, $environment);
    }

Here is the call graph for this function:

getUniqueIdentifier()

ILIAS\Test\Logging\TestAdministrationInteraction::getUniqueIdentifier

(

)

Implements ILIAS\Test\Logging\TestUserInteraction.

Definition at line 49 of file TestAdministrationInteraction.php.

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

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

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

Here is the caller graph for this function:

toStorage()

ILIAS\Test\Logging\TestAdministrationInteraction::toStorage

(

)

Implements ILIAS\Test\Logging\TestUserInteraction.

Definition at line 126 of file TestAdministrationInteraction.php.

References ilDBConstants\T_CLOB, ilDBConstants\T_INTEGER, and ilDBConstants\T_TEXT.

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

                               : array
    {
        return [
            'ref_id' => [\ilDBConstants::T_INTEGER , $this->test_ref_id],
            'admin_id' => [\ilDBConstants::T_INTEGER , $this->admin_id],
            'interaction_type' => [\ilDBConstants::T_TEXT , $this->interaction_type->value],
            'modification_ts' => [\ilDBConstants::T_INTEGER , $this->modification_timestamp],
            'additional_data' => [\ilDBConstants::T_CLOB , json_encode($this->additional_data)]
        ];
    }

Here is the caller graph for this function:

withId()

ILIAS\Test\Logging\TestAdministrationInteraction::withId

(

int

$id

)

Implements ILIAS\Test\Logging\TestUserInteraction.

Definition at line 54 of file TestAdministrationInteraction.php.

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

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

Field Documentation

$id

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

private

Definition at line 34 of file TestAdministrationInteraction.php.

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

IDENTIFIER

const ILIAS\Test\Logging\TestAdministrationInteraction::IDENTIFIER = 'tai'

Definition at line 32 of file TestAdministrationInteraction.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/TestAdministrationInteraction.php