ILIAS\Test\Logging\TestParticipantInteraction Class Reference

Inheritance diagram for ILIAS\Test\Logging\TestParticipantInteraction:

Collaboration diagram for ILIAS\Test\Logging\TestParticipantInteraction:

Public Member Functions
	__construct (private readonly int $test_ref_id, private readonly ?int $question_id, private readonly int $pax_id, private readonly string $source_ip, private readonly TestParticipantInteractionTypes $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 ()
	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 = 'pi'
Data Fields inherited from ILIAS\Test\Logging\TestUserInteraction
const	LANG_VAR_PREFIX = 'logs_'

Private Attributes
int	$id

Detailed Description

Definition at line 29 of file TestParticipantInteraction.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Test\Logging\TestParticipantInteraction::__construct	(	private readonly int	$test_ref_id,
		private readonly ?int	$question_id,
		private readonly int	$pax_id,
		private readonly string	$source_ip,
		private readonly TestParticipantInteractionTypes	$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 38 of file TestParticipantInteraction.php.

      {
 
    }

Member Function Documentation

getLogEntryAsDataTableRow()

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

Implements ILIAS\Test\Logging\TestUserInteraction.

Definition at line 62 of file TestParticipantInteraction.php.

     : DataRow {
        $values = [
            'date_and_time' => \DateTimeImmutable::createFromFormat('U', (string) $this->modification_timestamp)
                ->setTimezone($environment['timezone']),
            'corresponding_test' => $title_builder->buildTestTitleAsLink(
                $this->test_ref_id
            ),
            'admin' => '',
            'participant' => \ilUserUtil::getNamePresentation(
                $this->pax_id,
                false,
                false,
                '',
                true
            ),
            'ip' => $this->source_ip,
            '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
        )->withDisabledAction(
            LogTable::ACTION_ID_SHOW_ADDITIONAL_INFO,
            $this->additional_data === []
        );
    }

References ILIAS\Test\Utilities\TitleColumnsBuilder\buildQuestionTitleAsLink().

Here is the call graph for this function:

getLogEntryAsExportRow()

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

Implements ILIAS\Test\Logging\TestUserInteraction.

Definition at line 103 of file TestParticipantInteraction.php.

     : 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->pax_id,
                false,
                false,
                '',
                true
            ),
            $this->source_ip,
            $title_builder->buildQuestionTitleAsText($this->question_id),
            $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)
        ];
    }

getParsedAdditionalInformation()

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

Implements ILIAS\Test\Logging\TestUserInteraction.

Definition at line 130 of file TestParticipantInteraction.php.

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

getUniqueIdentifier()

ILIAS\Test\Logging\TestParticipantInteraction::getUniqueIdentifier

(

)

Implements ILIAS\Test\Logging\TestUserInteraction.

Definition at line 50 of file TestParticipantInteraction.php.

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

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

toStorage()

ILIAS\Test\Logging\TestParticipantInteraction::toStorage

(

)

Implements ILIAS\Test\Logging\TestUserInteraction.

Definition at line 138 of file TestParticipantInteraction.php.

                               : array
    {
        return [
            'ref_id' => [\ilDBConstants::T_INTEGER , $this->test_ref_id],
            'qst_id' => [\ilDBConstants::T_INTEGER , $this->question_id],
            'pax_id' => [\ilDBConstants::T_INTEGER , $this->pax_id],
            'source_ip' => [\ilDBConstants::T_TEXT , $this->source_ip],
            '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)]
        ];
    }

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

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

Here is the caller graph for this function:

withId()

ILIAS\Test\Logging\TestParticipantInteraction::withId

(

int

$id

)

Implements ILIAS\Test\Logging\TestUserInteraction.

Definition at line 55 of file TestParticipantInteraction.php.

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

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

Field Documentation

$id

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

private

Definition at line 33 of file TestParticipantInteraction.php.

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

IDENTIFIER

const ILIAS\Test\Logging\TestParticipantInteraction::IDENTIFIER = 'pi'

Definition at line 31 of file TestParticipantInteraction.php.

---

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

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