From 60ea5be56a334c273e0cf4941bddfbae978281e1 Mon Sep 17 00:00:00 2001 From: Julio Montoya Date: Tue, 7 May 2013 08:57:51 +0200 Subject: [PATCH] Reformat code --- main/inc/lib/glossary.lib.php | 1112 ++++++++++++++++++-------------- main/inc/lib/gradebook.lib.php | 197 +++--- 2 files changed, 736 insertions(+), 573 deletions(-) diff --git a/main/inc/lib/glossary.lib.php b/main/inc/lib/glossary.lib.php index 8f48bab28c..43d446b85d 100644 --- a/main/inc/lib/glossary.lib.php +++ b/main/inc/lib/glossary.lib.php @@ -1,107 +1,123 @@ * @return Array Contain glossary terms */ - public static function get_glossary_terms () { - global $course; - $glossary_data = array(); - $glossary_table = Database::get_course_table(TABLE_GLOSSARY); - $session_id = intval($session_id); - $sql_filter = api_get_session_condition($session_id); - $course_id = api_get_course_int_id(); - - $sql = "SELECT glossary_id as id, name, description FROM $glossary_table WHERE c_id = $course_id $sql_filter"; - $rs = Database::query($sql); - while ($row = Database::fetch_array($rs)) { - $glossary_data[] = $row; - } - return $glossary_data; - } - /** - * Get glossary term by glossary id - * @author Isaac Flores - * @param Integer The glossary id - * @return String The glossary description - */ - public static function get_glossary_term_by_glossary_id ($glossary_id) { - global $course; - $glossary_table = Database::get_course_table(TABLE_GLOSSARY); - $course_id = api_get_course_int_id(); - $sql = "SELECT description FROM $glossary_table WHERE c_id = $course_id AND glossary_id =".Database::escape_string($glossary_id); - $rs=Database::query($sql); + public static function get_glossary_terms() + { + global $course; + $glossary_data = array(); + $glossary_table = Database::get_course_table(TABLE_GLOSSARY); + $session_id = intval($session_id); + $sql_filter = api_get_session_condition($session_id); + $course_id = api_get_course_int_id(); + + $sql = "SELECT glossary_id as id, name, description FROM $glossary_table WHERE c_id = $course_id $sql_filter"; + $rs = Database::query($sql); + while ($row = Database::fetch_array($rs)) { + $glossary_data[] = $row; + } + + return $glossary_data; + } + + /** + * Get glossary term by glossary id + * @author Isaac Flores + * @param Integer The glossary id + * @return String The glossary description + */ + public static function get_glossary_term_by_glossary_id($glossary_id) + { + global $course; + $glossary_table = Database::get_course_table(TABLE_GLOSSARY); + $course_id = api_get_course_int_id(); + $sql = "SELECT description FROM $glossary_table WHERE c_id = $course_id AND glossary_id =".Database::escape_string( + $glossary_id + ); + $rs = Database::query($sql); if (Database::num_rows($rs) > 0) { $row = Database::fetch_array($rs); + return $row['description']; } else { return ''; } } - + /** - * Get glossary term by glossary id - * @author Isaac Flores - * @param String The glossary term name - * @return String The glossary description - */ - public static function get_glossary_term_by_glossary_name ($glossary_name) { - global $course; - $glossary_table = Database::get_course_table(TABLE_GLOSSARY); - $session_id = intval($session_id); - $course_id = api_get_course_int_id(); - $sql_filter = api_get_session_condition($session_id); - $sql = 'SELECT description FROM '.$glossary_table.' WHERE c_id = '.$course_id.' AND name LIKE trim("'.Database::escape_string($glossary_name).'")'.$sql_filter; - $rs = Database::query($sql); - if (Database::num_rows($rs) > 0) { - $row = Database::fetch_array($rs); + * Get glossary term by glossary id + * @author Isaac Flores + * @param String The glossary term name + * @return String The glossary description + */ + public static function get_glossary_term_by_glossary_name($glossary_name) + { + global $course; + $glossary_table = Database::get_course_table(TABLE_GLOSSARY); + $session_id = intval($session_id); + $course_id = api_get_course_int_id(); + $sql_filter = api_get_session_condition($session_id); + $sql = 'SELECT description FROM '.$glossary_table.' WHERE c_id = '.$course_id.' AND name LIKE trim("'.Database::escape_string( + $glossary_name + ).'")'.$sql_filter; + $rs = Database::query($sql); + if (Database::num_rows($rs) > 0) { + $row = Database::fetch_array($rs); + return $row['description']; - } else { - return ''; - } - } - /** - * This functions stores the glossary in the database - * - * @param array Array of title + description (glossary_title => $title, glossary_comment => $comment) - * @return mixed Term id on success, false on failure - * @author Christian Fasanando - * @author Patrick Cool , Ghent University, Belgium - * @version januari 2009, dokeos 1.8.6 - */ - function save_glossary($values, $message = true) { - if (!is_array($values) or !isset($values['glossary_title'])) { - return false; - } - // Database table definition - $t_glossary = Database :: get_course_table(TABLE_GLOSSARY); - - // get the maximum display order of all the glossary items - $max_glossary_item = GlossaryManager::get_max_glossary_item(); - - // session_id - $session_id = api_get_session_id(); - - // check if the glossary term already exists - if (GlossaryManager::glossary_exists($values['glossary_title'])) { - // display the feedback message - if ($message) + } else { + return ''; + } + } + + /** + * This functions stores the glossary in the database + * + * @param array Array of title + description (glossary_title => $title, glossary_comment => $comment) + * @return mixed Term id on success, false on failure + * @author Christian Fasanando + * @author Patrick Cool , Ghent University, Belgium + * @version januari 2009, dokeos 1.8.6 + */ + function save_glossary($values, $message = true) + { + if (!is_array($values) or !isset($values['glossary_title'])) { + return false; + } + // Database table definition + $t_glossary = Database :: get_course_table(TABLE_GLOSSARY); + + // get the maximum display order of all the glossary items + $max_glossary_item = GlossaryManager::get_max_glossary_item(); + + // session_id + $session_id = api_get_session_id(); + + // check if the glossary term already exists + if (GlossaryManager::glossary_exists($values['glossary_title'])) { + // display the feedback message + if ($message) { Display::display_error_message(get_lang('GlossaryTermAlreadyExistsYouShouldEditIt')); - return false; - } else { - $sql = "INSERT INTO $t_glossary (c_id, name, description, display_order, session_id) + } + + return false; + } else { + $sql = "INSERT INTO $t_glossary (c_id, name, description, display_order, session_id) VALUES( ".api_get_course_int_id().", '".Database::escape_string($values['glossary_title'])."', @@ -109,463 +125,577 @@ class GlossaryManager { '".(int)($max_glossary_item + 1)."', '".Database::escape_string($session_id)."' )"; - $result = Database::query($sql); - if ($result === false) { return false; } - $id = Database::insert_id(); - //insert into item_property - api_item_property_update(api_get_course_info(), TOOL_GLOSSARY, $id, 'GlossaryAdded', api_get_user_id()); - $_SESSION['max_glossary_display'] = GlossaryManager::get_max_glossary_item(); - // display the feedback message - if ($message) + $result = Database::query($sql); + if ($result === false) { + return false; + } + $id = Database::insert_id(); + //insert into item_property + api_item_property_update(api_get_course_info(), TOOL_GLOSSARY, $id, 'GlossaryAdded', api_get_user_id()); + $_SESSION['max_glossary_display'] = GlossaryManager::get_max_glossary_item(); + // display the feedback message + if ($message) { Display::display_confirmation_message(get_lang('TermAdded')); + } + return $id; - } - } - - /** - * update the information of a glossary term in the database - * - * @param array $values an array containing all the form elements - * @return boolean True on success, false on failure - * @author Christian Fasanando - * @author Patrick Cool , Ghent University, Belgium - * @version januari 2009, dokeos 1.8.6 - */ - function update_glossary($values, $message = true) { - // Database table definition - $t_glossary = Database :: get_course_table(TABLE_GLOSSARY); - - $course_id = api_get_course_int_id(); - - // check if the glossary term already exists - if (GlossaryManager::glossary_exists($values['glossary_title'],$values['glossary_id'])) { - // display the feedback message - if ($message) + } + } + + /** + * update the information of a glossary term in the database + * + * @param array $values an array containing all the form elements + * @return boolean True on success, false on failure + * @author Christian Fasanando + * @author Patrick Cool , Ghent University, Belgium + * @version januari 2009, dokeos 1.8.6 + */ + function update_glossary($values, $message = true) + { + // Database table definition + $t_glossary = Database :: get_course_table(TABLE_GLOSSARY); + + $course_id = api_get_course_int_id(); + + // check if the glossary term already exists + if (GlossaryManager::glossary_exists($values['glossary_title'], $values['glossary_id'])) { + // display the feedback message + if ($message) { Display::display_error_message(get_lang('GlossaryTermAlreadyExistsYouShouldEditIt')); - return false; - } else { - $sql = "UPDATE $t_glossary SET + } + + return false; + } else { + $sql = "UPDATE $t_glossary SET name = '".Database::escape_string($values['glossary_title'])."', description = '".Database::escape_string($values['glossary_comment'])."' WHERE c_id = $course_id AND glossary_id = ".Database::escape_string($values['glossary_id']); - $result = Database::query($sql); - if ($result === false) { return false; } - //update glossary into item_property - api_item_property_update(api_get_course_info(), TOOL_GLOSSARY, Database::escape_string($values['glossary_id']), 'GlossaryUpdated', api_get_user_id()); - // display the feedback message - if ($message) + $result = Database::query($sql); + if ($result === false) { + return false; + } + //update glossary into item_property + api_item_property_update( + api_get_course_info(), + TOOL_GLOSSARY, + Database::escape_string($values['glossary_id']), + 'GlossaryUpdated', + api_get_user_id() + ); + // display the feedback message + if ($message) { Display::display_confirmation_message(get_lang('TermUpdated')); - } - return true; - } - - /** - * Get the maximum display order of the glossary item - * @return integer Maximum glossary display order - * @author Christian Fasanando - * @author Patrick Cool , Ghent University, Belgium - * @version januari 2009, dokeos 1.8.6 - */ - function get_max_glossary_item() { - // Database table definition - $t_glossary = Database :: get_course_table(TABLE_GLOSSARY); - $course_id = api_get_course_int_id(); - $get_max = "SELECT MAX(display_order) FROM $t_glossary WHERE c_id = $course_id "; - $res_max = Database::query($get_max); - if (Database::num_rows($res_max)==0) { - return 0; - } - $row = Database::fetch_array($res_max); - if (!empty($row[0])) { - return $row[0]; - } - return 0; - } - - /** - * check if the glossary term exists or not - * - * @param string Term to look for - * @param integer ID to counter-check if the term exists with this ID as well (optional) - * @return bool True if term exists - * - * @author Patrick Cool , Ghent University, Belgium - * @version januari 2009, dokeos 1.8.6 - */ - function glossary_exists($term,$not_id='') { - // Database table definition - $t_glossary = Database :: get_course_table(TABLE_GLOSSARY); - $course_id = api_get_course_int_id(); + } + } - $sql = "SELECT name FROM $t_glossary WHERE c_id = $course_id AND name = '".Database::escape_string($term)."'"; - if ($not_id<>'') { - $sql .= " AND glossary_id <> '".Database::escape_string($not_id)."'"; - } - $result = Database::query($sql); - $count = Database::num_rows($result); - if ($count > 0) { - return true; - } else { - return false; - } - } - - /** - * Get one specific glossary term data - * - * @param integer ID of the flossary term - * @return mixed Array(glossary_id,glossary_title,glossary_comment,glossary_display_order) or false on error - * - * @author Patrick Cool , Ghent University, Belgium - */ - static function get_glossary_information($glossary_id) { - // Database table definition - $t_glossary = Database :: get_course_table(TABLE_GLOSSARY); - $t_item_propery = Database :: get_course_table(TABLE_ITEM_PROPERTY); - if (empty($glossary_id)) { return false; } - $sql = "SELECT g.glossary_id as glossary_id, + return true; + } + + /** + * Get the maximum display order of the glossary item + * @return integer Maximum glossary display order + * @author Christian Fasanando + * @author Patrick Cool , Ghent University, Belgium + * @version januari 2009, dokeos 1.8.6 + */ + function get_max_glossary_item() + { + // Database table definition + $t_glossary = Database :: get_course_table(TABLE_GLOSSARY); + $course_id = api_get_course_int_id(); + $get_max = "SELECT MAX(display_order) FROM $t_glossary WHERE c_id = $course_id "; + $res_max = Database::query($get_max); + if (Database::num_rows($res_max) == 0) { + return 0; + } + $row = Database::fetch_array($res_max); + if (!empty($row[0])) { + return $row[0]; + } + + return 0; + } + + /** + * check if the glossary term exists or not + * + * @param string Term to look for + * @param integer ID to counter-check if the term exists with this ID as well (optional) + * @return bool True if term exists + * + * @author Patrick Cool , Ghent University, Belgium + * @version januari 2009, dokeos 1.8.6 + */ + function glossary_exists($term, $not_id = '') + { + // Database table definition + $t_glossary = Database :: get_course_table(TABLE_GLOSSARY); + $course_id = api_get_course_int_id(); + + $sql = "SELECT name FROM $t_glossary WHERE c_id = $course_id AND name = '".Database::escape_string($term)."'"; + if ($not_id <> '') { + $sql .= " AND glossary_id <> '".Database::escape_string($not_id)."'"; + } + $result = Database::query($sql); + $count = Database::num_rows($result); + if ($count > 0) { + return true; + } else { + return false; + } + } + + /** + * Get one specific glossary term data + * + * @param integer ID of the flossary term + * @return mixed Array(glossary_id,glossary_title,glossary_comment,glossary_display_order) or false on error + * + * @author Patrick Cool , Ghent University, Belgium + */ + static function get_glossary_information($glossary_id) + { + // Database table definition + $t_glossary = Database :: get_course_table(TABLE_GLOSSARY); + $t_item_propery = Database :: get_course_table(TABLE_ITEM_PROPERTY); + if (empty($glossary_id)) { + return false; + } + $sql = "SELECT g.glossary_id as glossary_id, g.name as glossary_title, g.description as glossary_comment, g.display_order as glossary_display_order, ip.insert_date as insert_date, - ip.lastedit_date as update_date, - g.session_id + ip.lastedit_date as update_date, + g.session_id FROM $t_glossary g, $t_item_propery ip - WHERE g.glossary_id = ip.ref AND - tool = '".TOOL_GLOSSARY."' AND + WHERE g.glossary_id = ip.ref AND + tool = '".TOOL_GLOSSARY."' AND g.glossary_id = '".intval($glossary_id)."' AND g.c_id = ".api_get_course_int_id()." AND ip.c_id = ".api_get_course_int_id()." "; - $result = Database::query($sql); - if ($result === false || Database::num_rows($result) != 1) { - return false; - } - return Database::fetch_array($result); - } - - /** - * Delete a glossary term (and re-order all the others) - * - * @param integer The id of the glossary term to delete - * @return bool True on success, false on failure - * @author Patrick Cool , Ghent University, Belgium - * @version januari 2009, dokeos 1.8.6 - */ - function delete_glossary($glossary_id, $message = true) { - // Database table definition - $t_glossary = Database :: get_course_table(TABLE_GLOSSARY); - $course_id = api_get_course_int_id(); - - if (empty($glossary_id)) { return false; } - - $sql = "DELETE FROM $t_glossary WHERE c_id = $course_id AND glossary_id='".Database::escape_string($glossary_id)."'"; - $result = Database::query($sql); - if ($result === false or Database::affected_rows() < 1) { return false; } - //update item_property (delete) - api_item_property_update(api_get_course_info(), TOOL_GLOSSARY, Database::escape_string($glossary_id), 'delete', api_get_user_id()); - - // reorder the remaining terms - GlossaryManager::reorder_glossary(); - $_SESSION['max_glossary_display'] = GlossaryManager::get_max_glossary_item(); - if ($message) + $result = Database::query($sql); + if ($result === false || Database::num_rows($result) != 1) { + return false; + } + + return Database::fetch_array($result); + } + + /** + * Delete a glossary term (and re-order all the others) + * + * @param integer The id of the glossary term to delete + * @return bool True on success, false on failure + * @author Patrick Cool , Ghent University, Belgium + * @version januari 2009, dokeos 1.8.6 + */ + function delete_glossary($glossary_id, $message = true) + { + // Database table definition + $t_glossary = Database :: get_course_table(TABLE_GLOSSARY); + $course_id = api_get_course_int_id(); + + if (empty($glossary_id)) { + return false; + } + + $sql = "DELETE FROM $t_glossary WHERE c_id = $course_id AND glossary_id='".Database::escape_string( + $glossary_id + )."'"; + $result = Database::query($sql); + if ($result === false or Database::affected_rows() < 1) { + return false; + } + //update item_property (delete) + api_item_property_update( + api_get_course_info(), + TOOL_GLOSSARY, + Database::escape_string($glossary_id), + 'delete', + api_get_user_id() + ); + + // reorder the remaining terms + GlossaryManager::reorder_glossary(); + $_SESSION['max_glossary_display'] = GlossaryManager::get_max_glossary_item(); + if ($message) { Display::display_confirmation_message(get_lang('TermDeleted')); - return true; - } - - /** - * This is the main function that displays the list or the table with all - * the glossary terms - * @param string View ('table' or 'list'). Optional parameter. Defaults to 'table' and prefers glossary_view from the session by default. - * @return void - * @author Patrick Cool , Ghent University, Belgium - * @version januari 2009, dokeos 1.8.6 - */ - static function display_glossary($view = 'table') { - // This function should always be called with the corresponding - // parameter for view type. Meanwhile, use this cheap trick. - if (empty($_SESSION['glossary_view'])) { - $_SESSION['glossary_view'] = $view; - } - // action links - echo '
'; - - if (api_is_allowed_to_edit(null,true)) { - echo ''.Display::return_icon('new_glossary_term.png',get_lang('TermAddNew'),'','32').''; - } - - echo ''.Display::return_icon('export_csv.png',get_lang('ExportGlossaryAsCSV'),'','32').''; - if (api_is_allowed_to_edit(null,true)) { - echo ''.Display::return_icon('import_csv.png',get_lang('ImportGlossary'),'','32').''; - } - - echo ''.Display::return_icon('pdf.png',get_lang('ExportToPDF'),'', ICON_SIZE_MEDIUM).''; - - if ((isset($_SESSION['glossary_view']) && $_SESSION['glossary_view'] == 'table') or (!isset($_SESSION['glossary_view']))){ - echo ''.Display::return_icon('view_detailed.png',get_lang('ListView'),'','32').''; - } else { - echo ''.Display::return_icon('view_text.png',get_lang('TableView'),'','32').''; - } - echo '
'; - if (!$_SESSION['glossary_view'] OR $_SESSION['glossary_view'] == 'table') { - $table = new SortableTable('glossary', array('GlossaryManager','get_number_glossary_terms'), array('GlossaryManager','get_glossary_data'),0); - //$table->set_header(0, '', false); - $table->set_header(0, get_lang('TermName'), true); - $table->set_header(1, get_lang('TermDefinition'), true); - if (api_is_allowed_to_edit(null,true)) { - $table->set_header(2, get_lang('Actions'), false, 'width=90px', array('class' => 'td_actions')); - $table->set_column_filter(2, array('GlossaryManager','actions_filter')); - } - $table->display(); - } - if ($_SESSION['glossary_view'] == 'list') { - GlossaryManager::display_glossary_list(); - } - } - - /** - * Display the glossary terms in a list - * @return bool True - * @author Patrick Cool , Ghent University, Belgium - * @version januari 2009, dokeos 1.8.6 - */ - function display_glossary_list() { - $glossary_data = self::get_glossary_data(0,1000,0,'ASC'); - foreach($glossary_data as $key=>$glossary_item) { - echo '
'.$glossary_item[0].'
'; - echo '
'.$glossary_item[1].'
'; - if (api_is_allowed_to_edit(null,true)) { - echo '
'.self::actions_filter($glossary_item[2], '',$glossary_item).'
'; - } - } - return true; - } - - /** - * Get the number of glossary terms in the course (or course+session) - * @param int Session ID filter (optional) - * @return integer Count of glossary terms - * - * @author Patrick Cool , Ghent University, Belgium - * @version januari 2009, dokeos 1.8.6 - */ - static function get_number_glossary_terms($session_id=0) { - // Database table definition - $t_glossary = Database :: get_course_table(TABLE_GLOSSARY); - $course_id = api_get_course_int_id(); - - $session_id = intval($session_id); - $sql_filter = api_get_session_condition($session_id, true, true); - $sql = "SELECT count(glossary_id) as total FROM $t_glossary WHERE c_id = $course_id $sql_filter"; - $res = Database::query($sql); - if ($res === false) { return 0; } - $obj = Database::fetch_object($res); - return $obj->total; - } - - /** - * Get all the data of a glossary - * - * @param integer From which item - * @param integer Number of items to collect - * @param string Name of column on which to order - * @param string Whether to sort in ascending (ASC) or descending (DESC) - * @return unknown - * - * @author Patrick Cool - * @author Julio Montoya fixing this function, adding intvals - * @version januari 2009, dokeos 1.8.6 - */ - static function get_glossary_data($from, $number_of_items, $column, $direction) { - global $_user; - // Database table definition - $t_glossary = Database :: get_course_table(TABLE_GLOSSARY); - $t_item_propery = Database :: get_course_table(TABLE_ITEM_PROPERTY); - - if (api_is_allowed_to_edit(null,true)) { - $col2 = " glossary.glossary_id as col2, "; - } else { - $col2 = " "; - } - - //condition for the session - $session_id = api_get_session_id(); - $condition_session = api_get_session_condition($session_id, true, true); - $column = intval($column); - if (!in_array($direction,array('DESC', 'ASC'))) { - $direction = 'ASC'; - } - $from = intval($from); - $number_of_items = intval($number_of_items); - - $sql = "SELECT glossary.name as col0, - glossary.description as col1, + } + + return true; + } + + /** + * This is the main function that displays the list or the table with all + * the glossary terms + * @param string View ('table' or 'list'). Optional parameter. Defaults to 'table' and prefers glossary_view from the session by default. + * @return void + * @author Patrick Cool , Ghent University, Belgium + * @version januari 2009, dokeos 1.8.6 + */ + static function display_glossary($view = 'table') + { + // This function should always be called with the corresponding + // parameter for view type. Meanwhile, use this cheap trick. + if (empty($_SESSION['glossary_view'])) { + $_SESSION['glossary_view'] = $view; + } + // action links + echo '
'; + + if (api_is_allowed_to_edit(null, true)) { + echo ''.Display::return_icon( + 'new_glossary_term.png', + get_lang('TermAddNew'), + '', + '32' + ).''; + } + + echo ''.Display::return_icon( + 'export_csv.png', + get_lang('ExportGlossaryAsCSV'), + '', + '32' + ).''; + if (api_is_allowed_to_edit(null, true)) { + echo ''.Display::return_icon( + 'import_csv.png', + get_lang('ImportGlossary'), + '', + '32' + ).''; + } + + echo ''.Display::return_icon( + 'pdf.png', + get_lang('ExportToPDF'), + '', + ICON_SIZE_MEDIUM + ).''; + + if ((isset($_SESSION['glossary_view']) && $_SESSION['glossary_view'] == 'table') or (!isset($_SESSION['glossary_view']))) { + echo ''.Display::return_icon( + 'view_detailed.png', + get_lang('ListView'), + '', + '32' + ).''; + } else { + echo ''.Display::return_icon( + 'view_text.png', + get_lang('TableView'), + '', + '32' + ).''; + } + echo '
'; + if (!$_SESSION['glossary_view'] OR $_SESSION['glossary_view'] == 'table') { + $table = new SortableTable('glossary', array( + 'GlossaryManager', + 'get_number_glossary_terms' + ), array( + 'GlossaryManager', + 'get_glossary_data' + ), 0); + //$table->set_header(0, '', false); + $table->set_header(0, get_lang('TermName'), true); + $table->set_header(1, get_lang('TermDefinition'), true); + if (api_is_allowed_to_edit(null, true)) { + $table->set_header(2, get_lang('Actions'), false, 'width=90px', array('class' => 'td_actions')); + $table->set_column_filter(2, array('GlossaryManager', 'actions_filter')); + } + $table->display(); + } + if ($_SESSION['glossary_view'] == 'list') { + GlossaryManager::display_glossary_list(); + } + } + + /** + * Display the glossary terms in a list + * @return bool True + * @author Patrick Cool , Ghent University, Belgium + * @version januari 2009, dokeos 1.8.6 + */ + function display_glossary_list() + { + $glossary_data = self::get_glossary_data(0, 1000, 0, 'ASC'); + foreach ($glossary_data as $key => $glossary_item) { + echo '
'.$glossary_item[0].'
'; + echo '
'.$glossary_item[1].'
'; + if (api_is_allowed_to_edit(null, true)) { + echo '
'.self::actions_filter($glossary_item[2], '', $glossary_item).'
'; + } + } + + return true; + } + + /** + * Get the number of glossary terms in the course (or course+session) + * @param int Session ID filter (optional) + * @return integer Count of glossary terms + * + * @author Patrick Cool , Ghent University, Belgium + * @version januari 2009, dokeos 1.8.6 + */ + static function get_number_glossary_terms($session_id = 0) + { + // Database table definition + $t_glossary = Database :: get_course_table(TABLE_GLOSSARY); + $course_id = api_get_course_int_id(); + + $session_id = intval($session_id); + $sql_filter = api_get_session_condition($session_id, true, true); + $sql = "SELECT count(glossary_id) as total FROM $t_glossary WHERE c_id = $course_id $sql_filter"; + $res = Database::query($sql); + if ($res === false) { + return 0; + } + $obj = Database::fetch_object($res); + + return $obj->total; + } + + /** + * Get all the data of a glossary + * + * @param integer From which item + * @param integer Number of items to collect + * @param string Name of column on which to order + * @param string Whether to sort in ascending (ASC) or descending (DESC) + * @return unknown + * + * @author Patrick Cool + * @author Julio Montoya fixing this function, adding intvals + * @version januari 2009, dokeos 1.8.6 + */ + static function get_glossary_data($from, $number_of_items, $column, $direction) + { + global $_user; + // Database table definition + $t_glossary = Database :: get_course_table(TABLE_GLOSSARY); + $t_item_propery = Database :: get_course_table(TABLE_ITEM_PROPERTY); + + if (api_is_allowed_to_edit(null, true)) { + $col2 = " glossary.glossary_id as col2, "; + } else { + $col2 = " "; + } + + //condition for the session + $session_id = api_get_session_id(); + $condition_session = api_get_session_condition($session_id, true, true); + $column = intval($column); + if (!in_array($direction, array('DESC', 'ASC'))) { + $direction = 'ASC'; + } + $from = intval($from); + $number_of_items = intval($number_of_items); + + $sql = "SELECT glossary.name as col0, + glossary.description as col1, $col2 glossary.session_id as session_id FROM $t_glossary glossary, $t_item_propery ip - WHERE glossary.glossary_id = ip.ref AND + WHERE glossary.glossary_id = ip.ref AND tool = '".TOOL_GLOSSARY."' $condition_session AND glossary.c_id = ".api_get_course_int_id()." AND ip.c_id = ".api_get_course_int_id()." - ORDER BY col$column $direction + ORDER BY col$column $direction LIMIT $from,$number_of_items"; $res = Database::query($sql); - $return = array(); - $array = array(); - while ($data = Database::fetch_array($res)) { - //validacion when belongs to a session - $session_img = api_get_session_image($data['session_id'], $_user['status']); - $array[0] = $data[0] . $session_img; - - if (!$_SESSION['glossary_view'] || $_SESSION['glossary_view'] == 'table') { - $array[1] = str_replace(array('

','

'),array('','
'),$data[1]); - } else { - $array[1] = $data[1]; - } - - if (api_is_allowed_to_edit(null,true)) { - // Date treatment for timezones - /*if (!empty($data[2]) && $data[2] != '0000-00-00 00:00:00:') { + $return = array(); + $array = array(); + while ($data = Database::fetch_array($res)) { + //validacion when belongs to a session + $session_img = api_get_session_image($data['session_id'], $_user['status']); + $array[0] = $data[0].$session_img; + + if (!$_SESSION['glossary_view'] || $_SESSION['glossary_view'] == 'table') { + $array[1] = str_replace(array('

', '

'), array('', '
'), $data[1]); + } else { + $array[1] = $data[1]; + } + + if (api_is_allowed_to_edit(null, true)) { + // Date treatment for timezones + /*if (!empty($data[2]) && $data[2] != '0000-00-00 00:00:00:') { $array[2] = api_get_local_time($data[2], null, date_default_timezone_get()); - } - if (!empty($data[3]) && $data[3] != '0000-00-00 00:00:00:') { + } + if (!empty($data[3]) && $data[3] != '0000-00-00 00:00:00:') { $array[3] = api_get_local_time($data[3], null, date_default_timezone_get()); - }*/ - $array[2] = $data[2]; - } - $return[] = $array; - } - return $return; - } - - /** - * Update action icons column - * - * @param integer $glossary_id - * @param array Parameters to use to affect links - * @param array The line of results from a query on the glossary table - * @return string HTML string for the action icons columns - * - * @author Patrick Cool , Ghent University, Belgium - * @version januari 2009, dokeos 1.8.6 - */ - static function actions_filter($glossary_id, $url_params, $row) { - $glossary_id = $row[2]; - $return = ''.Display::return_icon('edit.png',get_lang('Edit'),'',22).''; - $glossary_data = GlossaryManager::get_glossary_information($glossary_id); - - $glossary_term = $glossary_data['glossary_title']; - - if (api_is_allowed_to_edit(null, true)) { - if ($glossary_data['session_id'] == api_get_session_id()) { - $return .= ''.Display::return_icon('delete.png', get_lang('Delete'),'',22).''; - } else { - $return = get_lang('EditionNotAvailableFromSession'); + }*/ + $array[2] = $data[2]; } - } - - return $return; - } - - /** - * a little bit of javascript to display a prettier warning when deleting a term - * - * @return string HTML string including JavaScript - * - * @author Patrick Cool , Ghent University, Belgium - * @version januari 2009, dokeos 1.8.6 - */ - static function javascript_glossary() { - return ""; - } - - /** - * Re-order glossary - * - * @author Patrick Cool , Ghent University, Belgium - * @version januari 2009, dokeos 1.8.6 - */ - function reorder_glossary() { - // Database table definition - $t_glossary = Database :: get_course_table(TABLE_GLOSSARY); - $course_id = api_get_course_int_id(); - $sql = "SELECT * FROM $t_glossary WHERE c_id = $course_id ORDER by display_order ASC"; - $res = Database::query($sql); - - $i = 1; - while ($data = Database::fetch_array($res)) { - $sql_reorder = "UPDATE $t_glossary SET display_order = $i - WHERE c_id = $course_id AND glossary_id = '".Database::escape_string($data['glossary_id'])."'"; - Database::query($sql_reorder); - $i++; - } - } - - /** - * Move a glossary term - * - * @param unknown_type $direction - * @param unknown_type $glossary_id - * - * @author Patrick Cool , Ghent University, Belgium - * @version januari 2009, dokeos 1.8.6 - */ - function move_glossary($direction, $glossary_id, $message = true) { - // Database table definition - $t_glossary = Database :: get_course_table(TABLE_GLOSSARY); - - // sort direction - if ($direction == 'up') { - $sortorder = 'DESC'; - } else { - $sortorder = 'ASC'; - } + } + + /** + * Re-order glossary + * + * @author Patrick Cool , Ghent University, Belgium + * @version januari 2009, dokeos 1.8.6 + */ + function reorder_glossary() + { + // Database table definition + $t_glossary = Database :: get_course_table(TABLE_GLOSSARY); + $course_id = api_get_course_int_id(); + $sql = "SELECT * FROM $t_glossary WHERE c_id = $course_id ORDER by display_order ASC"; + $res = Database::query($sql); + + $i = 1; + while ($data = Database::fetch_array($res)) { + $sql_reorder = "UPDATE $t_glossary SET display_order = $i + WHERE c_id = $course_id AND glossary_id = '".Database::escape_string( + $data['glossary_id'] + )."'"; + Database::query($sql_reorder); + $i++; + } + } + + /** + * Move a glossary term + * + * @param unknown_type $direction + * @param unknown_type $glossary_id + * + * @author Patrick Cool , Ghent University, Belgium + * @version januari 2009, dokeos 1.8.6 + */ + function move_glossary($direction, $glossary_id, $message = true) + { + // Database table definition + $t_glossary = Database :: get_course_table(TABLE_GLOSSARY); + + // sort direction + if ($direction == 'up') { + $sortorder = 'DESC'; + } else { + $sortorder = 'ASC'; + } $course_id = api_get_course_int_id(); - $sql = "SELECT * FROM $t_glossary WHERE c_id = $course_id ORDER BY display_order $sortorder"; - $res = Database::query($sql); - $found = false; - while ($row = Database::fetch_array($res)) { - if ($found && empty($next_id)) { - $next_id = $row['glossary_id']; - $next_display_order = $row['display_order']; - } - - if ($row['glossary_id'] == $glossary_id) { - $current_id = $glossary_id; - $current_display_order = $row['display_order']; - $found = true; - } - } - $sql1 = "UPDATE $t_glossary SET display_order = '".Database::escape_string($next_display_order)."' WHERE c_id = $course_id AND glossary_id = '".Database::escape_string($current_id)."'"; - $sql2 = "UPDATE $t_glossary SET display_order = '".Database::escape_string($current_display_order)."' WHERE c_id = $course_id AND glossary_id = '".Database::escape_string($next_id)."'"; - $res = Database::query($sql1); - $res = Database::query($sql2); - if ($message) + $sql = "SELECT * FROM $t_glossary WHERE c_id = $course_id ORDER BY display_order $sortorder"; + $res = Database::query($sql); + $found = false; + while ($row = Database::fetch_array($res)) { + if ($found && empty($next_id)) { + $next_id = $row['glossary_id']; + $next_display_order = $row['display_order']; + } + + if ($row['glossary_id'] == $glossary_id) { + $current_id = $glossary_id; + $current_display_order = $row['display_order']; + $found = true; + } + } + $sql1 = "UPDATE $t_glossary SET display_order = '".Database::escape_string( + $next_display_order + )."' WHERE c_id = $course_id AND glossary_id = '".Database::escape_string($current_id)."'"; + $sql2 = "UPDATE $t_glossary SET display_order = '".Database::escape_string( + $current_display_order + )."' WHERE c_id = $course_id AND glossary_id = '".Database::escape_string($next_id)."'"; + $res = Database::query($sql1); + $res = Database::query($sql2); + if ($message) { Display::display_confirmation_message(get_lang('TermMoved')); - } - - static function export_to_pdf() { - $data = GlossaryManager::get_glossary_data(0, GlossaryManager::get_number_glossary_terms(api_get_session_id()), 0, 'ASC'); + } + } + + static function export_to_pdf() + { + $data = GlossaryManager::get_glossary_data( + 0, + GlossaryManager::get_number_glossary_terms(api_get_session_id()), + 0, + 'ASC' + ); $html = ''; $html .= '

'.get_lang('Glossary').'



'; foreach ($data as $item) { - $term = $item[0]; + $term = $item[0]; $description = $item[1]; $html .= '

'.$term.'

'.$description.'

'; } $html .= ''; $course_code = api_get_course_id(); - $pdf = new PDF(); - //$pdf->set_custom_header($title); + $pdf = new PDF(); + //$pdf->set_custom_header($title); /*$css_file = api_get_path(SYS_CODE_PATH).'css/print.css'; if (file_exists($css_file)) { $css = @file_get_contents($css_file); diff --git a/main/inc/lib/gradebook.lib.php b/main/inc/lib/gradebook.lib.php index 2a8d5f878e..1f6236e958 100644 --- a/main/inc/lib/gradebook.lib.php +++ b/main/inc/lib/gradebook.lib.php @@ -1,161 +1,194 @@ table = Database::get_main_table(TABLE_MAIN_GRADEBOOK_CATEGORY); - $this->table_skill = Database::get_main_table(TABLE_MAIN_SKILL); - $this->table_skill_rel_gradebook = Database::get_main_table(TABLE_MAIN_SKILL_REL_GRADEBOOK); + public function __construct() + { + $this->table = Database::get_main_table(TABLE_MAIN_GRADEBOOK_CATEGORY); + $this->table_skill = Database::get_main_table(TABLE_MAIN_SKILL); + $this->table_skill_rel_gradebook = Database::get_main_table(TABLE_MAIN_SKILL_REL_GRADEBOOK); } - + /** * Returns true if the gradebook is active and visible in a course, false * otherwise. - * + * * @param int $c_id Course integer id, defaults to the current course - * @return boolean + * @return boolean */ - public static function is_active($c_id = null) { - $name = 'gradebook'; - $table = Database::get_main_table(TABLE_MAIN_SETTINGS_CURRENT); - $sql = "SELECT * from $table WHERE variable='course_hide_tools' AND subkey='$name'"; - $setting = ResultSet::create($sql)->first(); - $setting = $setting ? $setting : array(); + public static function is_active($c_id = null) + { + $name = 'gradebook'; + $table = Database::get_main_table(TABLE_MAIN_SETTINGS_CURRENT); + $sql = "SELECT * from $table WHERE variable='course_hide_tools' AND subkey='$name'"; + $setting = ResultSet::create($sql)->first(); + $setting = $setting ? $setting : array(); $inactive = isset($setting['selected_value']) && $setting['selected_value'] == 'true'; - + if ($inactive) { return false; } - $c_id = $c_id ? intval($c_id) : api_get_course_int_id(); - $table = Database::get_course_table(TABLE_TOOL_LIST); - $sql = "SELECT * from $table WHERE c_id = $c_id and name='$name'"; - $item = ResultSet::create($sql)->first(); + $c_id = $c_id ? intval($c_id) : api_get_course_int_id(); + $table = Database::get_course_table(TABLE_TOOL_LIST); + $sql = "SELECT * from $table WHERE c_id = $c_id and name='$name'"; + $item = ResultSet::create($sql)->first(); if (empty($item)) { return true; - } + } + return $item['visibility'] == '1'; } - - public function get_all($options = array()) { + + public function get_all($options = array()) + { $gradebooks = parent::get_all($options); - foreach($gradebooks as &$gradebook) { + foreach ($gradebooks as &$gradebook) { if (empty($gradebook['name'])) { $gradebook['name'] = $gradebook['course_code']; - } + } } - return $gradebooks; + + return $gradebooks; } - - public function update($params) { + + public function update($params) + { return parent::update($params); } - - public function update_skills_to_gradebook($gradebook_id, $skill_list) { - + + public function update_skills_to_gradebook($gradebook_id, $skill_list) + { + if (!empty($skill_list)) { - + //Cleaning skills - $skill_list = array_map('intval', $skill_list); - $skill_list = array_filter($skill_list); - $skill_gradebook = new SkillRelGradebook(); - $skill_gradebooks_source = $skill_gradebook->get_all(array('where'=>array('gradebook_id = ?' =>$gradebook_id))); - $clean_gradebook = array(); + $skill_list = array_map('intval', $skill_list); + $skill_list = array_filter($skill_list); + $skill_gradebook = new SkillRelGradebook(); + $skill_gradebooks_source = $skill_gradebook->get_all( + array('where' => array('gradebook_id = ?' => $gradebook_id)) + ); + $clean_gradebook = array(); if (!empty($skill_gradebooks_source)) { - foreach($skill_gradebooks_source as $source) { - $clean_gradebook[]= $source['skill_id']; + foreach ($skill_gradebooks_source as $source) { + $clean_gradebook[] = $source['skill_id']; } - } + } if (!empty($clean_gradebook)) { $skill_to_remove = array_diff($clean_gradebook, $skill_list); - } - + } + foreach ($skill_list as $skill_id) { - $params = array(); + $params = array(); $params['gradebook_id'] = $gradebook_id; - $params['skill_id'] = $skill_id; - if (!$skill_gradebook->exists_gradebook_skill($gradebook_id, $skill_id)) { + $params['skill_id'] = $skill_id; + if (!$skill_gradebook->exists_gradebook_skill($gradebook_id, $skill_id)) { $skill_gradebook->save($params); } } - + if (!empty($skill_to_remove)) { - foreach($skill_to_remove as $remove) { + foreach ($skill_to_remove as $remove) { $skill_item = $skill_gradebook->get_skill_info($remove, $gradebook_id); $skill_gradebook->delete($skill_item['id']); } - } + } + return true; - } - return false; + } + + return false; } - + /** * Returns a Form validator Obj * @todo the form should be auto generated * @param string url * @param string action add, edit - * @return obj form validator obj + * @return obj form validator obj */ - public function show_skill_form($gradebook_id, $url, $header = null) { - + public function show_skill_form($gradebook_id, $url, $header = null) + { + $form = new FormValidator('gradebook_add_skill', 'POST', $url); // Settting the form elements if (!isset($header)) { $header = get_lang('Add'); - } + } $form->addElement('header', '', $header); $id = isset($_GET['id']) ? intval($_GET['id']) : ''; $form->addElement('hidden', 'id', $id); - - $skill = new Skill(); - $skills = $skill->get_all(); + + $skill = new Skill(); + $skills = $skill->get_all(); $clean_skill_list = array(); foreach ($skills as $skill) { $clean_skill_list[$skill['id']] = $skill['name']; - } - $form->addElement('select', 'skill', get_lang('Skills'), $clean_skill_list, array('width'=>'450px', 'class'=>'chzn-select','multiple' => 'multiple')); - - $selected_skills = self::get_skills_by_gradebook($gradebook_id); + } + $form->addElement( + 'select', + 'skill', + get_lang('Skills'), + $clean_skill_list, + array('width' => '450px', 'class' => 'chzn-select', 'multiple' => 'multiple') + ); + + $selected_skills = self::get_skills_by_gradebook($gradebook_id); $clean_selected_skills = array(); if (!empty($selected_skills)) { - foreach($selected_skills as $skill) { + foreach ($selected_skills as $skill) { $clean_selected_skills[] = $skill['id']; } } - + $form->addElement('style_submit_button', 'submit', get_lang('Add'), 'class="save"'); - - $form->setDefaults(array('skill'=>$clean_selected_skills)); - return $form; + + $form->setDefaults(array('skill' => $clean_selected_skills)); + + return $form; } - function get_skills_by_gradebook($gradebook_id) { + function get_skills_by_gradebook($gradebook_id) + { $gradebook_id = intval($gradebook_id); - $sql = "SELECT skill.id, skill.name FROM {$this->table_skill} skill INNER JOIN {$this->table_skill_rel_gradebook} skill_rel_gradebook - ON skill.id = skill_rel_gradebook.skill_id + $sql = "SELECT skill.id, skill.name FROM {$this->table_skill} skill INNER JOIN {$this->table_skill_rel_gradebook} skill_rel_gradebook + ON skill.id = skill_rel_gradebook.skill_id WHERE skill_rel_gradebook.gradebook_id = $gradebook_id"; - $result = Database::query($sql); - $result = Database::store_result($result,'ASSOC'); + $result = Database::query($sql); + $result = Database::store_result($result, 'ASSOC'); + return $result; - } - + } + /** * Displays the title + grid */ - public function display() { + public function display() + { // action links - echo Display::grid_html('gradebooks'); + echo Display::grid_html('gradebooks'); } }