glossaryfunction.inc.php 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317
  1. <?php //$id: $
  2. /* For licensing terms, see /dokeos_license.txt */
  3. /**
  4. * @package dokeos.glossary
  5. * @author Christian Fasanando
  6. * This library enables maintenance of the glossary tool
  7. */
  8. /**
  9. * This function retrieves glossary details by course
  10. * and order by a type (1 = By Start Date, 2 = By End Date, 3 = By Term Name)
  11. * @return array Array of type ([glossary_id=>w,name=>x,description=>y],[])
  12. * @author Christian Fasanando <christian.fasanando@dokeos.com>,
  13. * @version november 2008, dokeos 1.8.6
  14. */
  15. function get_glossary_details($type) {
  16. $t_glossary = Database :: get_course_table(TABLE_GLOSSARY);
  17. $t_item_propery = Database :: get_course_table(TABLE_ITEM_PROPERTY);
  18. $safe_type = (int)$type;
  19. if (!empty($safe_type) && $safe_type==1) {
  20. $sql = "SELECT g.glossary_id, g.name, g.description, g.display_order
  21. FROM $t_glossary g,$t_item_propery ip WHERE g.glossary_id=ip.ref AND tool = '".TOOL_GLOSSARY."' ORDER BY ip.insert_date DESC ";
  22. } elseif (!empty($safe_type) && $safe_type==2) {
  23. $sql = "SELECT g.glossary_id, g.name, g.description, g.display_order
  24. FROM $t_glossary g,$t_item_propery ip WHERE g.glossary_id=ip.ref AND tool = '".TOOL_GLOSSARY."' ORDER BY ip.lastedit_date DESC ";
  25. } elseif (!empty($safe_type) && $safe_type==3) {
  26. $sql = "SELECT g.glossary_id, g.name, g.description, g.display_order
  27. FROM $t_glossary g,$t_item_propery ip WHERE g.glossary_id=ip.ref AND tool = '".TOOL_GLOSSARY."' ORDER BY g.name ASC ";
  28. } else {
  29. $sql = "SELECT g.glossary_id, g.name, g.description, g.display_order
  30. FROM $t_glossary g,$t_item_propery ip WHERE g.glossary_id=ip.ref AND tool = '".TOOL_GLOSSARY."' ORDER BY g.display_order,g.name ASC ";
  31. }
  32. $result = api_sql_query($sql, __FILE__, __LINE__);
  33. return $result;
  34. }
  35. /**
  36. * This function add glosary details by course
  37. * @param name type String
  38. * @param description type String
  39. * @return String (message about the results)
  40. * @author Christian Fasanando <christian.fasanando@dokeos.com>,
  41. * @version november 2008, dokeos 1.8.6
  42. */
  43. function add_glossary_details($name,$description) {
  44. $t_glossary = Database :: get_course_table(TABLE_GLOSSARY);
  45. if (empty($name) || empty($description)) { return false; }
  46. $safe_name = Database::escape_string($name);
  47. $safe_description = Database::escape_string($description);
  48. $get_max = "SELECT MAX(display_order) FROM $t_glossary";
  49. $res_max = api_sql_query($get_max, __FILE__, __LINE__);
  50. $dsp=0;
  51. if (Database::num_rows($res_max)<1) {
  52. $dsp = 1;
  53. } else {
  54. $row = Database::fetch_array($res_max);
  55. $dsp = $row[0]+1;
  56. }
  57. $safe_dsp = (int)$dsp;
  58. // check if term name exists
  59. $sql = "SELECT name FROM $t_glossary WHERE name = '$safe_name'";
  60. $result = @api_sql_query($sql,__FILE__,__LINE__);
  61. $count = Database::num_rows($result);
  62. $msg='';
  63. if ($count > 0) {
  64. $msg='error';
  65. return $msg;
  66. } else {
  67. $sql = "INSERT INTO $t_glossary (name, description,display_order) VALUES('$safe_name', '$safe_description',$safe_dsp)";
  68. $result = api_sql_query($sql, __FILE__, __LINE__);
  69. $id = Database::get_last_insert_id();
  70. if ($id>0) {
  71. //insert into item_property
  72. api_item_property_update(api_get_course_info(),TOOL_GLOSSARY,$id,'GlossaryAdded',api_get_user_id());
  73. }
  74. $msg='ok';
  75. return $msg;
  76. }
  77. }
  78. /**
  79. * This function edit glosary details by course
  80. * @param glossary_id int
  81. * @param name type String
  82. * @param description type String
  83. * @return String (message about the results)
  84. * @author Christian Fasanando <christian.fasanando@dokeos.com>,
  85. * @version november 2008, dokeos 1.8.6
  86. */
  87. function edit_glossary_details($glossary_id,$name,$description) {
  88. $t_glossary = Database :: get_course_table(TABLE_GLOSSARY);
  89. if (empty($glossary_id) || empty($name) || empty($description)) { return false; }
  90. $safe_name = Database::escape_string($name);
  91. $safe_description = Database::escape_string($description);
  92. $safe_glossary_id = (int)$glossary_id;
  93. // check if term name exists
  94. $sql = "SELECT name FROM $t_glossary WHERE name = '$safe_name' AND glossary_id NOT IN($safe_glossary_id)";
  95. $result = @api_sql_query($sql,__FILE__,__LINE__);
  96. $count = Database::num_rows($result);
  97. $msg='';
  98. if ($count > 0) {
  99. $msg='error';
  100. return $msg;
  101. } else {
  102. $sql = "UPDATE $t_glossary SET name='$safe_name', description='$safe_description' WHERE glossary_id=$safe_glossary_id";
  103. $result = api_sql_query($sql, __FILE__, __LINE__);
  104. //update glossary into item_property
  105. api_item_property_update(api_get_course_info(),TOOL_GLOSSARY,$safe_glossary_id,'GlossaryModified',api_get_user_id());
  106. $msg ='ok';
  107. return $msg;
  108. }
  109. }
  110. /**
  111. * This function delete glossary details by course
  112. * @param glossary_id int
  113. * @return boolean
  114. * @author Christian Fasanando <christian.fasanando@dokeos.com>,
  115. * @version november 2008, dokeos 1.8.6
  116. */
  117. function delete_glossary_details($glossary_id) {
  118. $t_glossary = Database :: get_course_table(TABLE_GLOSSARY);
  119. $safe_glossary_id = Database::escape_string($glossary_id);
  120. if (empty($glossary_id)) { return false; }
  121. $sql = "DELETE FROM $t_glossary WHERE glossary_id=$safe_glossary_id";
  122. $result = api_sql_query($sql, __FILE__, __LINE__);
  123. // update display_order
  124. $sql = "SELECT * FROM $t_glossary";
  125. $result = api_sql_query($sql, __FILE__, __LINE__);
  126. $dsp=1;
  127. while ($row=Database::fetch_array($result)) {
  128. $id = $row['glossary_id'];
  129. update_display_order($dsp,$id);
  130. $dsp++;
  131. }
  132. //update glossary into item_property
  133. api_item_property_update(api_get_course_info(),TOOL_GLOSSARY,$safe_glossary_id,'GlossaryDeleted',api_get_user_id());
  134. return $result;
  135. }
  136. /**
  137. * This function update glossary display order
  138. * @param $n_order int
  139. * @param $glossary_id int
  140. *
  141. */
  142. function update_display_order($n_order,$glossary_id) {
  143. $t_glossary = Database::get_course_table(TABLE_GLOSSARY);
  144. $safe_n_order = (int)$n_order;
  145. $safe_glossary_id = (int)$glossary_id;
  146. if (empty($n_order) || empty($glossary_id)) {
  147. return false;
  148. }
  149. $sql = "UPDATE $t_glossary SET display_order = $safe_n_order WHERE glossary_id = $safe_glossary_id";
  150. $result = @api_sql_query($sql,__FILE__,__LINE__);
  151. return $result;
  152. }
  153. /**
  154. * Move a term up (display_order)
  155. * @param integer Glossary ID
  156. */
  157. function move_up($glossary_id)
  158. {
  159. $tbl_glossary = Database::get_course_table(TABLE_GLOSSARY);
  160. $sql = "SELECT * FROM $tbl_glossary ORDER BY display_order";
  161. $res = api_sql_query($sql, __FILE__, __LINE__);
  162. if ($res === false) {
  163. return false;
  164. }
  165. $gs = array();
  166. $g_order = array();
  167. $num = Database::num_rows($res);
  168. //first check the order is correct, globally (might be wrong because
  169. //of versions < 1.8.4)
  170. if ($num > 0) {
  171. $i = 1;
  172. while ($row = Database::fetch_array($res)) {
  173. if ($row['display_order'] != $i) { //if we find a gap in the order, we need to fix it
  174. $need_fix = true;
  175. $sql_u = "UPDATE $tbl_glossary SET display_order = $i WHERE glossary_id = ".$row['glossary_id'];
  176. $res_u = api_sql_query($sql_u, __FILE__, __LINE__);
  177. }
  178. $row['display_order'] = $i;
  179. $gs[$row['glossary_id']] = $row;
  180. $g_order[$i] = $row['glossary_id'];
  181. $i++;
  182. }
  183. }
  184. if($num>1) {
  185. //if there's only one element, no need to sort
  186. $order = $gs[$glossary_id]['display_order'];
  187. if ($order>1) {
  188. //if it's the first element, no need to move up
  189. $sql_u1 = "UPDATE $tbl_glossary SET display_order = $order WHERE glossary_id = ".$g_order[$order-1];
  190. $res_u1 = api_sql_query($sql_u1, __FILE__, __LINE__);
  191. $sql_u2 = "UPDATE $tbl_glossary SET display_order = ".($order-1)." WHERE glossary_id = ".$glossary_id;
  192. $res_u2 = api_sql_query($sql_u2, __FILE__, __LINE__);
  193. }
  194. }
  195. }
  196. /**
  197. * Move a term down (display_order)
  198. * @param integer Glossary ID
  199. */
  200. function move_down($glossary_id)
  201. {
  202. $tbl_glossary = Database::get_course_table(TABLE_GLOSSARY);
  203. $sql = "SELECT * FROM $tbl_glossary ORDER BY display_order";
  204. $res = api_sql_query($sql, __FILE__, __LINE__);
  205. if ($res === false) {
  206. return false;
  207. }
  208. $gs = array();
  209. $g_order = array();
  210. $num = Database::num_rows($res);
  211. $max = 0;
  212. //first check the order is correct, globally (might be wrong because
  213. //of versions < 1.8.4)
  214. if ($num>0) {
  215. $i = 1;
  216. while ($row = Database::fetch_array($res)) {
  217. $max = $i;
  218. if ($row['display_order'] != $i) {
  219. //if we find a gap in the order, we need to fix it
  220. $need_fix = true;
  221. $sql_u = "UPDATE $tbl_glossary SET display_order = $i WHERE glossary_id = ".$row['glossary_id'];
  222. $res_u = api_sql_query($sql_u, __FILE__, __LINE__);
  223. }
  224. $row['display_order'] = $i;
  225. $gs[$row['glossary_id']] = $row;
  226. $g_order[$i] = $row['glossary_id'];
  227. $i++;
  228. }
  229. }
  230. if ($num>1) {
  231. //if there's only one element, no need to sort
  232. $order = $gs[$glossary_id]['display_order'];
  233. if($order<$max) {
  234. //if it's the first element, no need to move up
  235. $sql_u1 = "UPDATE $tbl_glossary SET display_order = $order WHERE glossary_id = ".$g_order[$order+1];
  236. $res_u1 = api_sql_query($sql_u1, __FILE__, __LINE__);
  237. $sql_u2 = "UPDATE $tbl_glossary SET display_order = ".($order+1)." WHERE glossary_id = ".$glossary_id;
  238. $res_u2 = api_sql_query($sql_u2, __FILE__, __LINE__);
  239. }
  240. }
  241. }
  242. /**
  243. * returns all the javascript that is required in glossary/index.php
  244. * this goes into the $htmlHeadXtra[] array
  245. */
  246. function to_javascript_glossary() {
  247. return "<script type=\"text/javascript\">
  248. function confirmation (name)
  249. {
  250. if (confirm(\" ". get_lang("TermConfirmDelete") ." \"+ name + \" ?\"))
  251. {return true;}
  252. else
  253. {return false;}
  254. }
  255. function add_glossary() {
  256. err_msg_term_name = '".get_lang("YouMustEnterATermName")."';
  257. err_msg_term_def = '".get_lang("YouMustEnterATermDefinition")."';
  258. if(document.frm_add_glossary.name_glossary.value=='') {
  259. document.getElementById('err_msg_add_term_name').style.display='block';
  260. document.getElementById('err_msg_add_term_name').innerHTML = err_msg_term_name;
  261. } else if(document.frm_add_glossary.description_glossary.value=='') {
  262. document.getElementById('err_msg_add_term_def').style.display='block';
  263. document.getElementById('err_msg_add_term_def').innerHTML = err_msg_term_def;
  264. } else {
  265. document.frm_add_glossary.submit();
  266. }
  267. }
  268. function edit_glossary() {
  269. err_msg_term_name = '".get_lang("YouMustEnterATermName")."';
  270. err_msg_term_def = '".get_lang("YouMustEnterATermDefinition")."';
  271. if(document.frm_edit_glossary.n_glossary.value=='') {
  272. document.getElementById('err_msg_edit_term_name').style.display='block';
  273. document.getElementById('err_msg_edit_term_name').innerHTML = err_msg_term_name;
  274. } else if(document.frm_edit_glossary.d_glossary.value=='') {
  275. document.getElementById('err_msg_edit_term_def').style.display='block';
  276. document.getElementById('err_msg_edit_term_def').innerHTML = err_msg_term_def;
  277. } else {
  278. document.frm_edit_glossary.submit();
  279. }
  280. }
  281. function add_cancel_glossary(){
  282. document.frm_add_glossary.name_glossary.value='';
  283. document.frm_add_glossary.description_glossary.value='';
  284. document.frm_add_glossary.submit();
  285. }
  286. function edit_cancel_glossary(){
  287. document.frm_edit_glossary.n_glossary.value='';
  288. document.frm_edit_glossary.d_glossary.value='';
  289. document.frm_edit_glossary.g_id.value='';
  290. document.frm_edit_glossary.submit();
  291. }
  292. </script>";
  293. }