ILIAS\Test\Logging\TestLogViewer Class Reference

Collaboration diagram for ILIAS\Test\Logging\TestLogViewer:

Public Member Functions
	__construct (private readonly TestLoggingRepository $logging_repository, private readonly TestLogger $logger, private readonly TitleColumnsBuilder $title_builder, private readonly GeneralQuestionPropertiesRepository $question_repository, private readonly ServerRequestInterface $request, private readonly RequestWrapper $request_wrapper, private readonly \ilUIService $ui_service, private readonly UIFactory $ui_factory, private readonly UIRenderer $ui_renderer, private readonly Refinery $refinery, private readonly \ilLanguage $lng, private \ilGlobalTemplateInterface $tpl, private readonly StreamDelivery $stream_delivery, private readonly \ilObjUser $current_user)
	getLogTable (URLBuilder $url_builder, URLBuilderToken $action_parameter_token, URLBuilderToken $row_id_token, ?int $ref_id=null)
	executeLogTableAction (URLBuilder $url_builder, URLBuilderToken $action_parameter_token, URLBuilderToken $row_id_token, ?int $ref_id=null)
	getLogExportForRefjId (int $ref_id)
	buildExcelWorkbookForLogs (\Generator $logs)
	buildUserDateTimeFormat ()
	getLegacyLogExportForObjId (?int $obj_id=null)
	buildQuestionTitleForLegacyLog (array $log)

Private Member Functions
	addRowsFromLogs (\Generator $logs, \ilExcel $workbook)
	getColumHeadingsForExport ()
	processCSVRow (mixed $row, bool $quote_all=false, string $separator=";")

Private Attributes
DataFactory	$data_factory

Detailed Description

Definition at line 36 of file TestLogViewer.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Test\Logging\TestLogViewer::__construct	(	private readonly TestLoggingRepository	$logging_repository,
		private readonly TestLogger	$logger,
		private readonly TitleColumnsBuilder	$title_builder,
		private readonly GeneralQuestionPropertiesRepository	$question_repository,
		private readonly ServerRequestInterface	$request,
		private readonly RequestWrapper	$request_wrapper,
		private readonly \ilUIService	$ui_service,
		private readonly UIFactory	$ui_factory,
		private readonly UIRenderer	$ui_renderer,
		private readonly Refinery	$refinery,
		private readonly \ilLanguage	$lng,
		private \ilGlobalTemplateInterface	$tpl,
		private readonly StreamDelivery	$stream_delivery,
		private readonly \ilObjUser	$current_user
	)

Definition at line 40 of file TestLogViewer.php.

      {
        $this->data_factory = new DataFactory();
    }

Member Function Documentation

addRowsFromLogs()

ILIAS\Test\Logging\TestLogViewer::addRowsFromLogs ( \Generator  $logs, \ilExcel  $workbook  )

private

Definition at line 167 of file TestLogViewer.php.

     : \ilExcel {
        $row = 1;
        foreach ($logs as $log) {
            $row++;
            $column = 0;
            foreach ($log->getLogEntryAsExportRow(
                $this->lng,
                $this->title_builder,
                $this->logger->getAdditionalInformationGenerator(),
                [
                    'timezone' => new \DateTimeZone($this->current_user->getTimeZone()),
                    'date_format' => $this->buildUserDateTimeFormat()->toString()
                ]
            ) as $cell_content) {
                $workbook->setCell(
                    $row,
                    $column++,
                    $cell_content
                );
            }
        }
        return $workbook;
    }

References $log, and ilExcel\setCell().

Here is the call graph for this function:

buildExcelWorkbookForLogs()

ILIAS\Test\Logging\TestLogViewer::buildExcelWorkbookForLogs

(

\Generator

$logs

)

Definition at line 152 of file TestLogViewer.php.

                                                               : \ilExcel
    {
        $workbook = new \ilExcel();
        $workbook->addSheet($this->lng->txt('history'));
 
        $column = 0;
        foreach ($this->getColumHeadingsForExport() as $header_cell) {
            $workbook->setCell(1, $column++, $header_cell);
        }
        $workbook->setBold('A' . 1 . ':' . $workbook->getColumnCoord($column - 1) . 1);
        $workbook->setColors('A' . 1 . ':' . $workbook->getColumnCoord($column - 1) . 1, 'C0C0C0');
 
        return $this->addRowsFromLogs($logs, $workbook);
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

buildQuestionTitleForLegacyLog()

ILIAS\Test\Logging\TestLogViewer::buildQuestionTitleForLegacyLog

(

array

$log

)

Definition at line 260 of file TestLogViewer.php.

                                                              : string
    {
        if (!$log['question_fi'] && !$log['original_fi']) {
            return '';
        }
        $title = '';
        if ($log['question_fi']) {
            $title = $this->question_repository->getForQuestionId((int) $log['question_fi'])?->getTitle();
        }
 
        if ($title === null && $log['original_fi']) {
            $title = $this->question_repository->getForQuestionId((int) $log['original_fi'])?->getTitle();
        }
 
        if ($title === null) {
            return '';
        }
 
        return $this->lng->txt('question') . ': ' . $title;
    }

References $log, and ILIAS\Repository\lng().

Here is the call graph for this function:

buildUserDateTimeFormat()

ILIAS\Test\Logging\TestLogViewer::buildUserDateTimeFormat

(

)

Definition at line 209 of file TestLogViewer.php.

                                             : DateFormat
    {
        $user_format = $this->current_user->getDateFormat();
        if ($this->current_user->getTimeFormat() == \ilCalendarSettings::TIME_FORMAT_24) {
            return $this->data_factory->dateFormat()->amend(
                $this->data_factory->dateFormat()->withTime24($user_format)
            )->colon()->seconds()->get();
        }
        return $this->data_factory->dateFormat()->amend(
            $user_format
        )->space()->hours12()->colon()->minutes()->colon()->seconds()->meridiem()->get();
    }

References ilCalendarSettings\TIME_FORMAT_24.

executeLogTableAction()

ILIAS\Test\Logging\TestLogViewer::executeLogTableAction	(	URLBuilder	$url_builder,
		URLBuilderToken	$action_parameter_token,
		URLBuilderToken	$row_id_token,
		?int	$ref_id = null
	)

Definition at line 90 of file TestLogViewer.php.

     : void {
        $log_table = new LogTable(
            $this->logging_repository,
            $this->logger,
            $this,
            $this->title_builder,
            $this->question_repository,
            $this->ui_service,
            $this->ui_factory,
            $this->ui_renderer,
            $this->lng,
            $this->tpl,
            $url_builder,
            $action_parameter_token,
            $row_id_token,
            $this->stream_delivery,
            $this->current_user,
            $ref_id,
        );
 
        $action = $this->request_wrapper->retrieve(
            $action_parameter_token->getName(),
            $this->refinery->kindlyTo()->string()
        );
 
        if ($action === '') {
            return;
        }
 
        $affected_items = [];
        if ($this->request_wrapper->has($row_id_token->getName())) {
            $affected_items = $this->request_wrapper->retrieve(
                $row_id_token->getName(),
                $this->refinery->byTrying(
                    [
                        $this->refinery->container()->mapValues(
                            $this->refinery->kindlyTo()->string()
                        ),
                        $this->refinery->always([])
                    ]
                )
            );
        }
 
        $log_table->executeAction($action, $affected_items);
    }

getColumHeadingsForExport()

ILIAS\Test\Logging\TestLogViewer::getColumHeadingsForExport ( )

private

Definition at line 194 of file TestLogViewer.php.

                                                : array
    {
        return [
            $this->lng->txt('date_time'),
            $this->lng->txt('test'),
            $this->lng->txt('author'),
            $this->lng->txt('tst_participant'),
            $this->lng->txt('client_ip'),
            $this->lng->txt('question'),
            $this->lng->txt('log_entry_type'),
            $this->lng->txt('interaction_type'),
            $this->lng->txt('additional_info')
        ];
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

getLegacyLogExportForObjId()

ILIAS\Test\Logging\TestLogViewer::getLegacyLogExportForObjId

(

?int

$obj_id = null

)

Definition at line 224 of file TestLogViewer.php.

                                                                   : string
    {
        $log_output = $this->logging_repository->getLegacyLogsForObjId($obj_id);
 
        $users = [];
        $csv = [];
        $separator = ';';
        $header_row = [
            $this->lng->txt('date_time'),
            $this->lng->txt('user'),
            $this->lng->txt('log_text'),
            $this->lng->txt('question')
        ];
 
        $csv[] = $this->processCSVRow($header_row);
        foreach ($log_output as $log) {
            if (!array_key_exists($log['user_fi'], $users)) {
                $users[$log['user_fi']] = \ilObjUser::_lookupName((int) $log['user_fi']);
            }
 
            $content_row = [];
            $date = new \ilDateTime((int) $log['tstamp'], IL_CAL_UNIX);
            $content_row[] = $date->get(IL_CAL_FKT_DATE, 'Y-m-d H:i');
            $content_row[] = trim($users[$log['user_fi']]['title'] . ' '
                . $users[$log['user_fi']]['firstname'] . ' ' . $users[$log['user_fi']]['lastname']);
            $content_row[] = trim($log['logtext']);
            $content_row[] = $this->buildQuestionTitleForLegacyLog($log);
            $csv[] = $this->processCSVRow($content_row);
        }
        $csvoutput = '';
        foreach ($csv as $row) {
            $csvoutput .= implode($separator, $row) . "\n";
        }
        return $csvoutput;
    }

References $log, ilObjUser\_lookupName(), IL_CAL_FKT_DATE, IL_CAL_UNIX, and ILIAS\Repository\lng().

Here is the call graph for this function:

getLogExportForRefjId()

ILIAS\Test\Logging\TestLogViewer::getLogExportForRefjId

(

int

$ref_id

)

Definition at line 142 of file TestLogViewer.php.

                                                      : \ilExcel
    {
        return $this->buildExcelWorkbookForLogs(
            $this->logging_repository->getLogs(
                $this->logger->getInteractionTypes(),
                [$ref_id]
            )
        );
    }

References $ref_id.

getLogTable()

ILIAS\Test\Logging\TestLogViewer::getLogTable	(	URLBuilder	$url_builder,
		URLBuilderToken	$action_parameter_token,
		URLBuilderToken	$row_id_token,
		?int	$ref_id = null
	)

Definition at line 59 of file TestLogViewer.php.

     : array {
        $log_table = new LogTable(
            $this->logging_repository,
            $this->logger,
            $this,
            $this->title_builder,
            $this->question_repository,
            $this->ui_service,
            $this->ui_factory,
            $this->ui_renderer,
            $this->lng,
            $this->tpl,
            $url_builder,
            $action_parameter_token,
            $row_id_token,
            $this->stream_delivery,
            $this->current_user,
            $ref_id,
        );
 
        return [
            $log_table->getFilter(),
            $log_table->getTable()->withRequest($this->request)
        ];
    }

processCSVRow()

ILIAS\Test\Logging\TestLogViewer::processCSVRow ( mixed  $row, bool  $quote_all = false, string  $separator = ";"  )

private

Definition at line 281 of file TestLogViewer.php.

     : array {
        $resultarray = [];
        foreach ($row as $rowindex => $entry) {
            $surround = false;
            if ($quote_all) {
                $surround = true;
            }
            if (is_string($entry) && strpos($entry, "\"") !== false) {
                $entry = str_replace("\"", "\"\"", $entry);
                $surround = true;
            }
            if (is_string($entry) && strpos($entry, $separator) !== false) {
                $surround = true;
            }
 
            if (is_string($entry)) {
                // replace all CR LF with LF (for Excel for Windows compatibility
                $entry = str_replace(chr(13) . chr(10), chr(10), $entry);
            }
 
            if ($surround) {
                $entry = "\"" . $entry . "\"";
            }
 
            $resultarray[$rowindex] = $entry;
        }
        return $resultarray;
    }

Field Documentation

$data_factory

DataFactory ILIAS\Test\Logging\TestLogViewer::$data_factory

private

Definition at line 38 of file TestLogViewer.php.

---

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

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