user_fields.php 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399
  1. <?php // $Id: $
  2. /* For licensing terms, see /dokeos_license.txt */
  3. /**
  4. ==============================================================================
  5. * @package dokeos.admin
  6. ==============================================================================
  7. */
  8. // name of the language file that needs to be included
  9. $language_file = array('admin','registration');
  10. $cidReset = true;
  11. // including necessary libraries
  12. require ('../inc/global.inc.php');
  13. $libpath = api_get_path(LIBRARY_PATH);
  14. include_once ($libpath.'usermanager.lib.php');
  15. require_once ($libpath.'formvalidator/FormValidator.class.php');
  16. // section for the tabs
  17. $this_section=SECTION_PLATFORM_ADMIN;
  18. // user permissions
  19. api_protect_admin_script();
  20. // Database table definitions
  21. $table_admin = Database :: get_main_table(TABLE_MAIN_ADMIN);
  22. $table_user = Database :: get_main_table(TABLE_MAIN_USER);
  23. $table_uf = Database :: get_main_table(TABLE_MAIN_USER_FIELD);
  24. $table_uf_opt = Database :: get_main_table(TABLE_MAIN_USER_FIELD_OPTIONS);
  25. $table_uf_val = Database :: get_main_table(TABLE_MAIN_USER_FIELD_VALUES);
  26. $interbreadcrumb[] = array ("url" => 'index.php', "name" => get_lang('PlatformAdmin'));
  27. // Display form
  28. if(1)
  29. {
  30. $tool_name = get_lang('UserFields');
  31. Display :: display_header($tool_name, "");
  32. //api_display_tool_title($tool_name);
  33. if (isset ($_GET['action']))
  34. {
  35. $check = Security::check_token('get');
  36. if($check) {
  37. switch ($_GET['action']) {
  38. case 'show_message' :
  39. Display :: display_normal_message($_GET['message']);
  40. break;
  41. case 'show_field' :
  42. if (api_is_platform_admin() && !empty($_GET['field_id']) && UserManager :: update_extra_field($_GET['field_id'],array('field_visible'=>'1'))) {
  43. Display :: display_confirmation_message(get_lang('FieldShown'));
  44. } else {
  45. Display :: display_error_message(get_lang('CannotShowField'));
  46. }
  47. break;
  48. case 'hide_field' :
  49. if (api_is_platform_admin() && !empty($_GET['field_id']) && UserManager :: update_extra_field($_GET['field_id'],array('field_visible'=>'0'))) {
  50. Display :: display_confirmation_message(get_lang('FieldHidden'));
  51. } else {
  52. Display :: display_error_message(get_lang('CannotHideField'));
  53. }
  54. break;
  55. case 'thaw_field' :
  56. if (api_is_platform_admin() && !empty($_GET['field_id']) && UserManager :: update_extra_field($_GET['field_id'],array('field_changeable'=>'1'))) {
  57. Display :: display_confirmation_message(get_lang('FieldMadeChangeable'));
  58. } else {
  59. Display :: display_error_message(get_lang('CannotMakeFieldChangeable'));
  60. }
  61. break;
  62. case 'freeze_field' :
  63. if (api_is_platform_admin() && !empty($_GET['field_id']) && UserManager :: update_extra_field($_GET['field_id'],array('field_changeable'=>'0'))) {
  64. Display :: display_confirmation_message(get_lang('FieldMadeUnchangeable'));
  65. } else {
  66. Display :: display_error_message(get_lang('CannotMakeFieldUnchangeable'));
  67. }
  68. break;
  69. case 'moveup' :
  70. if (api_is_platform_admin() && !empty($_GET['field_id'])) {
  71. if (move_user_field('moveup', $_GET['field_id'])) {
  72. Display :: display_confirmation_message(get_lang('FieldMovedUp'));
  73. } else {
  74. Display :: display_error_message(get_lang('CannotMoveField'));
  75. }
  76. }
  77. break;
  78. case 'movedown' :
  79. if (api_is_platform_admin() && !empty($_GET['field_id'])) {
  80. if (move_user_field('movedown', $_GET['field_id'])) {
  81. Display :: display_confirmation_message(get_lang('FieldMovedDown'));
  82. } else {
  83. Display :: display_error_message(get_lang('CannotMoveField'));
  84. }
  85. }
  86. break;
  87. case 'filter_on' :
  88. if (api_is_platform_admin() && !empty($_GET['field_id']) && UserManager :: update_extra_field($_GET['field_id'],array('field_filter'=>'1'))) {
  89. Display :: display_confirmation_message(get_lang('FieldFilterSetOn'));
  90. } else {
  91. Display :: display_error_message(get_lang('CannotShowField'));
  92. }
  93. break;
  94. case 'filter_off' :
  95. if (api_is_platform_admin() && !empty($_GET['field_id']) && UserManager :: update_extra_field($_GET['field_id'],array('field_filter'=>'0'))) {
  96. Display :: display_confirmation_message(get_lang('FieldFilterSetOff'));
  97. } else {
  98. Display :: display_error_message(get_lang('CannotShowField'));
  99. }
  100. break;
  101. case 'delete':
  102. if (api_is_platform_admin() && !empty($_GET['field_id'])) {
  103. if (delete_user_fields($_GET['field_id'])) {
  104. Display :: display_confirmation_message(get_lang('FieldDeleted'));
  105. } else {
  106. Display :: display_error_message(get_lang('CannotDeleteField'));
  107. }
  108. }
  109. break;
  110. }
  111. Security::clear_token();
  112. }
  113. }
  114. if (isset ($_POST['action'])) {
  115. $check = Security::check_token('get');
  116. if($check) {
  117. switch ($_POST['action']) {
  118. default:
  119. break;
  120. }
  121. Security::clear_token();
  122. }
  123. }
  124. // Create an add-field box
  125. $form = new FormValidator('add_field','post','','',null,false);
  126. $renderer =& $form->defaultRenderer();
  127. $renderer->setElementTemplate('<span>{element}</span> ');
  128. //$form->addElement('text','label',get_lang('FieldLabel'));
  129. //$form->addElement('text','type',get_lang('FieldType'));
  130. //$form->addElement('text','title',get_lang('FieldTitle'));
  131. //$form->addElement('text','default',get_lang('FieldDefaultValue'));
  132. //$form->addElement('submit','submit',get_lang('Search'));
  133. $form->addElement('static','search_advanced_link',null,'<a href="user_fields_add.php?action=fill">'.Display::return_icon('fieldadd.gif', get_lang('AddUserField')).get_lang('AddUserField').'</a>');
  134. echo '<div class="actions">';
  135. $form->display();
  136. echo '</div>';
  137. // Create a sortable table with user-data
  138. $parameters['sec_token'] = Security::get_token();
  139. $column_show = array(1,1,1,1,1,1,1,1,1,0,0);
  140. $column_order = array(1,2,3,4,5,6,7,8,9,10,11);
  141. $extra_fields = UserManager::get_extra_fields(0,100,5,'ASC');
  142. $number_of_extra_fields = count($extra_fields);
  143. $table = new SortableTableFromArrayConfig($extra_fields, 5, 50, '', $column_show, $column_order, 'ASC');
  144. $table->set_additional_parameters($parameters);
  145. $table->set_header(0, '', false);
  146. $table->set_header(1, get_lang('FieldLabel'), false);
  147. $table->set_header(2, get_lang('FieldType'), false);
  148. $table->set_header(3, get_lang('FieldTitle'),false);
  149. $table->set_header(4, get_lang('FieldDefaultValue'),false);
  150. $table->set_header(5, get_lang('FieldOrder'), false);
  151. $table->set_header(6, get_lang('FieldVisibility'), false);
  152. $table->set_header(7, get_lang('FieldChangeability'), false);
  153. $table->set_header(8, get_lang('FieldFilter'), false);
  154. $table->set_header(9, get_lang('Modify'), false);
  155. $table->set_column_filter(5, 'order_filter');
  156. $table->set_column_filter(6, 'modify_visibility');
  157. $table->set_column_filter(7, 'modify_changeability');
  158. $table->set_column_filter(8, 'modify_field_filter');
  159. $table->set_column_filter(9, 'edit_filter');
  160. $table->set_column_filter(2, 'type_filter');
  161. $table->display();
  162. }
  163. /*
  164. ==============================================================================
  165. FOOTER
  166. ==============================================================================
  167. */
  168. Display::display_footer();
  169. //gateway functions to the UserManager methods (provided for SorteableTable callback mechanism)
  170. function get_number_of_extra_fields()
  171. {
  172. return UserManager::get_number_of_extra_fields();
  173. }
  174. function get_extra_fields($f,$n,$o,$d)
  175. {
  176. return UserManager::get_extra_fields($f,$n,$o,$d);
  177. }
  178. /**
  179. * This functions translates the id of the form type into a human readable description
  180. *
  181. * @param integer $type the id of the form type
  182. * @return string the huma readable description of the field type (text, date, select drop-down, ...)
  183. *
  184. * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University, Belgium
  185. * @version July 2008
  186. * @since Dokeos 1.8.6
  187. */
  188. function type_filter($type)
  189. {
  190. $types[USER_FIELD_TYPE_TEXT] = get_lang('FieldTypeText');
  191. $types[USER_FIELD_TYPE_TEXTAREA] = get_lang('FieldTypeTextarea');
  192. $types[USER_FIELD_TYPE_RADIO] = get_lang('FieldTypeRadio');
  193. $types[USER_FIELD_TYPE_SELECT] = get_lang('FieldTypeSelect');
  194. $types[USER_FIELD_TYPE_SELECT_MULTIPLE] = get_lang('FieldTypeSelectMultiple');
  195. $types[USER_FIELD_TYPE_DATE] = get_lang('FieldTypeDate');
  196. $types[USER_FIELD_TYPE_DATETIME] = get_lang('FieldTypeDatetime');
  197. $types[USER_FIELD_TYPE_DOUBLE_SELECT] = get_lang('FieldTypeDoubleSelect');
  198. $types[USER_FIELD_TYPE_DIVIDER] = get_lang('FieldTypeDivider');
  199. $types[USER_FIELD_TYPE_TAG] = get_lang('FieldTypeTag');
  200. return $types[$type];
  201. }
  202. /**
  203. * Modify the display order field into up and down arrows
  204. *
  205. * @param unknown_type $field_order
  206. * @param array Url parameters
  207. * @param array The results row
  208. * @return string The link
  209. *
  210. * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University, Belgium
  211. * @version July 2008
  212. * @since Dokeos 1.8.6
  213. */
  214. function order_filter($field_order,$url_params,$row)
  215. {
  216. global $number_of_extra_fields;
  217. // the up icon only has to appear when the row can be moved up (all but the first row)
  218. if ($row[5]<>1)
  219. {
  220. $return .= '<a href="'.api_get_self().'?action=moveup&field_id='.$row[0].'&sec_token='.$_SESSION['sec_token'].'">'.Display::return_icon('up.gif', get_lang('Up')).'</a>';
  221. }
  222. else
  223. {
  224. $return .= Display::return_icon('blank.gif','',array('width'=>'21px'));
  225. }
  226. // the down icon only has to appear when the row can be moved down (all but the last row)
  227. if ($row[5]<>$number_of_extra_fields)
  228. {
  229. $return .= '<a href="'.api_get_self().'?action=movedown&field_id='.$row[0].'&sec_token='.$_SESSION['sec_token'].'">'.Display::return_icon('down.gif', get_lang('Down')).'</a>';
  230. }
  231. return $return;
  232. }
  233. /**
  234. * Modify the visible field to show links and icons
  235. * @param int The current visibility
  236. * @param array Url parameters
  237. * @param array The results row
  238. * @return string The link
  239. */
  240. function modify_visibility($visibility,$url_params,$row)
  241. {
  242. return ($visibility?'<a href="'.api_get_self().'?action=hide_field&field_id='.$row[0].'&sec_token='.$_SESSION['sec_token'].'">'.Display::return_icon('visible.gif', get_lang('Hide')).'</a>':'<a href="'.api_get_self().'?action=show_field&field_id='.$row[0].'&sec_token='.$_SESSION['sec_token'].'">'.Display::return_icon('invisible.gif', get_lang('Show')).'</a>');
  243. }
  244. /**
  245. * Modify the changeability field to show links and icons
  246. * @param int The current changeability
  247. * @param array Url parameters
  248. * @param array The results row
  249. * @return string The link
  250. */
  251. function modify_changeability($changeability,$url_params,$row)
  252. {
  253. return ($changeability?'<a href="'.api_get_self().'?action=freeze_field&field_id='.$row[0].'&sec_token='.$_SESSION['sec_token'].'">'.Display::return_icon('right.gif', get_lang('MakeUnchangeable')).'</a>':'<a href="'.api_get_self().'?action=thaw_field&field_id='.$row[0].'&sec_token='.$_SESSION['sec_token'].'">'.Display::return_icon('wrong.gif', get_lang('MakeChangeable')).'</a>');
  254. }
  255. function modify_field_filter ($changeability,$url_params,$row)
  256. {
  257. return ($changeability?'<a href="'.api_get_self().'?action=filter_off&field_id='.$row[0].'&sec_token='.$_SESSION['sec_token'].'">'.Display::return_icon('right.gif', get_lang('FilterOff')).'</a>':'' .
  258. '<a href="'.api_get_self().'?action=filter_on&field_id='.$row[0].'&sec_token='.$_SESSION['sec_token'].'">'.Display::return_icon('wrong.gif', get_lang('FilterOn')).'</a>');
  259. }
  260. function edit_filter($id,$url_params,$row)
  261. {
  262. global $charset;
  263. $return = '<a href="user_fields_add.php?action=edit&field_id='.$row[0].'&field_type='.$row[2].'&sec_token='.$_SESSION['sec_token'].'">'.Display::return_icon('edit.gif',get_lang('Edit')).'</a>';
  264. $return .= ' <a href="'.api_get_self().'?action=delete&field_id='.$row[0].'&sec_token='.$_SESSION['sec_token'].'" onclick="javascript:if(!confirm('."'".addslashes(api_htmlentities(get_lang("ConfirmYourChoice"),ENT_QUOTES,$charset))."'".')) return false;">'.Display::return_icon('delete.gif',get_lang('Delete')).'</a>';
  265. return $return;
  266. }
  267. /**
  268. * Move a user defined field up or down
  269. *
  270. * @param string $direction the direction we have to move the field to (up or down)
  271. * @param unknown_type $field_id
  272. *
  273. * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University, Belgium
  274. * @version July 2008
  275. * @since Dokeos 1.8.6
  276. */
  277. function move_user_field($direction,$field_id)
  278. {
  279. // Databse table definitions
  280. $table_user_field = Database::get_main_table(TABLE_MAIN_USER_FIELD);
  281. // check the parameters
  282. if (!in_array($direction,array('moveup','movedown')) OR !is_numeric($field_id))
  283. {
  284. return false;
  285. }
  286. // determine the SQL sort direction
  287. if ($direction == 'moveup')
  288. {
  289. $sortdirection = 'DESC';
  290. }
  291. else
  292. {
  293. $sortdirection = 'ASC';
  294. }
  295. $found = false;
  296. $sql = "SELECT id, field_order FROM $table_user_field ORDER BY field_order $sortdirection";
  297. $result = Database::query($sql,__FILE__,__LINE__);
  298. while($row = Database::fetch_array($result))
  299. {
  300. if ($found)
  301. {
  302. $next_id = $row['id'];
  303. $next_order = $row['field_order'];
  304. break;
  305. }
  306. if ($field_id == $row['id'])
  307. {
  308. $this_id = $row['id'];
  309. $this_order = $row['field_order'];
  310. $found = true;
  311. }
  312. }
  313. $sql1 = "UPDATE ".$table_user_field." SET field_order = '".Database::escape_string($next_order)."' WHERE id = '".Database::escape_string($this_id)."'";
  314. $sql2 = "UPDATE ".$table_user_field." SET field_order = '".Database::escape_string($this_order)."' WHERE id = '".Database::escape_string($next_id)."'";
  315. Database::query($sql1,__FILE__,__LINE__);
  316. Database::query($sql2,__FILE__,__LINE__);
  317. return true;
  318. }
  319. /**
  320. * Delete a user field (and also the options and values entered by the users)
  321. *
  322. * @param integer $field_id the id of the field that has to be deleted
  323. * @return boolean true if the field has been deleted, false if the field could not be deleted (for whatever reason)
  324. *
  325. * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University, Belgium
  326. * @version July 2008
  327. * @since Dokeos 1.8.6
  328. */
  329. function delete_user_fields($field_id)
  330. {
  331. // Database table definitions
  332. $table_user_field = Database::get_main_table(TABLE_MAIN_USER_FIELD);
  333. $table_user_field_options = Database::get_main_table(TABLE_MAIN_USER_FIELD_OPTIONS);
  334. $table_user_field_values = Database::get_main_table(TABLE_MAIN_USER_FIELD_VALUES);
  335. // delete the fields
  336. $sql = "DELETE FROM $table_user_field WHERE id = '".Database::escape_string($field_id)."'";
  337. $result = Database::query($sql,__FILE__,__LINE__);
  338. if (Database::affected_rows() == 1)
  339. {
  340. // delete the field options
  341. $sql = "DELETE FROM $table_user_field_options WHERE field_id = '".Database::escape_string($field_id)."'";
  342. $result = Database::query($sql,__FILE__,__LINE__);
  343. // delete the field values
  344. $sql = "DELETE FROM $table_user_field_values WHERE field_id = '".Database::escape_string($field_id)."'";
  345. $result = Database::query($sql,__FILE__,__LINE__);
  346. // recalculate the field_order because the value is used to show/hide the up/down icon
  347. // and the field_order value cannot be bigger than the number of fields
  348. $sql = "SELECT * FROM $table_user_field ORDER BY field_order ASC";
  349. $result = Database::query($sql,__FILE__,__LINE__);
  350. $i = 1;
  351. while($row = Database::fetch_array($result))
  352. {
  353. $sql_reorder = "UPDATE $table_user_field SET field_order = '".Database::escape_string($i)."' WHERE id = '".Database::escape_string($row['id'])."'";
  354. $result_reorder = Database::query($sql_reorder,__FILE__,__LINE__);
  355. $i++;
  356. }
  357. // field was deleted so we return true
  358. return true;
  359. }
  360. else
  361. {
  362. // the field was not deleted so we return false
  363. return false;
  364. }
  365. }
  366. ?>