Chamilo is a learning management system focused on ease of use and accessibility
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
chamilo-lms/main/glossary/index.php

603 lines
19 KiB

<?php //$id: $
/* For licensing terms, see /dokeos_license.txt */
/**
* @package dokeos.glossary
* @author Christian Fasanando, initial version
* @author Patrick Cool <patrick.cool@UGent.be>, Ghent University, Belgium, refactoring and tighter integration in Dokeos
*/
// name of the language file that needs to be included
$language_file = array('glossary');
// including the global dokeos file
require_once('../inc/global.inc.php');
require_once('../inc/lib/events.lib.inc.php');
// the section (tabs)
$this_section=SECTION_COURSES;
// notice for unauthorized people.
api_protect_course_script(true);
// including additional libraries
require_once (api_get_path(LIBRARY_PATH).'formvalidator/FormValidator.class.php');
// additional javascript
$htmlHeadXtra[] = javascript_glossary();
// setting the tool constants
$tool = TOOL_GLOSSARY;
// tracking
event_access_tool(TOOL_GLOSSARY);
// displaying the header
Display::display_header(get_lang(ucfirst($tool)));
// tool introduction
$fck_attribute['Width'] = '100%';
$fck_attribute['Height'] = '300';
$fck_attribute['ToolbarSet'] = 'Introduction';
Display::display_introduction_section(TOOL_GLOSSARY,'left');
$fck_attribute = null; // Clearing this global variable immediatelly after it has been used.
// Glossary FckEditor setting
$fck_attribute['Width'] = '100%';
$fck_attribute['Height'] = '400';
$fck_attribute['ToolbarSet'] = 'Glossary';
// action links
echo '<div class="actions">';
if (api_is_allowed_to_edit())
{
echo '<a href="index.php?'.api_get_cidreq().'&action=addglossary&msg=add">'.Display::return_icon('filenew.gif',get_lang('TermAddNew')).get_lang('TermAddNew').'</a>';
}
echo '<a href="index.php?'.api_get_cidreq().'&action=changeview&view=list">'.Display::return_icon('view_list.gif',get_lang('ListView')).get_lang('ListView').'</a>';
echo '<a href="index.php?'.api_get_cidreq().'&action=changeview&view=table">'.Display::return_icon('view_table.gif',get_lang('TableView')).get_lang('TableView').'</a>';
echo '</div>';
if ($_GET['action'] == 'changeview' AND in_array($_GET['view'],array('list','table')))
{
$_SESSION['glossary_view'] = $_GET['view'];
}
if (api_is_allowed_to_edit())
{
// Adding a glossary
if (isset($_GET['action']) && $_GET['action'] == 'addglossary')
{
if (isset($_GET['msg']) && $_GET['msg'] == 'add') {
api_display_tool_title(get_lang('TermAddNew'));
}
// initiate the object
$form = new FormValidator('glossary','post', api_get_self().'?action='.Security::remove_XSS($_GET['action']));
// settting the form elements
$form->addElement('text', 'glossary_title', get_lang('TermName'));
$form->addElement('html_editor', 'glossary_comment', get_lang('TermDefinition'));
$form->addElement('style_submit_button', 'SubmitGlossary', get_lang('TermAddButton'), 'class="add"');
// setting the rules
$form->addRule('glossary_title', '<div class="required">'.get_lang('ThisFieldIsRequired'), 'required');
// The validation or display
if ( $form->validate() )
{
$check = Security::check_token('post');
if ($check)
{
$values = $form->exportValues();
save_glossary($values);
display_glossary();
}
Security::clear_token();
}
else
{
$token = Security::get_token();
$form->addElement('hidden','sec_token');
$form->setConstants(array('sec_token' => $token));
$form->display();
}
}
// Editing a glossary
else if (isset($_GET['action']) && $_GET['action'] == 'edit_glossary' && is_numeric($_GET['glossary_id']))
{
if (isset($_GET['msg']) && $_GET['msg'] == 'edit') {
api_display_tool_title(get_lang('TermEdit'));
}
// initiate the object
$form = new FormValidator('glossary','post', api_get_self().'?action='.Security::remove_XSS($_GET['action']).'&glossary_id='.Security::remove_XSS($_GET['glossary_id']));
// settting the form elements
$form->addElement('hidden', 'glossary_id');
$form->addElement('text', 'glossary_title', get_lang('TermName'));
$form->addElement('html_editor', 'glossary_comment', get_lang('TermDefinition'));
$form->addElement('style_submit_button', 'SubmitGlossary', get_lang('TermUpdateButton'), 'class="save"');
// setting the defaults
$defaults = get_glossary_information(Security::remove_XSS($_GET['glossary_id']));
$form->setDefaults($defaults);
// setting the rules
$form->addRule('glossary_title', '<div class="required">'.get_lang('ThisFieldIsRequired'), 'required');
// The validation or display
if ( $form->validate() )
{
$check = Security::check_token('post');
if ($check)
{
$values = $form->exportValues();
update_glossary($values);
display_glossary();
}
Security::clear_token();
}
else
{
$token = Security::get_token();
$form->addElement('hidden','sec_token');
$form->setConstants(array('sec_token' => $token));
$form->display();
}
}
// deleting a glossary
else if (isset($_GET['action']) && $_GET['action'] == 'delete_glossary' && is_numeric($_GET['glossary_id']))
{
delete_glossary(Security::remove_XSS($_GET['glossary_id']));
display_glossary();
}
// moving a glossary term up
else if (isset($_GET['action']) && $_GET['action'] == 'moveup' && is_numeric($_GET['glossary_id']))
{
move_glossary('up',$_GET['glossary_id']);
display_glossary();
}
// moving a glossary term up
else if (isset($_GET['action']) && $_GET['action'] == 'movedown' && is_numeric($_GET['glossary_id']))
{
move_glossary('down',$_GET['glossary_id']);
display_glossary();
} else {
display_glossary();
}
} else {
display_glossary();
}
// footer
Display::display_footer();
/**
* This functions stores the glossary in the database
*
* @param unknown_type $values
*
* @author Christian Fasanando <christian.fasanando@dokeos.com>
* @author Patrick Cool <patrick.cool@ugent.be>, Ghent University, Belgium
* @version januari 2009, dokeos 1.8.6
*/
function save_glossary($values)
{
// Database table definition
$t_glossary = Database :: get_course_table(TABLE_GLOSSARY);
// get the maximum display order of all the glossary items
$max_glossary_item = get_max_glossary_item();
// check if the glossary term already exists
if (glossary_exists($values['glossary_title']))
{
// display the feedback message
Display::display_error_message('GlossaryTermAlreadyExistsYouShouldEditIt');
}
else
{
$sql = "INSERT INTO $t_glossary (name, description,display_order)
VALUES(
'".Database::escape_string($values['glossary_title'])."',
'".Database::escape_string($values['glossary_comment'])."',
'".(int)($max_glossary_item + 1)."')";
$result = api_sql_query($sql, __FILE__, __LINE__);
$id = Database::get_last_insert_id();
if ($id>0) {
//insert into item_property
api_item_property_update(api_get_course_info(),TOOL_GLOSSARY,$id,'GlossaryAdded',api_get_user_id());
}
$_SESSION['max_glossary_display'] = get_max_glossary_item();
// display the feedback message
Display::display_confirmation_message(get_lang('TermAdded'));
}
}
/**
* update the information of a glossary term in the database
*
* @param array $values an array containing all the form elements
*
* @author Christian Fasanando <christian.fasanando@dokeos.com>
* @author Patrick Cool <patrick.cool@ugent.be>, Ghent University, Belgium
* @version januari 2009, dokeos 1.8.6
*/
function update_glossary($values)
{
// Database table definition
$t_glossary = Database :: get_course_table(TABLE_GLOSSARY);
// check if the glossary term already exists
if (glossary_exists($values['glossary_title'],$values['glossary_id']))
{
// display the feedback message
Display::display_error_message('GlossaryTermAlreadyExistsYouShouldEditIt');
}
else
{
$sql = "UPDATE $t_glossary SET
name = '".Database::escape_string($values['glossary_title'])."',
description = '".Database::escape_string($values['glossary_comment'])."'
WHERE glossary_id = ".Database::escape_string($values['glossary_id']);
$result = api_sql_query($sql, __FILE__, __LINE__);
//update glossary into item_property
api_item_property_update(api_get_course_info(),TOOL_GLOSSARY,Database::escape_string($values['glossary_id']),'GlossaryModified',api_get_user_id());
// display the feedback message
Display::display_confirmation_message(get_lang('TermUpdated'));
}
}
/**
* Get the maximum display order of the glossary item
*
* @author Christian Fasanando <christian.fasanando@dokeos.com>
* @author Patrick Cool <patrick.cool@ugent.be>, 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);
$get_max = "SELECT MAX(display_order) FROM $t_glossary";
$res_max = api_sql_query($get_max, __FILE__, __LINE__);
$dsp=0;
$row = Database::fetch_array($res_max);
return $row[0];
}
/**
* check if the glossary term exists or not
*
* @param unknown_type $term
* @param unknown_type $not_id
* @return unknown
*
* @author Patrick Cool <patrick.cool@ugent.be>, 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);
$sql = "SELECT name FROM $t_glossary WHERE name = '".Database::escape_string($term)."'";
if ($not_id<>'')
{
$sql .= " AND glossary_id <> '".Database::escape_string($not_id)."'";
}
$result = api_sql_query($sql,__FILE__,__LINE__);
$count = Database::num_rows($result);
if ($count > 0)
{
return true;
}
else
{
return false;
}
}
/**
* get all the information about one specific glossary term
*
* @param unknown_type $glossary_id
* @return unknown
*
* @author Patrick Cool <patrick.cool@ugent.be>, Ghent University, Belgium
* @version januari 2009, dokeos 1.8.6
*/
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);
$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
FROM $t_glossary g, $t_item_propery ip
WHERE g.glossary_id = ip.ref
AND tool = '".TOOL_GLOSSARY."'
AND g.glossary_id = '".Database::escape_string($glossary_id)."' ";
$result = api_sql_query($sql, __FILE__, __LINE__);
return Database::fetch_array($result);
}
/**
* Delete a glossary term (and re-order all the others)
*
* @param integer $glossary_id the id of the glossary
*
* @author Patrick Cool <patrick.cool@ugent.be>, Ghent University, Belgium
* @version januari 2009, dokeos 1.8.6
*/
function delete_glossary($glossary_id)
{
// Database table definition
$t_glossary = Database :: get_course_table(TABLE_GLOSSARY);
$sql = "DELETE FROM $t_glossary WHERE glossary_id='".Database::escape_string($glossary_id)."'";
$result = api_sql_query($sql, __FILE__, __LINE__);
// reorder the remaining terms
reorder_glossary();
$_SESSION['max_glossary_display'] = get_max_glossary_item();
Display::display_confirmation_message(get_lang('TermDeleted'));
}
/**
* This is the main function that display the list or the table with all the glossary terms
*
* @author Patrick Cool <patrick.cool@ugent.be>, Ghent University, Belgium
* @version januari 2009, dokeos 1.8.6
*/
function display_glossary()
{
if (!$_SESSION['glossary_view'] OR $_SESSION['glossary_view'] == 'table')
{
$table = new SortableTable('glossary', 'get_number_glossary_terms', 'get_glossary_data',0);
$table->set_header(0, get_lang('DisplayOrder'), true);
$table->set_header(1, get_lang('TermName'), true);
$table->set_header(2, get_lang('TermDefinition'), true);
$table->set_header(3, get_lang('CreationDate'), false);
$table->set_header(4, get_lang('UpdateDate'), false);
if (api_is_allowed_to_edit()) {
$table->set_header(5, get_lang('Actions'), false);
$table->set_column_filter(5, 'actions_filter');
}
$table->display();
}
if ($_SESSION['glossary_view'] == 'list')
{
display_glossary_list();
}
}
/**
* display the glossary terms in a list
*
* @author Patrick Cool <patrick.cool@ugent.be>, Ghent University, Belgium
* @version januari 2009, dokeos 1.8.6
*/
function display_glossary_list()
{
$glossary_data = get_glossary_data(0,1000,0,ASC);
foreach($glossary_data as $key=>$glossary_item)
{
echo '<div class="sectiontitle">'.$glossary_item[1].'</div>';
echo '<div class="sectioncomment">'.$glossary_item[2].'</div>';
if (api_is_allowed_to_edit()) {
echo '<div>'.actions_filter($glossary_item[5], '',$glossary_item).'</div>';
}
}
}
/**
* Get the number of glossary terms
*
* @return unknown
*
* @author Patrick Cool <patrick.cool@ugent.be>, Ghent University, Belgium
* @version januari 2009, dokeos 1.8.6
*/
function get_number_glossary_terms()
{
// Database table definition
$t_glossary = Database :: get_course_table(TABLE_GLOSSARY);
$sql = "SELECT count(glossary_id) as total FROM $t_glossary";
$res = api_sql_query($sql, __FILE__, __LINE__);
$obj = Database::fetch_object($res);
return $obj->total;
}
/**
* get all the data of the glossary
*
* @param unknown_type $from
* @param unknown_type $number_of_items
* @param unknown_type $column
* @param unknown_type $direction
* @return unknown
*
* @author Patrick Cool <patrick.cool@ugent.be>, Ghent University, Belgium
* @version januari 2009, dokeos 1.8.6
*/
function get_glossary_data($from, $number_of_items, $column, $direction)
{
// 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()) {
$col5 = ", glossary.glossary_id as col5";
} else {
$col5 = " ";
}
$sql = "SELECT
glossary.display_order as col0,
glossary.name as col1,
glossary.description as col2,
ip.insert_date as col3,
ip.lastedit_date as col4
$col5
FROM $t_glossary glossary, $t_item_propery ip
WHERE glossary.glossary_id = ip.ref
AND tool = '".TOOL_GLOSSARY."' ";
$sql .= " ORDER BY col$column $direction ";
$sql .= " LIMIT $from,$number_of_items";
$res = api_sql_query($sql, __FILE__, __LINE__);
$return = array ();
while ($data = Database::fetch_row($res))
{
$return[] = $data;
}
return $return;
}
/**
* Enter description here...
*
* @param unknown_type $glossary_id
* @param unknown_type $url_params
* @param unknown_type $row
* @return unknown
*
* @author Patrick Cool <patrick.cool@ugent.be>, Ghent University, Belgium
* @version januari 2009, dokeos 1.8.6
*/
function actions_filter($glossary_id,$url_params,$row)
{
if (!$_SESSION['max_glossary_display'] OR $_SESSION['max_glossary_display'] == '')
{
$_SESSION['max_glossary_display'] = get_max_glossary_item();
}
$return = '';
if (empty($_GET['glossary_column'])) {
if ($row[0] > 1)
{
$return .= '<a href="'.api_get_self().'?action=moveup&amp;glossary_id='.$row[5].'">'.Display::return_icon('up.gif', get_lang('Up')).'</a>';
}
else
{
$return .= Display::return_icon('up_na.gif');
}
if ($row[0] < $_SESSION['max_glossary_display'])
{
$return .= '<a href="'.api_get_self().'?action=movedown&amp;glossary_id='.$row[5].'">'.Display::return_icon('down.gif',get_lang('Down')).'</a>';
}
else
{
$return .= Display::return_icon('down_na.gif');
}
}
$return .= '<a href="'.api_get_self().'?action=edit_glossary&amp;glossary_id='.$row[5].'&msg=edit">'.Display::return_icon('edit.gif',get_lang('Edit')).'</a>';
$return .= '<a href="'.api_get_self().'?action=delete_glossary&amp;glossary_id='.$row[5].'" onclick="return confirmation(\''.$row[1].'\');">'.Display::return_icon('delete.gif', get_lang('Delete')).'</a>';
return $return;
}
/**
* a little bit of javascript to display a prettier warning when deleting a term
*
* @return unknown
*
* @author Patrick Cool <patrick.cool@ugent.be>, Ghent University, Belgium
* @version januari 2009, dokeos 1.8.6
*/
function javascript_glossary()
{
return "<script type=\"text/javascript\">
function confirmation (name)
{
if (confirm(\" ". get_lang("TermConfirmDelete") ." \"+ name + \" ?\"))
{return true;}
else
{return false;}
}
</script>";
}
/**
* Enter description here...
*
* @author Patrick Cool <patrick.cool@ugent.be>, Ghent University, Belgium
* @version januari 2009, dokeos 1.8.6
*/
function reorder_glossary()
{
// Database table definition
$t_glossary = Database :: get_course_table(TABLE_GLOSSARY);
$sql = "SELECT * FROM $t_glossary ORDER by display_order ASC";
$res = api_sql_query($sql, __FILE__, __LINE__);
$i = 1;
while ($data = Database::fetch_array($res))
{
$sql_reorder = "UPDATE $t_glossary SET display_order = $i WHERE glossary_id = '".Database::escape_string($data['glossary_id'])."'";
api_sql_query($sql_reorder, __FILE__, __LINE__);
$i++;
}
}
/**
* Enter description here...
*
* @param unknown_type $direction
* @param unknown_type $glossary_id
*
* @author Patrick Cool <patrick.cool@ugent.be>, Ghent University, Belgium
* @version januari 2009, dokeos 1.8.6
*/
function move_glossary($direction, $glossary_id)
{
// Database table definition
$t_glossary = Database :: get_course_table(TABLE_GLOSSARY);
// sort direction
if ($direction == 'up')
{
$sortorder = 'DESC';
}
else
{
$sortorder = 'ASC';
}
$sql = "SELECT * FROM $t_glossary ORDER BY display_order $sortorder";
$res = api_sql_query($sql, __FILE__, __LINE__);
while ($row = Database::fetch_array($res))
{
if ($found == true and 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 glossary_id = '".Database::escape_string($current_id)."'";
$sql2 = "UPDATE $t_glossary SET display_order = '".Database::escape_string($current_display_order)."' WHERE glossary_id = '".Database::escape_string($next_id)."'";
$res = api_sql_query($sql1, __FILE__, __LINE__);
$res = api_sql_query($sql2, __FILE__, __LINE__);
}