display.lib.php 55 KB

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