display.lib.php 57 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313
  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, $grid_class = array()) {
  197. echo self::return_sortable_grid($name, $header, $content, $paging_options, $query_vars, $form_actions, $visibility_options, $sort_data, $grid_class);
  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, $grid_class = array()) {
  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, $grid_class);
  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. $hclickable_text = null;
  443. // Encrypt clickable text if @ is present
  444. if (strpos($clickable_text, '@')) {
  445. for ($i = 0; $i < strlen($clickable_text); $i ++) {
  446. $hclickable_text .= '&#'.ord($clickable_text {
  447. $i }).';';
  448. }
  449. } else {
  450. $hclickable_text = @htmlspecialchars($clickable_text, ENT_QUOTES, api_get_system_encoding());
  451. }
  452. // Return encrypted mailto hyperlink
  453. return '<a href="'.$hmail.'"'.$style_class.' name="clickable_email_link">'.$hclickable_text.'</a>';
  454. }
  455. /**
  456. * Creates a hyperlink to the platform homepage.
  457. * @param string $name, the visible name of the hyperlink, default is sitename
  458. * @return string with html code for hyperlink
  459. */
  460. public static function get_platform_home_link_html($name = '') {
  461. if ($name == '') {
  462. $name = api_get_setting('siteName');
  463. }
  464. return '<a href="'.api_get_path(WEB_PATH).'index.php">'.$name.'</a>';
  465. }
  466. /**
  467. * Displays the page header
  468. * @param string The name of the page (will be showed in the page title)
  469. * @param string Optional help file name
  470. */
  471. public static function display_header($tool_name ='', $help = null) {
  472. $nameTools = $tool_name;
  473. global $_plugins, $lp_theme_css, $mycoursetheme, $user_theme, $platform_theme;
  474. global $httpHeadXtra, $htmlHeadXtra, $htmlIncHeadXtra, $_course, $_user, $clarolineRepositoryWeb, $text_dir, $plugins, $_user, $rootAdminWeb, $_cid, $interbreadcrumb, $charset, $language_file, $noPHP_SELF;
  475. global $menu_navigation;
  476. require api_get_path(INCLUDE_PATH).'header.inc.php';
  477. }
  478. /**
  479. * Displays the reduced page header (without banner)
  480. */
  481. public static function display_reduced_header () {
  482. global $_plugins, $lp_theme_css, $mycoursetheme, $user_theme, $platform_theme;
  483. global $httpHeadXtra, $htmlHeadXtra, $htmlIncHeadXtra, $_course, $_user, $clarolineRepositoryWeb, $text_dir, $plugins, $_user, $rootAdminWeb, $_cid, $interbreadcrumb, $charset, $language_file, $noPHP_SELF, $language_interface;
  484. global $menu_navigation;
  485. require api_get_path(INCLUDE_PATH).'reduced_header.inc.php';
  486. }
  487. /**
  488. * Display the page footer
  489. */
  490. public static function display_footer () {
  491. global $_plugins;
  492. require api_get_path(INCLUDE_PATH).'footer.inc.php';
  493. }
  494. /**
  495. * Prints an <option>-list with all letters (A-Z).
  496. * @param char $selected_letter The letter that should be selected
  497. * @todo This is English language specific implementation. It should be adapted for the other languages.
  498. */
  499. public static function get_alphabet_options($selected_letter = '') {
  500. $result = '';
  501. for ($i = 65; $i <= 90; $i ++) {
  502. $letter = chr($i);
  503. $result .= '<option value="'.$letter.'"';
  504. if ($selected_letter == $letter) {
  505. $result .= ' selected="selected"';
  506. }
  507. $result .= '>'.$letter.'</option>';
  508. }
  509. return $result;
  510. }
  511. public static function get_numeric_options($min, $max, $selected_num = 0) {
  512. $result = '';
  513. for ($i = $min; $i <= $max; $i ++) {
  514. $result .= '<option value="'.$i.'"';
  515. if (is_int($selected_num))
  516. if ($selected_num == $i) {
  517. $result .= ' selected="selected"';
  518. }
  519. $result .= '>'.$i.'</option>';
  520. }
  521. return $result;
  522. }
  523. /**
  524. * Shows the so-called "left" menu for navigating
  525. */
  526. public static function show_course_navigation_menu($isHidden = false) {
  527. global $output_string_menu;
  528. global $_setting;
  529. // Check if the $_SERVER['REQUEST_URI'] contains already url parameters (thus a questionmark)
  530. if (strpos($_SERVER['REQUEST_URI'], '?') === false) {
  531. $sourceurl = api_get_self().'?';
  532. } else {
  533. $sourceurl = $_SERVER['REQUEST_URI'];
  534. }
  535. $output_string_menu = '';
  536. if ($isHidden == 'true' and $_SESSION['hideMenu']) {
  537. $_SESSION['hideMenu'] = 'hidden';
  538. $sourceurl = str_replace('&isHidden=true', '', $sourceurl);
  539. $sourceurl = str_replace('&isHidden=false', '', $sourceurl);
  540. $output_string_menu .= ' <a href="'.$sourceurl.'&isHidden=false"><img src="../../main/img/expand.gif" alt="'.'Show menu1'.'" padding:"2px"/></a>';
  541. } elseif ($isHidden == 'false' && $_SESSION['hideMenu']) {
  542. $sourceurl = str_replace('&isHidden=true', '', $sourceurl);
  543. $sourceurl = str_replace('&isHidden=false', '', $sourceurl);
  544. $_SESSION['hideMenu'] = 'shown';
  545. $output_string_menu .= '<div id="leftimg"><a href="'.$sourceurl.'&isHidden=true"><img src="../../main/img/collapse.gif" alt="'.'Hide menu2'.'" padding:"2px"/></a></div>';
  546. } elseif ($_SESSION['hideMenu']) {
  547. if ($_SESSION['hideMenu'] == 'shown') {
  548. $output_string_menu .= '<div id="leftimg"><a href="'.$sourceurl.'&isHidden=true"><img src="../../main/img/collapse.gif" alt="'.'Hide menu3'.' padding:"2px"/></a></div>';
  549. }
  550. if ($_SESSION['hideMenu'] == 'hidden') {
  551. $sourceurl = str_replace('&isHidden=true', '', $sourceurl);
  552. $output_string_menu .= '<a href="'.$sourceurl.'&isHidden=false"><img src="../../main/img/expand.gif" alt="'.'Hide menu4'.' padding:"2px"/></a>';
  553. }
  554. } elseif (!$_SESSION['hideMenu']) {
  555. $_SESSION['hideMenu'] = 'shown';
  556. if (isset($_cid)) {
  557. $output_string_menu .= '<div id="leftimg"><a href="'.$sourceurl.'&isHidden=true"><img src="main/img/collapse.gif" alt="'.'Hide menu5'.' padding:"2px"/></a></div>';
  558. }
  559. }
  560. }
  561. /**
  562. * This public function displays an icon
  563. * @param string The filename of the file (in the main/img/ folder
  564. * @param string The alt text (probably a language variable)
  565. * @param array additional attributes (for instance height, width, onclick, ...)
  566. * @param integer The wanted width of the icon (to be looked for in the corresponding img/icons/ folder)
  567. * @return void
  568. */
  569. public static function display_icon($image, $alt_text = '', $additional_attributes = array(), $size=null) {
  570. echo self::return_icon($image, $alt_text, $additional_attributes, $size);
  571. }
  572. /**
  573. * This public function returns the htmlcode for an icon
  574. *
  575. * @param string The filename of the file (in the main/img/ folder
  576. * @param string The alt text (probably a language variable)
  577. * @param array Additional attributes (for instance height, width, onclick, ...)
  578. * @param integer The wanted width of the icon (to be looked for in the corresponding img/icons/ folder)
  579. * @return string An HTML string of the right <img> tag
  580. *
  581. * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University 2006
  582. * @author Julio Montoya 2010 Function improved
  583. * @author Yannick Warnier 2011 Added size handler
  584. * @version Feb 2011
  585. */
  586. public static function return_icon($image, $alt_text = '', $additional_attributes = array(), $size=null) {
  587. $code_path = api_get_path(SYS_CODE_PATH);
  588. $w_code_path = api_get_path(WEB_CODE_PATH);
  589. $theme = 'css/'.api_get_visual_theme().'/icons/';
  590. $icon = '';
  591. $size_extra = '';
  592. if (isset($size)) {
  593. $size = intval($size);
  594. if (in_array($size,array(16,22,32,48,64,128))) {
  595. $size_extra = $size.'/';
  596. }
  597. }
  598. if (is_file($code_path.$theme.$size_extra.$image)) {
  599. $icon = $w_code_path.$theme.$size_extra.$image;
  600. } elseif (is_file($code_path.'img/icons/'.$size_extra.$image)) {
  601. $icon = $w_code_path.'img/icons/'.$size_extra.$image;
  602. } else {
  603. $icon = $w_code_path.'img/'.$image;
  604. }
  605. return self::img($icon, $alt_text,$additional_attributes);
  606. }
  607. /**
  608. * Returns the htmlcode for an image
  609. *
  610. * @param string $image the filename of the file (in the main/img/ folder
  611. * @param string $alt_text the alt text (probably a language variable)
  612. * @param array additional attributes (for instance height, width, onclick, ...)
  613. * @author Julio Montoya 2010
  614. */
  615. public static function img($image_path, $alt_text = '', $additional_attributes = array()) {
  616. // Sanitizing the parameter $image_path
  617. $image_path = Security::filter_img_path($image_path);
  618. $attribute_list = '';
  619. // alt text = the image name if there is none provided (for XHTML compliance)
  620. if ($alt_text == '') {
  621. $alt_text = basename($image_path);
  622. }
  623. $additional_attributes['src'] = $image_path;
  624. if (empty($additional_attributes['alt'])) {
  625. $additional_attributes['alt'] = $alt_text;
  626. }
  627. if (empty($additional_attributes['title'])) {
  628. $additional_attributes['title'] = $alt_text;
  629. }
  630. //return '<img src="'.$image_path.'" alt="'.$alt_text.'" title="'.$alt_text.'" '.$attribute_list.' />';
  631. return self::tag('img', '', $additional_attributes);
  632. }
  633. /**
  634. * Returns the htmlcode for a tag (h3, h1, div, a, button), etc
  635. *
  636. * @param string $image the filename of the file (in the main/img/ folder
  637. * @param string $alt_text the alt text (probably a language variable)
  638. * @param array additional attributes (for instance height, width, onclick, ...)
  639. * @author Julio Montoya 2010
  640. */
  641. public static function tag($tag, $content, $additional_attributes = array()) {
  642. $attribute_list = '';
  643. // Managing the additional attributes
  644. if (!empty($additional_attributes) && is_array($additional_attributes)) {
  645. $attribute_list = '';
  646. foreach ($additional_attributes as $key => & $value) {
  647. $attribute_list .= $key.'="'.$value.'" ';
  648. }
  649. }
  650. //some tags don't have this </XXX>
  651. if (in_array($tag, array('img','input','br'))) {
  652. $return_value = '<'.$tag.' '.$attribute_list.' />';
  653. } else {
  654. $return_value = '<'.$tag.' '.$attribute_list.' > '.$content.'</'.$tag.'>';
  655. }
  656. return $return_value;
  657. }
  658. /**
  659. * Creates a URL anchor
  660. */
  661. public static function url($name, $url, $extra_attributes = array()) {
  662. if (!empty($url)) {
  663. $extra_attributes['href']= $url;
  664. }
  665. return self::tag('a', $name, $extra_attributes);
  666. }
  667. /**
  668. * Creates a div tag
  669. */
  670. public static function div($content, $extra_attributes = array()) {
  671. return self::tag('div', $content, $extra_attributes);
  672. }
  673. /**
  674. * Creates a span tag
  675. */
  676. public static function span($content, $extra_attributes = array()) {
  677. return self::tag('span', $content, $extra_attributes);
  678. }
  679. /**
  680. * Displays an HTML input tag
  681. *
  682. */
  683. public static function input($type, $name, $value, $extra_attributes = array()) {
  684. if (!empty($type)) {
  685. $extra_attributes['type']= $type;
  686. }
  687. if (!empty($name)) {
  688. $extra_attributes['name']= $name;
  689. }
  690. if (!empty($value)) {
  691. $extra_attributes['value']= $value;
  692. }
  693. return self::tag('input', '',$extra_attributes);
  694. }
  695. /**
  696. * Displays an HTML select tag
  697. *
  698. */
  699. public function select($name, $values, $default = -1, $extra_attributes = array(), $show_blank_item = true) {
  700. $extra = '';
  701. $default_id = 'id="'.$name.'" ';
  702. foreach($extra_attributes as $key=>$parameter) {
  703. if ($key == 'id') {
  704. $default_id = '';
  705. }
  706. $extra .= $key.'="'.$parameter.'"';
  707. }
  708. $html .= '<select name="'.$name.'" '.$default_id.' '.$extra.'>';
  709. if ($show_blank_item) {
  710. $html .= self::tag('option', '-- '.get_lang('Select').' --', array('value'=>'-1'));
  711. }
  712. if($values) {
  713. foreach($values as $key => $value) {
  714. if(is_array($value) && isset($value['name'])) {
  715. $value = $value['name'];
  716. }
  717. $html .= '<option value="'.$key.'"';
  718. if($default == $key) {
  719. $html .= 'selected="selected"';
  720. }
  721. $html .= '>'.$value.'</option>';
  722. }
  723. }
  724. $html .= '</select>';
  725. return $html;
  726. }
  727. /**
  728. * Creates a tab menu
  729. * Requirements: declare the jquery, jquery-ui libraries + the jquery-ui.css in the $htmlHeadXtra variable before the display_header
  730. * Add this script
  731. * @example
  732. * <script>
  733. $(function() {
  734. $( "#tabs" ).tabs();
  735. });
  736. </script>
  737. * @param array list of the tab titles
  738. * @param array content that will be showed
  739. * @param string the id of the container of the tab in the example "tabs"
  740. * @param array attributes for the ul
  741. *
  742. */
  743. public static function tabs($header_list, $content_list, $id = 'tabs', $ul_attributes = array()) {
  744. if (empty($header_list) || count($header_list) == 0 ) {
  745. return '';
  746. }
  747. $lis = '';
  748. $i = 1;
  749. foreach ($header_list as $item) {
  750. $item =self::tag('a', $item, array('href'=>'#'.$id.'-'.$i));
  751. $lis .=self::tag('li', $item, $ul_attributes);
  752. $i++;
  753. }
  754. $ul = self::tag('ul',$lis);
  755. $i = 1;
  756. $divs = '';
  757. foreach ($content_list as $content) {
  758. $content = self::tag('p',$content);
  759. $divs .=self::tag('div', $content, array('id'=>$id.'-'.$i));
  760. $i++;
  761. }
  762. $main_div = self::tag('div',$ul.$divs, array('id'=>$id));
  763. return $main_div ;
  764. }
  765. /**
  766. * In order to display a grid using jqgrid you have to:
  767. * @example
  768. * After your Display::display_header function you have to add the nex javascript code: *
  769. * <script>
  770. * 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
  771. * </script>
  772. * //Then you have to call the grid_html
  773. * echo Display::grid_html('my_grid_name');
  774. * As you can see both function use the same "my_grid_name" this is very important otherwise nothing will work
  775. *
  776. * @param string the div id, this value must be the same with the first parameter of Display::grid_js()
  777. * @return string html
  778. *
  779. */
  780. public static function grid_html($div_id){
  781. $table = self::tag('table','',array('id'=>$div_id));
  782. $table .= self::tag('div','',array('id'=>$div_id.'_pager'));
  783. return $table;
  784. }
  785. public static function form_row($label, $form_item) {
  786. $label = self::div($label, array('class' =>'label'));
  787. $form_item = self::div($form_item, array('class' =>'formw'));
  788. return self::div($label.$form_item, array('class'=>'row'));
  789. }
  790. /**
  791. * 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
  792. * This function need to be in the ready jquery function example --> $(function() { <?php echo Display::grid_js('grid' ...); ?> }
  793. * In order to work this function needs the Display::grid_html function with the same div id
  794. *
  795. * @param string div id
  796. * @param string url where the jqgrid will ask for data (if datatype = json)
  797. * @param array Visible columns (you should use get_lang). An array in which we place the names of the columns.
  798. * This is the text that appears in the head of the grid (Header layer).
  799. * Example: colname {name:'date', index:'date', width:120, align:'right'},
  800. * @param array the column model : Array which describes the parameters of the columns.This is the most important part of the grid.
  801. * For a full description of all valid values see colModel API. See the url above.
  802. * @param array extra parameters
  803. * @param array data that will be loaded
  804. * @return string the js code
  805. *
  806. */
  807. public static function grid_js($div_id, $url, $column_names, $column_model, $extra_params, $data = array(), $formatter = '', $width_fix = false) {
  808. $obj = new stdClass();
  809. if (!empty($url))
  810. $obj->url = $url;
  811. $obj->colNames = $column_names;
  812. $obj->colModel = $column_model;
  813. $obj->pager = $div_id.'_pager';
  814. $obj->datatype = 'json';
  815. if (!empty($extra_params['datatype'])) {
  816. $obj->datatype = $extra_params['datatype'];
  817. }
  818. //Row even odd style
  819. $obj->altRows = true;
  820. if (!empty($extra_params['altRows'])) {
  821. $obj->altRows = $extra_params['altRows'];
  822. }
  823. if (!empty($extra_params['sortname'])) {
  824. $obj->sortname = $extra_params['sortname'];
  825. }
  826. //$obj->sortorder = 'desc';
  827. if (!empty($extra_params['sortorder'])) {
  828. $obj->sortorder = $extra_params['sortorder'];
  829. }
  830. if (!empty($extra_params['rowList'])) {
  831. $obj->rowList = $extra_params['rowList'];
  832. }
  833. //Sets how many records we want to view in the grid
  834. $obj->rowNum = 20;
  835. if (!empty($extra_params['rowNum'])) {
  836. $obj->rowNum = $extra_params['rowNum'];
  837. }
  838. //height: 'auto',
  839. $obj->viewrecords = 'true';
  840. if (!empty($extra_params['viewrecords']))
  841. $obj->viewrecords = $extra_params['viewrecords'];
  842. if (!empty($extra_params)) {
  843. foreach ($extra_params as $key=>$element){
  844. $obj->$key = $element;
  845. }
  846. }
  847. //Adding static data
  848. if (!empty($data)) {
  849. $data_var = $div_id.'_data';
  850. $json.=' var '.$data_var.' = '.json_encode($data).';';
  851. /* $json.='for(var i=0;i<='.$data_var.'.length;i++)
  852. jQuery("#'.$div_id.'").jqGrid(\'addRowData\',i+1,'.$data_var.'[i]);';*/
  853. $obj->data = $data_var;
  854. $obj->datatype = 'local';
  855. $json.="\n";
  856. }
  857. $json_encode = json_encode($obj);
  858. if (!empty($data)) {
  859. //Converts the "data":"js_variable" to "data":js_variable othersiwe it will not work
  860. $json_encode = str_replace('"data":"'.$data_var.'"','"data":'.$data_var.'',$json_encode);
  861. }
  862. //Fixing true/false js values that doesn't need the ""
  863. $json_encode = str_replace(':"true"',':true',$json_encode);
  864. $json_encode = str_replace(':"false"',':false',$json_encode);
  865. $json_encode = str_replace('"formatter":"action_formatter"','formatter:action_formatter',$json_encode);
  866. if ($width_fix) {
  867. if (is_numeric($width_fix)) {
  868. $width_fix = intval($width_fix);
  869. } else {
  870. $width_fix = '150';
  871. }
  872. //see BT#2020
  873. $json .= "$(window).bind('resize', function() {
  874. $('#".$div_id."').setGridWidth($(window).width() - ".$width_fix.");
  875. }).trigger('resize');";
  876. }
  877. //Creating the jqgrid element
  878. $json .= '$("#'.$div_id.'").jqGrid(';
  879. $json .= $json_encode;
  880. $json .= ');';
  881. $json.="\n";
  882. //Adding edit/delete icons
  883. $json.=$formatter;
  884. return $json;
  885. /*
  886. Real Example
  887. $("#list_week").jqGrid({
  888. url:'<?php echo api_get_path(WEB_AJAX_PATH).'course_home.ajax.php?a=session_courses_lp_by_week&session_id='.$session_id; ?>',
  889. datatype: 'json',
  890. colNames:['Week','Date','Course', 'LP'],
  891. colModel :[
  892. {name:'week', index:'week', width:120, align:'right'},
  893. {name:'date', index:'date', width:120, align:'right'},
  894. {name:'course', index:'course', width:150},
  895. {name:'lp', index:'lp', width:250}
  896. ],
  897. pager: '#pager3',
  898. rowNum:100,
  899. rowList:[10,20,30],
  900. sortname: 'date',
  901. sortorder: 'desc',
  902. viewrecords: true,
  903. grouping:true,
  904. groupingView : {
  905. groupField : ['week'],
  906. groupColumnShow : [false],
  907. groupText : ['<b>Week {0} - {1} Item(s)</b>']
  908. }
  909. }); */
  910. }
  911. public static function table($headers, $rows) {
  912. /*
  913. require_once api_get_path(LIBRARY_PATH).'pear/HTML/Table.php';
  914. $table = new HTML_Table(array('class' => 'data_table'));
  915. $row = 0;
  916. $column = 0;
  917. //Course headers
  918. foreach ($headers as $item) {
  919. $table->setHeaderContents($row, $column, $item);
  920. $column++;
  921. }
  922. $row = 1;
  923. $column = 0;
  924. foreach($rows as $content) {
  925. $table->setCellContents($row, $column, $content);
  926. $column++;
  927. }
  928. return $table->toHtml();*/
  929. }
  930. /**
  931. * Display dashboard link
  932. *
  933. */
  934. /*function display_dashboard_link() {
  935. echo '<li><a href="main/dashboard/index.php">'.get_lang('Dashboard').'</a></li>';
  936. }*/
  937. /**
  938. * Display edit course list links
  939. *
  940. */
  941. /*function display_edit_course_list_links() {
  942. echo '<li><a href="main/auth/courses.php">'.get_lang('CourseManagement').'</a></li>';
  943. }*/
  944. /**
  945. * Show history sessions
  946. *
  947. */
  948. /*
  949. function display_history_course_session() {
  950. if (api_get_setting('use_session_mode') == 'true') {
  951. if (isset($_GET['history']) && intval($_GET['history']) == 1) {
  952. echo '<li><a href="user_portal.php">'.get_lang('DisplayTrainingList').'</a></li>';
  953. } else {
  954. echo '<li><a href="user_portal.php?history=1">'.get_lang('HistoryTrainingSessions').'</a></li>';
  955. }
  956. }
  957. }*/
  958. /**
  959. * Returns the "what's new" icon notifications
  960. *
  961. * The general logic of this function is to track the last time the user
  962. * entered the course and compare to what has changed inside this course
  963. * since then, based on the item_property table inside this course. Note that,
  964. * if the user never entered the course before, he will not see notification
  965. * icons. This function takes session ID into account (if any) and only shows
  966. * the corresponding notifications.
  967. * @param array Course information array, containing at least elements 'db' and 'k'
  968. * @return string The HTML link to be shown next to the course
  969. */
  970. function show_notification($my_course) {
  971. $statistic_database = Database :: get_statistic_database();
  972. $user_id = api_get_user_id();
  973. $course_database = $my_course['db'];
  974. $course_tool_table = Database::get_course_table(TABLE_TOOL_LIST, $course_database);
  975. $tool_edit_table = Database::get_course_table(TABLE_ITEM_PROPERTY, $course_database);
  976. $course_group_user_table = Database :: get_course_table(TABLE_GROUP_USER, $course_database);
  977. $t_track_e_access = Database::get_statistic_table(TABLE_STATISTIC_TRACK_E_LASTACCESS);
  978. $my_course['k'] = Database::escape_string($my_course['k']);
  979. $my_course['id_session'] = intval($my_course['id_session']);
  980. // Get the user's last access dates to all tools of this course
  981. $sqlLastTrackInCourse = "SELECT * FROM $t_track_e_access ".
  982. " USE INDEX (access_cours_code, access_user_id) ".
  983. "WHERE access_cours_code = '".$my_course['k']."' ".
  984. "AND access_user_id = '$user_id' AND access_session_id ='".$my_course['id_session']."'";
  985. $resLastTrackInCourse = Database::query($sqlLastTrackInCourse);
  986. $oldestTrackDate = $oldestTrackDateOrig = '3000-01-01 00:00:00';
  987. while ($lastTrackInCourse = Database::fetch_array($resLastTrackInCourse)) {
  988. $lastTrackInCourseDate[$lastTrackInCourse['access_tool']] = $lastTrackInCourse['access_date'];
  989. if ($oldestTrackDate > $lastTrackInCourse['access_date']) {
  990. $oldestTrackDate = $lastTrackInCourse['access_date'];
  991. }
  992. }
  993. if ($oldestTrackDate == $oldestTrackDateOrig) {
  994. //if there was no connexion to the course ever, then take the
  995. // course creation date as a reference
  996. $course_table = Database::get_main_table(TABLE_MAIN_COURSE);
  997. $sql = "SELECT course.creation_date ".
  998. "FROM $course_table course ".
  999. "WHERE course.code = '".$my_course['k']."'";
  1000. $res = Database::query($sql);
  1001. if ($res && Database::num_rows($res)>0) {
  1002. $row = Database::fetch_array($res);
  1003. }
  1004. $oldestTrackDate = $row['creation_date'];
  1005. }
  1006. // Get the last edits of all tools of this course.
  1007. $sql = "SELECT tet.*, tet.lastedit_date last_date, tet.tool tool, tet.ref ref, ".
  1008. " tet.lastedit_type type, tet.to_group_id group_id, ".
  1009. " ctt.image image, ctt.link link ".
  1010. " FROM $tool_edit_table tet, $course_tool_table ctt ".
  1011. " WHERE tet.lastedit_date > '$oldestTrackDate' ".
  1012. " AND ctt.name = tet.tool ".
  1013. " AND ctt.visibility = '1' ".
  1014. " AND tet.lastedit_user_id != $user_id AND tet.id_session = '".$my_course['id_session']."' ".
  1015. " ORDER BY tet.lastedit_date";
  1016. $res = Database::query($sql);
  1017. // Get the group_id's with user membership.
  1018. $group_ids = GroupManager :: get_group_ids($course_database, $user_id);
  1019. $group_ids[] = 0; //add group 'everyone'
  1020. $notifications = array();
  1021. // Filter all last edits of all tools of the course
  1022. while ($res && ($item_property = Database::fetch_array($res))) {
  1023. // First thing to check is if the user never entered the tool
  1024. // or if his last visit was earlier than the last modification.
  1025. if ((!isset ($lastTrackInCourseDate[$item_property['tool']])
  1026. || $lastTrackInCourseDate[$item_property['tool']] < $item_property['lastedit_date'])
  1027. // Drop the tool elements that are part of a group that the
  1028. // user is not part of.
  1029. && ((in_array($item_property['to_group_id'], $group_ids)
  1030. // Drop the dropbox, notebook and chat tools (we don't care)
  1031. && ($item_property['tool'] != TOOL_DROPBOX
  1032. && $item_property['tool'] != TOOL_NOTEBOOK
  1033. && $item_property['tool'] != TOOL_CHAT)
  1034. )
  1035. )
  1036. // Take only what's visible or invisible but where the user is a teacher or where the visibility is unset.
  1037. && ($item_property['visibility'] == '1'
  1038. || ($my_course['s'] == '1' && $item_property['visibility'] == '0')
  1039. || !isset($item_property['visibility'])))
  1040. {
  1041. // Also drop announcements and events that are not for the user or his group.
  1042. if (($item_property['tool'] == TOOL_ANNOUNCEMENT
  1043. || $item_property['tool'] == TOOL_CALENDAR_EVENT)
  1044. && (($item_property['to_user_id'] != $user_id )
  1045. && (!isset($item_property['to_group_id'])
  1046. || !in_array($item_property['to_group_id'], $group_ids)))) {
  1047. continue;
  1048. }
  1049. // If it's a survey, make sure the user's invited. Otherwise drop it.
  1050. if ($item_property['tool'] == TOOL_SURVEY) {
  1051. $survey_info = survey_manager::get_survey($item_property['ref'], 0, $my_course['k']);
  1052. $invited_users = SurveyUtil::get_invited_users($survey_info['code'], $course_database);
  1053. if (!in_array($user_id, $invited_users['course_users'])) continue;
  1054. }
  1055. // If it's a learning path, ensure it is currently visible to the user
  1056. if ($item_property['tool'] == TOOL_LEARNPATH) {
  1057. require_once api_get_path(SYS_CODE_PATH).'newscorm/learnpath.class.php';
  1058. if (!learnpath::is_lp_visible_for_student($item_property['ref'],$user_id, $my_course['k'])) {
  1059. continue;
  1060. }
  1061. }
  1062. $notifications[$item_property['tool']] = $item_property;
  1063. }
  1064. }
  1065. // Show all tool icons where there is something new.
  1066. $retvalue = '&nbsp;';
  1067. while (list($key, $notification) = each($notifications)) {
  1068. $lastDate = date('d/m/Y H:i', convert_mysql_date($notification['lastedit_date']));
  1069. $type = $notification['lastedit_type'];
  1070. if (empty($my_course['id_session'])) {
  1071. $my_course['id_session'] = 0;
  1072. }
  1073. $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;';
  1074. }
  1075. return $retvalue;
  1076. }
  1077. /**
  1078. * Displays a digest e.g. short summary of new agenda and announcements items.
  1079. * This used to be displayed in the right hand menu, but is now
  1080. * disabled by default (see config settings in this file) because most people like
  1081. * the what's new icons better.
  1082. *
  1083. * @version 1.0
  1084. */
  1085. function display_digest($toolsList, $digest, $orderKey, $courses) {
  1086. $html = '';
  1087. if (is_array($digest) && (CONFVAL_showExtractInfo == SCRIPTVAL_UnderCourseList || CONFVAL_showExtractInfo == SCRIPTVAL_Both)) {
  1088. // // // LEVEL 1 // // //
  1089. reset($digest);
  1090. $html .= "<br /><br />\n";
  1091. while (list($key1) = each($digest)) {
  1092. if (is_array($digest[$key1])) {
  1093. // // // Title of LEVEL 1 // // //
  1094. $html .= "<strong>\n";
  1095. if ($orderKey[0] == 'keyTools') {
  1096. $tools = $key1;
  1097. $html .= $toolsList[$key1]['name'];
  1098. } elseif ($orderKey[0] == 'keyCourse') {
  1099. $courseSysCode = $key1;
  1100. $html .= "<a href=\"".api_get_path(WEB_COURSE_PATH). $courses[$key1]['coursePath']. "\">".$courses[$key1]['courseCode']. "</a>\n";
  1101. } elseif ($orderKey[0] == 'keyTime') {
  1102. $html .= api_convert_and_format_date($digest[$key1], DATE_FORMAT_LONG, date_default_timezone_get());
  1103. }
  1104. $html .= "</strong>\n";
  1105. // // // End Of Title of LEVEL 1 // // //
  1106. // // // LEVEL 2 // // //
  1107. reset($digest[$key1]);
  1108. while (list ($key2) = each($digest[$key1])) {
  1109. // // // Title of LEVEL 2 // // //
  1110. $html .= "<p>\n". "\n";
  1111. if ($orderKey[1] == 'keyTools') {
  1112. $tools = $key2;
  1113. $html .= $toolsList[$key2][name];
  1114. } elseif ($orderKey[1] == 'keyCourse') {
  1115. $courseSysCode = $key2;
  1116. $html .= "<a href=\"". api_get_path(WEB_COURSE_PATH). $courses[$key2]['coursePath']. "\">". $courses[$key2]['courseCode']. "</a>\n";
  1117. } elseif ($orderKey[1] == 'keyTime') {
  1118. $html .= api_convert_and_format_date($key2, DATE_FORMAT_LONG, date_default_timezone_get());
  1119. }
  1120. $html .= "\n";
  1121. $html .= "</p>";
  1122. // // // End Of Title of LEVEL 2 // // //
  1123. // // // LEVEL 3 // // //
  1124. reset($digest[$key1][$key2]);
  1125. while (list ($key3, $dataFromCourse) = each($digest[$key1][$key2])) {
  1126. // // // Title of LEVEL 3 // // //
  1127. if ($orderKey[2] == 'keyTools') {
  1128. $level3title = "<a href=\"".$toolsList[$key3]["path"].$courseSysCode."\">".$toolsList[$key3]['name']."</a>";
  1129. } elseif ($orderKey[2] == 'keyCourse') {
  1130. $level3title = "&#8226; <a href=\"".$toolsList[$tools]["path"].$key3."\">".$courses[$key3]['courseCode']."</a>\n";
  1131. } elseif ($orderKey[2] == 'keyTime') {
  1132. $level3title = "&#8226; <a href=\"".$toolsList[$tools]["path"].$courseSysCode."\">".api_convert_and_format_date($key3, DATE_FORMAT_LONG, date_default_timezone_get())."</a>";
  1133. }
  1134. // // // End Of Title of LEVEL 3 // // //
  1135. // // // LEVEL 4 (data) // // //
  1136. reset($digest[$key1][$key2][$key3]);
  1137. while (list ($key4, $dataFromCourse) = each($digest[$key1][$key2][$key3])) {
  1138. $html .= $level3title. ' &ndash; '. api_substr(strip_tags($dataFromCourse), 0, CONFVAL_NB_CHAR_FROM_CONTENT);
  1139. //adding ... (three dots) if the texts are too large and they are shortened
  1140. if (api_strlen($dataFromCourse) >= CONFVAL_NB_CHAR_FROM_CONTENT) {
  1141. $html .= '...';
  1142. }
  1143. }
  1144. $html .= "<br />\n";
  1145. }
  1146. }
  1147. }
  1148. }
  1149. return $html;
  1150. }
  1151. } // End function display_digest
  1152. /**
  1153. * Get the session box details as an array
  1154. * @param int Session ID
  1155. * @return array Empty array or session array ['title'=>'...','category'=>'','dates'=>'...','coach'=>'...','active'=>true/false,'session_category_id'=>int]
  1156. */
  1157. function get_session_title_box($session_id) {
  1158. global $nosession;
  1159. if (api_get_setting('use_session_mode') == 'true' && !$nosession) {
  1160. global $now, $date_start, $date_end;
  1161. }
  1162. $output = array();
  1163. if (api_get_setting('use_session_mode') == 'true' && !$nosession) {
  1164. $main_user_table = Database :: get_main_table(TABLE_MAIN_USER);
  1165. $tbl_session = Database :: get_main_table(TABLE_MAIN_SESSION);
  1166. $tbl_session_category = Database :: get_main_table(TABLE_MAIN_SESSION_CATEGORY);
  1167. $active = false;
  1168. // Request for the name of the general coach
  1169. $sql ='SELECT tu.lastname, tu.firstname, ts.name, ts.date_start, ts.date_end, ts.session_category_id
  1170. FROM '.$tbl_session.' ts LEFT JOIN '.$main_user_table .' tu ON ts.id_coach = tu.user_id
  1171. WHERE ts.id='.intval($session_id);
  1172. $rs = Database::query($sql);
  1173. $session_info = Database::store_result($rs);
  1174. $session_info = $session_info[0];
  1175. $session = array();
  1176. $session['title'] = $session_info[2];
  1177. $session['coach'] = '';
  1178. if ($session_info['date_end'] == '0000-00-00' && $session_info['date_start'] == '0000-00-00') {
  1179. //$session['dates'] = Display::tag('i', get_lang('WithoutTimeLimits'));
  1180. $session['dates'] = '';
  1181. if (api_get_setting('show_session_coach') === 'true') {
  1182. $session['coach'] = get_lang('GeneralCoach').': '.api_get_person_name($session_info[1], $session_info[0]);
  1183. }
  1184. $active = true;
  1185. } else {
  1186. $start = $stop = false;
  1187. $startt_buffer = $stop_buffer = '';
  1188. if ($session_info['date_start'] == '0000-00-00') {
  1189. $session_info['date_start'] = '';
  1190. } else {
  1191. $start = true;
  1192. $start_buffer = $session_info['date_start'];
  1193. $session_info['date_start'] = get_lang('From').' '.$session_info['date_start'];
  1194. }
  1195. if ($session_info['date_end'] == '0000-00-00') {
  1196. $session_info['date_end'] = '';
  1197. } else {
  1198. $stop = true;
  1199. $stop_buffer = $session_info['date_end'];
  1200. $session_info['date_end'] = get_lang('Until').' '.$session_info['date_end'];
  1201. }
  1202. if ($start && $stop) {
  1203. $session['dates'] = Display::tag('i', sprintf(get_lang('FromDateXToDateY'),$start_buffer, $stop_buffer));
  1204. } else {
  1205. $session['dates'] = Display::tag('i', $session_info['date_start'].' '.$session_info['date_end']);
  1206. }
  1207. if ( api_get_setting('show_session_coach') === 'true' ) {
  1208. $session['coach'] = get_lang('GeneralCoach').': '.api_get_person_name($session_info[1], $session_info[0]);
  1209. }
  1210. $active = ($date_start <= $now && $date_end >= $now);
  1211. }
  1212. $session['active'] = $active;
  1213. $session['session_category_id'] = $session_info[5];
  1214. $output = $session;
  1215. }
  1216. return $output;
  1217. }
  1218. } //end class Display