ILIAS\LegalDocuments\Table\HistoryTable Class Reference

Inheritance diagram for ILIAS\LegalDocuments\Table\HistoryTable:

Collaboration diagram for ILIAS\LegalDocuments\Table\HistoryTable:

Public Member Functions
	__construct (private readonly HistoryRepository $repository, private readonly ProvideDocument $document, public readonly string $reset_command, private readonly string $auto_complete_link, private readonly UI $ui, private readonly DocumentModal $modal, private readonly Closure $create, ?Closure $format_date=null)
	columns ()
	config (TableConfig $config)
	rows (TableSelection $selection)
	name ()

Private Member Functions
	row (History $record)
	userName ()
	time ()
	showCriteria (History $record)

Private Attributes
readonly Closure	$format_date

Detailed Description

Definition at line 40 of file HistoryTable.php.

Constructor & Destructor Documentation

__construct()

ILIAS\LegalDocuments\Table\HistoryTable::__construct	(	private readonly HistoryRepository	$repository,
		private readonly ProvideDocument	$document,
		public readonly string	$reset_command,
		private readonly string	$auto_complete_link,
		private readonly UI	$ui,
		private readonly DocumentModal	$modal,
		private readonly Closure	$create,
		?Closure	$format_date = null
	)

Parameters

Closure(class-string,...	$constructor_args): object<class-string> $create
null|Closure(DateTimeImmutable)	string $format_date

Definition at line 49 of file HistoryTable.php.

References ilDatePresentation\formatDate(), and IL_CAL_UNIX.

      {
        $this->format_date = $format_date ?? fn(DateTimeImmutable $date) => ilDatePresentation::formatDate(new ilDateTime($date->getTimestamp(), IL_CAL_UNIX));
    }

Here is the call graph for this function:

Member Function Documentation

columns()

ILIAS\LegalDocuments\Table\HistoryTable::columns

(

)

Returns

array<string, list<string>>

Implements ILIAS\LegalDocuments\Table.

Definition at line 62 of file HistoryTable.php.

References ILIAS\Repository\ui().

                             : array
    {
        return [
            'created' => [$this->ui->txt('tbl_hist_head_acceptance_date'), 'created'],
            'login' => [$this->ui->txt('tbl_hist_head_login'), 'login'],
            'firstname' => [$this->ui->txt('tbl_hist_head_firstname'), 'firstname'],
            'lastname' => [$this->ui->txt('tbl_hist_head_lastname'), 'lastname'],
            'document' => [$this->ui->txt('tbl_hist_head_document'), 'document'],
            'criteria' => [$this->ui->txt('tbl_hist_head_criteria')],
        ];
    }

Here is the call graph for this function:

config()

ILIAS\LegalDocuments\Table\HistoryTable::config

(

TableConfig

$config

)

Implements ILIAS\LegalDocuments\Table.

Definition at line 74 of file HistoryTable.php.

References ILIAS\LegalDocuments\TableConfig\asFilter(), ILIAS\LegalDocuments\TableConfig\setDefaultOrderDirection(), ILIAS\LegalDocuments\TableConfig\setDefaultOrderField(), ILIAS\LegalDocuments\TableConfig\setSelectableColumns(), ILIAS\LegalDocuments\TableConfig\setTitle(), ILIAS\LegalDocuments\Table\HistoryTable\time(), ILIAS\Repository\ui(), and ILIAS\LegalDocuments\Table\HistoryTable\userName().

                                               : void
    {
        $config->setTitle($this->ui->txt('acceptance_history'));
        $config->setDefaultOrderField('created');
        $config->setDefaultOrderDirection('DESC');
        $config->setSelectableColumns('firstname', 'lastname', 'criteria');

        $filter = $config->asFilter($this->reset_command);
        $filter->addFilterItem($this->userName());
        $filter->addFilterItem($this->time(), true);
    }

Here is the call graph for this function:

name()

ILIAS\LegalDocuments\Table\HistoryTable::name

(

)

Implements ILIAS\LegalDocuments\Table.

Definition at line 103 of file HistoryTable.php.

                          : string
    {
        return self::class;
    }

row()

ILIAS\LegalDocuments\Table\HistoryTable::row ( History  $record )

private

Definition at line 108 of file HistoryTable.php.

References ILIAS\LegalDocuments\Table\HistoryTable\$format_date, ILIAS\LegalDocuments\Value\History\creation(), ILIAS\LegalDocuments\Value\History\documentContent(), ILIAS\Repository\modal(), ILIAS\LegalDocuments\Table\HistoryTable\showCriteria(), and ILIAS\Repository\ui().

Referenced by ILIAS\LegalDocuments\Table\HistoryTable\rows().

                                         : array
    {
        $user = ($this->create)(ilObjUser::class, $record->creation()->user());

        return [
            'created' => ($this->format_date)($record->creation()->time()),
            'login' => $user?->getLogin() ?? $this->ui->txt('deleted'),
            'firstname' => $user?->getFirstname() ?? '-',
            'lastname' => $user?->getLastname() ?? '-',
            'document' => $this->modal->create($record->documentContent()),
            'criteria' => $this->showCriteria($record),
        ];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

rows()

ILIAS\LegalDocuments\Table\HistoryTable::rows

(

TableSelection

$select

)

Returns

list<array<string, string|Closure(): string>>

Implements ILIAS\LegalDocuments\Table.

Definition at line 86 of file HistoryTable.php.

References ILIAS\LegalDocuments\TableSelection\filter(), ILIAS\LegalDocuments\TableSelection\getLimit(), ILIAS\LegalDocuments\TableSelection\getOffset(), ILIAS\LegalDocuments\TableSelection\getOrderDirection(), ILIAS\LegalDocuments\TableSelection\getOrderField(), ILIAS\UI\examples\Deck\repository(), ILIAS\LegalDocuments\Table\HistoryTable\row(), and ILIAS\LegalDocuments\TableSelection\setMaxCount().

                                                   : array
    {
        $filter = $selection->filter();
        $period = $filter['period'] ?? [];
        unset($filter['period']);
        $filter = array_filter([...$filter, ...$period]);

        $selection->setMaxCount($this->repository->countAll($filter));

        return array_map($this->row(...), $this->repository->all(
            $filter,
            [$selection->getOrderField() => $selection->getOrderDirection()],
            $selection->getOffset(),
            $selection->getLimit()
        ));
    }

Here is the call graph for this function:

showCriteria()

ILIAS\LegalDocuments\Table\HistoryTable::showCriteria ( History  $record )

private

Returns

string|list<Component>

Definition at line 148 of file HistoryTable.php.

References $c, $components, ILIAS\LegalDocuments\Value\History\criteriaContent(), and ILIAS\Repository\ui().

Referenced by ILIAS\LegalDocuments\Table\HistoryTable\row().

    {
        $conv = $this->document->toCondition(...);
        $components = array_map(fn($c) => $conv($c)->asComponent(), $record->criteriaContent());

        return $components === [] ?
                           $this->ui->txt('tbl_hist_cell_not_criterion') :
                           $components;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

time()

ILIAS\LegalDocuments\Table\HistoryTable::time ( )

private

Definition at line 131 of file HistoryTable.php.

References $duration, IL_CAL_UNIX, null, and ILIAS\Repository\ui().

Referenced by ILIAS\LegalDocuments\Table\HistoryTable\config().

                           : ilDateDurationInputGUI
    {
        class_exists(ilDateTime::class); // Trigger autoloader to ensure IL_CAL_UNIX is defined.
        $duration = ($this->create)(ResettingDurationInputGUI::class, $this->ui->txt('period'), 'period');
        $duration->setAllowOpenIntervals(true);
        $duration->setShowTime(true);
        $duration->setStartText($this->ui->txt('period_from'));
        $duration->setEndText($this->ui->txt('period_until'));
        $duration->setStart(($this->create)(ilDateTime::class, null, IL_CAL_UNIX));
        $duration->setEnd(($this->create)(ilDateTime::class, null, IL_CAL_UNIX));

        return $duration;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

userName()

ILIAS\LegalDocuments\Table\HistoryTable::userName ( )

private

Definition at line 122 of file HistoryTable.php.

References ILIAS\Repository\ui().

Referenced by ILIAS\LegalDocuments\Table\HistoryTable\config().

                               : ilTextInputGUI
    {
        $ul = ($this->create)(ilTextInputGUI::class, join('/', array_map($this->ui->txt(...), ['login', 'email', 'name'])), 'query');
        $ul->setDataSource($this->auto_complete_link);
        $ul->setSize(20);
        $ul->setSubmitFormOnEnter(true);
        return $ul;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$format_date

readonly Closure ILIAS\LegalDocuments\Table\HistoryTable::$format_date

private

Definition at line 43 of file HistoryTable.php.

Referenced by ILIAS\LegalDocuments\Table\HistoryTable\row().

---

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

• components/ILIAS/LegalDocuments/classes/Table/HistoryTable.php