Inheritance diagram for ILIAS\components\Authentication\Pages\AuthPageLanguagesOverviewTable:

Collaboration diagram for ILIAS\components\Authentication\Pages\AuthPageLanguagesOverviewTable:

Public Member Functions
	__construct (private readonly ilCtrlInterface $ctrl, private readonly ilLanguage $lng, \ILIAS\HTTP\Services $http, private readonly \ILIAS\UI\Factory $ui_factory, private readonly \ILIAS\UI\Renderer $ui_renderer, private readonly AuthPageEditorContext $context)

	getComponent ()

	getRows (UI\Component\Table\DataRowBuilder $row_builder, array $visible_column_ids, Data\Range $range, 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...

Data Fields
const	ACTIVATE = 'activate'

const	DEACTIVATE = 'deactivate'

const	EDIT = 'edit'

Protected Member Functions
	getActions ()

Private Member Functions
	getColumns ()

	initRecords ()

	getStatusIcon (bool $status)

	sortedRecords (Data\Order $order)

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

	limitRecords (array $records, Data\Range $range)

Private Attributes
ServerRequestInterface	$request

Data Factory	$data_factory

array	$records = null

Detailed Description

Definition at line 31 of file AuthPageLanguagesOverviewTable.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\components\Authentication\Pages\AuthPageLanguagesOverviewTable::__construct	(	private readonly ilCtrlInterface	$ctrl,
		private readonly ilLanguage	$lng,
		\ILIAS\HTTP\Services	$http,
		private readonly \ILIAS\UI\Factory	$ui_factory,
		private readonly \ILIAS\UI\Renderer	$ui_renderer,
		private readonly AuthPageEditorContext	$context
	)

Definition at line 44 of file AuthPageLanguagesOverviewTable.php.

       {
         $this->request = $http->request();
         $this->data_factory = new Data\Factory();
     }

Member Function Documentation

◆ getActions()

ILIAS\components\Authentication\Pages\AuthPageLanguagesOverviewTable::getActions ( )

protected

Returns: array<string, >

Definition at line 92 of file AuthPageLanguagesOverviewTable.php.

References ILIAS\Repository\ctrl(), ilAuthPageEditorGUI\LANGUAGE_TABLE_ACTIONS_COMMAND, and ILIAS\Repository\lng().

Referenced by ILIAS\components\Authentication\Pages\AuthPageLanguagesOverviewTable\getComponent().

                                    : array
     {
         $query_params_namespace = ['authpage', 'languages'];
 
         $overview_uri = $this->data_factory->uri(
             ILIAS_HTTP_PATH . '/' . $this->ctrl->getLinkTargetByClass(
                 \ilAuthPageEditorGUI::class,
                 \ilAuthPageEditorGUI::LANGUAGE_TABLE_ACTIONS_COMMAND
             )
         );
 
         $overview_url_builder = new UI\URLBuilder($overview_uri);
         [
             $overview_url_builder,
             $overview_action_parameter,
             $overview_row_id
         ] = $overview_url_builder->acquireParameters(
             $query_params_namespace,
             'action',
             'key'
         );
 
         return [
             self::EDIT => $this->ui_factory->table()->action()->single(
                 $this->lng->txt('edit'),
                 $overview_url_builder->withParameter($overview_action_parameter, self::EDIT),
                 $overview_row_id
             ),
             self::ACTIVATE => $this->ui_factory->table()->action()->standard(
                 $this->lng->txt('page_design_activate'),
                 $overview_url_builder->withParameter($overview_action_parameter, self::ACTIVATE),
                 $overview_row_id
             ),
             self::DEACTIVATE => $this->ui_factory->table()->action()->standard(
                 $this->lng->txt('page_design_deactivate'),
                 $overview_url_builder->withParameter($overview_action_parameter, self::DEACTIVATE),
                 $overview_row_id
             )
         ];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getColumns()

ILIAS\components\Authentication\Pages\AuthPageLanguagesOverviewTable::getColumns ( )

private

Returns: array<string, >

Definition at line 73 of file AuthPageLanguagesOverviewTable.php.

References ILIAS\Repository\lng().

Referenced by ILIAS\components\Authentication\Pages\AuthPageLanguagesOverviewTable\getComponent().

                                  : array
     {
         return [
             'language' => $this->ui_factory
                 ->table()
                 ->column()
                 ->text($this->lng->txt($this->context->pageLanguageIdentifier()))
                 ->withIsSortable(true),
             'status_icon' => $this->ui_factory
                 ->table()
                 ->column()
                 ->statusIcon($this->lng->txt('active'))
                 ->withIsSortable(true)
         ];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getComponent()

ILIAS\components\Authentication\Pages\AuthPageLanguagesOverviewTable::getComponent ( )

Definition at line 56 of file AuthPageLanguagesOverviewTable.php.

References ILIAS\Data\Order\ASC, ILIAS\components\Authentication\Pages\AuthPageLanguagesOverviewTable\getActions(), ILIAS\components\Authentication\Pages\AuthPageLanguagesOverviewTable\getColumns(), and ILIAS\Repository\lng().

                                   : UI\Component\Table\Data
     {
         $columns = $this->getColumns();
         $actions = $this->getActions();
 
         return $this->ui_factory
             ->table()
             ->data($this, $this->lng->txt($this->context->pageLanguageIdentifier(true)), $columns)
             ->withId(self::class . '_' . $this->context->value)
             ->withOrder(new \ILIAS\Data\Order('language', \ILIAS\Data\Order::ASC))
             ->withActions($actions)
             ->withRequest($this->request);
     }

Here is the call graph for this function:

◆ getRecords()

ILIAS\components\Authentication\Pages\AuthPageLanguagesOverviewTable::getRecords	(	Data\Range	$range,
		Data\Order	$order
	)

private

Returns: list<array<string, mixed>>

Definition at line 214 of file AuthPageLanguagesOverviewTable.php.

References ILIAS\components\Authentication\Pages\AuthPageLanguagesOverviewTable\initRecords(), ILIAS\components\Authentication\Pages\AuthPageLanguagesOverviewTable\limitRecords(), and ILIAS\components\Authentication\Pages\AuthPageLanguagesOverviewTable\sortedRecords().

Referenced by ILIAS\components\Authentication\Pages\AuthPageLanguagesOverviewTable\getRows().

                                                                      : array
     {
         $this->initRecords();
 
         $records = $this->sortedRecords($order);
 
         return $this->limitRecords($records, $range);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRows()

ILIAS\components\Authentication\Pages\AuthPageLanguagesOverviewTable::getRows	(	UI\Component\Table\DataRowBuilder	$row_builder,
		array	$visible_column_ids,
		Data\Range	$range,
		Data\Order	$order,
		?array	$filter_data,
		?array	$additional_parameters
	)

Definition at line 170 of file AuthPageLanguagesOverviewTable.php.

References ILIAS\components\Authentication\Pages\AuthPageLanguagesOverviewTable\getRecords().

      : \Generator {
         $records = $this->getRecords($range, $order);
 
         foreach ($records as $record) {
             $row_id = (string) $record['key'];
             $deactivate_action = (bool) $record['status'] === true ? self::ACTIVATE : self::DEACTIVATE;
             yield $row_builder->buildDataRow($row_id, $record)->withDisabledAction($deactivate_action);
         }
     }

Here is the call graph for this function:

◆ getStatusIcon()

ILIAS\components\Authentication\Pages\AuthPageLanguagesOverviewTable::getStatusIcon ( bool $status )

private

Definition at line 155 of file AuthPageLanguagesOverviewTable.php.

References ilUtil\getImagePath(), and ILIAS\Repository\lng().

Referenced by ILIAS\components\Authentication\Pages\AuthPageLanguagesOverviewTable\initRecords().

                                                 : \ILIAS\UI\Component\Symbol\Icon\Icon
     {
         if ($status) {
             return $this->ui_factory->symbol()->icon()->custom(
                 \ilUtil::getImagePath('standard/icon_ok.svg'),
                 $this->lng->txt('active')
             );
         }
 
         return $this->ui_factory->symbol()->icon()->custom(
             \ilUtil::getImagePath('standard/icon_not_ok.svg'),
             $this->lng->txt('inactive')
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTotalRowCount()

ILIAS\components\Authentication\Pages\AuthPageLanguagesOverviewTable::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 187 of file AuthPageLanguagesOverviewTable.php.

References ILIAS\components\Authentication\Pages\AuthPageLanguagesOverviewTable\initRecords().

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

Here is the call graph for this function:

◆ initRecords()

ILIAS\components\Authentication\Pages\AuthPageLanguagesOverviewTable::initRecords ( )

private

Definition at line 133 of file AuthPageLanguagesOverviewTable.php.

References ilAuthPageEditorSettings\getInstance(), ILIAS\components\Authentication\Pages\AuthPageLanguagesOverviewTable\getStatusIcon(), ILIAS\Repository\lng(), ilLanguage\lookupId(), and null.

Referenced by ILIAS\components\Authentication\Pages\AuthPageLanguagesOverviewTable\getRecords(), and ILIAS\components\Authentication\Pages\AuthPageLanguagesOverviewTable\getTotalRowCount().

                                   : void
     {
         if ($this->records === null) {
             $this->records = [];
             $i = 0;
             $entries = $this->lng->getInstalledLanguages();
             foreach ($entries as $langkey) {
                 $this->records[$i]['key'] = $langkey;
                 $this->records[$i]['id'] = ilLanguage::lookupId($langkey);
                 $status = ilAuthPageEditorSettings::getInstance($this->context)->isIliasEditorEnabled(
                     $langkey
                 );
 
                 $this->records[$i]['status'] = $status;
                 $this->records[$i]['status_icon'] = $this->getStatusIcon($status);
                 $this->records[$i]['language'] = $this->lng->txt('meta_l_' . $langkey);
 
                 ++$i;
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ limitRecords()

ILIAS\components\Authentication\Pages\AuthPageLanguagesOverviewTable::limitRecords	(	array	$records,
		Data\Range	$range
	)

private

Parameters

list<array<string,mixed>> $records

Returns: list<array<string, mixed>>

Definition at line 227 of file AuthPageLanguagesOverviewTable.php.

Referenced by ILIAS\components\Authentication\Pages\AuthPageLanguagesOverviewTable\getRecords().

                                                                     : array
     {
         return \array_slice($records, $range->getStart(), $range->getLength());
     }

Here is the caller graph for this function:

◆ sortedRecords()

ILIAS\components\Authentication\Pages\AuthPageLanguagesOverviewTable::sortedRecords ( Data\Order $order )

private

Returns: list<array<string, mixed>>

Definition at line 199 of file AuthPageLanguagesOverviewTable.php.

References ILIAS\components\Authentication\Pages\AuthPageLanguagesOverviewTable\$records, and ilArrayUtil\stableSortArray().

Referenced by ILIAS\components\Authentication\Pages\AuthPageLanguagesOverviewTable\getRecords().

                                                      : array
     {
         $records = $this->records;
         [$order_field, $order_direction] = $order->join([], fn($ret, $key, $value) => [$key, $value]);
 
         if ($order_field === 'status_icon') {
             $order_field = 'status';
         }
 
         return ilArrayUtil::stableSortArray($records, $order_field, strtolower($order_direction));
     }