Inheritance diagram for ILIAS\COPage\Editor\Server\UI\ServerTable:

Collaboration diagram for ILIAS\COPage\Editor\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\Factory $df, private string $parent_cmd, 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, ?array $filter_data, ?array $additional_parameters)

	getTotalRowCount (?array $filter_data, ?array $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, ?array $filter_data, ?array $additional_parameters)
	This is called by the table to retrieve rows; map data-records to rows using the $row_builder e.g. 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\COPage\Editor\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\Factory	$df,
		private string	$parent_cmd,
		private bool	$has_write_access
	)

Parameters

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

Definition at line 32 of file ServerTable.php.

References ILIAS\COPage\Editor\Server\UI\ServerTable\$action_parameter_token, ILIAS\COPage\Editor\Server\UI\ServerTable\$row_id_token, ILIAS\COPage\Editor\Server\UI\ServerTable\$url_builder, ilUtil\_getHttpPath(), and ILIAS\Repository\ctrl().

       {
         $form_action = $this->df->uri(
             \ilUtil::_getHttpPath() . '/' .
             $this->ctrl->getLinkTarget($this->parent_gui, $this->parent_cmd)
         );
 
         [
             $this->url_builder,
             $this->action_parameter_token,
             $this->row_id_token
         ] = (new \ILIAS\UI\URLBuilder($form_action))->acquireParameters(
             ['ldap', 'servers'],
             'table_action',
             'server_id'
         );
     }

Here is the call graph for this function:

Member Function Documentation

◆ getActions()

ILIAS\COPage\Editor\Server\UI\ServerTable::getActions ( )

private

Returns: array<string, >

Definition at line 182 of file ServerTable.php.

References ILIAS\COPage\Editor\Server\UI\ServerTable\$row_id_token, and ILIAS\Repository\lng().

Referenced by ILIAS\COPage\Editor\Server\UI\ServerTable\getComponent().

                                  : 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
             )
         ];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getColumnDefinition()

ILIAS\COPage\Editor\Server\UI\ServerTable::getColumnDefinition ( )

private

Returns: array<string, >

Definition at line 142 of file ServerTable.php.

References ILIAS\Repository\lng().

Referenced by ILIAS\COPage\Editor\Server\UI\ServerTable\getComponent().

                                           : 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')}"
                 ),
             'title' => $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)
         ];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getComponent()

ILIAS\COPage\Editor\Server\UI\ServerTable::getComponent ( )

Definition at line 212 of file ServerTable.php.

References ILIAS\Data\Order\ASC, ILIAS\COPage\Editor\Server\UI\ServerTable\getActions(), ILIAS\COPage\Editor\Server\UI\ServerTable\getColumnDefinition(), and ILIAS\Repository\lng().

                                   : \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);
     }

Here is the call graph for this function:

◆ getRecords()

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

private

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

Definition at line 63 of file ServerTable.php.

References $server, ilObjUser\_getExternalAccountsByAuthMode(), and ilArrayUtil\sortArray().

Referenced by ILIAS\COPage\Editor\Server\UI\ServerTable\getRows().

                                                                                    : 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;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRows()

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

Definition at line 94 of file ServerTable.php.

References $server, ILIAS\Repository\ctrl(), and ILIAS\COPage\Editor\Server\UI\ServerTable\getRecords().

      : \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'],
                     [
                         'title' => $title,
                         'active' => (bool) $server['active'],
                         'user' => $server['user']
                     ]
                 )
                 ->withDisabledAction(
                     'activateServer',
                     (bool) $server['active'],
                 )
                 ->withDisabledAction(
                     'deactivateServer',
                     !$server['active'],
                 );
         }
     }

Here is the call graph for this function:

◆ getTotalRowCount()

ILIAS\COPage\Editor\Server\UI\ServerTable::getTotalRowCount	(	?array	$filter_data,
		?array	$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 134 of file ServerTable.php.

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

Field Documentation

◆ $action_parameter_token

ILIAS UI URLBuilderToken ILIAS\COPage\Editor\Server::UI\ServerTable::$action_parameter_token

private

Definition at line 26 of file ServerTable.php.

Referenced by ILIAS\COPage\Editor\Server\UI\ServerTable\__construct().

◆ $row_id_token

ILIAS UI URLBuilderToken ILIAS\COPage\Editor\Server::UI\ServerTable::$row_id_token

private

Definition at line 27 of file ServerTable.php.

Referenced by ILIAS\COPage\Editor\Server\UI\ServerTable\__construct(), and ILIAS\COPage\Editor\Server\UI\ServerTable\getActions().

◆ $url_builder

ILIAS UI URLBuilder ILIAS\COPage\Editor\Server::UI\ServerTable::$url_builder

private

Definition at line 25 of file ServerTable.php.

Referenced by ILIAS\COPage\Editor\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