usergroup.lib.php 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375
  1. <?php
  2. /* For licensing terms, see /license.txt */
  3. /**
  4. * This class provides methods for the UserGroup management.
  5. * Include/require it in your code to use its features.
  6. * @package chamilo.library
  7. */
  8. /**
  9. * Code
  10. */
  11. require_once 'model.lib.php';
  12. /**
  13. * Class
  14. * @package chamilo.library
  15. */
  16. class UserGroup extends Model {
  17. var $columns = array('id', 'name','description');
  18. public function __construct() {
  19. $this->table = Database::get_main_table(TABLE_USERGROUP);
  20. $this->usergroup_rel_user_table = Database::get_main_table(TABLE_USERGROUP_REL_USER);
  21. $this->usergroup_rel_course_table = Database::get_main_table(TABLE_USERGROUP_REL_COURSE);
  22. $this->usergroup_rel_session_table = Database::get_main_table(TABLE_USERGROUP_REL_SESSION);
  23. $this->table_course = Database::get_main_table(TABLE_MAIN_COURSE);
  24. }
  25. public function get_count() {
  26. $row = Database::select('count(*) as count', $this->table, array(),'first');
  27. return $row['count'];
  28. }
  29. public function get_usergroup_by_course_with_data_count($course_id) {
  30. $row = Database::select('count(*) as count', $this->usergroup_rel_course_table, array('where' => array('course_id = ?' => $course_id)), 'first');
  31. return $row['count'];
  32. }
  33. public function get_id_by_name($name) {
  34. $row = Database::select('id', $this->table, array('where' => array('name = ?' => $name)),'first');
  35. return $row['id'];
  36. }
  37. /**
  38. * Displays the title + grid
  39. */
  40. function display() {
  41. // action links
  42. echo '<div class="actions">';
  43. echo '<a href="../admin/index.php">'.Display::return_icon('back.png', get_lang('BackTo').' '.get_lang('PlatformAdmin'),'','32').'</a>';
  44. echo '<a href="'.api_get_self().'?action=add">'.Display::return_icon('new_class.png',get_lang('AddClasses'),'','32').'</a>';
  45. echo Display::url(Display::return_icon('import_csv.png', get_lang('Import'), array(), ICON_SIZE_MEDIUM), 'usergroup_import.php');
  46. echo Display::url(Display::return_icon('export_csv.png', get_lang('Export'), array(), ICON_SIZE_MEDIUM), 'usergroup_export.php');
  47. echo '</div>';
  48. echo Display::grid_html('usergroups');
  49. }
  50. function display_teacher_view() {
  51. // action links
  52. echo Display::grid_html('usergroups');
  53. }
  54. /**
  55. * Gets a list of course ids by user group
  56. * @param int user group id
  57. * @return array
  58. */
  59. public function get_courses_by_usergroup($id) {
  60. $results = Database::select('course_id', $this->usergroup_rel_course_table, array('where'=>array('usergroup_id = ?'=>$id)));
  61. $array = array();
  62. if (!empty($results)) {
  63. foreach($results as $row) {
  64. $array[] = $row['course_id'];
  65. }
  66. }
  67. return $array;
  68. }
  69. public function get_usergroup_in_course($options = array()) {
  70. $sql = "SELECT u.* FROM {$this->usergroup_rel_course_table} usergroup
  71. INNER JOIN {$this->table} u
  72. ON (u.id = usergroup.usergroup_id)
  73. INNER JOIN {$this->table_course} c
  74. ON (usergroup.course_id = c.id)
  75. ";
  76. $conditions = Database::parse_conditions($options);
  77. $sql .= $conditions;
  78. $result = Database::query($sql);
  79. $array = Database::store_result($result, 'ASSOC');
  80. return $array;
  81. }
  82. public function get_usergroup_not_in_course($options = array()) {
  83. $course_id = intval($options['course_id']);
  84. unset($options['course_id']);
  85. if (empty($course_id)) {
  86. return false;
  87. }
  88. $sql = "SELECT DISTINCT u.id, name
  89. FROM {$this->table} u
  90. LEFT OUTER JOIN {$this->usergroup_rel_course_table} urc
  91. ON (u.id = urc.usergroup_id AND course_id = $course_id)
  92. WHERE course_id is NULL
  93. ";
  94. $conditions = Database::parse_conditions($options);
  95. $sql .= $conditions;
  96. $result = Database::query($sql);
  97. $array = Database::store_result($result, 'ASSOC');
  98. return $array;
  99. }
  100. public function get_usergroup_by_course($course_id) {
  101. $options = array('where' => array('course_id = ?' => $course_id));
  102. $results = Database::select('usergroup_id', $this->usergroup_rel_course_table, $options);
  103. $array = array();
  104. if (!empty($results)) {
  105. foreach($results as $row) {
  106. $array[]= $row['usergroup_id'];
  107. }
  108. }
  109. return $array;
  110. }
  111. public function usergroup_was_added_in_course($usergroup_id, $course_id) {
  112. $results = Database::select('usergroup_id', $this->usergroup_rel_course_table, array('where'=>array('course_id = ? AND usergroup_id = ?'=> array($course_id, $usergroup_id))));
  113. if (empty($results)) {
  114. return false;
  115. }
  116. return true;
  117. }
  118. /**
  119. * Gets a list of session ids by user group
  120. * @param int user group id
  121. * @return array
  122. */
  123. public function get_sessions_by_usergroup($id) {
  124. $results = Database::select('session_id', $this->usergroup_rel_session_table, array('where' => array('usergroup_id = ?' => $id)));
  125. $array = array();
  126. if (!empty($results)) {
  127. foreach($results as $row) {
  128. $array[]= $row['session_id'];
  129. }
  130. }
  131. return $array;
  132. }
  133. /**
  134. * Gets a list of user ids by user group
  135. * @param int user group id
  136. * @return array with a list of user ids
  137. */
  138. public function get_users_by_usergroup($id = null) {
  139. if (empty($id)) {
  140. $conditions = array();
  141. } else {
  142. $conditions = array('where'=>array('usergroup_id = ?'=>$id));
  143. }
  144. $results = Database::select('user_id', $this->usergroup_rel_user_table, $conditions, true);
  145. $array = array();
  146. if (!empty($results)) {
  147. foreach($results as $row) {
  148. $array[]= $row['user_id'];
  149. }
  150. }
  151. return $array;
  152. }
  153. /**
  154. * Gets the usergroup id list by user id
  155. * @param int user id
  156. */
  157. public function get_usergroup_by_user($id) {
  158. $results = Database::select('usergroup_id', $this->usergroup_rel_user_table, array('where' => array('user_id = ?' => $id)));
  159. $array = array();
  160. if (!empty($results)) {
  161. foreach($results as $row) {
  162. $array[]= $row['usergroup_id'];
  163. }
  164. }
  165. return $array;
  166. }
  167. /**
  168. * Subscribes sessions to a group (also adding the members of the group in the session and course)
  169. * @param int usergroup id
  170. * @param array list of session ids
  171. */
  172. function subscribe_sessions_to_usergroup($usergroup_id, $list) {
  173. $current_list = self::get_sessions_by_usergroup($usergroup_id);
  174. $user_list = self::get_users_by_usergroup($usergroup_id);
  175. $delete_items = $new_items = array();
  176. if (!empty($list)) {
  177. foreach ($list as $session_id) {
  178. if (!in_array($session_id, $current_list)) {
  179. $new_items[] = $session_id;
  180. }
  181. }
  182. }
  183. if (!empty($current_list)) {
  184. foreach($current_list as $session_id) {
  185. if (!in_array($session_id, $list)) {
  186. $delete_items[] = $session_id;
  187. }
  188. }
  189. }
  190. //Deleting items
  191. if (!empty($delete_items)) {
  192. foreach($delete_items as $session_id) {
  193. if (!empty($user_list)) {
  194. foreach($user_list as $user_id) {
  195. SessionManager::unsubscribe_user_from_session($session_id, $user_id);
  196. }
  197. }
  198. Database::delete($this->usergroup_rel_session_table, array('usergroup_id = ? AND session_id = ?'=>array($usergroup_id, $session_id)));
  199. }
  200. }
  201. //Addding new relationships
  202. if (!empty($new_items)) {
  203. foreach($new_items as $session_id) {
  204. $params = array('session_id'=>$session_id, 'usergroup_id' => $usergroup_id);
  205. Database::insert($this->usergroup_rel_session_table, $params);
  206. if (!empty($user_list)) {
  207. SessionManager::suscribe_users_to_session($session_id, $user_list, null, false);
  208. }
  209. }
  210. }
  211. }
  212. /**
  213. * Subscribes courses to a group (also adding the members of the group in the course)
  214. * @param int usergroup id
  215. * @param array list of course ids (integers)
  216. */
  217. function subscribe_courses_to_usergroup($usergroup_id, $list, $delete_groups = true) {
  218. $current_list = self::get_courses_by_usergroup($usergroup_id);
  219. $user_list = self::get_users_by_usergroup($usergroup_id);
  220. $delete_items = $new_items = array();
  221. if (!empty($list)) {
  222. foreach ($list as $id) {
  223. if (!in_array($id, $current_list)) {
  224. $new_items[] = $id;
  225. }
  226. }
  227. }
  228. if (!empty($current_list)) {
  229. foreach($current_list as $id) {
  230. if (!in_array($id, $list)) {
  231. $delete_items[] = $id;
  232. }
  233. }
  234. }
  235. if ($delete_groups) {
  236. self::unsubscribe_courses_from_usergroup($usergroup_id, $delete_items);
  237. }
  238. //Addding new relationships
  239. if (!empty($new_items)) {
  240. foreach ($new_items as $course_id) {
  241. $course_info = api_get_course_info_by_id($course_id);
  242. if (!empty($user_list)) {
  243. foreach($user_list as $user_id) {
  244. CourseManager::subscribe_user($user_id, $course_info['code']);
  245. }
  246. }
  247. $params = array('course_id'=>$course_id, 'usergroup_id'=>$usergroup_id);
  248. Database::insert($this->usergroup_rel_course_table, $params);
  249. }
  250. }
  251. }
  252. function unsubscribe_courses_from_usergroup($usergroup_id, $delete_items) {
  253. //Deleting items
  254. if (!empty($delete_items)) {
  255. $user_list = self::get_users_by_usergroup($usergroup_id);
  256. foreach ($delete_items as $course_id) {
  257. $course_info = api_get_course_info_by_id($course_id);
  258. if (!empty($user_list)) {
  259. foreach ($user_list as $user_id) {
  260. CourseManager::unsubscribe_user($user_id, $course_info['code']);
  261. }
  262. }
  263. Database::delete($this->usergroup_rel_course_table, array('usergroup_id = ? AND course_id = ?'=>array($usergroup_id, $course_id)));
  264. }
  265. }
  266. }
  267. /**
  268. * Subscribes users to a group
  269. * @param int usergroup id
  270. * @param array list of user ids
  271. */
  272. function subscribe_users_to_usergroup($usergroup_id, $list, $delete_users_not_present_in_list = true) {
  273. $current_list = self::get_users_by_usergroup($usergroup_id);
  274. $course_list = self::get_courses_by_usergroup($usergroup_id);
  275. $session_list = self::get_sessions_by_usergroup($usergroup_id);
  276. $delete_items = array();
  277. $new_items = array();
  278. if (!empty($list)) {
  279. foreach ($list as $user_id) {
  280. if (!in_array($user_id, $current_list)) {
  281. $new_items[] = $user_id;
  282. }
  283. }
  284. }
  285. if (!empty($current_list)) {
  286. foreach($current_list as $user_id) {
  287. if (!in_array($user_id, $list)) {
  288. $delete_items[] = $user_id;
  289. }
  290. }
  291. }
  292. //Deleting items
  293. if (!empty($delete_items) && $delete_users_not_present_in_list) {
  294. foreach ($delete_items as $user_id) {
  295. //Removing courses
  296. if (!empty($course_list)) {
  297. foreach($course_list as $course_id) {
  298. $course_info = api_get_course_info_by_id($course_id);
  299. CourseManager::unsubscribe_user($user_id, $course_info['code']);
  300. }
  301. }
  302. //Removing sessions
  303. if (!empty($session_list)) {
  304. foreach($session_list as $session_id) {
  305. SessionManager::unsubscribe_user_from_session($session_id, $user_id);
  306. }
  307. }
  308. Database::delete($this->usergroup_rel_user_table, array('usergroup_id = ? AND user_id = ?'=>array($usergroup_id, $user_id)));
  309. }
  310. }
  311. //Addding new relationships
  312. if (!empty($new_items)) {
  313. //Adding sessions
  314. if (!empty($session_list)) {
  315. foreach($session_list as $session_id) {
  316. SessionManager::suscribe_users_to_session($session_id, $new_items, null, false);
  317. }
  318. }
  319. foreach($new_items as $user_id) {
  320. //Adding courses
  321. if (!empty($course_list)) {
  322. foreach($course_list as $course_id) {
  323. $course_info = api_get_course_info_by_id($course_id);
  324. CourseManager::subscribe_user($user_id, $course_info['code']);
  325. }
  326. }
  327. $params = array('user_id'=>$user_id, 'usergroup_id'=>$usergroup_id);
  328. Database::insert($this->usergroup_rel_user_table, $params);
  329. }
  330. }
  331. }
  332. function usergroup_exists($name) {
  333. $sql = "SELECT * FROM $this->table WHERE name='".Database::escape_string($name)."'";
  334. $res = Database::query($sql);
  335. return Database::num_rows($res) != 0;
  336. }
  337. }