From ee6a1b03e1562bfdd07dedbaba30e7d2684f4265 Mon Sep 17 00:00:00 2001
From: Yannick Warnier <yannick.warnier@beeznest.com>
Date: Tue, 25 Nov 2008 05:52:19 +0100
Subject: [PATCH] [svn r16896] Various updates and improvements to new glossary
 tool

---
 main/glossary/glossaryfunction.inc.php |  46 +++++----
 main/glossary/index.php                | 125 ++++++++++++-------------
 2 files changed, 80 insertions(+), 91 deletions(-)

diff --git a/main/glossary/glossaryfunction.inc.php b/main/glossary/glossaryfunction.inc.php
index 11e18c384a..c827f87bd8 100755
--- a/main/glossary/glossaryfunction.inc.php
+++ b/main/glossary/glossaryfunction.inc.php
@@ -1,11 +1,10 @@
-<?php
-/*
- * Created on 19/11/2008
+<?php //$id: $
+/* For licensing terms, see /dokeos_license.txt */
+/**
+ * @package dokeos.glossary
  * @author Christian Fasanando
- * 
- * This class allows the maintenance of the tool glossary
+ * This library enables maintenance of the glossary tool
  */
- 
 /**
 * This function retrieves glossary details by course
 * @return	array Array of type ([glossary_id=>w,name=>x,description=>y],[])
@@ -14,9 +13,9 @@
 */
 
 function get_glossary_details() {
-	$t_glosary = Database :: get_course_table(TABLE_GLOSSARY);
-	$sql = "SELECT glossary_id,name,description
-			  FROM $t_glosary";
+	$t_glossary = Database :: get_course_table(TABLE_GLOSSARY);
+	$sql = "SELECT glossary_id, name, description
+			  FROM $t_glossary";
 
 	$result = api_sql_query($sql, __FILE__, __LINE__);
 	return $result;
@@ -31,15 +30,14 @@ function get_glossary_details() {
 * @version november 2008, dokeos 1.8.6
 */
 function add_glossary_details($name,$description) {
-	$t_glosary = Database :: get_course_table(TABLE_GLOSSARY);
+	$t_glossary = Database :: get_course_table(TABLE_GLOSSARY);
+    if (empty($name) || empty($description)) {
+        return false;
+    }
 	$safe_name = Database::escape_string($name);
 	$safe_description = Database::escape_string($description);
 	
-	if (empty($name) || empty($description)) {
-		return false;
-	}
-	
-	$sql = "INSERT INTO $t_glosary(name,description) VALUES('$safe_name' , '$safe_description')";
+	$sql = "INSERT INTO $t_glossary (name, description) VALUES('$safe_name', '$safe_description')";
 	$result = api_sql_query($sql, __FILE__, __LINE__);
 	return $result;
 } 
@@ -54,15 +52,15 @@ function add_glossary_details($name,$description) {
 * @version november 2008, dokeos 1.8.6
 */
 function edit_glossary_details($glossary_id,$name,$description) {
-	$t_glosary 			= Database :: get_course_table(TABLE_GLOSSARY);
+	$t_glossary 			= Database :: get_course_table(TABLE_GLOSSARY);
+
+    if (empty($glossary_id) || empty($name) || empty($description)) { return false; }
+
 	$safe_name 			= Database::escape_string($name);
 	$safe_description 	= Database::escape_string($description);
 	$safe_glossary_id 	= Database::escape_string($glossary_id);
-	
-	if (empty($name) || empty($description))return false;
-	
-	$sql = "UPDATE $t_glosary SET name='$safe_name' , description='$safe_description' WHERE glossary_id=$safe_glossary_id";
 
+	$sql = "UPDATE $t_glossary SET name='$safe_name', description='$safe_description' WHERE glossary_id=$safe_glossary_id";
 	$result = api_sql_query($sql, __FILE__, __LINE__);
 	return $result;
 }
@@ -76,11 +74,11 @@ function edit_glossary_details($glossary_id,$name,$description) {
 */
 
 function delete_glossary_details($glossary_id) {
-	$t_glosary 			= Database :: get_course_table(TABLE_GLOSSARY);	
+	$t_glossary 			= Database :: get_course_table(TABLE_GLOSSARY);	
 	$safe_glossary_id 	= Database::escape_string($glossary_id);
-			
-	$sql = "DELETE FROM $t_glosary  WHERE glossary_id=$safe_glossary_id";
+	if (empty($glossary_id)) { return false; }
 
+	$sql = "DELETE FROM $t_glossary WHERE glossary_id=$safe_glossary_id";
 	$result = api_sql_query($sql, __FILE__, __LINE__);
 	return $result;
-}  
\ No newline at end of file
+}
\ No newline at end of file
diff --git a/main/glossary/index.php b/main/glossary/index.php
index 66e3eeaa6a..ee9da0201f 100755
--- a/main/glossary/index.php
+++ b/main/glossary/index.php
@@ -1,26 +1,23 @@
-<?php
+<?php //$id: $
+/* For licensing terms, see /dokeos_license.txt */
 /**
- * Created on 15/10/2008
- * @Author Christian Fasanando
- * Show a glossary
- * 
+ * @package dokeos.glossary
+ * @author Christian Fasanando
+ * Glossary tool's user interface
  */
- 
- $language_file = array('glossary');
- require_once('../inc/global.inc.php');
- include('glossaryfunction.inc.php');
- $status = $_user['status'];
+$language_file = array('glossary');
+require_once('../inc/global.inc.php');
+require_once('glossaryfunction.inc.php');
+$status = $_user['status'];
 /*
------------------------------------------------------------
-	Header
------------------------------------------------------------
-*/
+ *	Header
+ */
 
 $htmlHeadXtra[] =
 "<script type=\"text/javascript\">
 function confirmation (name)
 {
-	if (confirm(\" ". get_lang("AreYouSureToDeleteThis") ." \"+ name + \" ?\"))
+	if (confirm(\" ". get_lang("TermConfirmDelete") ." \"+ name + \" ?\"))
 		{return true;}
 	else
 		{return false;}
@@ -35,92 +32,86 @@ $tool = TOOL_GLOSSARY;
 Display::display_header($tool);
 //---------------------------------------------------------
 
-if($status=='1') {
-	echo '<a href="index.php?action=addglossary"><img src="../img/filenew.gif" title ="'.get_lang('NewDescription').'">'.get_lang('NewDescription').'</a>';
+if ($status == 1) {
+	echo '<a href="index.php?action=addglossary"><img src="../img/filenew.gif" title ="'.get_lang('AddNewTerm').'">'.get_lang('AddNewTerm').'</a>';
 	
 	/*======================================
 				Form Glossary 
 	======================================*/
 	 
 	echo '<p><div>';
-	if ($_GET['action'] == 'addglossary'){
+	if ($_GET['action'] == 'addglossary') {
 		echo '<form name="frm_glossary" action="index.php">';
-		echo '<div class="term_glossary">'.get_lang('Name').'<br /><input type="text" name="name_glossary"></div>';
-		echo '<div class="definition_glossary">'.get_lang('Definition').'<br /><textarea cols="60" rows="5" maxlength="255" name="description_glossary"></textarea></div>';
-		echo '<div class="action_glossary"><input type="submit" value="'.get_lang('Ok').'"></div>';
+		echo '<div class="term_glossary">'.get_lang('TermName').'<br /><input type="text" name="name_glossary"></div>';
+		echo '<div class="definition_glossary">'.get_lang('TermDefinition').'<br /><textarea cols="60" rows="5" maxlength="255" name="description_glossary"></textarea></div>';
+		echo '<div class="action_glossary"><input type="submit" value="'.get_lang('TermAddButton').'"></div>';
 		echo '</form>';	
 	}
-	echo '</div><hr />';
+	echo '</div></p><hr />';
 }
 /*======================================
 			Add Glossary Details
 ======================================*/
  
-	$name_glossary = Security::remove_XSS($_GET['name_glossary']);
-	$description_glossary = Security::remove_XSS($_GET['description_glossary']);
-	$add_glossary = add_glossary_details($name_glossary,$description_glossary);
-	
-
+$name_glossary = Security::remove_XSS($_GET['name_glossary']);
+$description_glossary = Security::remove_XSS($_GET['description_glossary']);
+$add_glossary = add_glossary_details($name_glossary,$description_glossary);
 
 /*======================================
 			Edit Glossary Details
 ======================================*/		
 
-	$g_id = Security::remove_XSS($_GET['g_id']);
-	$n_glossary = Security::remove_XSS($_GET['n_glossary']);
-	$d_glossary = Security::remove_XSS($_GET['d_glossary']);
-	$edit_glossary = edit_glossary_details($g_id,$n_glossary,$d_glossary);
-			
+$g_id = Security::remove_XSS($_GET['g_id']);
+$n_glossary = Security::remove_XSS($_GET['n_glossary']);
+$d_glossary = Security::remove_XSS($_GET['d_glossary']);
+$edit_glossary = edit_glossary_details($g_id,$n_glossary,$d_glossary);
 
 /*======================================
 			Delete Glossary Details
 ======================================*/
 	
-		
-	if ($_GET['action'] == 'delete_glossary') {
+if ($_GET['action'] == 'delete_glossary') {
 	$g_id = Security::remove_XSS($_GET['glossary_id']);	
 	$delete_glossary = delete_glossary_details($g_id);
 	
-	Display::display_confirmation_message(get_lang('NameDeleted'));
-					
-	}
-
+	Display::display_confirmation_message(get_lang('TermDeleted'));
+}
 
 /*======================================
 			Display Glossary Details
 ======================================*/
 
-    $glossary_list=get_glossary_details();			
-	Database::num_rows($glossary_list);
-	echo '<p><div><dl>';
-	while ($row_glossary_list=Database::fetch_array($glossary_list)) {
-			
-			if ($_GET['action'] == 'edit_glossary' && $_GET['glossary_id']==$row_glossary_list['glossary_id']){				
-				echo '<body onload="text_focus()">';
-				echo '<form name="form_glossary" action="index.php">';
-				echo '<input type="hidden" name="g_id" value="'.Security::remove_XSS($_GET['glossary_id']).'"><dl>';
-				echo '<dt><strong>'.get_lang('Name').'</strong><br /><input type="text" name="n_glossary" value="'.$row_glossary_list['name'].'" onfocus="this.select()"></dt>';
-				echo '<dd><strong>'.get_lang('Definition').'</strong><br /><textarea cols="60" rows="5" maxlength="255" name="d_glossary" onfocus="this.select()">'.$row_glossary_list['description'].'</textarea><br>';
-				echo '<input type="submit" value="'.get_lang('OK').'"></dd><br>';
-				echo '</dl></form></body>';
-			}else{
-				echo '<dt><strong>'.$row_glossary_list['name'].'</strong></dt>';
-				echo '<dd>'.$row_glossary_list['description'].'<br><br>';			
-				$icon_edit ='edit.gif';
-				$icon_delete ='delete.gif';
-				if($status=='1'){
-				echo '<a href="index.php?action=edit_glossary&glossary_id='.$row_glossary_list['glossary_id'].'"><img src="../img/'.$icon_edit.'" title ="'.get_lang('Editar').'"></a>&nbsp;';
-				echo '<a href="index.php?action=delete_glossary&glossary_id='.$row_glossary_list['glossary_id'].'" onclick="return confirmation(\''.$row_glossary_list['name'].'\');"><img src="../img/'.$icon_delete.'" title ="'.get_lang('Eliminar').'"></a></dd><p>';
-				}
-			}			
-	}					
-	echo '</dl><br></p></div>';
-
-
+$glossary_list=get_glossary_details(); //returns a results resource		
+Database::num_rows($glossary_list);
+echo '<p><div><dl>';
+while ($row_glossary_list=Database::fetch_array($glossary_list)) {
+	if ( ($_GET['action'] == 'edit_glossary') && ($_GET['glossary_id'] == $row_glossary_list['glossary_id']) ) {				
+		echo '<body onload="text_focus()">';
+		echo '<form name="form_glossary" action="index.php">';
+		echo '<input type="hidden" name="g_id" value="'.Security::remove_XSS($_GET['glossary_id']).'">';
+        echo '<dl>';
+		echo '  <dt><strong>'.get_lang('TermName').'</strong><br />';
+        echo '    <input type="text" name="n_glossary" value="'.$row_glossary_list['name'].'" onfocus="this.select()">';
+        echo '  </dt>';
+		echo '  <dd><strong>'.get_lang('TermDefinition').'</strong><br /><textarea cols="60" rows="5" maxlength="255" name="d_glossary" onfocus="this.select()">'.$row_glossary_list['description'].'</textarea><br />';
+		echo '    <input type="submit" value="'.get_lang('TermUpdateButton').'">';
+        echo '  </dd><br />';
+		echo '</dl></form></body>';
+	} else {
+		echo '<dt><strong>'.$row_glossary_list['name'].'</strong></dt>';
+		echo '<dd>'.$row_glossary_list['description'].'<br /><br />';			
+		$icon_edit ='edit.gif';
+		$icon_delete ='delete.gif';
+		if ($status == 1) {
+		    echo '<a href="index.php?action=edit_glossary&glossary_id='.$row_glossary_list['glossary_id'].'"><img src="../img/'.$icon_edit.'" title ="'.get_lang('Editar').'"></a>&nbsp;';
+		    echo '<a href="index.php?action=delete_glossary&glossary_id='.$row_glossary_list['glossary_id'].'" onclick="return confirmation(\''.$row_glossary_list['name'].'\');"><img src="../img/'.$icon_delete.'" title ="'.get_lang('Eliminar').'"></a></dd><p>';
+		}
+	}			
+}					
+echo '</dl></p></div>';
 /*
 ==============================================================================
 		FOOTER
 ==============================================================================
 */
-Display::display_footer();
-?>
+Display::display_footer();
\ No newline at end of file