ILIAS\LegalDocuments\Table\DocumentTable Class Reference

Inheritance diagram for ILIAS\LegalDocuments\Table\DocumentTable:

Collaboration diagram for ILIAS\LegalDocuments\Table\DocumentTable:

Public Member Functions
	__construct (private readonly Closure $criterion_as_component, private readonly DocumentRepository $repository, private readonly UI $ui, private readonly DocumentModal $modal, ?Closure $create=null, ?Closure $format_date=null)
	columns ()
	config (TableConfig $config)
	rows (TableSelection $select)
	mapSelection (Closure $proc, TableSelection $select)
	select (TableSelection $select)
	row (Document $document, int $sorting)
	showCriteria (Document $document, Closure $proc)
	showCriterion (Criterion $criterion)
	criterionName (Criterion $criterion)
	orderInputGui (Document $document, int $sorting)
	step ()
	ui ()
	name ()

Private Attributes
readonly Closure	$create
readonly Closure	$format_date

Detailed Description

Definition at line 38 of file DocumentTable.php.

Constructor & Destructor Documentation

__construct()

ILIAS\LegalDocuments\Table\DocumentTable::__construct	(	private readonly Closure	$criterion_as_component,
		private readonly DocumentRepository	$repository,
		private readonly UI	$ui,
		private readonly DocumentModal	$modal,
		?Closure	$create = null,
		?Closure	$format_date = null
	)

Parameters

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

Definition at line 50 of file DocumentTable.php.

References ilDatePresentation\formatDate(), and IL_CAL_UNIX.

      {
        $this->create = $create ?? fn($class, ...$args) => new $class(...$args);
        $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\DocumentTable::columns

(

)

Returns

array<string, list<string>>

Implements ILIAS\LegalDocuments\Table.

Definition at line 62 of file DocumentTable.php.

References ILIAS\LegalDocuments\Table\DocumentTable\ui().

                             : array
    {
        return [
            'order' => [$this->ui->txt('tbl_docs_head_sorting'), '', '5%'],
            'title' => [$this->ui->txt('tbl_docs_head_title'), '', '25%'],
            'created' => [$this->ui->txt('tbl_docs_head_created')],
            'change' => [$this->ui->txt('tbl_docs_head_last_change')],
            'criteria' => [$this->ui->txt('tbl_docs_head_criteria')],
        ];
    }

Here is the call graph for this function:

config()

ILIAS\LegalDocuments\Table\DocumentTable::config

(

TableConfig

$config

)

Implements ILIAS\LegalDocuments\Table.

Definition at line 73 of file DocumentTable.php.

References ILIAS\LegalDocuments\TableConfig\setSelectableColumns(), ILIAS\LegalDocuments\TableConfig\setTitle(), and ILIAS\LegalDocuments\Table\DocumentTable\ui().

                                               : void
    {
        $config->setTitle($this->ui->txt('tbl_docs_title'));
        $config->setSelectableColumns('created', 'change');
    }

Here is the call graph for this function:

criterionName()

ILIAS\LegalDocuments\Table\DocumentTable::criterionName

(

Criterion

$criterion

)

Definition at line 134 of file DocumentTable.php.

References ILIAS\LegalDocuments\Value\Criterion\content().

Referenced by ILIAS\LegalDocuments\Table\DocumentTable\showCriterion().

                                                       : Component
    {
        return ($this->criterion_as_component)($criterion->content());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

mapSelection()

ILIAS\LegalDocuments\Table\DocumentTable::mapSelection	(	Closure	$proc,
		TableSelection	$select
	)

Definition at line 84 of file DocumentTable.php.

References ILIAS\LegalDocuments\Table\DocumentTable\select(), and ILIAS\LegalDocuments\Table\DocumentTable\step().

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

                                                                       : array
    {
        $step = $this->step();
        return array_map(fn($x) => $proc($x, $step()), $this->select($select));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

name()

ILIAS\LegalDocuments\Table\DocumentTable::name

(

)

Implements ILIAS\LegalDocuments\Table.

Definition at line 164 of file DocumentTable.php.

                          : string
    {
        return self::class;
    }

orderInputGui()

ILIAS\LegalDocuments\Table\DocumentTable::orderInputGui	(	Document	$document,
		int	$sorting
	)

Definition at line 139 of file DocumentTable.php.

References ILIAS\LegalDocuments\Table\DocumentTable\$create, and ILIAS\LegalDocuments\Value\Document\id().

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

                                                                   : ilNumberInputGUI
    {
        $input = ($this->create)(ilNumberInputGUI::class, '', 'order[' . $document->id() . ']');
        $input->setValue((string) $sorting);
        $input->setMaxLength(4);
        $input->setSize(2);
        $input->setDisabled(true);

        return $input;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

row()

ILIAS\LegalDocuments\Table\DocumentTable::row	(	Document	$document,
		int	$sorting
	)

Definition at line 95 of file DocumentTable.php.

References ILIAS\LegalDocuments\Value\Document\content(), ILIAS\LegalDocuments\Value\Document\meta(), ILIAS\Repository\modal(), ILIAS\LegalDocuments\Table\DocumentTable\orderInputGui(), ILIAS\LegalDocuments\Table\DocumentTable\showCriteria(), and ILIAS\LegalDocuments\Table\DocumentTable\showCriterion().

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

                                                         : array
    {
        $render_order = $this->orderInputGui($document, $sorting);

        return [
            'order' => fn() => $render_order->render(),
            'title' => $this->modal->create($document->content()),
            'created' => ($this->format_date)($document->meta()->creation()->time()),
            'change' => ($this->format_date)($document->meta()->lastModification()->time()),
            'criteria' => $this->showCriteria($document, $this->showCriterion(...)),
        ];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

rows()

ILIAS\LegalDocuments\Table\DocumentTable::rows

(

TableSelection

$select

)

Returns

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

Implements ILIAS\LegalDocuments\Table.

Definition at line 79 of file DocumentTable.php.

References ILIAS\LegalDocuments\Table\DocumentTable\mapSelection(), and ILIAS\LegalDocuments\Table\DocumentTable\row().

                                                : array
    {
        return $this->mapSelection($this->row(...), $select);
    }

Here is the call graph for this function:

select()

ILIAS\LegalDocuments\Table\DocumentTable::select

(

TableSelection

$select

)

Definition at line 90 of file DocumentTable.php.

References ILIAS\UI\examples\Deck\repository().

Referenced by ILIAS\LegalDocuments\Table\DocumentTable\mapSelection().

                                                  : array
    {
        return $this->repository->all();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showCriteria()

ILIAS\LegalDocuments\Table\DocumentTable::showCriteria	(	Document	$document,
		Closure	$proc
	)

Parameters

Closure(Criterion)

list<Component> $proc

Returns

string|list<Component>

Definition at line 112 of file DocumentTable.php.

References ILIAS\LegalDocuments\Value\Document\criteria(), and ILIAS\LegalDocuments\Table\DocumentTable\ui().

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

    {
        if ([] === $document->criteria()) {
            return $this->ui->txt('tbl_docs_cell_not_criterion');
        }
        return array_merge(...array_map(
            $proc,
            $document->criteria()
        ));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showCriterion()

ILIAS\LegalDocuments\Table\DocumentTable::showCriterion

(

Criterion

$criterion

)

Returns

list<Component>

Definition at line 126 of file DocumentTable.php.

References ILIAS\LegalDocuments\Table\DocumentTable\criterionName(), and ILIAS\LegalDocuments\Table\DocumentTable\ui().

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

                                                       : array
    {
        return [
            $this->criterionName($criterion),
            $this->ui->create()->legacy('<br/>'),
        ];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

step()

ILIAS\LegalDocuments\Table\DocumentTable::step

(

)

Definition at line 150 of file DocumentTable.php.

Referenced by ILIAS\LegalDocuments\Table\DocumentTable\mapSelection().

                          : Closure
    {
        $step = 0;
        return static function () use (&$step): int {
            $step += 10;
            return $step;
        };
    }

Here is the caller graph for this function:

ui()

ILIAS\LegalDocuments\Table\DocumentTable::ui

(

)

Definition at line 159 of file DocumentTable.php.

Referenced by ILIAS\LegalDocuments\Table\DocumentTable\columns(), ILIAS\LegalDocuments\Table\DocumentTable\config(), ILIAS\LegalDocuments\Table\DocumentTable\showCriteria(), and ILIAS\LegalDocuments\Table\DocumentTable\showCriterion().

                        : UI
    {
        return $this->ui;
    }

Here is the caller graph for this function:

Field Documentation

$create

readonly Closure ILIAS\LegalDocuments\Table\DocumentTable::$create

private

Definition at line 41 of file DocumentTable.php.

Referenced by ILIAS\LegalDocuments\Table\DocumentTable\orderInputGui().

$format_date

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

private

Definition at line 43 of file DocumentTable.php.

---

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

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