Inheritance diagram for ILIAS\LDAP\Server\UI\ServerTable:

Collaboration diagram for ILIAS\LDAP\Server\UI\ServerTable:

Public Member Functions
	__construct (private array $servers, private \ilLDAPSettingsGUI $parent_gui, private \ILIAS\UI\Factory $ui_factory, private \ILIAS\UI\Renderer $ui_renderer, private \ilLanguage $lng, private \ilCtrlInterface $ctrl, private \Psr\Http\Message\ServerRequestInterface $http_request, private \ILIAS\Data\URI $action_url, private bool $has_write_access)

	getRows (\ILIAS\UI\Component\Table\DataRowBuilder $row_builder, array $visible_column_ids, \ILIAS\Data\Range $range, \ILIAS\Data\Order $order, mixed $additional_viewcontrol_data, mixed $filter_data, mixed $additional_parameters)

	getTotalRowCount (mixed $additional_viewcontrol_data, mixed $filter_data, mixed $additional_parameters)
	Mainly for the purpose of pagination-support, it is important to know about the total number of records available. More...

	getComponent ()

Public Member Functions inherited from ILIAS\UI\Component\Table\DataRetrieval
	getRows (DataRowBuilder $row_builder, array $visible_column_ids, Range $range, Order $order, mixed $additional_viewcontrol_data, mixed $filter_data, mixed $additional_parameters)
	This is called by the table to retrieve rows; map data-records to rows using the $row_builder e.g. More...

	getTotalRowCount (mixed $additional_viewcontrol_data, mixed $filter_data, mixed $additional_parameters)
	Mainly for the purpose of pagination-support, it is important to know about the total number of records available. More...

Private Member Functions
	getRecords (\ILIAS\Data\Range $range, \ILIAS\Data\Order $order)

	getColumnDefinition ()

	getActions ()

Private Attributes
ILIAS UI URLBuilder	$url_builder

ILIAS UI URLBuilderToken	$action_parameter_token

ILIAS UI URLBuilderToken	$row_id_token

Detailed Description

Definition at line 23 of file ServerTable.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\LDAP\Server\UI\ServerTable::__construct	(	private array	$servers,
		private \ilLDAPSettingsGUI	$parent_gui,
		private \ILIAS\UI\Factory	$ui_factory,
		private \ILIAS\UI\Renderer	$ui_renderer,
		private \ilLanguage	$lng,
		private \ilCtrlInterface	$ctrl,
		private \Psr\Http\Message\ServerRequestInterface	$http_request,
		private \ILIAS\Data\URI	$action_url,
		private bool	$has_write_access
	)

Parameters

list<array<string,string|int|float|null>> $servers

Definition at line 32 of file ServerTable.php.

      {
        [
            $this->url_builder,
            $this->action_parameter_token,
            $this->row_id_token
        ] = (new \ILIAS\UI\URLBuilder($action_url))->acquireParameters(
            ['ldap', 'servers'],
            'table_action',
            'server_id'
        );
    }

References ILIAS\LDAP\Server\UI\ServerTable\$action_parameter_token, ILIAS\LDAP\Server\UI\ServerTable\$row_id_token, and ILIAS\LDAP\Server\UI\ServerTable\$url_builder.

Member Function Documentation

◆ getActions()

ILIAS\LDAP\Server\UI\ServerTable::getActions ( )

private

Returns: array<string, \ILIAS\UI\Component\Table\Action\Action>

Definition at line 180 of file ServerTable.php.

                                 : array
    {
        if (!$this->has_write_access) {
            return [];
        }
 
        return [
            'editServerSettings' => $this->ui_factory->table()->action()->single(
                $this->lng->txt('edit'),
                $this->url_builder->withParameter($this->action_parameter_token, 'editServerSettings'),
                $this->row_id_token
            ),
            'activateServer' => $this->ui_factory->table()->action()->single(
                $this->lng->txt('activate'),
                $this->url_builder->withParameter($this->action_parameter_token, 'activateServer'),
                $this->row_id_token
            ),
            'deactivateServer' => $this->ui_factory->table()->action()->single(
                $this->lng->txt('deactivate'),
                $this->url_builder->withParameter($this->action_parameter_token, 'deactivateServer'),
                $this->row_id_token
            ),
            'confirmDeleteServerSettings' => $this->ui_factory->table()->action()->single(
                $this->lng->txt('delete'),
                $this->url_builder->withParameter($this->action_parameter_token, 'confirmDeleteServerSettings'),
                $this->row_id_token
            )
        ];
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

◆ getColumnDefinition()

ILIAS\LDAP\Server\UI\ServerTable::getColumnDefinition ( )

private

Returns: array<string, \ILIAS\UI\Component\Table\Column\Column>

Definition at line 140 of file ServerTable.php.

                                          : array
    {
        return [
            'active' => $this->ui_factory
                ->table()
                ->column()
                ->boolean(
                    $this->lng->txt('status'),
                    $this->ui_factory->symbol()->icon()->custom(
                        'assets/images/standard/icon_ok.svg',
                        $this->lng->txt('active'),
                        'small'
                    ),
                    $this->ui_factory->symbol()->icon()->custom(
                        'assets/images/standard/icon_not_ok.svg',
                        $this->lng->txt('inactive'),
                        'small'
                    )
                )
                ->withIsSortable(true)
                ->withOrderingLabels(
                    "{$this->lng->txt('status')}, {$this->lng->txt('active')} {$this->lng->txt('order_option_first')}",
                    "{$this->lng->txt('status')}, {$this->lng->txt('inactive')} {$this->lng->txt('order_option_first')}"
                ),
            'name' => $this->ui_factory
                ->table()
                ->column()
                ->text($this->lng->txt('title'))
                ->withIsSortable(true),
            'user' => $this->ui_factory
                ->table()
                ->column()
                ->number($this->lng->txt('user'))
                ->withIsSortable(true)
        ];
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

◆ getComponent()

ILIAS\LDAP\Server\UI\ServerTable::getComponent ( )

Definition at line 210 of file ServerTable.php.

                                  : \ILIAS\UI\Component\Table\Table
    {
        return $this->ui_factory
            ->table()
            ->data(
                $this,
                $this->lng->txt('ldap_servers'),
                $this->getColumnDefinition(),
            )
            ->withId(self::class)
            ->withOrder(new \ILIAS\Data\Order('title', \ILIAS\Data\Order::ASC))
            ->withActions($this->getActions())
            ->withRequest($this->http_request);
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

◆ getRecords()

ILIAS\LDAP\Server\UI\ServerTable::getRecords	(	\ILIAS\Data\Range	$range,
		\ILIAS\Data\Order	$order
	)

private

Returns: list<array<string, string|int|float|null>>

Definition at line 57 of file ServerTable.php.

                                                                                   : array
    {
        $servers = $this->servers;
 
        [$order_field, $order_direction] = $order->join([], static function ($ret, $key, $value) {
            return [$key, $value];
        });
 
        array_walk(
            $servers,
            static function (array &$server): void {
                $server['user'] = \count(\ilObjUser::_getExternalAccountsByAuthMode('ldap_' . $server['server_id']));
            }
        );
 
        $records = \ilArrayUtil::sortArray(
            $servers,
            $order_field,
            strtolower($order_direction),
            \in_array($order_field, ['user', 'active'], true)
        );
 
        if ($order_field === 'active') {
            $records = array_reverse($records);
        }
 
        $records = \array_slice($records, $range->getStart(), $range->getLength());
 
        return $records;
    }

References ILIAS\UI\Implementation\Component\Table\$range, $server, ilObjUser\_getExternalAccountsByAuthMode(), ILIAS\Data\Range\getLength(), ILIAS\Data\Range\getStart(), and ilArrayUtil\sortArray().

Here is the call graph for this function:

◆ getRows()

ILIAS\LDAP\Server\UI\ServerTable::getRows	(	\ILIAS\UI\Component\Table\DataRowBuilder	$row_builder,
		array	$visible_column_ids,
		\ILIAS\Data\Range	$range,
		\ILIAS\Data\Order	$order,
		mixed	$additional_viewcontrol_data,
		mixed	$filter_data,
		mixed	$additional_parameters
	)

Definition at line 88 of file ServerTable.php.

     : \Generator {
        foreach ($this->getRecords($range, $order) as $server) {
            $title = $server['name'];
            if ($this->has_write_access) {
                $this->ctrl->setParameter($this->parent_gui, 'ldap_server_id', $server['server_id']);
                $title = $this->ui_renderer->render(
                    $this->ui_factory->link()->standard(
                        $title,
                        $this->ctrl->getLinkTarget($this->parent_gui, 'editServerSettings')
                    )
                );
            }
 
            yield $row_builder
                ->buildDataRow(
                    (string) $server['server_id'],
                    [
                        'name' => $title,
                        'active' => (bool) $server['active'],
                        'user' => $server['user']
                    ]
                )
                ->withDisabledAction(
                    'activateServer',
                    (bool) $server['active'],
                )
                ->withDisabledAction(
                    'deactivateServer',
                    !$server['active'],
                );
        }
    }

References $server, and ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ getTotalRowCount()

ILIAS\LDAP\Server\UI\ServerTable::getTotalRowCount	(	mixed	$additional_viewcontrol_data,
		mixed	$filter_data,
		mixed	$additional_parameters
	)

Mainly for the purpose of pagination-support, it is important to know about the total number of records available.

Given the nature of a DataTable, which is, opposite to a PresentationTable, rather administrative than explorative, this information will increase user experience quite a bit. However, you may return null, if the call is to costly, but expect the View Control to look a little different in this case.

Make sure that potential filters or user restrictions are being applied to the count.

Implements ILIAS\UI\Component\Table\DataRetrieval.

Definition at line 129 of file ServerTable.php.

     : ?int {
        return \count($this->servers);
    }

Field Documentation

◆ $action_parameter_token

ILIAS UI URLBuilderToken ILIAS\LDAP\Server\UI\ServerTable::$action_parameter_token

private

Definition at line 26 of file ServerTable.php.

Referenced by ILIAS\LDAP\Server\UI\ServerTable\__construct().

◆ $row_id_token

ILIAS UI URLBuilderToken ILIAS\LDAP\Server\UI\ServerTable::$row_id_token

private

Definition at line 27 of file ServerTable.php.

Referenced by ILIAS\LDAP\Server\UI\ServerTable\__construct().

◆ $url_builder

ILIAS UI URLBuilder ILIAS\LDAP\Server\UI\ServerTable::$url_builder

private

Definition at line 25 of file ServerTable.php.

Referenced by ILIAS\LDAP\Server\UI\ServerTable\__construct().

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

components/ILIAS/LDAP/src/Server/UI/ServerTable.php

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getActions()

◆ getColumnDefinition()

◆ getComponent()

◆ getRecords()

◆ getRows()

◆ getTotalRowCount()

Field Documentation

◆ $action_parameter_token

◆ $row_id_token

◆ $url_builder