Inheritance diagram for ilSamlIdpTableGUI:

Collaboration diagram for ilSamlIdpTableGUI:

Public Member Functions
	__construct (private ilSamlSettingsGUI $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)

	get ()

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

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

	getActions ()

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

Private Attributes
array	$idps

ILIAS UI URLBuilder	$url_builder

ILIAS UI URLBuilderToken	$action_parameter_token

ILIAS UI URLBuilderToken	$row_id_token

Additional Inherited Members
Data Fields inherited from ilSamlCommands
const string	CMD_LIST_IDPS = 'listIdps'

const string	CMD_TABLE_ACTIONS = 'handleTableActions'

const string	CMD_SHOW_NEW_IDP_FORM = 'showNewIdpForm'

const string	CMD_SAVE_NEW_IDP = 'saveNewIdp'

const string	CMD_DELETE_IDP = 'deleteIdp'

const string	CMD_SAVE_SETTINGS = 'saveSettings'

const string	CMD_SHOW_SETTINGS = 'showSettings'

const string	CMD_SHOW_IDP_SETTINGS = 'showIdpSettings'

const string	CMD_SAVE_IDP_SETTINGS = 'saveIdpSettings'

const string	CMD_SAVE_USER_ATTRIBUTE_MAPPING = 'saveUserAttributeMapping'

const string	CMD_SHOW_USER_ATTRIBUTE_MAPPING_FORM = 'showUserAttributeMappingForm'

const string	TABLE_ACTION_CONFIRM_DELETE_IDP = 'confirmDeleteIdp'

const string	TABLE_ACTION_DEACTIVATE_IDP = 'deactivateIdp'

const string	TABLE_ACTION_ACTIVATE_IDP = 'activateIdp'

const string	TABLE_ACTION_SHOW_IDP_SETTINGS = 'showIdpSettings'

const array	GLOBAL_COMMANDS

const array	GLOBAL_ENTITY_COMMANDS

const array	GLOBAL_ENTITY_TABLE_ACTIONS

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilSamlIdpTableGUI::__construct	(	private ilSamlSettingsGUI	$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
	)

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

      {
        $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'
        );
    }

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

Here is the call graph for this function:

Member Function Documentation

◆ get()

ilSamlIdpTableGUI::get ( )

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

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

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

Here is the call graph for this function:

◆ getActions()

ilSamlIdpTableGUI::getActions ( )

private

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

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

                                 : 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, self::TABLE_ACTION_SHOW_IDP_SETTINGS),
                $this->row_id_token
            ),
            'activate' => $this->ui_factory->table()->action()->single(
                $this->lng->txt('activate'),
                $this->url_builder->withParameter($this->action_parameter_token, self::TABLE_ACTION_ACTIVATE_IDP),
                $this->row_id_token
            ),
            'deactivate' => $this->ui_factory->table()->action()->single(
                $this->lng->txt('deactivate'),
                $this->url_builder->withParameter($this->action_parameter_token, self::TABLE_ACTION_DEACTIVATE_IDP),
                $this->row_id_token
            ),
            'delete' => $this->ui_factory->table()->action()->single(
                $this->lng->txt('delete'),
                $this->url_builder->withParameter($this->action_parameter_token, self::TABLE_ACTION_CONFIRM_DELETE_IDP),
                $this->row_id_token
            )
        ];
    }

References ILIAS\Repository\lng().

Referenced by get().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getColumnDefinition()

ilSamlIdpTableGUI::getColumnDefinition ( )

private

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

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

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

References ILIAS\Repository\lng().

Referenced by get().

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.

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

References $idps, ILIAS\UI\Implementation\Component\Table\$range, ilSamlIdp\getEntityId(), ILIAS\Data\Range\getLength(), ILIAS\Data\Range\getStart(), ILIAS\Repository\int(), ilSamlIdp\isActive(), and ilStr\strCmp().

Here is the call 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,
		mixed	$additional_viewcontrol_data,
		mixed	$filter_data,
		mixed	$additional_parameters
	)

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

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

◆ getTotalRowCount()

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

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

Field Documentation

◆ $action_parameter_token

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

ILIAS UI URLBuilderToken ilSamlIdpTableGUI::$row_id_token

private

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

Referenced by __construct().

◆ $url_builder

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

Additional Inherited Members

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