From 2fc2a1a228dbfada803618bdc4714f4ffaa9d149 Mon Sep 17 00:00:00 2001
From: Hypolite Petovan <ben.lort@gmail.com>
Date: Mon, 24 Oct 2016 22:17:02 -0400
Subject: [PATCH] Fix typo in get_available_languages function name

- Add Doxygen comment block
- Fix formatting
- Renamed variable for faster understanding
---
 include/pgettext.php | 44 +++++++++++++++++++++++++-------------------
 mod/admin.php        |  2 +-
 mod/install.php      |  2 +-
 mod/settings.php     |  2 +-
 4 files changed, 28 insertions(+), 22 deletions(-)

diff --git a/include/pgettext.php b/include/pgettext.php
index ea08b4c5c..0acbb02cf 100644
--- a/include/pgettext.php
+++ b/include/pgettext.php
@@ -162,25 +162,31 @@ function string_plural_select_default($n) {
 }}
 
 
-/**
- * Return installed languages as associative array
- * [
- * 		lang => lang,
- * 		...
- * ]
- */
-function get_avaiable_languages() {
-	$lang_choices = array();
-	$langs = glob('view/lang/*/strings.php'); /**/
 
-	if(is_array($langs) && count($langs)) {
-		if(! in_array('view/lang/en/strings.php',$langs))
-			$langs[] = 'view/lang/en/';
-		asort($langs);
-		foreach($langs as $l) {
-			$t = explode("/",$l);
-			$lang_choices[$t[2]] = $t[2];
+/**
+ * @brief Return installed languages codes as associative array
+ *
+ * Scans the view/lang directory for the existence of "strings.php" files, and
+ * returns an alphabetical list of their folder names (@-char language codes).
+ * Adds the english language if it's missing from the list.
+ *
+ * Ex: array('de' => 'de', 'en' => 'en', 'fr' => 'fr', ...)
+ *
+ * @return array
+ */
+function get_available_languages() {
+	$langs = array();
+	$strings_file_paths = glob('view/lang/*/strings.php');
+
+	if (is_array($strings_file_paths) && count($strings_file_paths)) {
+		if (!in_array('view/lang/en/strings.php', $strings_file_paths)) {
+			$strings_file_paths[] = 'view/lang/en/strings.php';
+		}
+		asort($strings_file_paths);
+		foreach($strings_file_paths as $strings_file_path) {
+			$path_array = explode('/', $strings_file_path);
+			$langs[$path_array[2]] = $path_array[2];
 		}
 	}
-	return $lang_choices;
-}
+	return $langs;
+}
\ No newline at end of file
diff --git a/mod/admin.php b/mod/admin.php
index c9ff23e2d..4ddc4a56c 100644
--- a/mod/admin.php
+++ b/mod/admin.php
@@ -820,7 +820,7 @@ function admin_page_site_post(&$a) {
 function admin_page_site(&$a) {
 
 	/* Installed langs */
-	$lang_choices = get_avaiable_languages();
+	$lang_choices = get_available_languages();
 
 	if(strlen(get_config('system','directory_submit_url')) AND
 		!strlen(get_config('system','directory'))) {
diff --git a/mod/install.php b/mod/install.php
index 1e0d7a5fa..d18d4ac3e 100755
--- a/mod/install.php
+++ b/mod/install.php
@@ -285,7 +285,7 @@ function install_content(&$a) {
 			$adminmail = notags(trim($_POST['adminmail']));
 			$timezone = ((x($_POST,'timezone')) ? ($_POST['timezone']) : 'America/Los_Angeles');
 			/* Installed langs */
-			$lang_choices = get_avaiable_languages();
+			$lang_choices = get_available_languages();
 
 			$tpl = get_markup_template('install_settings.tpl');
 			$o .= replace_macros($tpl, array(
diff --git a/mod/settings.php b/mod/settings.php
index 37498a0dd..18d7352d2 100644
--- a/mod/settings.php
+++ b/mod/settings.php
@@ -1246,7 +1246,7 @@ function settings_content(&$a) {
 		$public_post_link = '&public=1';
 
 	/* Installed langs */
-	$lang_choices = get_avaiable_languages();
+	$lang_choices = get_available_languages();
 
 	$o .= replace_macros($stpl, array(
 		'$ptitle' 	=> t('Account Settings'),