makary/phpbb
1
0
Fork 0
mirror of https://github.com/phpbb/phpbb.git synced 2025-06-07 20:08:53 +00:00
Code Issues Projects Releases Packages Wiki Activity

[ticket/10824] Improve code style and docblocks in language file helper

Browse source 
PHPBB3-10824
This commit is contained in:
Marc Alexander 2021-01-18 21:08:05 +01:00
parent c93da86f83
commit 42b2a109d1
No known key found for this signature in database
GPG key ID: 50E0D2423696F995
1 changed files with 13 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
phpBB/phpbb/language/language_file_helper.php
View file

@ -30,9 +30,9 @@ class language_file_helper
/** /**
* Constructor * Constructor
* *
* @param string $phpbb_root_path Path to phpBB's root * @param string $phpbb_root_path Path to phpBB's root
*/ */
public function __construct($phpbb_root_path) public function __construct(string $phpbb_root_path)
{ {
$this->phpbb_root_path = $phpbb_root_path; $this->phpbb_root_path = $phpbb_root_path;
} }
@ -41,8 +41,11 @@ class language_file_helper
* Returns available languages * Returns available languages
* *
* @return array * @return array
*
* @throws DomainException When one of the languages in language directory
* could not be loaded or have invalid composer.json data
*/ */
public function get_available_languages() public function get_available_languages() : array
{ {
// Find available language packages // Find available language packages
$finder = new Finder(); $finder = new Finder();
@ -69,8 +72,10 @@ class language_file_helper
* *
* @param string $path * @param string $path
* @return array * @return array
*
* @throws DomainException When unable to language data from composer.json
*/ */
public function get_language_data_from_composer_file(string $path): array public function get_language_data_from_composer_file(string $path) : array
{ {
$json_data = file_get_contents($path); $json_data = file_get_contents($path);
return $this->get_language_data_from_json(json_sanitizer::decode($json_data)); return $this->get_language_data_from_json(json_sanitizer::decode($json_data));
@ -81,12 +86,14 @@ class language_file_helper
* *
* @param array $data * @param array $data
* @return array * @return array
*
* @throws DomainException When composer.json data is invalid for language files
*/ */
protected function get_language_data_from_json(array $data): array protected function get_language_data_from_json(array $data) : array
{ {
if (!isset($data['extra']['language-iso']) || !isset($data['extra']['english-name']) || !isset($data['extra']['local-name'])) if (!isset($data['extra']['language-iso']) || !isset($data['extra']['english-name']) || !isset($data['extra']['local-name']))
{ {
throw new \DomainException('INVALID_LANGUAGE_PACK'); throw new DomainException('INVALID_LANGUAGE_PACK');
} }
$authors = []; $authors = [];