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, private readonly object $gui, private readonly ?EditLinks $edit_links=null, ServerRequestInterface\|RequestInterface\|null $request=null, ?Factory $data_factory=null, ?ilCtrlInterface $ctrl=null, ?Renderer $ui_renderer=null, ?ilObjUser $user=null)

	getRows (OrderingRowBuilder $row_builder, array $visible_column_ids)
	This is called by the (ordering-)table to retrieve rows; map data-records to rows using the $row_builder e.g. More...

	criterionName (Criterion $criterion)

	getTotalRowCount (mixed $additional_viewcontrol_data, mixed $filter_data, mixed $additional_parameters)

	render ()

	getRows (OrderingRowBuilder $row_builder, array $visible_column_ids)
	This is called by the (ordering-)table to retrieve rows; map data-records to rows using the $row_builder e.g. More...

Data Fields
const	CMD_EDIT_DOCUMENT = 'editDocument'

const	CMD_DELETE_DOCUMENT = 'deleteDocument'

const	CMD_DELETE_DOCUMENTS = 'deleteDocuments'

const	CMD_ADD_CRITERION = 'addCriterion'

Private Member Functions
	buildTable ()

	buildTableRow (OrderingRowBuilder $row_builder, Document $document)

	buildTableActions ()

Private Attributes
readonly ServerRequestInterface RequestInterface	$request

readonly Factory	$data_factory

readonly ilCtrlInterface	$ctrl

readonly Ordering	$table

readonly Renderer	$ui_renderer

readonly ilObjUser	$user

readonly DateTimeZone	$usr_timezone

array	$modals = []

Detailed Description

Definition at line 48 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,
		private readonly object	$gui,
		private readonly ?EditLinks	$edit_links = `null`,
		ServerRequestInterface\|RequestInterface\|null	$request = `null`,
		?Factory	$data_factory = `null`,
		?ilCtrlInterface	$ctrl = `null`,
		?Renderer	$ui_renderer = `null`,
		?ilObjUser	$user = `null`
	)

Definition at line 66 of file DocumentTable.php.

      {
        global $DIC;
        $this->request = $request ?: $DIC->http()->request();
        $this->data_factory = $data_factory ?: new Factory();
        $this->ctrl = $ctrl ?: $DIC->ctrl();
        $this->ui_renderer = $ui_renderer ?: $DIC->ui()->renderer();
        $this->user = $user ?: $DIC->user();
        $this->usr_timezone = new \DateTimeZone($this->user->getTimeZone());
 
        $this->table = $this->buildTable();
    }

References ILIAS\LegalDocuments\Table\DocumentTable\$data_factory, $DIC, ILIAS\LegalDocuments\Table\DocumentTable\$request, ILIAS\LegalDocuments\Table\DocumentTable\$ui_renderer, ILIAS\LegalDocuments\Table\DocumentTable\buildTable(), ILIAS\Repository\ctrl(), and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

◆ buildTable()

ILIAS\LegalDocuments\Table\DocumentTable::buildTable ( )

private

Definition at line 90 of file DocumentTable.php.

                                 : Ordering
    {
        $uiTable = $this->ui->create()->table();
 
        if ((int) $this->user->getTimeFormat() === ilCalendarSettings::TIME_FORMAT_12) {
            $date_format = $this->data_factory->dateFormat()->withTime12($this->user->getDateFormat());
        } else {
            $date_format = $this->data_factory->dateFormat()->withTime24($this->user->getDateFormat());
        }
 
        $table = $uiTable->ordering(
            $this,
            (new URI((string) $this->request->getUri()))->withParameter('cmd', 'saveOrder'),
            $this->ui->txt('tbl_docs_title'),
            [
                'title' => $uiTable->column()->text($this->ui->txt('tbl_docs_head_title')),
                'created' => $uiTable->column()->date($this->ui->txt('tbl_docs_head_created'), $date_format),
                'change' => $uiTable->column()->date($this->ui->txt('tbl_docs_head_last_change'), $date_format),
                'criteria' => $uiTable->column()->text($this->ui->txt('tbl_docs_head_criteria')),
            ],
        )
            ->withId('legalDocsTable')
            ->withRequest($this->request);
 
        if ($this->edit_links) {
            $table = $table->withActions($this->buildTableActions());
        }
 
        return $table;
    }

References ILIAS\LegalDocuments\Table\DocumentTable\$table, ILIAS\LegalDocuments\Table\DocumentTable\buildTableActions(), ilCalendarSettings\TIME_FORMAT_12, ILIAS\Repository\ui(), ILIAS\Repository\user(), and ILIAS\UI\Component\Table\Ordering\withActions().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildTableActions()

ILIAS\LegalDocuments\Table\DocumentTable::buildTableActions ( )

private

Returns: array{deleteDocuments: Multi, editDocument: Single, addCriterion: Single, deleteDocument: Single}

Definition at line 197 of file DocumentTable.php.

                                        : array
    {
        return [
            self::CMD_DELETE_DOCUMENTS => $this->buildTableAction(self::CMD_DELETE_DOCUMENTS, $this->ui->txt('delete'), true),
            self::CMD_EDIT_DOCUMENT => $this->buildTableAction(self::CMD_EDIT_DOCUMENT, $this->ui->txt('edit')),
            self::CMD_ADD_CRITERION => $this->buildTableAction(
                self::CMD_ADD_CRITERION,
                $this->ui->txt('tbl_docs_action_add_criterion')
            ),
            self::CMD_DELETE_DOCUMENT => $this->buildTableAction(self::CMD_DELETE_DOCUMENT, $this->ui->txt('delete')),
        ];
    }

References ILIAS\Repository\ui().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildTableRow()

ILIAS\LegalDocuments\Table\DocumentTable::buildTableRow	(	OrderingRowBuilder	$row_builder,
		Document	$document
	)

private

Definition at line 130 of file DocumentTable.php.

                                                                                       : OrderingRow
    {
        $criterion_components = [];
        foreach ($document->criteria() as $criterion) {
            $criterion_components[] = $this->ui->create()->legacy()->content('<div style="display: flex; gap: 1rem;">');
            $criterion_components[] = $this->criterionName($criterion);
 
            if ($this->edit_links) {
                $delete_modal = $this->ui->create()->modal()->interruptive(
                    $this->ui->txt('doc_detach_crit_confirm_title'),
                    $this->ui->txt('doc_sure_detach_crit'),
                    $this->edit_links->deleteCriterion($document, $criterion)
                );
 
                $dropdown = $this->ui->create()->dropdown()->standard([
                    $this->ui->create()->button()->shy(
                        $this->ui->txt('edit'),
                        $this->edit_links->editCriterion($document, $criterion)
                    ),
                    $this->ui->create()->button()->shy(
                        $this->ui->txt('delete'),
                        ''
                    )->withOnClick($delete_modal->getShowSignal())
                ]);
 
                $this->modals[] = $delete_modal;
                $criterion_components[] = $dropdown;
            }
 
            $criterion_components[] = $this->ui->create()->legacy()->content('</div>');
        }
 
        $table_row = [
            'id' => $document->id(),
            'title' => $this->ui_renderer->render($this->modal->create($document->content())),
            'created' => $document->meta()->creation()->time()->setTimezone($this->usr_timezone),
            'change' => $document->meta()->lastModification()->time()->setTimezone($this->usr_timezone),
            'criteria' => $this->ui_renderer->render($criterion_components),
        ];
        return $row_builder->buildOrderingRow((string) $document->id(), $table_row);
    }

References ILIAS\UI\Component\Table\OrderingRowBuilder\buildOrderingRow(), ILIAS\LegalDocuments\Value\Document\content(), ILIAS\LegalDocuments\Value\Document\criteria(), ILIAS\LegalDocuments\Value\Document\id(), ILIAS\LegalDocuments\Value\Document\meta(), ILIAS\Repository\modal(), and ILIAS\Repository\ui().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ criterionName()

ILIAS\LegalDocuments\Table\DocumentTable::criterionName ( Criterion $criterion )

Definition at line 172 of file DocumentTable.php.

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

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

Here is the call graph for this function:

◆ getRows()

ILIAS\LegalDocuments\Table\DocumentTable::getRows	(	OrderingRowBuilder	$row_builder,
		array	$visible_column_ids
	)

This is called by the (ordering-)table to retrieve rows; map data-records to rows using the $row_builder e.g.

yield $row_builder->buildOrderingRow($row_id, $record).

Implements ILIAS\UI\Component\Table\OrderingRetrieval.

Definition at line 121 of file DocumentTable.php.

     : Generator {
        foreach ($this->repository->all() as $document) {
            yield $this->buildTableRow($row_builder, $document);
        }
    }

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

Here is the call graph for this function:

◆ getTotalRowCount()

ILIAS\LegalDocuments\Table\DocumentTable::getTotalRowCount	(	mixed	$additional_viewcontrol_data,
		mixed	$filter_data,
		mixed	$additional_parameters
	)

Definition at line 177 of file DocumentTable.php.

     : ?int {
        return $this->repository->countAll();
    }

◆ render()

ILIAS\LegalDocuments\Table\DocumentTable::render ( )

Definition at line 185 of file DocumentTable.php.

                            : string
    {
        // This MUST be rendered BEFORE $this->modal->components(),
        // because the components are filled within the rendering process.
        $html = $this->ui_renderer->render($this->table);
 
        return $html . $this->ui_renderer->render([...$this->modal->popComponents(), ...$this->modals]);
    }

References ILIAS\Repository\modal().

Here is the call graph for this function:

Field Documentation

◆ $ctrl

readonly ilCtrlInterface ILIAS\LegalDocuments\Table\DocumentTable::$ctrl

private

Definition at line 57 of file DocumentTable.php.

◆ $data_factory

readonly Factory ILIAS\LegalDocuments\Table\DocumentTable::$data_factory

private

Definition at line 56 of file DocumentTable.php.

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

◆ $modals

array ILIAS\LegalDocuments\Table\DocumentTable::$modals = []

private

Definition at line 64 of file DocumentTable.php.

◆ $request

readonly ServerRequestInterface RequestInterface ILIAS\LegalDocuments\Table\DocumentTable::$request

private

Definition at line 55 of file DocumentTable.php.

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

◆ $table

readonly Ordering ILIAS\LegalDocuments\Table\DocumentTable::$table

private

Definition at line 58 of file DocumentTable.php.

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

◆ $ui_renderer

readonly Renderer ILIAS\LegalDocuments\Table\DocumentTable::$ui_renderer

private

Definition at line 59 of file DocumentTable.php.

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

◆ $user

readonly ilObjUser ILIAS\LegalDocuments\Table\DocumentTable::$user

private

Definition at line 60 of file DocumentTable.php.

◆ $usr_timezone

readonly DateTimeZone ILIAS\LegalDocuments\Table\DocumentTable::$usr_timezone

private

Definition at line 61 of file DocumentTable.php.

◆ CMD_ADD_CRITERION

const ILIAS\LegalDocuments\Table\DocumentTable::CMD_ADD_CRITERION = 'addCriterion'

Definition at line 53 of file DocumentTable.php.

◆ CMD_DELETE_DOCUMENT

const ILIAS\LegalDocuments\Table\DocumentTable::CMD_DELETE_DOCUMENT = 'deleteDocument'

Definition at line 51 of file DocumentTable.php.

◆ CMD_DELETE_DOCUMENTS

const ILIAS\LegalDocuments\Table\DocumentTable::CMD_DELETE_DOCUMENTS = 'deleteDocuments'

Definition at line 52 of file DocumentTable.php.

◆ CMD_EDIT_DOCUMENT

const ILIAS\LegalDocuments\Table\DocumentTable::CMD_EDIT_DOCUMENT = 'editDocument'

Definition at line 50 of file DocumentTable.php.

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

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

Public Member Functions

Data Fields

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ buildTable()

◆ buildTableActions()

◆ buildTableRow()

◆ criterionName()

◆ getRows()

◆ getTotalRowCount()

◆ render()

Field Documentation

◆ $ctrl

◆ $data_factory

◆ $modals

◆ $request

◆ $table

◆ $ui_renderer

◆ $user

◆ $usr_timezone

◆ CMD_ADD_CRITERION

◆ CMD_DELETE_DOCUMENT

◆ CMD_DELETE_DOCUMENTS

◆ CMD_EDIT_DOCUMENT