ILIAS\UI\Implementation\Component\Table Namespace Reference

Namespaces
	Action
	Column

Data Structures
class	AbstractTable
class	Data
class	DataRow
class	DataRowBuilder
class	Factory
class	Ordering
class	OrderingRow
class	OrderingRowBuilder
class	Presentation
class	PresentationRow
class	Renderer
class	RowBuilder
class	Table

Functions
	initViewControlFieldSelection (array $columns)
	getViewControlFieldSelection ()
	filterVisibleColumnIds (array $columns)
	withSelectedOptionalColumns (?array $selected_optional_column_ids)
	getSelectedOptionalColumns ()
	getOptionalColumns ()
	getInitiallyVisibleColumns ()
	getVisibleColumns ()
	initViewControlOrdering ()
	initialOrder ()
	getViewControlOrdering (int|null $total_count)
	withOrder (?Order $order)
	getOrder ()
	initViewControlpagination ()
	getViewControlPagination (?int $total_count=null)
	withRange (?Range $range)
	getRange ()

Variables
trait	TableViewControlFieldSelection
trait	TableViewControlOrdering
trait	TableViewControlPagination
Range	$range = null

Function Documentation

filterVisibleColumnIds()

ILIAS\UI\Implementation\Component\Table\filterVisibleColumnIds ( array  $columns )

protected

Parameters

array<string,Column>

$columns

Returns

array<string>

Definition at line 60 of file TableViewControlFieldSelection.php.

References $c.

Referenced by ILIAS\UI\Implementation\Component\Table\initViewControlFieldSelection().

                                                             : array
    {
        return array_keys(
            array_filter(
                $columns,
                static fn($c): bool => $c->isInitiallyVisible()
            )
        );
    }

Here is the caller graph for this function:

getInitiallyVisibleColumns()

ILIAS\UI\Implementation\Component\Table\getInitiallyVisibleColumns ( )

protected

Returns

array<int, Column>

Definition at line 105 of file TableViewControlFieldSelection.php.

References $c, and ILIAS\UI\Implementation\Component\Table\getOptionalColumns().

Referenced by ILIAS\UI\Implementation\Component\Table\getSelectedOptionalColumns().

                                                   : array
    {
        return array_filter(
            $this->getOptionalColumns(),
            static fn($c): bool => $c->isInitiallyVisible()
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getOptionalColumns()

ILIAS\UI\Implementation\Component\Table\getOptionalColumns ( )

protected

Returns

array<int, Column>

Definition at line 94 of file TableViewControlFieldSelection.php.

References $c.

Referenced by ILIAS\UI\Implementation\Component\Table\getInitiallyVisibleColumns(), and ILIAS\UI\Implementation\Component\Table\getViewControlFieldSelection().

                                           : array
    {
        return array_filter(
            $this->getColumns(),
            static fn($c): bool => $c->isOptional()
        );
    }

Here is the caller graph for this function:

getOrder()

ILIAS\UI\Implementation\Component\Table\getOrder

(

)

Definition at line 90 of file TableViewControlOrdering.php.

References ILIAS\Data\Order\ASC, and ILIAS\UI\Implementation\Component\Table\initialOrder().

Referenced by assTextSubset\deleteAnswer(), assSingleChoice\deleteAnswer(), assMultipleChoice\deleteAnswer(), assTextQuestion\deleteAnswer(), ILIAS\UI\Implementation\Component\Table\getViewControlOrdering(), and ILIAS\UI\Implementation\Component\Table\initViewControlOrdering().

                              : Order
    {
        return $this->order ?? $this->data_factory->order($this->initialOrder(), Order::ASC);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getRange()

ILIAS\UI\Implementation\Component\Table\getRange

(

)

Definition at line 63 of file TableViewControlPagination.php.

Referenced by ILIAS\UI\Implementation\Component\Table\getViewControlPagination(), and ILIAS\UI\Implementation\Component\Table\initViewControlpagination().

                              : Range
    {
        return $this->range ?? $this->data_factory->range(0, $this->number_of_rows);
    }

Here is the caller graph for this function:

getSelectedOptionalColumns()

ILIAS\UI\Implementation\Component\Table\getSelectedOptionalColumns

(

)

Returns

string[]

Definition at line 83 of file TableViewControlFieldSelection.php.

References ILIAS\UI\Implementation\Component\Table\getInitiallyVisibleColumns().

Referenced by ILIAS\UI\Implementation\Component\Table\getViewControlFieldSelection(), and ILIAS\UI\Implementation\Component\Table\getVisibleColumns().

                                                : array
    {
        if (is_null($this->selected_optional_column_ids)) {
            return array_keys($this->getInitiallyVisibleColumns());
        }
        return $this->selected_optional_column_ids;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getViewControlFieldSelection()

ILIAS\UI\Implementation\Component\Table\getViewControlFieldSelection ( )

protected

Definition at line 41 of file TableViewControlFieldSelection.php.

References $c, ILIAS\UI\Implementation\Component\Table\getOptionalColumns(), ILIAS\UI\Implementation\Component\Table\getSelectedOptionalColumns(), and null.

Referenced by ILIAS\UI\Implementation\Component\Table\Ordering\getViewControls(), and ILIAS\UI\Implementation\Component\Table\Data\getViewControls().

                                                     : ?FieldSelection
    {
        $optional_cols = $this->getOptionalColumns();
        if ($optional_cols === []) {
            return null;
        }

        return $this->view_control_factory
            ->fieldSelection(array_map(
                static fn($c): string => $c->getTitle(),
                $optional_cols
            ))
            ->withValue($this->getSelectedOptionalColumns());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getViewControlOrdering()

ILIAS\UI\Implementation\Component\Table\getViewControlOrdering ( int|null  $total_count )

protected

Definition at line 50 of file TableViewControlOrdering.php.

References $c, ILIAS\Data\Order\ASC, ILIAS\Data\Order\DESC, ILIAS\UI\Implementation\Component\Table\getOrder(), ILIAS\UI\Implementation\Component\Table\getVisibleColumns(), and null.

Referenced by ILIAS\UI\Implementation\Component\Table\Data\getViewControls().

                                                                    : Sortation|ViewControl\Group
    {

        $sortable_visible_cols = array_filter(
            $this->getVisibleColumns(),
            static fn($c): bool => $c->isSortable()
        );

        if ($sortable_visible_cols === [] ||
            ($total_count !== null && $total_count < 2)
        ) {
            return $this->view_control_factory->group([
                $this->view_control_factory->nullControl(),
                $this->view_control_factory->nullControl()
            ]);
        }

        $sort_options = [];
        foreach ($sortable_visible_cols as $col_id => $col) {

            $order_asc = $this->data_factory->order($col_id, Order::ASC);
            $order_desc = $this->data_factory->order($col_id, Order::DESC);

            $labels = $col->getOrderingLabels();
            $sort_options[$labels[0]] = $order_asc;
            $sort_options[$labels[1]] = $order_desc;
        }

        $value = $this->getOrder()->join('', fn($ret, $key, $value) => [$key, $value]);
        return $this->view_control_factory->sortation($sort_options)
            ->withValue($value);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getViewControlPagination()

ILIAS\UI\Implementation\Component\Table\getViewControlPagination ( ?int  $total_count = null )

protected

Definition at line 37 of file TableViewControlPagination.php.

References ILIAS\Data\Range\getLength(), ILIAS\UI\Implementation\Component\Table\getRange(), and ILIAS\Data\Range\getStart().

Referenced by ILIAS\UI\Implementation\Component\Table\Data\getViewControls().

                                                                         : ViewControl\Pagination|ViewControl\Group
    {
        $smallest_option = current(Pagination::DEFAULT_LIMITS);
        if (is_null($total_count) || $total_count >= $smallest_option) {
            $range = $this->getRange();
            return
                $this->view_control_factory->pagination()
                    ->withTotalCount($total_count)
                    ->withValue([
                        Pagination::FNAME_OFFSET => $range->getStart(),
                        Pagination::FNAME_LIMIT => $range->getLength()
                    ]);
        }
        return $this->view_control_factory->group([
            $this->view_control_factory->nullControl(),
            $this->view_control_factory->nullControl()
        ]);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getVisibleColumns()

ILIAS\UI\Implementation\Component\Table\getVisibleColumns

(

)

Returns

array<string, Column>

Definition at line 116 of file TableViewControlFieldSelection.php.

References ILIAS\UI\Implementation\Component\Table\getSelectedOptionalColumns(), and ILIAS\UI\Component\Table\Column\Column\isOptional().

Referenced by ILIAS\UI\Implementation\Component\Table\Ordering\getRowBuilder(), ILIAS\UI\Implementation\Component\Table\Data\getRowBuilder(), ILIAS\UI\Implementation\Component\Table\getViewControlOrdering(), and ILIAS\UI\Implementation\Component\Table\initialOrder().

                                       : array
    {
        $visible_optional_columns = $this->getSelectedOptionalColumns();
        return array_filter(
            $this->getColumns(),
            fn(Column $col, string $col_id): bool => !$col->isOptional() || in_array($col_id, $visible_optional_columns, true),
            ARRAY_FILTER_USE_BOTH
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initialOrder()

ILIAS\UI\Implementation\Component\Table\initialOrder ( )

private

Definition at line 37 of file TableViewControlOrdering.php.

References $c, and ILIAS\UI\Implementation\Component\Table\getVisibleColumns().

Referenced by ILIAS\UI\Implementation\Component\Table\getOrder().

                                   : string
    {
        $visible_cols = $this->getVisibleColumns();
        $sortable_visible_cols = array_filter(
            $visible_cols,
            static fn($c): bool => $c->isSortable()
        );
        if ($sortable_visible_cols === []) {
            return array_key_first($visible_cols);
        }
        return array_key_first($sortable_visible_cols);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initViewControlFieldSelection()

ILIAS\UI\Implementation\Component\Table\initViewControlFieldSelection ( array  $columns )

protected

Parameters

array<string,Column>

$columns

Definition at line 36 of file TableViewControlFieldSelection.php.

References ILIAS\UI\Implementation\Component\Table\filterVisibleColumnIds().

Referenced by ILIAS\UI\Implementation\Component\Table\Ordering\__construct(), and ILIAS\UI\Implementation\Component\Table\Data\__construct().

                                                                    : void
    {
        $this->selected_optional_column_ids = $this->filterVisibleColumnIds($columns);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initViewControlOrdering()

ILIAS\UI\Implementation\Component\Table\initViewControlOrdering ( )

protected

Definition at line 32 of file TableViewControlOrdering.php.

References ILIAS\UI\Implementation\Component\Table\getOrder().

Referenced by ILIAS\UI\Implementation\Component\Table\Data\__construct().

                                                : void
    {
        $this->order = $this->getOrder();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initViewControlpagination()

ILIAS\UI\Implementation\Component\Table\initViewControlpagination ( )

protected

Definition at line 32 of file TableViewControlPagination.php.

References ILIAS\UI\Implementation\Component\Table\getRange().

Referenced by ILIAS\UI\Implementation\Component\Table\Data\__construct().

                                                  : void
    {
        $this->range = $this->getRange();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

withOrder()

ILIAS\UI\Implementation\Component\Table\withOrder

(

?Order

$order

)

Definition at line 83 of file TableViewControlOrdering.php.

Referenced by ilBiblLibraryTableGUI\buildTable(), ILIAS\Contact\MailingLists\MailingListsMembersTable\getComponent(), ILIAS\Forum\Moderation\ForumModeratorsTable\getComponent(), and ILIAS\Contact\MailingLists\MailingListsTable\getComponent().

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

Here is the caller graph for this function:

withRange()

ILIAS\UI\Implementation\Component\Table\withRange

(

?Range

$range

)

Definition at line 56 of file TableViewControlPagination.php.

References ILIAS\UI\Implementation\Component\Table\$range.

Referenced by ilBiblLibraryTableGUI\buildTable(), ILIAS\components\ResourceStorage\Collections\View\RequestToDataTable\buildTable(), and ILIAS\components\ResourceStorage\Container\View\RequestToDataTable\buildTable().

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

Here is the caller graph for this function:

withSelectedOptionalColumns()

ILIAS\UI\Implementation\Component\Table\withSelectedOptionalColumns

(

?array

$selected_optional_column_ids

)

Parameters

string[]

$selected_optional_column_ids

Definition at line 73 of file TableViewControlFieldSelection.php.

                                                                                     : static
    {
        $clone = clone $this;
        $clone->selected_optional_column_ids = $selected_optional_column_ids;
        return $clone;
    }

Variable Documentation

$range

Range ILIAS::UI::Implementation::Component::Table\$range = null

protected

Definition at line 30 of file TableViewControlPagination.php.

Referenced by ILIAS\Certificate\Overview\CertificateOverviewTable\__construct(), ILIAS\UI\Implementation\Component\Table\Data\applyViewControls(), ILIAS\UI\examples\Table\Column\LinkListing\base(), ILIAS\UI\examples\Table\Column\Boolean\base(), ILIAS\UI\examples\Table\Column\Date\base(), ILIAS\UI\examples\Table\Column\Link\base(), ILIAS\UI\examples\Table\Column\EMail\base(), ILIAS\UI\examples\Table\Column\Number\base(), ILIAS\UI\examples\Table\Column\Status\base(), ILIAS\UI\examples\Table\Column\StatusIcon\base(), ILIAS\UI\examples\Table\Column\Text\base(), ILIAS\UI\examples\Table\Column\TimeSpan\base(), ILIAS\UI\Examples\Listing\Entity\Standard\base(), ILIAS\UI\examples\Table\Data\base(), ILIAS\FileDelivery\FileDeliveryTypes\PHPChunked\deliver(), ilUserCertificateRepository\fetchCertificatesForOverview(), ilUserCertificateRepository\fetchCertificatesForOverviewCount(), ILIAS\UI\Implementation\Component\Input\ViewControl\Renderer\findCurrentPage(), ILIAS\UI\Implementation\Component\Chart\Bar\Renderer\getAccessibilityList(), ILIAS\Bibliographic\Field\Table\TreeTable\getActions(), ilOrgUnitPositionDBRepository\getAllPositions(), ilStudyProgrammeTypeDBRepository\getAllTypes(), DataViewControlsTest\getDataRetrieval(), DataTest\getDataRetrieval(), ILIAS\components\ILIAS\Glossary\Table\TermDefinitionBulkCreationTable\getDataRetrieval(), ILIAS\components\ILIAS\Glossary\Table\TermUsagesTable\getDataRetrieval(), ILIAS\Bibliographic\Field\Table\AssignedObjectsTable\getDataRetrieval(), ILIAS\components\ILIAS\Glossary\Table\GlossaryForeignTermTable\getDataRetrieval(), ILIAS\components\ILIAS\Glossary\Table\GlossaryAutoLinkTable\getDataRetrieval(), ILIAS\Bibliographic\Field\Table\ProfileUserAssignmentTable\getDataRetrieval(), ILIAS\Bibliographic\Field\Table\AssignMaterialsTable\getDataRetrieval(), ILIAS\Bibliographic\Field\Table\ProfileTable\getDataRetrieval(), ILIAS\Bibliographic\Field\Table\LevelResourcesTable\getDataRetrieval(), ILIAS\components\ILIAS\Glossary\Table\TermListTable\getDataRetrieval(), ilTestArchiver\getDataRetrievalForAttemptOverviewTable(), ILIAS\UI\Implementation\Component\Listing\Entity\EntityListing\getEntities(), ILIAS\UI\examples\Table\Action\Single\getExampleTable(), ILIAS\UI\examples\Table\Action\Multi\getExampleTable(), ILIAS\UI\examples\Table\Action\Standard\getExampleTable(), ilLanguageStatisticsTable\getItems(), ilLanguageFolderTable\getItems(), ILIAS\Test\Logging\TestLoggingDatabaseRepository\getLogs(), ILIAS\Test\Participants\ParticipantRepository\getParticipants(), ilBiblLibraryTableGUI\getRecords(), ILIAS\Test\Logging\LogTable\getRows(), ilOrgUnitTypeGUI\getTableDataRetrieval(), ILIAS\Test\Participants\ParticipantTable\getTotalRowCount(), ilOrgUnitUserAssignmentDBRepository\getUserDataByOrgUnitsAndPosition(), ILIAS\MetaData\Settings\Vocabularies\DataRetrieval\getVocabs(), ilPresentationTableGUI\initViewControl(), ILIAS\Test\Questions\Presentation\QuestionsBrowserTable\loadRecords(), ILIAS\UI\Implementation\Component\ViewControl\Renderer\renderPagination(), ILIAS\UI\Implementation\Component\Input\ViewControl\Renderer\renderPagination(), RangeTest\testConstructionWrongLength(), RangeTest\testConstructionWrongStart(), RangeTest\testCroppedTo(), DataRendererTest\testDataTableRenderHeaderWithActions(), DataRendererTest\testDataTableRenderHeaderWithoutSortableColums(), DataRendererTest\testDataTableRenderTableHeader(), DataTest\testDataTableWithRange(), EntityListingTest\testEntityListingYieldingEntities(), RangeTest\testFactory(), PaginationTest\testGetRangeOnNull(), DataRendererTest\testRenderEmptyDataCell(), RangeTest\testWithLength(), RangeTest\testWithStart(), ILIAS\Export\ExportHandler\Table\DataRetrieval\Handler\withExportObject(), ILIAS\UI\examples\Table\Data\without_data(), and ILIAS\UI\Implementation\Component\Table\withRange().

TableViewControlFieldSelection

trait ILIAS::UI::Implementation::Component::Table\TableViewControlFieldSelection

Initial value:

{
    
    protected ?array $selected_optional_column_ids = null

Definition at line 27 of file TableViewControlFieldSelection.php.

TableViewControlOrdering

trait ILIAS::UI::Implementation::Component::Table\TableViewControlOrdering

Initial value:

{
    protected ?Order $order = null

Definition at line 29 of file TableViewControlOrdering.php.

TableViewControlPagination

trait ILIAS::UI::Implementation::Component::Table\TableViewControlPagination

Initial value:

{
    protected int $number_of_rows = 800

Definition at line 28 of file TableViewControlPagination.php.