From 18c8b497e6d562b1c932c2ee158c34e9a16a5d3c Mon Sep 17 00:00:00 2001
From: Yannick Warnier <yannick.warnier@beeznest.com>
Date: Mon, 30 Jul 2012 00:00:33 -0500
Subject: [PATCH] Minor - code documetation update

---
 main/admin/sub_language.php          | 16 +++++--
 main/admin/sub_language_ajax.inc.php | 72 ++++++++++++++++------------
 2 files changed, 54 insertions(+), 34 deletions(-)

diff --git a/main/admin/sub_language.php b/main/admin/sub_language.php
index a3d1a091d2..35bb957fee 100644
--- a/main/admin/sub_language.php
+++ b/main/admin/sub_language.php
@@ -1,6 +1,12 @@
 <?php
 /* For licensing terms, see /license.txt */
-/*		INIT SECTION	*/
+/**
+ * Script for sub-language administration
+ * @package chamilo.admin.sub_language
+ */
+/**
+ * Init section
+ */
 // name of the language file that needs to be included
 $language_file = 'admin';
 $cidReset = true;
@@ -47,7 +53,9 @@ $htmlHeadXtra[] ='<script type="text/javascript">
 	});
  		});
 </script>';
-/* 		MAIN CODE	*/
+/**
+ * Main code
+ */
 // setting the name of the tool
 $tool_name = get_lang('CreateSubLanguage');
 // setting breadcrumbs
@@ -265,7 +273,9 @@ function search_language_term($term, $search_in_variable = true , $search_in_eng
 	$list_info = array_unique_dimensional($list_info);
 	return $list_info;
 }
-
+/**
+ * Output
+ */
 //allow see data in sortetable
 if (isset($_REQUEST['txt_search_word'])) {
 	//@todo fix to accept a char with 1 char
diff --git a/main/admin/sub_language_ajax.inc.php b/main/admin/sub_language_ajax.inc.php
index 995f2af199..9fc9082baf 100644
--- a/main/admin/sub_language_ajax.inc.php
+++ b/main/admin/sub_language_ajax.inc.php
@@ -1,5 +1,12 @@
 <?php
 /* For licensing terms, see /license.txt */
+/**
+ * Sub language AJAX script to update variables
+ * @package chamilo.admin.sub_language
+ */
+/**
+ * Init
+ */
 $language_file = 'admin';
 $this_script = 'sub_language';
 require_once '../inc/global.inc.php';
@@ -7,39 +14,42 @@ require_once 'sub_language.class.php';
 
 api_protect_admin_script();
 
-$new_language		= Security::remove_XSS($_REQUEST['new_language']);
-$language_variable	= Security::remove_XSS($_REQUEST['variable_language']);
-$file_id			= intval($_REQUEST['file_id']);
-
+$new_language        = Security::remove_XSS($_REQUEST['new_language']);
+$language_variable    = Security::remove_XSS($_REQUEST['variable_language']);
+$file_id            = intval($_REQUEST['file_id']);
+/**
+ * Code
+ */
 if (isset($new_language) && isset($language_variable) && isset($file_id)) {
-	$file_language           = $language_files_to_load[$file_id].'.inc.php';	
-	$id_language             = intval($_REQUEST['id']);
-	$sub_language_id         = intval($_REQUEST['sub']);
-	$all_data_of_language    = SubLanguageManager::get_all_information_of_sub_language($id_language, $sub_language_id);
-	
-	$path_folder             = api_get_path(SYS_LANG_PATH).$all_data_of_language['dokeos_folder'].'/'.$file_language;
-	$all_file_of_directory   = SubLanguageManager::get_all_language_variable_in_file($path_folder);
-	$return_value            = SubLanguageManager::add_file_in_language_directory($path_folder);
-	
-	//update variable language
-    $new_language = str_replace('"', '\"',$new_language);    
-	$all_file_of_directory[$language_variable]="\"".api_convert_encoding($new_language, api_get_system_encoding(),'UTF-8')."\";";
+    $file_language           = $language_files_to_load[$file_id].'.inc.php';
+    $id_language             = intval($_REQUEST['id']);
+    $sub_language_id         = intval($_REQUEST['sub']);
+    $all_data_of_language    = SubLanguageManager::get_all_information_of_sub_language($id_language, $sub_language_id);
+
+    $path_folder             = api_get_path(SYS_LANG_PATH).$all_data_of_language['dokeos_folder'].'/'.$file_language;
+    $all_file_of_directory   = SubLanguageManager::get_all_language_variable_in_file($path_folder);
+    $return_value            = SubLanguageManager::add_file_in_language_directory($path_folder);
+
+    //update variable language
+    $new_language = str_replace('"', '\"',$new_language);
+    $all_file_of_directory[$language_variable]="\"".api_convert_encoding($new_language, api_get_system_encoding(),'UTF-8')."\";";
     $result_array = array();
-    
-	foreach ($all_file_of_directory as $key_value=>$value_info) {
-		$result_array[$key_value] = SubLanguageManager::write_data_in_file($path_folder, $value_info, $key_value);
-	}
-	$variables_with_problems = '';
-	if (!empty($result_array)) {
+
+    foreach ($all_file_of_directory as $key_value=>$value_info) {
+        $result_array[$key_value] = SubLanguageManager::write_data_in_file($path_folder, $value_info, $key_value);
+    }
+    $variables_with_problems = '';
+    if (!empty($result_array)) {
         foreach($result_array as $key =>$result) {
             if ($result == false) {
-    	        $variables_with_problems .=$key.' <br />';
-            }             
-    	}
-	}	
-	if (!empty($variables_with_problems)) {
-	    echo $path_folder.' '.get_lang('IsNotWritable').'<br /> '.api_ucwords(get_lang('ErrorsFound')).': <br />'.$variables_with_problems;
-	} else {
-	    echo 1;
-	}	
+                $variables_with_problems .=$key.' <br />';
+            }
+        }
+    }
+    if (!empty($variables_with_problems)) {
+        echo $path_folder.' '.get_lang('IsNotWritable').'<br /> '.api_ucwords(get_lang('ErrorsFound')).': <br />'.$variables_with_problems;
+    } else {
+        echo get_lang('Saved');
+    } 
 }
+