Table class for. More...

Inheritance diagram for ilLanguageFolderTable:

Collaboration diagram for ilLanguageFolderTable:

Public Member Functions
	__construct (ilObjLanguageFolder $a_folder, URLBuilder $url_builder, URLBuilderToken $action_token, URLBuilderToken $row_id_token)

	getTable ()

	getItems (?Range $range=null, ?Order $order=null)
	Get language data. More...

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

Protected Member Functions
	getColums ()

	getActions ()

	buildAction (string $act, string $type, bool $async=false)

	getURIWithTargetClass (string $target_gui, string $command)

Protected Attributes
URLBuilder	$url_builder

URLBuilderToken	$action_token

URLBuilderToken	$row_id_token

ILIAS UI Factory	$ui_factory

ilLanguage	$lng

ilObjLanguageFolder	$folder

ilCtrlInterface	$ctrl

ilSetting	$ilSetting

ilAccessHandler	$access

Detailed Description

Table class for.

Author: Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version: $Id$

Definition at line 37 of file class.ilLanguageFolderTable.php.

Constructor & Destructor Documentation

◆ __construct()

ilLanguageFolderTable::__construct	(	ilObjLanguageFolder	$a_folder,
		URLBuilder	$url_builder,
		URLBuilderToken	$action_token,
		URLBuilderToken	$row_id_token
	)

Definition at line 49 of file class.ilLanguageFolderTable.php.

      {
        global $DIC;
        $this->ui_factory = $DIC['ui.factory'];
        $this->lng = $DIC->language();
        $this->folder = $a_folder;
        $this->url_builder = $url_builder;
        $this->action_token = $action_token;
        $this->row_id_token = $row_id_token;
        $this->ctrl = $DIC->ctrl();
        $this->ilSetting = $DIC->settings();
        $this->access = $DIC->access();
    }

References $action_token, $DIC, $row_id_token, $url_builder, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Here is the call graph for this function:

Member Function Documentation

◆ buildAction()

ilLanguageFolderTable::buildAction	(	string	$act,
		string	$type,
		bool	$async = `false`
	)

protected

Definition at line 117 of file class.ilLanguageFolderTable.php.

                                                                                  : array
    {
        $action = $this->ui_factory->table()->action()
                                   ->$type(
                                       $this->lng->txt($act),
                                       $this->url_builder->withParameter($this->action_token, $act),
                                       $this->row_id_token
                                   );
        if ($async) {
            $action = $action->withAsync(true);
        }
 
        return [$act => $action];
    }

References ILIAS\Repository\lng().

Referenced by getActions().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getActions()

ilLanguageFolderTable::getActions ( )

protected

Definition at line 103 of file class.ilLanguageFolderTable.php.

                                   : array
    {
        $actions = array_merge(
            $this->buildAction('refresh', 'standard', true),
            $this->buildAction('install', 'standard'),
            $this->buildAction('install_local', 'standard'),
            $this->buildAction('uninstall', 'standard', true),
            $this->buildAction('lang_uninstall_changes', 'standard', true),
            $this->buildAction('setSystemLanguage', 'single'),
            $this->buildAction('setUserLanguage', 'single'),
        );
        return $actions;
    }

References buildAction().

Referenced by getTable().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getColums()

ilLanguageFolderTable::getColums ( )

protected

Definition at line 80 of file class.ilLanguageFolderTable.php.

                                  : array
    {
        $f = $this->ui_factory;
        $icon_yes = $f->symbol()->icon()->custom(
            'assets/images/standard/icon_checked.svg',
            $this->lng->txt('yes'),
            'small'
        );
        $icon_no = $f->symbol()->icon()->custom(
            'assets/images/standard/icon_unchecked.svg',
            $this->lng->txt('no'),
            'small'
        );
        return [
            'language' => $f->table()->column()->link($this->lng->txt("language"))->withIsSortable(false),
            'status' => $f->table()->column()->text($this->lng->txt("status"))->withIsSortable(false),
            'users' => $f->table()->column()->text($this->lng->txt("users"))->withIsSortable(false),
            'page_translation' => $f->table()->column()->boolean($this->lng->txt("language_translation"), $icon_yes, $icon_no)->withIsSortable(false),
            'last_refresh' => $f->table()->column()->text($this->lng->txt("last_refresh"))->withIsSortable(false),
            'last_change' => $f->table()->column()->text($this->lng->txt("last_change"))->withIsSortable(false)
        ];
    }

References Vendor\Package\$f, $ui_factory, and ILIAS\Repository\lng().

Referenced by getTable().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getItems()

ilLanguageFolderTable::getItems	(	?Range	$range = `null`,
		?Order	$order = `null`
	)

Get language data.

Definition at line 135 of file class.ilLanguageFolderTable.php.

                                                                        : array
    {
        $languages = $this->folder->getLanguages();
        $data = [];
        $names = [];
        $installed = [];
 
        foreach ($languages as $k => $l) {
            $data[] = array_merge($l, ["key" => $k]);
            $names[] = $l['name'];
            $installed[] = str_starts_with($l["desc"], 'installed') ? 1 : 2;
        }
 
        // sort alphabetically but show installed languages first
        array_multisort($installed, SORT_ASC, $names, SORT_ASC, $data);
 
        if ($range) {
            $data = array_slice($data, $range->getStart(), $range->getLength());
        }
 
        return $data;
    }

References $data, ILIAS\UI\Implementation\Component\Table\$range, ILIAS\Data\Range\getLength(), and ILIAS\Data\Range\getStart().

Here is the call graph for this function:

◆ getRows()

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

Definition at line 158 of file class.ilLanguageFolderTable.php.

     : Generator {
        foreach ($this->getItems($range, $order) as $idx => $record) {
            $obj_id = (string) $record['obj_id'];
            $language = $record['name'];
            if (array_key_exists('status', $record) and $record['status'] !== '') {
                $language .= ' (' . $this->lng->txt($record["status"]) . ')';
            }
            $to_language = $this->url_builder
                ->withParameter($this->action_token, 'view')
                ->withParameter($this->row_id_token, $obj_id)
                ->withURI($this->getURIWithTargetClass(ilObjLanguageExtGUI::class, 'view'))
                ->buildURI()->__toString();
 
            $record['language'] = $this->ui_factory->link()->standard($language, $to_language)->withDisabled();
 
            $record['status'] = $this->lng->txt($record['desc']);
 
            $record['page_translation'] = false;
            if ($this->ilSetting->get("lang_translate_" . $record["key"])) {
                $record['page_translation'] = true;
            }
 
            $record['users'] = ilObjLanguage::countUsers($record["key"]);
            if ($record["desc"] !== "not_installed") {
                if ($this->access->checkAccess('write', '', $this->folder->getId())) {
                    $record['language'] = $record['language']->withDisabled(false);
                }
                $record['last_refresh'] = ilDatePresentation::formatDate(new ilDateTime($record["last_update"], IL_CAL_DATETIME, 'UTC'));
 
                $last_change = ilObjLanguage::_getLastLocalChange($record["key"]);
                $record['last_change'] = ilDatePresentation::formatDate(new ilDateTime($last_change, IL_CAL_DATETIME, 'UTC'));
            }
 
            yield $row_builder->buildDataRow($obj_id, $record)
                              ->withDisabledAction('setSystemLanguage', ($record['desc'] === 'not_installed') || ($record['key'] === $this->lng->getDefaultLanguage()))
                              ->withDisabledAction('setUserLanguage', ($record['desc'] === 'not_installed') || ($record['key'] === $this->lng->getUserLanguage()))
                              ->withDisabledAction('refresh', ($record['desc'] === 'not_installed'))
                              ->withDisabledAction('uninstall', ($record['desc'] === 'not_installed'))
                              ->withDisabledAction('lang_uninstall_changes', ($record['desc'] === 'not_installed'))
                              ->withDisabledAction('install', ($record['desc'] !== 'not_installed'))
                              ->withDisabledAction('install_local', ($record['desc'] !== 'not_installed'));
        }
    }

References ilObjLanguage\_getLastLocalChange(), ILIAS\Repository\access(), ilObjLanguage\countUsers(), ilDatePresentation\formatDate(), ilSetting\get(), getURIWithTargetClass(), IL_CAL_DATETIME, and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ getTable()

ilLanguageFolderTable::getTable ( )

Definition at line 67 of file class.ilLanguageFolderTable.php.

                              : DataTable\Data
    {
        $table = $this->ui_factory->table()->data(
            $this,
            '',
            $this->getColums(),
        );
        if ($this->access->checkAccess('write', '', $this->folder->getId())) {
            $table = $table->withActions($this->getActions());
        }
        return $table;
    }

References ILIAS\Repository\access(), getActions(), and getColums().

Here is the call graph for this function:

◆ getTotalRowCount()

ilLanguageFolderTable::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 220 of file class.ilLanguageFolderTable.php.

     : ?int {
        return 1;
    }

◆ getURIWithTargetClass()

ilLanguageFolderTable::getURIWithTargetClass	(	string	$target_gui,
		string	$command
	)

protected

Definition at line 210 of file class.ilLanguageFolderTable.php.

                                                                                 : URI
    {
        return new URI(
            ILIAS_HTTP_PATH . "/" . $this->ctrl->getLinkTargetByClass(
                $target_gui,
                $command
            )
        );
    }