Inheritance diagram for ilSamlIdpTableGUI:

Collaboration diagram for ilSamlIdpTableGUI:

Public Member Functions
	__construct (private readonly ilSamlSettingsGUI $parent_gui, private readonly \ILIAS\UI\Factory $ui_factory, private readonly \ILIAS\UI\Renderer $ui_renderer, private readonly ilLanguage $lng, private readonly ilCtrlInterface $ctrl, private readonly \Psr\Http\Message\ServerRequestInterface $http_request, private readonly \ILIAS\Data\Factory $df, private readonly string $parent_cmd, private readonly bool $has_write_access)

	get ()

	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...

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
	getColumnDefinition ()

	getActions ()

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

Private Attributes
array	$idps

readonly ILIAS UI URLBuilder	$url_builder

readonly ILIAS UI URLBuilderToken	$action_parameter_token

readonly ILIAS UI URLBuilderToken	$row_id_token

Detailed Description

Definition at line 21 of file class.ilSamlIdpTableGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilSamlIdpTableGUI::__construct	(	private readonly ilSamlSettingsGUI	$parent_gui,
		private readonly \ILIAS\UI\Factory	$ui_factory,
		private readonly \ILIAS\UI\Renderer	$ui_renderer,
		private readonly ilLanguage	$lng,
		private readonly ilCtrlInterface	$ctrl,
		private readonly \Psr\Http\Message\ServerRequestInterface	$http_request,
		private readonly \ILIAS\Data\Factory	$df,
		private readonly string	$parent_cmd,
		private readonly bool	$has_write_access
	)

Definition at line 29 of file class.ilSamlIdpTableGUI.php.

References $action_parameter_token, $row_id_token, $url_builder, ilUtil\_getHttpPath(), ILIAS\Repository\ctrl(), and ilSamlIdp\getAllIdps().

       {
         $this->idps = ilSamlIdp::getAllIdps();
 
         $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(
             ['saml', 'idps'],
             'table_action',
             'idp_id'
         );
     }

Here is the call graph for this function:

Member Function Documentation

◆ get()

ilSamlIdpTableGUI::get ( )

Definition at line 58 of file class.ilSamlIdpTableGUI.php.

References getActions(), getColumnDefinition(), and ILIAS\Repository\lng().

                          : \ILIAS\UI\Component\Table\Data
     {
         return $this->ui_factory
             ->table()
             ->data(
                 $this->lng->txt('auth_saml_idps'),
                 $this->getColumnDefinition(),
                 $this
             )
             ->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:

◆ getActions()

ilSamlIdpTableGUI::getActions ( )

private

Returns: array<string, >

Definition at line 111 of file class.ilSamlIdpTableGUI.php.

References $row_id_token, and ILIAS\Repository\lng().

Referenced by get().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getColumnDefinition()

ilSamlIdpTableGUI::getColumnDefinition ( )

private

Returns: array<string, >

Definition at line 76 of file class.ilSamlIdpTableGUI.php.

References ILIAS\Repository\lng().

Referenced by get().

                                           : array
     {
         return [
             'title' => $this->ui_factory
                 ->table()
                 ->column()
                 ->text($this->lng->txt('saml_tab_head_idp'))
                 ->withIsSortable(true),
             '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')}"
                 )
         ];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRecords()

ilSamlIdpTableGUI::getRecords	(	\ILIAS\Data\Range	$range,
		\ILIAS\Data\Order	$order
	)

private

Returns: list<ilSamlIdp>

Definition at line 144 of file class.ilSamlIdpTableGUI.php.

References $idps, ilSamlIdp\getEntityId(), ILIAS\Repository\int(), ilSamlIdp\isActive(), and ilStr\strCmp().

Referenced by getRows().

                                                                                    : array
     {
         $records = $this->idps;
 
         [$order_field, $order_direction] = $order->join([], static function ($ret, $key, $value) {
             return [$key, $value];
         });
 
         usort($records, static function (ilSamlIdp $left, ilSamlIdp $right) use ($order_field): int {
             if ($order_field === 'title') {
                 return ilStr::strCmp($left->getEntityId(), $right->getEntityId());
             }
 
             return (int) $right->isActive() <=> (int) $left->isActive();
         });
 
         if ($order_direction === \ILIAS\Data\Order::DESC) {
             $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()

ilSamlIdpTableGUI::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 169 of file class.ilSamlIdpTableGUI.php.

References getRecords().

      : Generator {
         foreach ($this->getRecords($range, $order) as $item) {
             yield $row_builder
                 ->buildDataRow((string) $item->getIdpId(), [
                     'title' => $item->getEntityId(),
                     'active' => $item->isActive()
                 ])
                 ->withDisabledAction(
                     'activate',
                     $item->isActive(),
                 )
                 ->withDisabledAction(
                     'deactivate',
                     !$item->isActive(),
                 );
         }
     }

Here is the call graph for this function:

◆ getTotalRowCount()

ilSamlIdpTableGUI::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 194 of file class.ilSamlIdpTableGUI.php.

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

Field Documentation

◆ $action_parameter_token

readonly ILIAS UI URLBuilderToken ilSamlIdpTableGUI::$action_parameter_token

private

Definition at line 26 of file class.ilSamlIdpTableGUI.php.

Referenced by __construct().

◆ $idps

array ilSamlIdpTableGUI::$idps

private

Definition at line 24 of file class.ilSamlIdpTableGUI.php.

Referenced by getRecords().

◆ $row_id_token

readonly ILIAS UI URLBuilderToken ilSamlIdpTableGUI::$row_id_token

private

Definition at line 27 of file class.ilSamlIdpTableGUI.php.

Referenced by __construct(), and getActions().

◆ $url_builder

readonly ILIAS UI URLBuilder ilSamlIdpTableGUI::$url_builder

private

Definition at line 25 of file class.ilSamlIdpTableGUI.php.

Referenced by __construct().

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

components/ILIAS/Saml/classes/class.ilSamlIdpTableGUI.php

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ get()

◆ getActions()

◆ getColumnDefinition()

◆ getRecords()

◆ getRows()

◆ getTotalRowCount()

Field Documentation

◆ $action_parameter_token

◆ $idps

◆ $row_id_token

◆ $url_builder