Improve list_languages to show the local name of the language, too

Author: mudrd8mz

classes/output/filter.php

@@ -518,7 +518,7 @@ protected function export_for_template_flng(\renderer_base $outpup, object $filt
             'someselected' => false,
         ];
 
-        foreach (\mlang_tools::list_languages(false) as $langcode => $langname) {
+        foreach (\mlang_tools::list_languages(false, true, true, true) as $langcode => $langname) {
             $option = [
                 'value' => $langcode,
                 'text' => $langname,

mlanglib.php

@@ -1735,9 +1735,10 @@ class mlang_tools {
      * @param bool $english shall the English be included?
      * @param bool $usecache can the internal cache be used?
      * @param bool $showcode append language code to the name
+     * @param bool $showlocal also show the language name in the language itself
      * @return array (string)langcode => (string)langname
      */
-    public static function list_languages($english=true, $usecache=true, $showcode=true) {
+    public static function list_languages($english=true, $usecache=true, $showcode=true, $showlocal=false) {
         global $DB;
 
         $cache = cache::make('local_amos', 'lists');
@@ -1769,9 +1770,9 @@ public static function list_languages($english=true, $usecache=true, $showcode=t
             $rs = $DB->get_recordset_sql($sql);
 
             foreach ($rs as $lang) {
-                if (!isset($langs[$lang->code])) {
+                if (!isset($langs[$lang->code][$lang->strname])) {
                     // Use the first returned value, all others are historical records.
-                    $langs[$lang->code] = $lang->name;
+                    $langs[$lang->code][$lang->strname] = $lang->name;
                 }
             }
 
@@ -1780,16 +1781,26 @@ public static function list_languages($english=true, $usecache=true, $showcode=t
             $cache->set('languages', $langs);
         }
 
-        if ($showcode) {
-            foreach (array_keys($langs) as $code) {
-                $langs[$code] .= ' (' . $code . ')';
+        $result = [];
+
+        foreach ($langs as $code => $names) {
+            $lang = $names['thislanguageint'] ?? '???';
+
+            if ($showlocal && $code !== 'en' && substr($code, 0, 3) !== 'en_') {
+                $lang .= ' / ' . ($names['thislanguage'] ?? '???');
             }
+
+            if ($showcode) {
+                $lang .= ' [' . $code . ']';
+            }
+
+            $result[$code] = $lang;
         }
 
         if ($english) {
-            return $langs;
+            return $result;
         } else {
-            return array_diff_key($langs, array('en' => 'English'));
+            return array_diff_key($result, ['en' => '']);
         }
     }
 

tests/mlanglib_test.php

@@ -1063,34 +1063,60 @@ public function test_list_languages() {
         $stage = new mlang_stage();
         $component = new mlang_component('langconfig', 'en', mlang_version::by_branch('MOODLE_19_STABLE'));
         $component->add_string(new mlang_string('thislanguageint', 'English'));
+        $component->add_string(new mlang_string('thislanguage', 'English'));
         $stage->add($component);
         $component->clear();
 
         $component = new mlang_component('langconfig', 'cs', mlang_version::by_branch('MOODLE_20_STABLE'));
         $component->add_string(new mlang_string('thislanguageint', 'Czech'));
+        $component->add_string(new mlang_string('thislanguage', 'Česky'));
         $stage->add($component);
         $component->clear();
 
         $component = new mlang_component('langconfig', 'cs', mlang_version::by_branch('MOODLE_19_STABLE'));
         $component->add_string(new mlang_string('thislanguageint', 'CS'));
+        $component->add_string(new mlang_string('thislanguage', 'ČS'));
         $stage->add($component);
         $component->clear();
 
-        $stage->commit('Registering two languages', array('source' => 'unittest'));
+        $component = new mlang_component('langconfig', 'xx', mlang_version::by_branch('MOODLE_21_STABLE'));
+        $component->add_string(new mlang_string('thislanguage', 'Xx'));
+        $stage->add($component);
+        $component->clear();
+
+        $component = new mlang_component('langconfig', 'yy', mlang_version::by_branch('MOODLE_23_STABLE'));
+        $component->add_string(new mlang_string('thislanguageint', 'Yy'));
+        $stage->add($component);
+        $component->clear();
+
+        $stage->commit('Registering languages', array('source' => 'unittest'));
 
         $langs = mlang_tools::list_languages(true, true, false);
         $this->assertEquals(gettype($langs), 'array');
-        $this->assertEquals(count($langs), 2);
+        $this->assertEquals(count($langs), 4);
         $this->assertTrue(array_key_exists('cs', $langs));
         $this->assertTrue(array_key_exists('en', $langs));
         $this->assertEquals($langs['en'], 'English');
         $this->assertEquals($langs['cs'], 'Czech');
+        $this->assertEquals($langs['xx'], '???');
+        $this->assertEquals($langs['yy'], 'Yy');
 
         $langs = mlang_tools::list_languages(false, true, true);
         $this->assertEquals(gettype($langs), 'array');
-        $this->assertEquals(count($langs), 1);
+        $this->assertEquals(count($langs), 3);
+        $this->assertTrue(array_key_exists('cs', $langs));
+        $this->assertEquals($langs['cs'], 'Czech [cs]');
+        $this->assertEquals($langs['xx'], '??? [xx]');
+        $this->assertEquals($langs['yy'], 'Yy [yy]');
+
+        $langs = mlang_tools::list_languages(true, true, true, true);
+        $this->assertEquals(gettype($langs), 'array');
+        $this->assertEquals(count($langs), 4);
         $this->assertTrue(array_key_exists('cs', $langs));
-        $this->assertEquals($langs['cs'], 'Czech (cs)');
+        $this->assertEquals($langs['en'], 'English [en]');
+        $this->assertEquals($langs['cs'], 'Czech / Česky [cs]');
+        $this->assertEquals($langs['xx'], '??? / Xx [xx]');
+        $this->assertEquals($langs['yy'], 'Yy / ??? [yy]');
     }
 
     public function test_list_components() {