mirror_php/moodle
1
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-03-14 20:50:21 +01:00
Code Issues Projects Releases Wiki Activity

MDL-72885 core: New weblib function get_html_lang_attribute_value()

Browse Source 
Converts a language code to hyphen-separated format in accordance to the
BCP47 syntax appropriate for the HTML lang attribute.

See
https://datatracker.ietf.org/doc/html/rfc5646#section-2.1
https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/lang
This commit is contained in:
Jun Pataleta 2022-05-27 14:24:29 +08:00
parent 3bdd840e63
commit 92e080465e
2 changed files with 44 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
lib/tests/weblib_test.php
View File

@ -941,4 +941,30 @@ EXPECTED;
$this->assertNotEquals($policydisabled, print_password_policy());
}
/**
* Data provider for the testing get_html_lang_attribute_value().
*
* @return string[][]
*/
public function get_html_lang_attribute_value_provider() {
return [
'Empty lang code' => [' ', 'unknown'],
'English' => ['en', 'en'],
'English, US' => ['en_us', 'en-us'],
];
}
/**
* Test for get_html_lang_attribute_value().
*
* @covers ::get_html_lang_attribute_value()
* @dataProvider get_html_lang_attribute_value_provider
* @param string $langcode The language code to convert.
* @param string $expected The expected converted value.
* @return void
*/
public function test_get_html_lang_attribute_value(string $langcode, string $expected): void {
$this->assertEquals($expected, get_html_lang_attribute_value($langcode));
}
}

18
lib/weblib.php
View File

@ -2206,6 +2206,24 @@ function highlightfast($needle, $haystack) {
return str_replace('<span class="highlight"></span>', '', join('', $parts));
}
/**
* Converts a language code to hyphen-separated format in accordance to the
* {@link https://datatracker.ietf.org/doc/html/rfc5646#section-2.1 BCP47 syntax}.
*
* For additional information, check out
* {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/lang MDN web docs - lang}.
*
* @param string $langcode The language code to convert.
* @return string
*/
function get_html_lang_attribute_value(string $langcode): string {
if (empty(trim($langcode))) {
// If the language code passed is an empty string, return 'unknown'.
return 'unknown';
}
return str_replace('_', '-', $langcode);
}
/**
* Return a string containing 'lang', xml:lang and optionally 'dir' HTML attributes.
*