display.lib.php 57 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312
  1. <?php
  2. /* For licensing terms, see /license.txt */
  3. /**
  4. * This is a display library for Chamilo.
  5. *
  6. * Include/require it in your code to use its public functionality.
  7. * There are also several display public functions in the main api library.
  8. *
  9. * All public functions static public functions inside a class called Display,
  10. * so you use them like this: e.g.
  11. * Display::display_normal_message($message)
  12. *
  13. * @package chamilo.library
  14. */
  15. /**
  16. * Display class
  17. * contains several public functions dealing with the display of
  18. * table data, messages, help topics, ...
  19. *
  20. * @package chamilo.library
  21. */
  22. class Display {
  23. private function __construct() {
  24. }
  25. /**
  26. * Displays the tool introduction of a tool.
  27. *
  28. * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
  29. * @param string $tool These are the constants that are used for indicating the tools.
  30. * @param array $editor_config Optional configuration settings for the online editor.
  31. * @return $tool return a string array list with the "define" in main_api.lib
  32. * @return html code for adding an introduction
  33. */
  34. public static function display_introduction_section($tool, $editor_config = null) {
  35. $is_allowed_to_edit = api_is_allowed_to_edit();
  36. $moduleId = $tool;
  37. if (api_get_setting('enable_tool_introduction') == 'true' || $tool == TOOL_COURSE_HOMEPAGE) {
  38. require api_get_path(INCLUDE_PATH).'introductionSection.inc.php';
  39. }
  40. }
  41. /**
  42. * Displays a localised html file
  43. * tries to show the file "$full_file_name"."_".$language_interface.".html"
  44. * and if this does not exist, shows the file "$full_file_name".".html"
  45. * warning this public function defines a global
  46. * @param $full_file_name, the (path) name of the file, without .html
  47. * @return return a string with the path
  48. */
  49. public static function display_localised_html_file($full_file_name) {
  50. global $language_interface;
  51. $localised_file_name = $full_file_name.'_'.$language_interface.'.html';
  52. $default_file_name = $full_file_name.'.html';
  53. if (file_exists($localised_file_name)) {
  54. include $localised_file_name;
  55. } else {
  56. include ($default_file_name);
  57. }
  58. }
  59. /**
  60. * Display simple html header of table.
  61. * @deprecated
  62. */
  63. /*public static function display_table_header() {
  64. $bgcolor = 'bgcolor="white"';
  65. echo '<table border="0" cellspacing="0" cellpadding="4" width="85%"><tbody>';
  66. return $bgcolor;
  67. }*/
  68. /**
  69. * Display html header of table with several options.
  70. *
  71. * @param $properties, array with elements, all of which have defaults
  72. * "width" - the table width, e.g. "100%", default is 85%
  73. * "class" - the class to use for the table, e.g. "class=\"data_table\""
  74. * "cellpadding" - the extra border in each cell, e.g. "8",default is 4
  75. * "cellspacing" - the extra space between cells, default = 0
  76. * @param column_header, array with the header elements.
  77. * @author Roan Embrechts
  78. * @version 1.01
  79. * @todo remove this function, is only use in user.php
  80. * @return return type string, bgcolor
  81. */
  82. public static function display_complex_table_header($properties, $column_header) {
  83. $width = $properties['width'];
  84. if (!isset($width)) {
  85. $width = '85%';
  86. }
  87. $class = $properties['class'];
  88. if (!isset($class)) {
  89. $class = 'class="data_table"';
  90. }
  91. $cellpadding = $properties['cellpadding'];
  92. if (!isset($cellpadding)) {
  93. $cellpadding = '4';
  94. }
  95. $cellspacing = $properties['cellspacing'];
  96. if (!isset ($cellspacing)) {
  97. $cellspacing = '0';
  98. }
  99. //... add more properties as you see fit
  100. //api_display_debug_info("Light grey is " . DOKEOSLIGHTGREY);
  101. $bgcolor = 'bgcolor="'.DOKEOSLIGHTGREY.'"';
  102. echo '<table '.$class.' border="0" cellspacing="$cellspacing" cellpadding="'.$cellpadding.'" width="'.$width.'">'."\n";
  103. echo '<thead><tr '.$bgcolor.'>';
  104. foreach ($column_header as & $table_element) {
  105. echo '<th>'.$table_element.'</th>';
  106. }
  107. echo "</tr></thead>\n";
  108. echo "<tbody>\n";
  109. $bgcolor = 'bgcolor="'.HTML_WHITE.'"';
  110. return $bgcolor;
  111. }
  112. /**
  113. * Displays a table row.
  114. *
  115. * @param $bgcolor the background colour for the table
  116. * @param $table_row an array with the row elements
  117. * @param $is_alternating true: the row colours alternate, false otherwise
  118. * @todo remove this function, is only use in user.php
  119. */
  120. public static function display_table_row($bgcolor, $table_row, $is_alternating = true) {
  121. echo '<tr '.$bgcolor.'>';
  122. foreach ($table_row as & $table_element) {
  123. echo '<td>'.$table_element.'</td>';
  124. }
  125. echo "</tr>\n";
  126. if ($is_alternating) {
  127. if ($bgcolor == 'bgcolor="'.HTML_WHITE.'"') {
  128. $bgcolor = 'bgcolor="'.DOKEOSLIGHTGREY.'"';
  129. } elseif ($bgcolor == 'bgcolor="'.DOKEOSLIGHTGREY.'"') {
  130. $bgcolor = 'bgcolor="'.HTML_WHITE.'"';
  131. }
  132. }
  133. return $bgcolor;
  134. }
  135. /**
  136. * Displays a table
  137. * @param array $header Titles for the table header
  138. * each item in this array can contain 3 values
  139. * - 1st element: the column title
  140. * - 2nd element: true or false (column sortable?)
  141. * - 3th element: additional attributes for
  142. * th-tag (eg for column-width)
  143. * - 4the element: additional attributes for the td-tags
  144. * @param array $content 2D-array with the tables content
  145. * @param array $sorting_options Keys are:
  146. * 'column' = The column to use as sort-key
  147. * 'direction' = SORT_ASC or SORT_DESC
  148. * @param array $paging_options Keys are:
  149. * 'per_page_default' = items per page when switching from
  150. * full- list to per-page-view
  151. * 'per_page' = number of items to show per page
  152. * 'page_nr' = The page to display
  153. * @param array $query_vars Additional variables to add in the query-string
  154. * @param string The style that the table will show. You can set 'table' or 'grid'
  155. * @author bart.mollet@hogent.be
  156. */
  157. public static function display_sortable_table($header, $content, $sorting_options = array(), $paging_options = array(), $query_vars = null, $form_actions = array(), $style = 'table') {
  158. if (!class_exists('SortableTable')) {
  159. require_once 'sortabletable.class.php';
  160. }
  161. global $origin;
  162. $column = isset($sorting_options['column']) ? $sorting_options['column'] : 0;
  163. $default_items_per_page = isset($paging_options['per_page']) ? $paging_options['per_page'] : 20;
  164. $table = new SortableTableFromArray($content, $column, $default_items_per_page);
  165. if (is_array($query_vars)) {
  166. $table->set_additional_parameters($query_vars);
  167. }
  168. if ($style == 'table') {
  169. if (is_array($header) && count($header) > 0) {
  170. foreach ($header as $index => $header_item) {
  171. $table->set_header($index, $header_item[0], $header_item[1], $header_item[2], $header_item[3]);
  172. }
  173. }
  174. $table->set_form_actions($form_actions);
  175. $table->display();
  176. } else {
  177. $table->display_grid();
  178. }
  179. }
  180. /**
  181. * Shows a nice grid
  182. * @param string grid name (important to create css)
  183. * @param array header content
  184. * @param array array with the information to show
  185. * @param array $paging_options Keys are:
  186. * 'per_page_default' = items per page when switching from
  187. * full- list to per-page-view
  188. * 'per_page' = number of items to show per page
  189. * 'page_nr' = The page to display
  190. * 'hide_navigation' = true to hide the navigation
  191. * @param array $query_vars Additional variables to add in the query-string
  192. * @param array $form actions Additional variables to add in the query-string
  193. * @param mixed An array with bool values to know which columns show. i.e: $visibility_options= array(true, false) we will only show the first column
  194. * Can be also only a bool value. TRUE: show all columns, FALSE: show nothing
  195. */
  196. public static function display_sortable_grid($name, $header, $content, $paging_options = array(), $query_vars = null, $form_actions = array(), $visibility_options = true, $sort_data = true) {
  197. echo self::return_sortable_grid($name, $header, $content, $paging_options, $query_vars, $form_actions, $visibility_options, $sort_data);
  198. }
  199. /**
  200. * Gets a nice grid in html string
  201. * @param string grid name (important to create css)
  202. * @param array header content
  203. * @param array array with the information to show
  204. * @param array $paging_options Keys are:
  205. * 'per_page_default' = items per page when switching from
  206. * full- list to per-page-view
  207. * 'per_page' = number of items to show per page
  208. * 'page_nr' = The page to display
  209. * 'hide_navigation' = true to hide the navigation
  210. * @param array $query_vars Additional variables to add in the query-string
  211. * @param array $form actions Additional variables to add in the query-string
  212. * @param mixed An array with bool values to know which columns show. i.e: $visibility_options= array(true, false) we will only show the first column
  213. * Can be also only a bool value. TRUE: show all columns, FALSE: show nothing
  214. * @param bool true for sorting data or false otherwise
  215. * @return string html grid
  216. */
  217. public static function return_sortable_grid($name, $header, $content, $paging_options = array(), $query_vars = null, $form_actions = array(), $visibility_options = true, $sort_data = true) {
  218. if (!class_exists('SortableTable')) {
  219. require_once 'sortabletable.class.php';
  220. }
  221. global $origin;
  222. $column = 0;
  223. $default_items_per_page = isset($paging_options['per_page']) ? $paging_options['per_page'] : 20;
  224. $table = new SortableTableFromArray($content, $column, $default_items_per_page, $name);
  225. if (is_array($query_vars)) {
  226. $table->set_additional_parameters($query_vars);
  227. }
  228. return $table->display_simple_grid($visibility_options, $paging_options['hide_navigation'], $default_items_per_page, $sort_data);
  229. }
  230. /**
  231. * Displays a table with a special configuration
  232. * @param array $header Titles for the table header
  233. * each item in this array can contain 3 values
  234. * - 1st element: the column title
  235. * - 2nd element: true or false (column sortable?)
  236. * - 3th element: additional attributes for
  237. * th-tag (eg for column-width)
  238. * - 4the element: additional attributes for the td-tags
  239. * @param array $content 2D-array with the tables content
  240. * @param array $sorting_options Keys are:
  241. * 'column' = The column to use as sort-key
  242. * 'direction' = SORT_ASC or SORT_DESC
  243. * @param array $paging_options Keys are:
  244. * 'per_page_default' = items per page when switching from
  245. * full- list to per-page-view
  246. * 'per_page' = number of items to show per page
  247. * 'page_nr' = The page to display
  248. * @param array $query_vars Additional variables to add in the query-string
  249. * @param array $column_show Array of binaries 1= show columns 0. hide a column
  250. * @param array $column_order An array of integers that let us decide how the columns are going to be sort.
  251. * i.e: $column_order=array('1''4','3','4'); The 2nd column will be order like the 4th column
  252. * @param array $form_actions Set optional forms actions
  253. *
  254. * @author Julio Montoya
  255. */
  256. public static function display_sortable_config_table($table_name, $header, $content, $sorting_options = array(), $paging_options = array(), $query_vars = null, $column_show = array(), $column_order = array(), $form_actions = array()) {
  257. if (!class_exists('SortableTable')) {
  258. require_once 'sortabletable.class.php';
  259. }
  260. global $origin;
  261. $column = isset($sorting_options['column']) ? $sorting_options['column'] : 0;
  262. $default_items_per_page = isset($paging_options['per_page']) ? $paging_options['per_page'] : 20;
  263. $table = new SortableTableFromArrayConfig($content, $column, $default_items_per_page, $table_name, $column_show, $column_order);
  264. if (is_array($query_vars)) {
  265. $table->set_additional_parameters($query_vars);
  266. }
  267. // Show or hide the columns header
  268. if (is_array($column_show)) {
  269. for ($i = 0; $i < count($column_show); $i++) {
  270. if (!empty($column_show[$i])) {
  271. $val0 = isset($header[$i][0]) ? $header[$i][0] : null;
  272. $val1 = isset($header[$i][1]) ? $header[$i][1] : null;
  273. $val2 = isset($header[$i][2]) ? $header[$i][2] : null;
  274. $val3 = isset($header[$i][3]) ? $header[$i][3] : null;
  275. $table->set_header($i, $val0, $val1, $val2, $val3);
  276. }
  277. }
  278. }
  279. $table->set_form_actions($form_actions);
  280. $table->display();
  281. }
  282. /**
  283. * Displays a normal message. It is recommended to use this public function
  284. * to display any normal information messages.
  285. *
  286. * @author Roan Embrechts
  287. * @param string $message - include any additional html
  288. * tags if you need them
  289. * @param bool Filter (true) or not (false)
  290. * @return void
  291. */
  292. public static function display_normal_message($message, $filter = true) {
  293. if ($filter) {
  294. // Filter message
  295. $message = api_htmlentities($message, ENT_QUOTES, api_is_xml_http_request() ? 'UTF-8' : api_get_system_encoding());
  296. }
  297. if (!headers_sent()) {
  298. echo '
  299. <style type="text/css" media="screen, projection">
  300. /*<![CDATA[*/
  301. @import "'.api_get_path(WEB_CODE_PATH).'css/default.css";
  302. /*]]>*/
  303. </style>'; // TODO: There is no "default.css" file in this location.
  304. }
  305. echo '<div class="normal-message">';
  306. //Display :: display_icon('message_normal.gif', get_lang('InfoMessage'), array ('style' => 'float:left; margin-right:10px;'));
  307. /*
  308. get_lang('InfoMessage', array ('style' => 'float:left; margin-right:10px;'));
  309. */
  310. echo $message.'</div>';
  311. }
  312. /**
  313. * Displays an warning message. Use this if you want to draw attention to something
  314. * This can also be used for instance with the hint in the exercises
  315. *
  316. * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
  317. * @param string $message
  318. * @param bool Filter (true) or not (false)
  319. * @return void
  320. */
  321. public static function display_warning_message($message, $filter = true) {
  322. if ($filter){
  323. // Filter message
  324. $message = api_htmlentities($message, ENT_QUOTES, api_is_xml_http_request() ? 'UTF-8' : api_get_system_encoding());
  325. }
  326. if (!headers_sent()) {
  327. echo '
  328. <style type="text/css" media="screen, projection">
  329. /*<![CDATA[*/
  330. @import "'.api_get_path(WEB_CODE_PATH).'css/default.css";
  331. /*]]>*/
  332. </style>'; // TODO: There is no "default.css" file in this location.
  333. }
  334. echo '<div class="warning-message">';
  335. //Display :: display_icon('message_warning.png', get_lang('WarningMessage'), array ('style' => 'float:left; margin-right:10px;'));
  336. /*
  337. get_lang('WarningMessage', array ('style' => 'float:left; margin-right:10px;'));
  338. */
  339. echo $message.'</div>';
  340. }
  341. /**
  342. * Displays an confirmation message. Use this if something has been done successfully
  343. *
  344. * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
  345. * @param string $message
  346. * @param bool Filter (true) or not (false)
  347. * @return void
  348. */
  349. public static function display_confirmation_message ($message, $filter = true) {
  350. if ($filter){
  351. // Filter message
  352. $message = api_htmlentities($message, ENT_QUOTES, api_is_xml_http_request() ? 'UTF-8' : api_get_system_encoding());
  353. }
  354. if (!headers_sent()) {
  355. echo '
  356. <style type="text/css" media="screen, projection">
  357. /*<![CDATA[*/
  358. @import "'.api_get_path(WEB_CODE_PATH).'css/default.css";
  359. /*]]>*/
  360. </style>'; // TODO: There is no "default.css" file in this location.
  361. }
  362. echo '<div class="confirmation-message">';
  363. //Display :: display_icon('message_confirmation.gif', get_lang('ConfirmationMessage'), array ('style' => 'float:left; margin-right:10px;margin-left:5px;'));
  364. /*
  365. get_lang('ConfirmationMessage', array ('style' => 'float:left; margin-right:10px;margin-left:5px;'));
  366. */
  367. echo $message.'</div>';
  368. }
  369. /**
  370. * Displays an error message. It is recommended to use this public function if an error occurs
  371. *
  372. * @author Hugues Peeters
  373. * @author Roan Embrechts
  374. * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
  375. * @param string $message - include any additional html
  376. * tags if you need them
  377. * @param bool Filter (true) or not (false)
  378. * @return void
  379. */
  380. public static function display_error_message ($message, $filter = true) {
  381. if($filter){
  382. // Filter message
  383. $message = api_htmlentities($message, ENT_QUOTES, api_is_xml_http_request() ? 'UTF-8' : api_get_system_encoding());
  384. }
  385. if (!headers_sent()) {
  386. echo '
  387. <style type="text/css" media="screen, projection">
  388. /*<![CDATA[*/
  389. @import "'.api_get_path(WEB_CODE_PATH).'css/default.css";
  390. /*]]>*/
  391. </style>'; // TODO: There is no "default.css" file in this location.
  392. }
  393. echo '<div class="error-message">'.$message.'</div>';
  394. }
  395. /**
  396. * Returns a div html string with
  397. */
  398. public function return_message($message, $type='normal', $filter = true) {
  399. if ($filter) {
  400. $message = Security::remove_XSS($message);
  401. }
  402. switch($type) {
  403. case 'warning':
  404. $class = 'warning-message';
  405. break;
  406. case 'error':
  407. $class = 'error-message';
  408. break;
  409. case 'normal':
  410. case 'confirmation-message':
  411. default:
  412. $class = 'normal-message';
  413. }
  414. return self::div($message, array('class'=>$class));
  415. }
  416. /**
  417. * Returns an encrypted mailto hyperlink
  418. *
  419. * @param - $email (string) - e-mail
  420. * @param - $text (string) - clickable text
  421. * @param - $style_class (string) - optional, class from stylesheet
  422. * @return - encrypted mailto hyperlink
  423. */
  424. public static function encrypted_mailto_link ($email, $clickable_text = null, $style_class = '') {
  425. if (is_null($clickable_text)) {
  426. $clickable_text = $email;
  427. }
  428. // "mailto:" already present?
  429. if (substr($email, 0, 7) != 'mailto:') {
  430. $email = 'mailto:'.$email;
  431. }
  432. // Class (stylesheet) defined?
  433. if ($style_class != '') {
  434. $style_class = ' class="'.$style_class.'"';
  435. }
  436. // Encrypt email
  437. $hmail = '';
  438. for ($i = 0; $i < strlen($email); $i ++) {
  439. $hmail .= '&#'.ord($email {
  440. $i }).';';
  441. }
  442. // Encrypt clickable text if @ is present
  443. if (strpos($clickable_text, '@')) {
  444. for ($i = 0; $i < strlen($clickable_text); $i ++) {
  445. $hclickable_text .= '&#'.ord($clickable_text {
  446. $i }).';';
  447. }
  448. } else {
  449. $hclickable_text = @htmlspecialchars($clickable_text, ENT_QUOTES, api_get_system_encoding());
  450. }
  451. // Return encrypted mailto hyperlink
  452. return '<a href="'.$hmail.'"'.$style_class.' name="clickable_email_link">'.$hclickable_text.'</a>';
  453. }
  454. /**
  455. * Creates a hyperlink to the platform homepage.
  456. * @param string $name, the visible name of the hyperlink, default is sitename
  457. * @return string with html code for hyperlink
  458. */
  459. public static function get_platform_home_link_html($name = '') {
  460. if ($name == '') {
  461. $name = api_get_setting('siteName');
  462. }
  463. return '<a href="'.api_get_path(WEB_PATH).'index.php">'.$name.'</a>';
  464. }
  465. /**
  466. * Displays the page header
  467. * @param string The name of the page (will be showed in the page title)
  468. * @param string Optional help file name
  469. */
  470. public static function display_header($tool_name ='', $help = null) {
  471. $nameTools = $tool_name;
  472. global $_plugins, $lp_theme_css, $mycoursetheme, $user_theme, $platform_theme;
  473. global $httpHeadXtra, $htmlHeadXtra, $htmlIncHeadXtra, $_course, $_user, $clarolineRepositoryWeb, $text_dir, $plugins, $_user, $rootAdminWeb, $_cid, $interbreadcrumb, $charset, $language_file, $noPHP_SELF;
  474. global $menu_navigation;
  475. require api_get_path(INCLUDE_PATH).'header.inc.php';
  476. }
  477. /**
  478. * Displays the reduced page header (without banner)
  479. */
  480. public static function display_reduced_header () {
  481. global $_plugins, $lp_theme_css, $mycoursetheme, $user_theme, $platform_theme;
  482. global $httpHeadXtra, $htmlHeadXtra, $htmlIncHeadXtra, $_course, $_user, $clarolineRepositoryWeb, $text_dir, $plugins, $_user, $rootAdminWeb, $_cid, $interbreadcrumb, $charset, $language_file, $noPHP_SELF, $language_interface;
  483. global $menu_navigation;
  484. require api_get_path(INCLUDE_PATH).'reduced_header.inc.php';
  485. }
  486. /**
  487. * Display the page footer
  488. */
  489. public static function display_footer () {
  490. global $_plugins;
  491. require api_get_path(INCLUDE_PATH).'footer.inc.php';
  492. }
  493. /**
  494. * Prints an <option>-list with all letters (A-Z).
  495. * @param char $selected_letter The letter that should be selected
  496. * @todo This is English language specific implementation. It should be adapted for the other languages.
  497. */
  498. public static function get_alphabet_options($selected_letter = '') {
  499. $result = '';
  500. for ($i = 65; $i <= 90; $i ++) {
  501. $letter = chr($i);
  502. $result .= '<option value="'.$letter.'"';
  503. if ($selected_letter == $letter) {
  504. $result .= ' selected="selected"';
  505. }
  506. $result .= '>'.$letter.'</option>';
  507. }
  508. return $result;
  509. }
  510. public static function get_numeric_options($min, $max, $selected_num = 0) {
  511. $result = '';
  512. for ($i = $min; $i <= $max; $i ++) {
  513. $result .= '<option value="'.$i.'"';
  514. if (is_int($selected_num))
  515. if ($selected_num == $i) {
  516. $result .= ' selected="selected"';
  517. }
  518. $result .= '>'.$i.'</option>';
  519. }
  520. return $result;
  521. }
  522. /**
  523. * Shows the so-called "left" menu for navigating
  524. */
  525. public static function show_course_navigation_menu($isHidden = false) {
  526. global $output_string_menu;
  527. global $_setting;
  528. // Check if the $_SERVER['REQUEST_URI'] contains already url parameters (thus a questionmark)
  529. if (strpos($_SERVER['REQUEST_URI'], '?') === false) {
  530. $sourceurl = api_get_self().'?';
  531. } else {
  532. $sourceurl = $_SERVER['REQUEST_URI'];
  533. }
  534. $output_string_menu = '';
  535. if ($isHidden == 'true' and $_SESSION['hideMenu']) {
  536. $_SESSION['hideMenu'] = 'hidden';
  537. $sourceurl = str_replace('&isHidden=true', '', $sourceurl);
  538. $sourceurl = str_replace('&isHidden=false', '', $sourceurl);
  539. $output_string_menu .= ' <a href="'.$sourceurl.'&isHidden=false"><img src="../../main/img/expand.gif" alt="'.'Show menu1'.'" padding:"2px"/></a>';
  540. } elseif ($isHidden == 'false' && $_SESSION['hideMenu']) {
  541. $sourceurl = str_replace('&isHidden=true', '', $sourceurl);
  542. $sourceurl = str_replace('&isHidden=false', '', $sourceurl);
  543. $_SESSION['hideMenu'] = 'shown';
  544. $output_string_menu .= '<div id="leftimg"><a href="'.$sourceurl.'&isHidden=true"><img src="../../main/img/collapse.gif" alt="'.'Hide menu2'.'" padding:"2px"/></a></div>';
  545. } elseif ($_SESSION['hideMenu']) {
  546. if ($_SESSION['hideMenu'] == 'shown') {
  547. $output_string_menu .= '<div id="leftimg"><a href="'.$sourceurl.'&isHidden=true"><img src="../../main/img/collapse.gif" alt="'.'Hide menu3'.' padding:"2px"/></a></div>';
  548. }
  549. if ($_SESSION['hideMenu'] == 'hidden') {
  550. $sourceurl = str_replace('&isHidden=true', '', $sourceurl);
  551. $output_string_menu .= '<a href="'.$sourceurl.'&isHidden=false"><img src="../../main/img/expand.gif" alt="'.'Hide menu4'.' padding:"2px"/></a>';
  552. }
  553. } elseif (!$_SESSION['hideMenu']) {
  554. $_SESSION['hideMenu'] = 'shown';
  555. if (isset($_cid)) {
  556. $output_string_menu .= '<div id="leftimg"><a href="'.$sourceurl.'&isHidden=true"><img src="main/img/collapse.gif" alt="'.'Hide menu5'.' padding:"2px"/></a></div>';
  557. }
  558. }
  559. }
  560. /**
  561. * This public function displays an icon
  562. * @param string The filename of the file (in the main/img/ folder
  563. * @param string The alt text (probably a language variable)
  564. * @param array additional attributes (for instance height, width, onclick, ...)
  565. * @param integer The wanted width of the icon (to be looked for in the corresponding img/icons/ folder)
  566. * @return void
  567. */
  568. public static function display_icon($image, $alt_text = '', $additional_attributes = array(), $size=null) {
  569. echo self::return_icon($image, $alt_text, $additional_attributes, $size);
  570. }
  571. /**
  572. * This public function returns the htmlcode for an icon
  573. *
  574. * @param string The filename of the file (in the main/img/ folder
  575. * @param string The alt text (probably a language variable)
  576. * @param array Additional attributes (for instance height, width, onclick, ...)
  577. * @param integer The wanted width of the icon (to be looked for in the corresponding img/icons/ folder)
  578. * @return string An HTML string of the right <img> tag
  579. *
  580. * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University 2006
  581. * @author Julio Montoya 2010 Function improved
  582. * @author Yannick Warnier 2011 Added size handler
  583. * @version Feb 2011
  584. */
  585. public static function return_icon($image, $alt_text = '', $additional_attributes = array(), $size=null) {
  586. $code_path = api_get_path(SYS_CODE_PATH);
  587. $w_code_path = api_get_path(WEB_CODE_PATH);
  588. $theme = 'css/'.api_get_visual_theme().'/icons/';
  589. $icon = '';
  590. $size_extra = '';
  591. if (isset($size)) {
  592. $size = intval($size);
  593. if (in_array($size,array(16,22,32,48,64,128))) {
  594. $size_extra = $size.'/';
  595. }
  596. }
  597. if (is_file($code_path.$theme.$size_extra.$image)) {
  598. $icon = $w_code_path.$theme.$size_extra.$image;
  599. } elseif (is_file($code_path.'img/icons/'.$size_extra.$image)) {
  600. $icon = $w_code_path.'img/icons/'.$size_extra.$image;
  601. } else {
  602. $icon = $w_code_path.'img/'.$image;
  603. }
  604. return self::img($icon, $alt_text,$additional_attributes);
  605. }
  606. /**
  607. * Returns the htmlcode for an image
  608. *
  609. * @param string $image the filename of the file (in the main/img/ folder
  610. * @param string $alt_text the alt text (probably a language variable)
  611. * @param array additional attributes (for instance height, width, onclick, ...)
  612. * @author Julio Montoya 2010
  613. */
  614. public static function img($image_path, $alt_text = '', $additional_attributes = array()) {
  615. // Sanitizing the parameter $image_path
  616. $image_path = Security::filter_img_path($image_path);
  617. $attribute_list = '';
  618. // alt text = the image name if there is none provided (for XHTML compliance)
  619. if ($alt_text == '') {
  620. $alt_text = basename($image_path);
  621. }
  622. $additional_attributes['src'] = $image_path;
  623. if (empty($additional_attributes['alt'])) {
  624. $additional_attributes['alt'] = $alt_text;
  625. }
  626. if (empty($additional_attributes['title'])) {
  627. $additional_attributes['title'] = $alt_text;
  628. }
  629. //return '<img src="'.$image_path.'" alt="'.$alt_text.'" title="'.$alt_text.'" '.$attribute_list.' />';
  630. return self::tag('img', '', $additional_attributes);
  631. }
  632. /**
  633. * Returns the htmlcode for a tag (h3, h1, div, a, button), etc
  634. *
  635. * @param string $image the filename of the file (in the main/img/ folder
  636. * @param string $alt_text the alt text (probably a language variable)
  637. * @param array additional attributes (for instance height, width, onclick, ...)
  638. * @author Julio Montoya 2010
  639. */
  640. public static function tag($tag, $content, $additional_attributes = array()) {
  641. $attribute_list = '';
  642. // Managing the additional attributes
  643. if (!empty($additional_attributes) && is_array($additional_attributes)) {
  644. $attribute_list = '';
  645. foreach ($additional_attributes as $key => & $value) {
  646. $attribute_list .= $key.'="'.$value.'" ';
  647. }
  648. }
  649. //some tags don't have this </XXX>
  650. if (in_array($tag, array('img','input','br'))) {
  651. $return_value = '<'.$tag.' '.$attribute_list.' />';
  652. } else {
  653. $return_value = '<'.$tag.' '.$attribute_list.' > '.$content.'</'.$tag.'>';
  654. }
  655. return $return_value;
  656. }
  657. /**
  658. * Creates a URL anchor
  659. */
  660. public static function url($name, $url, $extra_attributes = array()) {
  661. if (!empty($url)) {
  662. $extra_attributes['href']= $url;
  663. }
  664. return self::tag('a', $name, $extra_attributes);
  665. }
  666. /**
  667. * Creates a div tag
  668. */
  669. public static function div($content, $extra_attributes = array()) {
  670. return self::tag('div', $content, $extra_attributes);
  671. }
  672. /**
  673. * Creates a span tag
  674. */
  675. public static function span($content, $extra_attributes = array()) {
  676. return self::tag('span', $content, $extra_attributes);
  677. }
  678. /**
  679. * Displays an HTML input tag
  680. *
  681. */
  682. public static function input($type, $name, $value, $extra_attributes = array()) {
  683. if (!empty($type)) {
  684. $extra_attributes['type']= $type;
  685. }
  686. if (!empty($name)) {
  687. $extra_attributes['name']= $name;
  688. }
  689. if (!empty($value)) {
  690. $extra_attributes['value']= $value;
  691. }
  692. return self::tag('input', '',$extra_attributes);
  693. }
  694. /**
  695. * Displays an HTML select tag
  696. *
  697. */
  698. public function select($name, $values, $default = -1, $extra_attributes = array(), $show_blank_item = true) {
  699. $extra = '';
  700. $default_id = 'id="'.$name.'" ';
  701. foreach($extra_attributes as $key=>$parameter) {
  702. if ($key == 'id') {
  703. $default_id = '';
  704. }
  705. $extra .= $key.'="'.$parameter.'"';
  706. }
  707. $html .= '<select name="'.$name.'" '.$default_id.' '.$extra.'>';
  708. if ($show_blank_item) {
  709. $html .= self::tag('option', '-- '.get_lang('Select').' --', array('value'=>'-1'));
  710. }
  711. if($values) {
  712. foreach($values as $key => $value) {
  713. if(is_array($value) && isset($value['name'])) {
  714. $value = $value['name'];
  715. }
  716. $html .= '<option value="'.$key.'"';
  717. if($default == $key) {
  718. $html .= 'selected="selected"';
  719. }
  720. $html .= '>'.$value.'</option>';
  721. }
  722. }
  723. $html .= '</select>';
  724. return $html;
  725. }
  726. /**
  727. * Creates a tab menu
  728. * Requirements: declare the jquery, jquery-ui libraries + the jquery-ui.css in the $htmlHeadXtra variable before the display_header
  729. * Add this script
  730. * @example
  731. * <script>
  732. $(function() {
  733. $( "#tabs" ).tabs();
  734. });
  735. </script>
  736. * @param array list of the tab titles
  737. * @param array content that will be showed
  738. * @param string the id of the container of the tab in the example "tabs"
  739. * @param array attributes for the ul
  740. *
  741. */
  742. public static function tabs($header_list, $content_list, $id = 'tabs', $ul_attributes = array()) {
  743. if (empty($header_list) || count($header_list) == 0 ) {
  744. return '';
  745. }
  746. $lis = '';
  747. $i = 1;
  748. foreach ($header_list as $item) {
  749. $item =self::tag('a', $item, array('href'=>'#'.$id.'-'.$i));
  750. $lis .=self::tag('li', $item, $ul_attributes);
  751. $i++;
  752. }
  753. $ul = self::tag('ul',$lis);
  754. $i = 1;
  755. $divs = '';
  756. foreach ($content_list as $content) {
  757. $content = self::tag('p',$content);
  758. $divs .=self::tag('div', $content, array('id'=>$id.'-'.$i));
  759. $i++;
  760. }
  761. $main_div = self::tag('div',$ul.$divs, array('id'=>$id));
  762. return $main_div ;
  763. }
  764. /**
  765. * In order to display a grid using jqgrid you have to:
  766. * @example
  767. * After your Display::display_header function you have to add the nex javascript code: *
  768. * <script>
  769. * echo Display::grid_js('my_grid_name', $url,$columns, $column_model, $extra_params,array()); // for more information of this function check the grid_js() function
  770. * </script>
  771. * //Then you have to call the grid_html
  772. * echo Display::grid_html('my_grid_name');
  773. * As you can see both function use the same "my_grid_name" this is very important otherwise nothing will work
  774. *
  775. * @param string the div id, this value must be the same with the first parameter of Display::grid_js()
  776. * @return string html
  777. *
  778. */
  779. public static function grid_html($div_id){
  780. $table = self::tag('table','',array('id'=>$div_id));
  781. $table .= self::tag('div','',array('id'=>$div_id.'_pager'));
  782. return $table;
  783. }
  784. public static function form_row($label, $form_item) {
  785. $label = self::div($label, array('class' =>'label'));
  786. $form_item = self::div($form_item, array('class' =>'formw'));
  787. return self::div($label.$form_item, array('class'=>'row'));
  788. }
  789. /**
  790. * This is a wrapper to use the jqgrid in Chamilo. For the other jqgrid options visit http://www.trirand.com/jqgridwiki/doku.php?id=wiki:options
  791. * This function need to be in the ready jquery function example --> $(function() { <?php echo Display::grid_js('grid' ...); ?> }
  792. * In order to work this function needs the Display::grid_html function with the same div id
  793. *
  794. * @param string div id
  795. * @param string url where the jqgrid will ask for data (if datatype = json)
  796. * @param array Visible columns (you should use get_lang). An array in which we place the names of the columns.
  797. * This is the text that appears in the head of the grid (Header layer).
  798. * Example: colname {name:'date', index:'date', width:120, align:'right'},
  799. * @param array the column model : Array which describes the parameters of the columns.This is the most important part of the grid.
  800. * For a full description of all valid values see colModel API. See the url above.
  801. * @param array extra parameters
  802. * @param array data that will be loaded
  803. * @return string the js code
  804. *
  805. */
  806. public static function grid_js($div_id, $url, $column_names, $column_model, $extra_params, $data = array(), $formatter = '', $width_fix = false) {
  807. $obj = new stdClass();
  808. if (!empty($url))
  809. $obj->url = $url;
  810. $obj->colNames = $column_names;
  811. $obj->colModel = $column_model;
  812. $obj->pager = $div_id.'_pager';
  813. $obj->datatype = 'json';
  814. if (!empty($extra_params['datatype'])) {
  815. $obj->datatype = $extra_params['datatype'];
  816. }
  817. //Row even odd style
  818. $obj->altRows = true;
  819. if (!empty($extra_params['altRows'])) {
  820. $obj->altRows = $extra_params['altRows'];
  821. }
  822. if (!empty($extra_params['sortname'])) {
  823. $obj->sortname = $extra_params['sortname'];
  824. }
  825. //$obj->sortorder = 'desc';
  826. if (!empty($extra_params['sortorder'])) {
  827. $obj->sortorder = $extra_params['sortorder'];
  828. }
  829. if (!empty($extra_params['rowList'])) {
  830. $obj->rowList = $extra_params['rowList'];
  831. }
  832. //Sets how many records we want to view in the grid
  833. $obj->rowNum = 20;
  834. if (!empty($extra_params['rowNum'])) {
  835. $obj->rowNum = $extra_params['rowNum'];
  836. }
  837. //height: 'auto',
  838. $obj->viewrecords = 'true';
  839. if (!empty($extra_params['viewrecords']))
  840. $obj->viewrecords = $extra_params['viewrecords'];
  841. if (!empty($extra_params)) {
  842. foreach ($extra_params as $key=>$element){
  843. $obj->$key = $element;
  844. }
  845. }
  846. //Adding static data
  847. if (!empty($data)) {
  848. $data_var = $div_id.'_data';
  849. $json.=' var '.$data_var.' = '.json_encode($data).';';
  850. /* $json.='for(var i=0;i<='.$data_var.'.length;i++)
  851. jQuery("#'.$div_id.'").jqGrid(\'addRowData\',i+1,'.$data_var.'[i]);';*/
  852. $obj->data = $data_var;
  853. $obj->datatype = 'local';
  854. $json.="\n";
  855. }
  856. $json_encode = json_encode($obj);
  857. if (!empty($data)) {
  858. //Converts the "data":"js_variable" to "data":js_variable othersiwe it will not work
  859. $json_encode = str_replace('"data":"'.$data_var.'"','"data":'.$data_var.'',$json_encode);
  860. }
  861. //Fixing true/false js values that doesn't need the ""
  862. $json_encode = str_replace(':"true"',':true',$json_encode);
  863. $json_encode = str_replace(':"false"',':false',$json_encode);
  864. $json_encode = str_replace('"formatter":"action_formatter"','formatter:action_formatter',$json_encode);
  865. if ($width_fix) {
  866. if (is_numeric($width_fix)) {
  867. $width_fix = intval($width_fix);
  868. } else {
  869. $width_fix = '150';
  870. }
  871. //see BT#2020
  872. $json .= "$(window).bind('resize', function() {
  873. $('#".$div_id."').setGridWidth($(window).width() - ".$width_fix.");
  874. }).trigger('resize');";
  875. }
  876. //Creating the jqgrid element
  877. $json .= '$("#'.$div_id.'").jqGrid(';
  878. $json .= $json_encode;
  879. $json .= ');';
  880. $json.="\n";
  881. //Adding edit/delete icons
  882. $json.=$formatter;
  883. return $json;
  884. /*
  885. Real Example
  886. $("#list_week").jqGrid({
  887. url:'<?php echo api_get_path(WEB_AJAX_PATH).'course_home.ajax.php?a=session_courses_lp_by_week&session_id='.$session_id; ?>',
  888. datatype: 'json',
  889. colNames:['Week','Date','Course', 'LP'],
  890. colModel :[
  891. {name:'week', index:'week', width:120, align:'right'},
  892. {name:'date', index:'date', width:120, align:'right'},
  893. {name:'course', index:'course', width:150},
  894. {name:'lp', index:'lp', width:250}
  895. ],
  896. pager: '#pager3',
  897. rowNum:100,
  898. rowList:[10,20,30],
  899. sortname: 'date',
  900. sortorder: 'desc',
  901. viewrecords: true,
  902. grouping:true,
  903. groupingView : {
  904. groupField : ['week'],
  905. groupColumnShow : [false],
  906. groupText : ['<b>Week {0} - {1} Item(s)</b>']
  907. }
  908. }); */
  909. }
  910. public static function table($headers, $rows) {
  911. /*
  912. require_once api_get_path(LIBRARY_PATH).'pear/HTML/Table.php';
  913. $table = new HTML_Table(array('class' => 'data_table'));
  914. $row = 0;
  915. $column = 0;
  916. //Course headers
  917. foreach ($headers as $item) {
  918. $table->setHeaderContents($row, $column, $item);
  919. $column++;
  920. }
  921. $row = 1;
  922. $column = 0;
  923. foreach($rows as $content) {
  924. $table->setCellContents($row, $column, $content);
  925. $column++;
  926. }
  927. return $table->toHtml();*/
  928. }
  929. /**
  930. * Display dashboard link
  931. *
  932. */
  933. /*function display_dashboard_link() {
  934. echo '<li><a href="main/dashboard/index.php">'.get_lang('Dashboard').'</a></li>';
  935. }*/
  936. /**
  937. * Display edit course list links
  938. *
  939. */
  940. /*function display_edit_course_list_links() {
  941. echo '<li><a href="main/auth/courses.php">'.get_lang('CourseManagement').'</a></li>';
  942. }*/
  943. /**
  944. * Show history sessions
  945. *
  946. */
  947. /*
  948. function display_history_course_session() {
  949. if (api_get_setting('use_session_mode') == 'true') {
  950. if (isset($_GET['history']) && intval($_GET['history']) == 1) {
  951. echo '<li><a href="user_portal.php">'.get_lang('DisplayTrainingList').'</a></li>';
  952. } else {
  953. echo '<li><a href="user_portal.php?history=1">'.get_lang('HistoryTrainingSessions').'</a></li>';
  954. }
  955. }
  956. }*/
  957. /**
  958. * Returns the "what's new" icon notifications
  959. *
  960. * The general logic of this function is to track the last time the user
  961. * entered the course and compare to what has changed inside this course
  962. * since then, based on the item_property table inside this course. Note that,
  963. * if the user never entered the course before, he will not see notification
  964. * icons. This function takes session ID into account (if any) and only shows
  965. * the corresponding notifications.
  966. * @param array Course information array, containing at least elements 'db' and 'k'
  967. * @return string The HTML link to be shown next to the course
  968. */
  969. function show_notification($my_course) {
  970. $statistic_database = Database :: get_statistic_database();
  971. $user_id = api_get_user_id();
  972. $course_database = $my_course['db'];
  973. $course_tool_table = Database::get_course_table(TABLE_TOOL_LIST, $course_database);
  974. $tool_edit_table = Database::get_course_table(TABLE_ITEM_PROPERTY, $course_database);
  975. $course_group_user_table = Database :: get_course_table(TABLE_GROUP_USER, $course_database);
  976. $t_track_e_access = Database::get_statistic_table(TABLE_STATISTIC_TRACK_E_LASTACCESS);
  977. $my_course['k'] = Database::escape_string($my_course['k']);
  978. $my_course['id_session'] = intval($my_course['id_session']);
  979. // Get the user's last access dates to all tools of this course
  980. $sqlLastTrackInCourse = "SELECT * FROM $t_track_e_access ".
  981. " USE INDEX (access_cours_code, access_user_id) ".
  982. "WHERE access_cours_code = '".$my_course['k']."' ".
  983. "AND access_user_id = '$user_id' AND access_session_id ='".$my_course['id_session']."'";
  984. $resLastTrackInCourse = Database::query($sqlLastTrackInCourse);
  985. $oldestTrackDate = $oldestTrackDateOrig = '3000-01-01 00:00:00';
  986. while ($lastTrackInCourse = Database::fetch_array($resLastTrackInCourse)) {
  987. $lastTrackInCourseDate[$lastTrackInCourse['access_tool']] = $lastTrackInCourse['access_date'];
  988. if ($oldestTrackDate > $lastTrackInCourse['access_date']) {
  989. $oldestTrackDate = $lastTrackInCourse['access_date'];
  990. }
  991. }
  992. if ($oldestTrackDate == $oldestTrackDateOrig) {
  993. //if there was no connexion to the course ever, then take the
  994. // course creation date as a reference
  995. $course_table = Database::get_main_table(TABLE_MAIN_COURSE);
  996. $sql = "SELECT course.creation_date ".
  997. "FROM $course_table course ".
  998. "WHERE course.code = '".$my_course['k']."'";
  999. $res = Database::query($sql);
  1000. if ($res && Database::num_rows($res)>0) {
  1001. $row = Database::fetch_array($res);
  1002. }
  1003. $oldestTrackDate = $row['creation_date'];
  1004. }
  1005. // Get the last edits of all tools of this course.
  1006. $sql = "SELECT tet.*, tet.lastedit_date last_date, tet.tool tool, tet.ref ref, ".
  1007. " tet.lastedit_type type, tet.to_group_id group_id, ".
  1008. " ctt.image image, ctt.link link ".
  1009. " FROM $tool_edit_table tet, $course_tool_table ctt ".
  1010. " WHERE tet.lastedit_date > '$oldestTrackDate' ".
  1011. " AND ctt.name = tet.tool ".
  1012. " AND ctt.visibility = '1' ".
  1013. " AND tet.lastedit_user_id != $user_id AND tet.id_session = '".$my_course['id_session']."' ".
  1014. " ORDER BY tet.lastedit_date";
  1015. $res = Database::query($sql);
  1016. // Get the group_id's with user membership.
  1017. $group_ids = GroupManager :: get_group_ids($course_database, $user_id);
  1018. $group_ids[] = 0; //add group 'everyone'
  1019. $notifications = array();
  1020. // Filter all last edits of all tools of the course
  1021. while ($res && ($item_property = Database::fetch_array($res))) {
  1022. // First thing to check is if the user never entered the tool
  1023. // or if his last visit was earlier than the last modification.
  1024. if ((!isset ($lastTrackInCourseDate[$item_property['tool']])
  1025. || $lastTrackInCourseDate[$item_property['tool']] < $item_property['lastedit_date'])
  1026. // Drop the tool elements that are part of a group that the
  1027. // user is not part of.
  1028. && ((in_array($item_property['to_group_id'], $group_ids)
  1029. // Drop the dropbox, notebook and chat tools (we don't care)
  1030. && ($item_property['tool'] != TOOL_DROPBOX
  1031. && $item_property['tool'] != TOOL_NOTEBOOK
  1032. && $item_property['tool'] != TOOL_CHAT)
  1033. )
  1034. )
  1035. // Take only what's visible or invisible but where the user is a teacher or where the visibility is unset.
  1036. && ($item_property['visibility'] == '1'
  1037. || ($my_course['s'] == '1' && $item_property['visibility'] == '0')
  1038. || !isset($item_property['visibility'])))
  1039. {
  1040. // Also drop announcements and events that are not for the user or his group.
  1041. if (($item_property['tool'] == TOOL_ANNOUNCEMENT
  1042. || $item_property['tool'] == TOOL_CALENDAR_EVENT)
  1043. && (($item_property['to_user_id'] != $user_id )
  1044. && (!isset($item_property['to_group_id'])
  1045. || !in_array($item_property['to_group_id'], $group_ids)))) {
  1046. continue;
  1047. }
  1048. // If it's a survey, make sure the user's invited. Otherwise drop it.
  1049. if ($item_property['tool'] == TOOL_SURVEY) {
  1050. $survey_info = survey_manager::get_survey($item_property['ref'], 0, $my_course['k']);
  1051. $invited_users = SurveyUtil::get_invited_users($survey_info['code'], $course_database);
  1052. if (!in_array($user_id, $invited_users['course_users'])) continue;
  1053. }
  1054. // If it's a learning path, ensure it is currently visible to the user
  1055. if ($item_property['tool'] == TOOL_LEARNPATH) {
  1056. require_once api_get_path(SYS_CODE_PATH).'newscorm/learnpath.class.php';
  1057. if (!learnpath::is_lp_visible_for_student($item_property['ref'],$user_id, $my_course['k'])) {
  1058. continue;
  1059. }
  1060. }
  1061. $notifications[$item_property['tool']] = $item_property;
  1062. }
  1063. }
  1064. // Show all tool icons where there is something new.
  1065. $retvalue = '&nbsp;';
  1066. while (list($key, $notification) = each($notifications)) {
  1067. $lastDate = date('d/m/Y H:i', convert_mysql_date($notification['lastedit_date']));
  1068. $type = $notification['lastedit_type'];
  1069. if (empty($my_course['id_session'])) {
  1070. $my_course['id_session'] = 0;
  1071. }
  1072. $retvalue .= '<a href="'.api_get_path(WEB_CODE_PATH).$notification['link'].'?cidReq='.$my_course['k'].'&amp;ref='.$notification['ref'].'&amp;gidReq='.$notification['to_group_id'].'&amp;id_session='.$my_course['id_session'].'">'.'<img title="-- '.get_lang(ucfirst($notification['tool'])).' -- '.get_lang('_title_notification').": ".get_lang($type)." ($lastDate).\"".' src="'.api_get_path(WEB_CODE_PATH).'img/'.$notification['image'].'" border="0" align="absbottom" /></a>&nbsp;';
  1073. }
  1074. return $retvalue;
  1075. }
  1076. /**
  1077. * Displays a digest e.g. short summary of new agenda and announcements items.
  1078. * This used to be displayed in the right hand menu, but is now
  1079. * disabled by default (see config settings in this file) because most people like
  1080. * the what's new icons better.
  1081. *
  1082. * @version 1.0
  1083. */
  1084. function display_digest($toolsList, $digest, $orderKey, $courses) {
  1085. $html = '';
  1086. if (is_array($digest) && (CONFVAL_showExtractInfo == SCRIPTVAL_UnderCourseList || CONFVAL_showExtractInfo == SCRIPTVAL_Both)) {
  1087. // // // LEVEL 1 // // //
  1088. reset($digest);
  1089. $html .= "<br /><br />\n";
  1090. while (list($key1) = each($digest)) {
  1091. if (is_array($digest[$key1])) {
  1092. // // // Title of LEVEL 1 // // //
  1093. $html .= "<strong>\n";
  1094. if ($orderKey[0] == 'keyTools') {
  1095. $tools = $key1;
  1096. $html .= $toolsList[$key1]['name'];
  1097. } elseif ($orderKey[0] == 'keyCourse') {
  1098. $courseSysCode = $key1;
  1099. $html .= "<a href=\"".api_get_path(WEB_COURSE_PATH). $courses[$key1]['coursePath']. "\">".$courses[$key1]['courseCode']. "</a>\n";
  1100. } elseif ($orderKey[0] == 'keyTime') {
  1101. $html .= api_convert_and_format_date($digest[$key1], DATE_FORMAT_LONG, date_default_timezone_get());
  1102. }
  1103. $html .= "</strong>\n";
  1104. // // // End Of Title of LEVEL 1 // // //
  1105. // // // LEVEL 2 // // //
  1106. reset($digest[$key1]);
  1107. while (list ($key2) = each($digest[$key1])) {
  1108. // // // Title of LEVEL 2 // // //
  1109. $html .= "<p>\n". "\n";
  1110. if ($orderKey[1] == 'keyTools') {
  1111. $tools = $key2;
  1112. $html .= $toolsList[$key2][name];
  1113. } elseif ($orderKey[1] == 'keyCourse') {
  1114. $courseSysCode = $key2;
  1115. $html .= "<a href=\"". api_get_path(WEB_COURSE_PATH). $courses[$key2]['coursePath']. "\">". $courses[$key2]['courseCode']. "</a>\n";
  1116. } elseif ($orderKey[1] == 'keyTime') {
  1117. $html .= api_convert_and_format_date($key2, DATE_FORMAT_LONG, date_default_timezone_get());
  1118. }
  1119. $html .= "\n";
  1120. $html .= "</p>";
  1121. // // // End Of Title of LEVEL 2 // // //
  1122. // // // LEVEL 3 // // //
  1123. reset($digest[$key1][$key2]);
  1124. while (list ($key3, $dataFromCourse) = each($digest[$key1][$key2])) {
  1125. // // // Title of LEVEL 3 // // //
  1126. if ($orderKey[2] == 'keyTools') {
  1127. $level3title = "<a href=\"".$toolsList[$key3]["path"].$courseSysCode."\">".$toolsList[$key3]['name']."</a>";
  1128. } elseif ($orderKey[2] == 'keyCourse') {
  1129. $level3title = "&#8226; <a href=\"".$toolsList[$tools]["path"].$key3."\">".$courses[$key3]['courseCode']."</a>\n";
  1130. } elseif ($orderKey[2] == 'keyTime') {
  1131. $level3title = "&#8226; <a href=\"".$toolsList[$tools]["path"].$courseSysCode."\">".api_convert_and_format_date($key3, DATE_FORMAT_LONG, date_default_timezone_get())."</a>";
  1132. }
  1133. // // // End Of Title of LEVEL 3 // // //
  1134. // // // LEVEL 4 (data) // // //
  1135. reset($digest[$key1][$key2][$key3]);
  1136. while (list ($key4, $dataFromCourse) = each($digest[$key1][$key2][$key3])) {
  1137. $html .= $level3title. ' &ndash; '. api_substr(strip_tags($dataFromCourse), 0, CONFVAL_NB_CHAR_FROM_CONTENT);
  1138. //adding ... (three dots) if the texts are too large and they are shortened
  1139. if (api_strlen($dataFromCourse) >= CONFVAL_NB_CHAR_FROM_CONTENT) {
  1140. $html .= '...';
  1141. }
  1142. }
  1143. $html .= "<br />\n";
  1144. }
  1145. }
  1146. }
  1147. }
  1148. return $html;
  1149. }
  1150. } // End function display_digest
  1151. /**
  1152. * Get the session box details as an array
  1153. * @param int Session ID
  1154. * @return array Empty array or session array ['title'=>'...','category'=>'','dates'=>'...','coach'=>'...','active'=>true/false,'session_category_id'=>int]
  1155. */
  1156. function get_session_title_box($session_id) {
  1157. global $nosession;
  1158. if (api_get_setting('use_session_mode') == 'true' && !$nosession) {
  1159. global $now, $date_start, $date_end;
  1160. }
  1161. $output = array();
  1162. if (api_get_setting('use_session_mode') == 'true' && !$nosession) {
  1163. $main_user_table = Database :: get_main_table(TABLE_MAIN_USER);
  1164. $tbl_session = Database :: get_main_table(TABLE_MAIN_SESSION);
  1165. $tbl_session_category = Database :: get_main_table(TABLE_MAIN_SESSION_CATEGORY);
  1166. $active = false;
  1167. // Request for the name of the general coach
  1168. $sql ='SELECT tu.lastname, tu.firstname, ts.name, ts.date_start, ts.date_end, ts.session_category_id
  1169. FROM '.$tbl_session.' ts LEFT JOIN '.$main_user_table .' tu ON ts.id_coach = tu.user_id
  1170. WHERE ts.id='.intval($session_id);
  1171. $rs = Database::query($sql);
  1172. $session_info = Database::store_result($rs);
  1173. $session_info = $session_info[0];
  1174. $session = array();
  1175. $session['title'] = $session_info[2];
  1176. $session['coach'] = '';
  1177. if ($session_info['date_end'] == '0000-00-00' && $session_info['date_start'] == '0000-00-00') {
  1178. //$session['dates'] = Display::tag('i', get_lang('WithoutTimeLimits'));
  1179. $session['dates'] = '';
  1180. if (api_get_setting('show_session_coach') === 'true') {
  1181. $session['coach'] = get_lang('GeneralCoach').': '.api_get_person_name($session_info[1], $session_info[0]);
  1182. }
  1183. $active = true;
  1184. } else {
  1185. $start = $stop = false;
  1186. $startt_buffer = $stop_buffer = '';
  1187. if ($session_info['date_start'] == '0000-00-00') {
  1188. $session_info['date_start'] = '';
  1189. } else {
  1190. $start = true;
  1191. $start_buffer = $session_info['date_start'];
  1192. $session_info['date_start'] = get_lang('From').' '.$session_info['date_start'];
  1193. }
  1194. if ($session_info['date_end'] == '0000-00-00') {
  1195. $session_info['date_end'] = '';
  1196. } else {
  1197. $stop = true;
  1198. $stop_buffer = $session_info['date_end'];
  1199. $session_info['date_end'] = get_lang('Until').' '.$session_info['date_end'];
  1200. }
  1201. if ($start && $stop) {
  1202. $session['dates'] = Display::tag('i', sprintf(get_lang('FromDateXToDateY'),$start_buffer, $stop_buffer));
  1203. } else {
  1204. $session['dates'] = Display::tag('i', $session_info['date_start'].' '.$session_info['date_end']);
  1205. }
  1206. if ( api_get_setting('show_session_coach') === 'true' ) {
  1207. $session['coach'] = get_lang('GeneralCoach').': '.api_get_person_name($session_info[1], $session_info[0]);
  1208. }
  1209. $active = ($date_start <= $now && $date_end >= $now);
  1210. }
  1211. $session['active'] = $active;
  1212. $session['session_category_id'] = $session_info[5];
  1213. $output = $session;
  1214. }
  1215. return $output;
  1216. }
  1217. } //end class Display