user_fields.php 16 KB

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