@@ -7,40 +7,40 @@ |
||
7 | 7 | require_once '../inc/global.inc.php'; |
8 | 8 | api_block_anonymous_users(); |
9 | 9 | if (api_get_setting('allow_message_tool')!='true') { |
10 | - api_not_allowed(); |
|
10 | + api_not_allowed(); |
|
11 | 11 | } |
12 | 12 | |
13 | 13 | if (isset($_REQUEST['f']) && $_REQUEST['f'] == 'social') { |
14 | - $this_section = SECTION_SOCIAL; |
|
15 | - $interbreadcrumb[]= array ('url' => api_get_path(WEB_PATH).'main/social/home.php','name' => get_lang('Social')); |
|
16 | - $interbreadcrumb[]= array ('url' => 'inbox.php?f=social','name' => get_lang('Inbox')); |
|
14 | + $this_section = SECTION_SOCIAL; |
|
15 | + $interbreadcrumb[]= array ('url' => api_get_path(WEB_PATH).'main/social/home.php','name' => get_lang('Social')); |
|
16 | + $interbreadcrumb[]= array ('url' => 'inbox.php?f=social','name' => get_lang('Inbox')); |
|
17 | 17 | } else { |
18 | - $this_section = SECTION_MYPROFILE; |
|
19 | - $interbreadcrumb[]= array ('url' => api_get_path(WEB_PATH).'main/auth/profile.php','name' => get_lang('Profile')); |
|
18 | + $this_section = SECTION_MYPROFILE; |
|
19 | + $interbreadcrumb[]= array ('url' => api_get_path(WEB_PATH).'main/auth/profile.php','name' => get_lang('Profile')); |
|
20 | 20 | } |
21 | 21 | |
22 | 22 | $social_right_content = ''; |
23 | 23 | |
24 | 24 | if (isset($_GET['f']) && $_GET['f']=='social') { |
25 | - $social_parameter = '?f=social'; |
|
25 | + $social_parameter = '?f=social'; |
|
26 | 26 | } else { |
27 | - if (api_get_setting('extended_profile') == 'true') { |
|
28 | - $social_right_content .= '<div class="actions">'; |
|
27 | + if (api_get_setting('extended_profile') == 'true') { |
|
28 | + $social_right_content .= '<div class="actions">'; |
|
29 | 29 | |
30 | - if (api_get_setting('allow_social_tool') === 'true' && api_get_setting('allow_message_tool') === 'true') { |
|
31 | - $social_right_content .= '<a href="'.api_get_path(WEB_PATH).'main/social/profile.php">'. |
|
30 | + if (api_get_setting('allow_social_tool') === 'true' && api_get_setting('allow_message_tool') === 'true') { |
|
31 | + $social_right_content .= '<a href="'.api_get_path(WEB_PATH).'main/social/profile.php">'. |
|
32 | 32 | Display::return_icon('shared_profile.png', get_lang('ViewSharedProfile')).'</a>'; |
33 | - } |
|
34 | - if (api_get_setting('allow_message_tool') === 'true') { |
|
35 | - $social_right_content .= '<a href="'.api_get_path(WEB_PATH).'main/messages/new_message.php">'. |
|
33 | + } |
|
34 | + if (api_get_setting('allow_message_tool') === 'true') { |
|
35 | + $social_right_content .= '<a href="'.api_get_path(WEB_PATH).'main/messages/new_message.php">'. |
|
36 | 36 | Display::return_icon('message_new.png',get_lang('ComposeMessage')).'</a>'; |
37 | 37 | $social_right_content .= '<a href="'.api_get_path(WEB_PATH).'main/messages/inbox.php">'. |
38 | 38 | Display::return_icon('inbox.png',get_lang('Inbox')).'</a>'; |
39 | 39 | $social_right_content .= '<a href="'.api_get_path(WEB_PATH).'main/messages/outbox.php">'. |
40 | 40 | Display::return_icon('outbox.png',get_lang('Outbox')).'</a>'; |
41 | - } |
|
42 | - $social_right_content .= '</div>'; |
|
43 | - } |
|
41 | + } |
|
42 | + $social_right_content .= '</div>'; |
|
43 | + } |
|
44 | 44 | } |
45 | 45 | |
46 | 46 | if (empty($_GET['id'])) { |
@@ -44,7 +44,7 @@ |
||
44 | 44 | $message .= '<p><a class="btn btn-primary" href="'.api_get_path(WEB_CODE_PATH).'course_info/maintenance.php?'.api_get_cidreq().'">'. |
45 | 45 | get_lang('No').'</a> <a class="btn btn-danger" href="'.api_get_self().'?delete=yes&'.api_get_cidreq().'">'. |
46 | 46 | get_lang('Yes').'</a></p>'; |
47 | - $interbreadcrumb[] = array('url' => 'maintenance.php', 'name' => get_lang('Maintenance')); |
|
47 | + $interbreadcrumb[] = array('url' => 'maintenance.php', 'name' => get_lang('Maintenance')); |
|
48 | 48 | } |
49 | 49 | Display :: display_header($tool_name, 'Settings'); |
50 | 50 | echo Display::page_header($tool_name); |
@@ -115,13 +115,13 @@ discard block |
||
115 | 115 | } |
116 | 116 | |
117 | 117 | /** |
118 | - * Export tabular data to XML-file |
|
119 | - * @param array Simple array of data to put in XML |
|
120 | - * @param string Name of file to be given to the user |
|
121 | - * @param string Name of common tag to place each line in |
|
122 | - * @param string Name of the root element. A root element should always be given. |
|
123 | - * @param string Encoding in which the data is provided |
|
124 | - */ |
|
118 | + * Export tabular data to XML-file |
|
119 | + * @param array Simple array of data to put in XML |
|
120 | + * @param string Name of file to be given to the user |
|
121 | + * @param string Name of common tag to place each line in |
|
122 | + * @param string Name of the root element. A root element should always be given. |
|
123 | + * @param string Encoding in which the data is provided |
|
124 | + */ |
|
125 | 125 | public static function arrayToXml( |
126 | 126 | $data, |
127 | 127 | $filename = 'export', |
@@ -200,7 +200,7 @@ discard block |
||
200 | 200 | foreach ($data as $row) { |
201 | 201 | $string .= "\n".str_repeat("\t",$level).'<'.$row['name'].'>'; |
202 | 202 | if (is_array($row['value'])) { |
203 | - $string .= self::_export_complex_table_xml_helper($row['value'],$level+1)."\n"; |
|
203 | + $string .= self::_export_complex_table_xml_helper($row['value'],$level+1)."\n"; |
|
204 | 204 | $string .= str_repeat("\t",$level).'</'.$row['name'].'>'; |
205 | 205 | } else { |
206 | 206 | $string .= $row['value']; |
@@ -25,29 +25,29 @@ |
||
25 | 25 | function search_courses($needle,$type) |
26 | 26 | { |
27 | 27 | $tbl_session = Database :: get_main_table(TABLE_MAIN_SESSION); |
28 | - $xajax_response = new xajaxResponse(); |
|
29 | - $return = ''; |
|
30 | - if(!empty($needle) && !empty($type)) { |
|
31 | - // xajax send utf8 datas... datas in db can be non-utf8 datas |
|
32 | - $charset = api_get_system_encoding(); |
|
33 | - $needle = api_convert_encoding($needle, $charset, 'utf-8'); |
|
34 | - $needle = Database::escape_string($needle); |
|
28 | + $xajax_response = new xajaxResponse(); |
|
29 | + $return = ''; |
|
30 | + if(!empty($needle) && !empty($type)) { |
|
31 | + // xajax send utf8 datas... datas in db can be non-utf8 datas |
|
32 | + $charset = api_get_system_encoding(); |
|
33 | + $needle = api_convert_encoding($needle, $charset, 'utf-8'); |
|
34 | + $needle = Database::escape_string($needle); |
|
35 | 35 | |
36 | - $sql = 'SELECT * FROM '.$tbl_session.' WHERE name LIKE "'.$needle.'%" ORDER BY id'; |
|
36 | + $sql = 'SELECT * FROM '.$tbl_session.' WHERE name LIKE "'.$needle.'%" ORDER BY id'; |
|
37 | 37 | |
38 | - $rs = Database::query($sql); |
|
39 | - $course_list = array(); |
|
38 | + $rs = Database::query($sql); |
|
39 | + $course_list = array(); |
|
40 | 40 | |
41 | - $return .= '<select id="origin" name="NoSessionCategoryList[]" multiple="multiple" size="20" style="width:340px;">'; |
|
42 | - while($course = Database :: fetch_array($rs)) { |
|
43 | - $course_list[] = $course['id']; |
|
44 | - $return .= '<option value="'.$course['id'].'" title="'.htmlspecialchars($course['name'],ENT_QUOTES).'">'.$course['name'].'</option>'; |
|
45 | - } |
|
46 | - $return .= '</select>'; |
|
47 | - $xajax_response -> addAssign('ajax_list_courses_multiple','innerHTML',api_utf8_encode($return)); |
|
48 | - } |
|
49 | - $_SESSION['course_list'] = $course_list; |
|
41 | + $return .= '<select id="origin" name="NoSessionCategoryList[]" multiple="multiple" size="20" style="width:340px;">'; |
|
42 | + while($course = Database :: fetch_array($rs)) { |
|
43 | + $course_list[] = $course['id']; |
|
44 | + $return .= '<option value="'.$course['id'].'" title="'.htmlspecialchars($course['name'],ENT_QUOTES).'">'.$course['name'].'</option>'; |
|
45 | + } |
|
46 | + $return .= '</select>'; |
|
47 | + $xajax_response -> addAssign('ajax_list_courses_multiple','innerHTML',api_utf8_encode($return)); |
|
48 | + } |
|
49 | + $_SESSION['course_list'] = $course_list; |
|
50 | 50 | |
51 | - return $xajax_response; |
|
52 | - } |
|
51 | + return $xajax_response; |
|
52 | + } |
|
53 | 53 | } |
@@ -137,7 +137,7 @@ |
||
137 | 137 | array('\r', '\n', '\x3c', '\x3e', '\x26'), |
138 | 138 | addslashes($var) |
139 | 139 | ).'"'; |
140 | - case 'array': |
|
140 | + case 'array': |
|
141 | 141 | // Arrays in JSON can't be associative. If the array is empty or if it |
142 | 142 | // has sequential whole number keys starting with 0, it's not associative |
143 | 143 | // so we can go ahead and convert it as an array. |
@@ -304,9 +304,9 @@ discard block |
||
304 | 304 | */ |
305 | 305 | public static function remove_XSS($var, $user_status = null, $filter_terms = false) |
306 | 306 | { |
307 | - if ($filter_terms) { |
|
308 | - $var = self::filter_terms($var); |
|
309 | - } |
|
307 | + if ($filter_terms) { |
|
308 | + $var = self::filter_terms($var); |
|
309 | + } |
|
310 | 310 | |
311 | 311 | if (empty($user_status)) { |
312 | 312 | if (api_is_anonymous()) { |
@@ -401,7 +401,7 @@ discard block |
||
401 | 401 | */ |
402 | 402 | public static function filter_terms($text) |
403 | 403 | { |
404 | - static $bad_terms = array(); |
|
404 | + static $bad_terms = array(); |
|
405 | 405 | |
406 | 406 | if (empty($bad_terms)) { |
407 | 407 | $list = api_get_setting('filter_terms'); |
@@ -422,14 +422,14 @@ discard block |
||
422 | 422 | } |
423 | 423 | } |
424 | 424 | |
425 | - $replace = '***'; |
|
426 | - if (!empty($bad_terms)) { |
|
427 | - // Fast way |
|
428 | - $new_text = str_ireplace($bad_terms, $replace, $text, $count); |
|
429 | - $text = $new_text; |
|
430 | - } |
|
425 | + $replace = '***'; |
|
426 | + if (!empty($bad_terms)) { |
|
427 | + // Fast way |
|
428 | + $new_text = str_ireplace($bad_terms, $replace, $text, $count); |
|
429 | + $text = $new_text; |
|
430 | + } |
|
431 | 431 | |
432 | - return $text; |
|
432 | + return $text; |
|
433 | 433 | } |
434 | 434 | |
435 | 435 |
@@ -139,7 +139,7 @@ |
||
139 | 139 | api_get_local_time($glossary_data['update_date']) |
140 | 140 | ); |
141 | 141 | } else { |
142 | - $glossary_data['update_date'] = ''; |
|
142 | + $glossary_data['update_date'] = ''; |
|
143 | 143 | } |
144 | 144 | |
145 | 145 | $form->addLabel(get_lang('CreationDate'), $glossary_data['insert_date']); |
@@ -1267,13 +1267,13 @@ discard block |
||
1267 | 1267 | } |
1268 | 1268 | |
1269 | 1269 | /** |
1270 | - * Get the users by ID |
|
1271 | - * @param array $ids student ids |
|
1272 | - * @param string $active |
|
1273 | - * @param string $order |
|
1274 | - * @param string $limit |
|
1275 | - * @return array $result student information |
|
1276 | - */ |
|
1270 | + * Get the users by ID |
|
1271 | + * @param array $ids student ids |
|
1272 | + * @param string $active |
|
1273 | + * @param string $order |
|
1274 | + * @param string $limit |
|
1275 | + * @return array $result student information |
|
1276 | + */ |
|
1277 | 1277 | public static function get_user_list_by_ids($ids = array(), $active = null, $order = null, $limit = null) |
1278 | 1278 | { |
1279 | 1279 | if (empty($ids)) { |
@@ -2314,7 +2314,7 @@ discard block |
||
2314 | 2314 | * |
2315 | 2315 | * @return array with extra data info of a user i.e array('field_variable'=>'value'); |
2316 | 2316 | */ |
2317 | - public static function get_extra_user_data_by_value($variable, $value, $all_visibility = true) |
|
2317 | + public static function get_extra_user_data_by_value($variable, $value, $all_visibility = true) |
|
2318 | 2318 | { |
2319 | 2319 | $extraFieldValue = new ExtraFieldValue('user'); |
2320 | 2320 | $extraField = new ExtraField('user'); |
@@ -3409,12 +3409,12 @@ discard block |
||
3409 | 3409 | if ($tag_id == 0) { |
3410 | 3410 | //the tag doesn't exist |
3411 | 3411 | $sql = "INSERT INTO $table_user_tag (tag, field_id,count) VALUES ('$tag','$field_id', count + 1)"; |
3412 | - Database::query($sql); |
|
3412 | + Database::query($sql); |
|
3413 | 3413 | $last_insert_id = Database::insert_id(); |
3414 | 3414 | } else { |
3415 | 3415 | //the tag exists we update it |
3416 | 3416 | $sql = "UPDATE $table_user_tag SET count = count + 1 WHERE id = $tag_id"; |
3417 | - Database::query($sql); |
|
3417 | + Database::query($sql); |
|
3418 | 3418 | $last_insert_id = $tag_id; |
3419 | 3419 | } |
3420 | 3420 | |
@@ -3610,9 +3610,9 @@ discard block |
||
3610 | 3610 | } |
3611 | 3611 | |
3612 | 3612 | /** |
3613 | - * Get extra filtrable user fields (only type select) |
|
3614 | - * @return array |
|
3615 | - */ |
|
3613 | + * Get extra filtrable user fields (only type select) |
|
3614 | + * @return array |
|
3615 | + */ |
|
3616 | 3616 | public static function get_extra_filtrable_fields() |
3617 | 3617 | { |
3618 | 3618 | $extraFieldList = UserManager::get_extra_fields(); |
@@ -3637,9 +3637,9 @@ discard block |
||
3637 | 3637 | } |
3638 | 3638 | |
3639 | 3639 | /** |
3640 | - * Get extra where clauses for finding users based on extra filtrable user fields (type select) |
|
3641 | - * @return string With AND clauses based on user's ID which have the values to search in extra user fields |
|
3642 | - */ |
|
3640 | + * Get extra where clauses for finding users based on extra filtrable user fields (type select) |
|
3641 | + * @return string With AND clauses based on user's ID which have the values to search in extra user fields |
|
3642 | + */ |
|
3643 | 3643 | public static function get_search_form_where_extra_fields() |
3644 | 3644 | { |
3645 | 3645 | $useExtraFields = false; |
@@ -3958,23 +3958,23 @@ discard block |
||
3958 | 3958 | } |
3959 | 3959 | |
3960 | 3960 | /** |
3961 | - * Get users followed by human resource manager |
|
3962 | - * @param int $userId |
|
3963 | - * @param int $userStatus Filter users by status (STUDENT, COURSEMANAGER, etc) |
|
3964 | - * @param bool $getOnlyUserId |
|
3965 | - * @param bool $getSql |
|
3966 | - * @param bool $getCount |
|
3967 | - * @param int $from |
|
3968 | - * @param int $numberItems |
|
3969 | - * @param int $column |
|
3970 | - * @param string $direction |
|
3971 | - * @param int $active |
|
3972 | - * @param string $lastConnectionDate |
|
3973 | - * @param int $status the function is called by who? COURSEMANAGER, DRH? |
|
3974 | - * @param string $keyword |
|
3961 | + * Get users followed by human resource manager |
|
3962 | + * @param int $userId |
|
3963 | + * @param int $userStatus Filter users by status (STUDENT, COURSEMANAGER, etc) |
|
3964 | + * @param bool $getOnlyUserId |
|
3965 | + * @param bool $getSql |
|
3966 | + * @param bool $getCount |
|
3967 | + * @param int $from |
|
3968 | + * @param int $numberItems |
|
3969 | + * @param int $column |
|
3970 | + * @param string $direction |
|
3971 | + * @param int $active |
|
3972 | + * @param string $lastConnectionDate |
|
3973 | + * @param int $status the function is called by who? COURSEMANAGER, DRH? |
|
3974 | + * @param string $keyword |
|
3975 | 3975 | * |
3976 | - * @return array user list |
|
3977 | - */ |
|
3976 | + * @return array user list |
|
3977 | + */ |
|
3978 | 3978 | public static function getUsersFollowedByUser( |
3979 | 3979 | $userId, |
3980 | 3980 | $userStatus = null, |
@@ -10,521 +10,521 @@ |
||
10 | 10 | */ |
11 | 11 | class WSCMCourse extends WSCM |
12 | 12 | { |
13 | - /** |
|
14 | - * Deletes a course (helper method) |
|
15 | - * |
|
16 | - * @param string Course id field name |
|
17 | - * @param string Course id value |
|
18 | - * @return mixed True if the course was successfully deleted, WSError otherwise |
|
19 | - */ |
|
20 | - protected function deleteCourseHelper($course_id_field_name, $course_id_value) { |
|
21 | - $course_id = $this->getCourseId($course_id_field_name, $course_id_value); |
|
22 | - if($course_id instanceof WSCMError) { |
|
23 | - return $course_id; |
|
24 | - } else { |
|
25 | - $course_code = CourseManager::get_course_code_from_course_id($course_id); |
|
26 | - CourseManager::delete_course($course_code); |
|
27 | - return true; |
|
28 | - } |
|
29 | - } |
|
30 | - |
|
31 | - /** |
|
32 | - * Deletes a course |
|
33 | - * |
|
34 | - * @param string API secret key |
|
35 | - * @param string Course id field name |
|
36 | - * @param string Course id value |
|
37 | - */ |
|
38 | - public function DeleteCourse($secret_key, $course_id_field_name, $course_id_value) { |
|
39 | - $verifKey = $this->verifyKey($secret_key); |
|
40 | - if($verifKey instanceof WSError) { |
|
41 | - $this->handleError($verifKey); |
|
42 | - } else { |
|
43 | - $result = $this->deleteCourseHelper($course_id_field_name, $course_id_value); |
|
44 | - if($result instanceof WSError) { |
|
45 | - $this->handleError($result); |
|
46 | - } |
|
47 | - } |
|
48 | - } |
|
49 | - |
|
50 | - /** |
|
51 | - * Deletes multiple courses |
|
52 | - * |
|
53 | - * @param string API secret key |
|
54 | - * @param array Array of courses with elements of the form array('course_id_field_name' => 'name_of_field', 'course_id_value' => 'value') |
|
55 | - * @return array Array with elements like array('course_id_value' => 'value', 'result' => array('code' => 0, 'message' => 'Operation was successful')). Note that if the result array contains a code different |
|
56 | - * than 0, an error occured |
|
57 | - */ |
|
58 | - public function DeleteCourses($secret_key, $courses) { |
|
59 | - $verifKey = $this->verifyKey($secret_key); |
|
60 | - if($verifKey instanceof WSError) { |
|
61 | - $this->handleError($verifKey); |
|
62 | - } else { |
|
63 | - $results = array(); |
|
64 | - foreach($courses as $course) { |
|
65 | - $result_tmp = array(); |
|
66 | - $result_op = $this->deleteCourseHelper($course['course_id_field_name'], $course['course_id_value']); |
|
67 | - $result_tmp['course_id_value'] = $course['course_id_value']; |
|
68 | - if($result_op instanceof WSCMError) { |
|
69 | - // Return the error in the results |
|
70 | - $result_tmp['result'] = $result_op->toArray(); |
|
71 | - } else { |
|
72 | - $result_tmp['result'] = $this->getSuccessfulResult(); |
|
73 | - } |
|
74 | - $results[] = $result_tmp; |
|
75 | - } |
|
76 | - return $results; |
|
77 | - } |
|
78 | - } |
|
79 | - |
|
80 | - /** |
|
81 | - * Creates a course (helper method) |
|
82 | - * |
|
83 | - * @param string Title |
|
84 | - * @param string Category code |
|
85 | - * @param string Wanted code. If it's not defined, it will be generated automatically |
|
86 | - * @param string Tutor name |
|
87 | - * @param string Course admin user id field name |
|
88 | - * @param string Course admin user id value |
|
89 | - * @param string Course language |
|
90 | - * @param string Course id field name |
|
91 | - * @param string Course id value |
|
92 | - * @param array Course extra fields |
|
93 | - * @return mixed Generated id if creation was successful, WSError otherwise |
|
94 | - */ |
|
95 | - protected function createCourseHelper($title, $category_code, $wanted_code, $tutor_name, $course_admin_user_id_field_name, $course_admin_user_id_value, $language, $course_id_field_name, $course_id_value, $extras) { |
|
96 | - // Add the original course id field name and value to the extra fields if needed |
|
97 | - $extras_associative = array(); |
|
98 | - if($course_id_field_name != "chamilo_course_id") { |
|
99 | - $extras_associative[$course_id_field_name] = $course_id_value; |
|
100 | - } |
|
101 | - foreach($extras as $extra) { |
|
102 | - $extras_associative[$extra['field_name']] = $extra['field_value']; |
|
103 | - } |
|
104 | - $course_admin_id = $this->getUserId($course_admin_user_id_field_name, $course_admin_user_id_value); |
|
105 | - if($course_admin_id instanceof WSError) { |
|
106 | - return $course_admin_id; |
|
107 | - } |
|
108 | - if($wanted_code == '') { |
|
109 | - $wanted_code = CourseManager::generate_course_code($title); |
|
110 | - } |
|
111 | - $result = create_course($wanted_code, $title, $tutor_name, $category_code, $language, $course_admin_id, $this->_configuration['db_prefix'], 0); |
|
112 | - if (!$result) { |
|
113 | - return new WSError(202, 'There was an error creating the course'); |
|
114 | - } else { |
|
115 | - // Update extra fields |
|
116 | - foreach($extras_associative as $fname => $fvalue) { |
|
117 | - CourseManager::update_course_extra_field_value($result, $fname, $fvalue); |
|
118 | - } |
|
119 | - // Get course id |
|
120 | - $course_info = CourseManager::get_course_information($result); |
|
121 | - return $course_info['real_id']; |
|
122 | - } |
|
123 | - } |
|
124 | - |
|
125 | - /** |
|
126 | - * Creates a course |
|
127 | - * |
|
128 | - * @param string API secret key |
|
129 | - * @param string Title |
|
130 | - * @param string Category code |
|
131 | - * @param string Wanted code. If it's not defined, it will be generated automatically |
|
132 | - * @param string Tutor name |
|
133 | - * @param string Course admin user id field name |
|
134 | - * @param string Course admin user id value |
|
135 | - * @param string Course language |
|
136 | - * @param string Course id field name |
|
137 | - * @param string Course id value |
|
138 | - * @param array Course extra fields |
|
139 | - * @return int Course id generated |
|
140 | - */ |
|
141 | - public function CreateCourse($secret_key, $title, $category_code, $wanted_code, $tutor_name, $course_admin_user_id_field_name, $course_admin_user_id_value, $language, $course_id_field_name, $course_id_value, $extras) { |
|
142 | - // First, verify the secret key |
|
143 | - $verifKey = $this->verifyKey($secret_key); |
|
144 | - if($verifKey instanceof WSError) { |
|
145 | - $this->handleError($verifKey); |
|
146 | - } else { |
|
147 | - $result = $this->createCourseHelper($title, $category_code, $wanted_code, $tutor_name, $course_admin_user_id_field_name, $course_admin_user_id_value, $language, $course_id_field_name, $course_id_value, $extras); |
|
148 | - if($result instanceof WSError) { |
|
149 | - $this->handleError($result); |
|
150 | - } else { |
|
151 | - return $result; |
|
152 | - } |
|
153 | - } |
|
154 | - } |
|
155 | - |
|
156 | - /** |
|
157 | - * Create multiple courses |
|
158 | - * |
|
159 | - * @param string API secret key |
|
160 | - * @param array Courses to be created, with elements following the structure presented in CreateCourse |
|
161 | - * @return array Array with elements of the form array('course_id_value' => 'original value sent', 'course_id_generated' => 'value_generated', 'result' => array('code' => 0, 'message' => 'Operation was successful')) |
|
162 | - */ |
|
163 | - public function CreateCourses($secret_key, $courses) { |
|
164 | - // First, verify the secret key |
|
165 | - $verifKey = $this->verifyKey($secret_key); |
|
166 | - if($verifKey instanceof WSCMError) { |
|
167 | - $this->handleError($verifKey); |
|
168 | - } else { |
|
169 | - $results = array(); |
|
170 | - foreach($courses as $course) { |
|
171 | - $result_tmp = array(); |
|
172 | - //reinitialize variables just in case |
|
173 | - $title = $category_code = $wanted_code = $tutor_name = $course_admin_user_id_field_name = $course_admin_user_id_value = $language = $course_id_field_name = $course_id_value = $extras = null; |
|
174 | - extract($course); |
|
175 | - $result = $this->createCourseHelper($title, $category_code, $wanted_code, $tutor_name, $course_admin_user_id_field_name, $course_admin_user_id_value, $language, $course_id_field_name, $course_id_value, $extras); |
|
176 | - if($result instanceof WSCMError) { |
|
177 | - $result_tmp['result'] = $result->toArray(); |
|
178 | - $result_tmp['course_id_value'] = $course_id_value; |
|
179 | - $result_tmp['course_id_generated'] = 0; |
|
180 | - } else { |
|
181 | - $result_tmp['result'] = $this->getSuccessfulResult(); |
|
182 | - $result_tmp['course_id_value'] = $course_id_value; |
|
183 | - $result_tmp['course_id_generated'] = $result; |
|
184 | - } |
|
185 | - $results[] = $result_tmp; |
|
186 | - } |
|
187 | - return $results; |
|
188 | - } |
|
189 | - } |
|
190 | - |
|
191 | - /** |
|
192 | - * Edits a course (helper method) |
|
193 | - * |
|
194 | - * @param string Course id field name |
|
195 | - * @param string Course id value |
|
196 | - * @param string Title |
|
197 | - * @param string Category code |
|
198 | - * @param string Department name |
|
199 | - * @param string Department url |
|
200 | - * @param string Course language |
|
201 | - * @param int Visibility |
|
202 | - * @param int Subscribe (0 = denied, 1 = allowed) |
|
203 | - * @param int Unsubscribe (0 = denied, 1 = allowed) |
|
204 | - * @param string Visual code |
|
205 | - * @param array Course extra fields |
|
206 | - * @return mixed True in case of success, WSError otherwise |
|
207 | - */ |
|
208 | - protected function editCourseHelper($course_id_field_name, $course_id_value, $title, $category_code, $department_name, $department_url, $language, $visibility, $subscribe, $unsubscribe, $visual_code, $extras) { |
|
209 | - $course_id = $this->getCourseId($course_id_field_name, $course_id_value); |
|
210 | - if($course_id instanceof WSCMError) { |
|
211 | - return $course_id; |
|
212 | - } else { |
|
213 | - $attributes = array(); |
|
214 | - if(!empty($title)) { |
|
215 | - $attributes['title'] = $title; |
|
216 | - } |
|
217 | - if(!empty($category_code)) { |
|
218 | - $attributes['category_code'] = $category_code; |
|
219 | - } |
|
220 | - if(!empty($department_name)) { |
|
221 | - $attributes['department_name'] = $department_name; |
|
222 | - } |
|
223 | - if(!empty($department_url)) { |
|
224 | - $attributes['department_url'] = $department_url; |
|
225 | - } |
|
226 | - if(!empty($language)) { |
|
227 | - $attributes['course_language'] = $language; |
|
228 | - } |
|
229 | - if($visibility != '') { |
|
230 | - $attributes['visibility'] = (int)$visibility; |
|
231 | - } |
|
232 | - if($subscribe != '') { |
|
233 | - $attributes['subscribe'] = (int)$subscribe; |
|
234 | - } |
|
235 | - if($unsubscribe != '') { |
|
236 | - $attributes['unsubscribe'] = (int)$unsubscribe; |
|
237 | - } |
|
238 | - if(!empty($visual_code)) { |
|
239 | - $attributes['visual_code'] = $visual_code; |
|
240 | - } |
|
241 | - if(!empty($attributes)) { |
|
242 | - CourseManager::update_attributes($course_id, $attributes); |
|
243 | - } |
|
244 | - if(!empty($extras)) { |
|
245 | - $course_code = CourseManager::get_course_code_from_course_id($course_id); |
|
246 | - $extras_associative = array(); |
|
247 | - foreach($extras as $extra) { |
|
248 | - $extras_associative[$extra['field_name']] = $extra['field_value']; |
|
249 | - } |
|
250 | - foreach($extras_associative as $fname => $fvalue) { |
|
251 | - CourseManager::update_extra_field_value($course_code, $fname, $fvalue); |
|
252 | - } |
|
253 | - } |
|
254 | - return true; |
|
255 | - } |
|
256 | - } |
|
257 | - |
|
258 | - /** |
|
259 | - * Edits a course |
|
260 | - * |
|
261 | - * @param string API secret key |
|
262 | - * @param string Course id field name |
|
263 | - * @param string Course id value |
|
264 | - * @param string Title |
|
265 | - * @param string Category code |
|
266 | - * @param string Department name |
|
267 | - * @param string Department url |
|
268 | - * @param string Course language |
|
269 | - * @param int Visibility |
|
270 | - * @param int Subscribe (0 = denied, 1 = allowed) |
|
271 | - * @param int Unsubscribe (0 = denied, 1 = allowed) |
|
272 | - * @param string Visual code |
|
273 | - * @param array Course extra fields |
|
274 | - */ |
|
275 | - public function EditCourse($secret_key, $course_id_field_name, $course_id_value, $title, $category_code, $department_name, $department_url, $language, $visibility, $subscribe, $unsubscribe, $visual_code, $extras) { |
|
276 | - $verifKey = $this->verifyKey($secret_key); |
|
277 | - if($verifKey instanceof WSCMError) { |
|
278 | - $this->handleError($verifKey); |
|
279 | - } else { |
|
280 | - $result = $this->editCourseHelper($course_id_field_name, $course_id_value, $title, $category_code, $department_name, $department_url, $language, $visibility, $subscribe, $unsubscribe, $visual_code, $extras); |
|
281 | - if($result instanceof WSCMError) { |
|
282 | - $this->handleError($result); |
|
283 | - } |
|
284 | - } |
|
285 | - } |
|
286 | - |
|
287 | - /** |
|
288 | - * List courses |
|
289 | - * |
|
290 | - * @param string API secret key |
|
291 | - * @param string Course id field name. Use "chamilo_course_id" to use internal id |
|
292 | - * @return array An array with elements of the form ('id' => 'Course internal id', 'code' => 'Course code', 'title' => 'Course title', 'language' => 'Course language', 'visibility' => 'Course visibility', |
|
293 | - * 'category_name' => 'Name of the category of the course', 'number_students' => 'Number of students in the course', 'external_course_id' => 'External course id') |
|
294 | - */ |
|
295 | - public function ListCourses($secret_key, $course_id_field_name) { |
|
296 | - $verifKey = $this->verifyKey($secret_key); |
|
297 | - if($verifKey instanceof WSError) { |
|
298 | - $this->handleError($verifKey); |
|
299 | - } else { |
|
300 | - $courses_result = array(); |
|
301 | - $category_names = array(); |
|
302 | - |
|
303 | - $courses = CourseManager::get_courses_list(); |
|
304 | - foreach($courses as $course) { |
|
305 | - $course_tmp = array(); |
|
306 | - $course_tmp['id'] = $course['id']; |
|
307 | - $course_tmp['code'] = $course['code']; |
|
308 | - $course_tmp['title'] = $course['title']; |
|
309 | - $course_tmp['language'] = $course['course_language']; |
|
310 | - $course_tmp['visibility'] = $course['visibility']; |
|
311 | - |
|
312 | - // Determining category name |
|
313 | - if($category_names[$course['category_code']]) { |
|
314 | - $course_tmp['category_name'] = $category_names[$course['category_code']]; |
|
315 | - } else { |
|
316 | - $category = CourseManager::get_course_category($course['category_code']); |
|
317 | - $category_names[$course['category_code']] = $category['name']; |
|
318 | - $course_tmp['category_name'] = $category['name']; |
|
319 | - } |
|
320 | - |
|
321 | - // Determining number of students registered in course |
|
322 | - $user_list = CourseManager::get_user_list_from_course_code($course['code']); |
|
323 | - $course_tmp['number_students'] = count($user_list); |
|
324 | - |
|
325 | - // Determining external course id |
|
326 | - $course_tmp['external_course_id'] = CourseManager::get_course_extra_field_value($course_id_field_name, $course['code']); |
|
327 | - |
|
328 | - |
|
329 | - $courses_result[] = $course_tmp; |
|
330 | - } |
|
331 | - |
|
332 | - return $courses_result; |
|
333 | - } |
|
334 | - } |
|
335 | - |
|
336 | - /** |
|
337 | - * Subscribe or unsubscribe user to a course (helper method) |
|
338 | - * |
|
339 | - * @param string Course id field name. Use "chamilo_course_id" to use internal id |
|
340 | - * @param string Course id value. |
|
341 | - * @param string User id field name. Use "chamilo_user_id" to use internal id |
|
342 | - * @param string User id value |
|
343 | - * @param int Set to 1 to subscribe, 0 to unsubscribe |
|
344 | - * @param int Status (STUDENT or TEACHER) Used for subscription only |
|
345 | - * @return mixed True if subscription or unsubscription was successful, false otherwise |
|
346 | - */ |
|
347 | - protected function changeUserSubscription($course_id_field_name, $course_id_value, $user_id_field_name, $user_id_value, $state, $status = STUDENT) { |
|
348 | - $course_id = $this->getCourseId($course_id_field_name, $course_id_value); |
|
349 | - if($course_id instanceof WSError) { |
|
350 | - return $course_id; |
|
351 | - } else { |
|
352 | - $user_id = $this->getUserId($user_id_field_name, $user_id_value); |
|
353 | - if($user_id instanceof WSError) { |
|
354 | - return $user_id; |
|
355 | - } else { |
|
356 | - $course_code = CourseManager::get_course_code_from_course_id($course_id); |
|
357 | - if($state == 0) { |
|
358 | - // Unsubscribe user |
|
359 | - CourseManager::unsubscribe_user($user_id, $course_code); |
|
360 | - return true; |
|
361 | - } else { |
|
362 | - // Subscribe user |
|
363 | - if(CourseManager::subscribe_user($user_id, $course_code, $status)) { |
|
364 | - return true; |
|
365 | - } else { |
|
366 | - return new WSError(203, 'An error occured subscribing to this course'); |
|
367 | - } |
|
368 | - } |
|
369 | - } |
|
370 | - } |
|
371 | - } |
|
372 | - |
|
373 | - /** |
|
374 | - * Subscribe user to a course |
|
375 | - * |
|
376 | - * @param string API secret key |
|
377 | - * @param string Course id field name. Use "chamilo_course_id" to use internal id |
|
378 | - * @param string Course id value. |
|
379 | - * @param string User id field name. Use "chamilo_user_id" to use internal id |
|
380 | - * @param string User id value |
|
381 | - * @param int Status (1 = Teacher, 5 = Student) |
|
382 | - */ |
|
383 | - public function SubscribeUserToCourse($secret_key, $course_id_field_name, $course_id_value, $user_id_field_name, $user_id_value, $status) { |
|
384 | - $verifKey = $this->verifyKey($secret_key); |
|
385 | - if($verifKey instanceof WSError) { |
|
386 | - $this->handleError($verifKey); |
|
387 | - } else { |
|
388 | - $result = $this->changeUserSubscription($course_id_field_name, $course_id_value, $user_id_field_name, $user_id_value, 1, $status); |
|
389 | - if($result instanceof WSError) { |
|
390 | - $this->handleError($result); |
|
391 | - } |
|
392 | - } |
|
393 | - } |
|
394 | - |
|
395 | - /** |
|
396 | - * Unsusbscribe user from course |
|
397 | - * |
|
398 | - * @param string API secret key |
|
399 | - * @param string Course id field name. Use "chamilo_course_id" to use internal id |
|
400 | - * @param string Course id value. |
|
401 | - * @param string User id field name. Use "chamilo_user_id" to use internal id |
|
402 | - * @param string User id value |
|
403 | - */ |
|
404 | - public function UnsubscribeUserFromCourse($secret_key, $course_id_field_name, $course_id_value, $user_id_field_name, $user_id_value) { |
|
405 | - $verifKey = $this->verifyKey($secret_key); |
|
406 | - if($verifKey instanceof WSError) { |
|
407 | - $this->handleError($verifKey); |
|
408 | - } else { |
|
409 | - $result = $this->changeUserSubscription($course_id_field_name, $course_id_value, $user_id_field_name, $user_id_value, 0); |
|
410 | - if($result instanceof WSError) { |
|
411 | - $this->handleError($result); |
|
412 | - } |
|
413 | - } |
|
414 | - } |
|
415 | - |
|
416 | - /** |
|
417 | - * Returns the descriptions of a course, along with their id |
|
418 | - * |
|
419 | - * @param string API secret key |
|
420 | - * @param string Course id field name |
|
421 | - * @param string Course id value |
|
422 | - * @return array Returns an array with elements of the form ('course_desc_id' => 1, 'course_desc_title' => 'Title', 'course_desc_content' => 'Content') |
|
423 | - */ |
|
424 | - public function GetCourseDescriptions($secret_key, $course_id_field_name, $course_id_value) { |
|
425 | - $verifKey = $this->verifyKey($secret_key); |
|
426 | - if($verifKey instanceof WSError) { |
|
427 | - $this->handleError($verifKey); |
|
428 | - } else { |
|
429 | - $course_id = $this->getCourseId($course_id_field_name, $course_id_value); |
|
430 | - if($course_id instanceof WSError) { |
|
431 | - return $course_id; |
|
432 | - } else { |
|
433 | - // Course exists, get its descriptions |
|
434 | - $descriptions = CourseDescription::get_descriptions($course_id); |
|
435 | - $results = array(); |
|
436 | - foreach($descriptions as $description) { |
|
437 | - $results[] = array('course_desc_id' => $description->get_description_type(), |
|
438 | - 'course_desc_title' => $description->get_title(), |
|
439 | - 'course_desc_content' => $description->get_content()); |
|
440 | - } |
|
441 | - return $results; |
|
442 | - } |
|
443 | - } |
|
444 | - } |
|
445 | - |
|
446 | - |
|
447 | - /** |
|
448 | - * Edit course description |
|
449 | - * |
|
450 | - * @param string API secret key |
|
451 | - * @param string Course id field name |
|
452 | - * @param string Course id value |
|
453 | - * @param int Category id from course description |
|
454 | - * @param string Description title |
|
455 | - * @param string Course description content |
|
456 | - */ |
|
457 | - public function EditCourseDescription($secret_key, $course_id_field_name, $course_id_value, $course_desc_id, $course_desc_title, $course_desc_content) { |
|
458 | - $verifKey = $this->verifyKey($secret_key); |
|
459 | - if($verifKey instanceof WSError) { |
|
460 | - $this->handleError($verifKey); |
|
461 | - } else { |
|
462 | - $course_id = $this->getCourseId($course_id_field_name, $course_id_value); |
|
463 | - if($course_id instanceof WSError) { |
|
464 | - return $course_id; |
|
465 | - } else { |
|
466 | - // Create the new course description |
|
467 | - $cd = new CourseDescription(); |
|
468 | - $cd->set_description_type($course_desc_id); |
|
469 | - $cd->set_title($course_desc_title); |
|
470 | - $cd->set_content($course_desc_content); |
|
471 | - $cd->set_session_id(0); |
|
472 | - |
|
473 | - // Get course info |
|
13 | + /** |
|
14 | + * Deletes a course (helper method) |
|
15 | + * |
|
16 | + * @param string Course id field name |
|
17 | + * @param string Course id value |
|
18 | + * @return mixed True if the course was successfully deleted, WSError otherwise |
|
19 | + */ |
|
20 | + protected function deleteCourseHelper($course_id_field_name, $course_id_value) { |
|
21 | + $course_id = $this->getCourseId($course_id_field_name, $course_id_value); |
|
22 | + if($course_id instanceof WSCMError) { |
|
23 | + return $course_id; |
|
24 | + } else { |
|
25 | + $course_code = CourseManager::get_course_code_from_course_id($course_id); |
|
26 | + CourseManager::delete_course($course_code); |
|
27 | + return true; |
|
28 | + } |
|
29 | + } |
|
30 | + |
|
31 | + /** |
|
32 | + * Deletes a course |
|
33 | + * |
|
34 | + * @param string API secret key |
|
35 | + * @param string Course id field name |
|
36 | + * @param string Course id value |
|
37 | + */ |
|
38 | + public function DeleteCourse($secret_key, $course_id_field_name, $course_id_value) { |
|
39 | + $verifKey = $this->verifyKey($secret_key); |
|
40 | + if($verifKey instanceof WSError) { |
|
41 | + $this->handleError($verifKey); |
|
42 | + } else { |
|
43 | + $result = $this->deleteCourseHelper($course_id_field_name, $course_id_value); |
|
44 | + if($result instanceof WSError) { |
|
45 | + $this->handleError($result); |
|
46 | + } |
|
47 | + } |
|
48 | + } |
|
49 | + |
|
50 | + /** |
|
51 | + * Deletes multiple courses |
|
52 | + * |
|
53 | + * @param string API secret key |
|
54 | + * @param array Array of courses with elements of the form array('course_id_field_name' => 'name_of_field', 'course_id_value' => 'value') |
|
55 | + * @return array Array with elements like array('course_id_value' => 'value', 'result' => array('code' => 0, 'message' => 'Operation was successful')). Note that if the result array contains a code different |
|
56 | + * than 0, an error occured |
|
57 | + */ |
|
58 | + public function DeleteCourses($secret_key, $courses) { |
|
59 | + $verifKey = $this->verifyKey($secret_key); |
|
60 | + if($verifKey instanceof WSError) { |
|
61 | + $this->handleError($verifKey); |
|
62 | + } else { |
|
63 | + $results = array(); |
|
64 | + foreach($courses as $course) { |
|
65 | + $result_tmp = array(); |
|
66 | + $result_op = $this->deleteCourseHelper($course['course_id_field_name'], $course['course_id_value']); |
|
67 | + $result_tmp['course_id_value'] = $course['course_id_value']; |
|
68 | + if($result_op instanceof WSCMError) { |
|
69 | + // Return the error in the results |
|
70 | + $result_tmp['result'] = $result_op->toArray(); |
|
71 | + } else { |
|
72 | + $result_tmp['result'] = $this->getSuccessfulResult(); |
|
73 | + } |
|
74 | + $results[] = $result_tmp; |
|
75 | + } |
|
76 | + return $results; |
|
77 | + } |
|
78 | + } |
|
79 | + |
|
80 | + /** |
|
81 | + * Creates a course (helper method) |
|
82 | + * |
|
83 | + * @param string Title |
|
84 | + * @param string Category code |
|
85 | + * @param string Wanted code. If it's not defined, it will be generated automatically |
|
86 | + * @param string Tutor name |
|
87 | + * @param string Course admin user id field name |
|
88 | + * @param string Course admin user id value |
|
89 | + * @param string Course language |
|
90 | + * @param string Course id field name |
|
91 | + * @param string Course id value |
|
92 | + * @param array Course extra fields |
|
93 | + * @return mixed Generated id if creation was successful, WSError otherwise |
|
94 | + */ |
|
95 | + protected function createCourseHelper($title, $category_code, $wanted_code, $tutor_name, $course_admin_user_id_field_name, $course_admin_user_id_value, $language, $course_id_field_name, $course_id_value, $extras) { |
|
96 | + // Add the original course id field name and value to the extra fields if needed |
|
97 | + $extras_associative = array(); |
|
98 | + if($course_id_field_name != "chamilo_course_id") { |
|
99 | + $extras_associative[$course_id_field_name] = $course_id_value; |
|
100 | + } |
|
101 | + foreach($extras as $extra) { |
|
102 | + $extras_associative[$extra['field_name']] = $extra['field_value']; |
|
103 | + } |
|
104 | + $course_admin_id = $this->getUserId($course_admin_user_id_field_name, $course_admin_user_id_value); |
|
105 | + if($course_admin_id instanceof WSError) { |
|
106 | + return $course_admin_id; |
|
107 | + } |
|
108 | + if($wanted_code == '') { |
|
109 | + $wanted_code = CourseManager::generate_course_code($title); |
|
110 | + } |
|
111 | + $result = create_course($wanted_code, $title, $tutor_name, $category_code, $language, $course_admin_id, $this->_configuration['db_prefix'], 0); |
|
112 | + if (!$result) { |
|
113 | + return new WSError(202, 'There was an error creating the course'); |
|
114 | + } else { |
|
115 | + // Update extra fields |
|
116 | + foreach($extras_associative as $fname => $fvalue) { |
|
117 | + CourseManager::update_course_extra_field_value($result, $fname, $fvalue); |
|
118 | + } |
|
119 | + // Get course id |
|
120 | + $course_info = CourseManager::get_course_information($result); |
|
121 | + return $course_info['real_id']; |
|
122 | + } |
|
123 | + } |
|
124 | + |
|
125 | + /** |
|
126 | + * Creates a course |
|
127 | + * |
|
128 | + * @param string API secret key |
|
129 | + * @param string Title |
|
130 | + * @param string Category code |
|
131 | + * @param string Wanted code. If it's not defined, it will be generated automatically |
|
132 | + * @param string Tutor name |
|
133 | + * @param string Course admin user id field name |
|
134 | + * @param string Course admin user id value |
|
135 | + * @param string Course language |
|
136 | + * @param string Course id field name |
|
137 | + * @param string Course id value |
|
138 | + * @param array Course extra fields |
|
139 | + * @return int Course id generated |
|
140 | + */ |
|
141 | + public function CreateCourse($secret_key, $title, $category_code, $wanted_code, $tutor_name, $course_admin_user_id_field_name, $course_admin_user_id_value, $language, $course_id_field_name, $course_id_value, $extras) { |
|
142 | + // First, verify the secret key |
|
143 | + $verifKey = $this->verifyKey($secret_key); |
|
144 | + if($verifKey instanceof WSError) { |
|
145 | + $this->handleError($verifKey); |
|
146 | + } else { |
|
147 | + $result = $this->createCourseHelper($title, $category_code, $wanted_code, $tutor_name, $course_admin_user_id_field_name, $course_admin_user_id_value, $language, $course_id_field_name, $course_id_value, $extras); |
|
148 | + if($result instanceof WSError) { |
|
149 | + $this->handleError($result); |
|
150 | + } else { |
|
151 | + return $result; |
|
152 | + } |
|
153 | + } |
|
154 | + } |
|
155 | + |
|
156 | + /** |
|
157 | + * Create multiple courses |
|
158 | + * |
|
159 | + * @param string API secret key |
|
160 | + * @param array Courses to be created, with elements following the structure presented in CreateCourse |
|
161 | + * @return array Array with elements of the form array('course_id_value' => 'original value sent', 'course_id_generated' => 'value_generated', 'result' => array('code' => 0, 'message' => 'Operation was successful')) |
|
162 | + */ |
|
163 | + public function CreateCourses($secret_key, $courses) { |
|
164 | + // First, verify the secret key |
|
165 | + $verifKey = $this->verifyKey($secret_key); |
|
166 | + if($verifKey instanceof WSCMError) { |
|
167 | + $this->handleError($verifKey); |
|
168 | + } else { |
|
169 | + $results = array(); |
|
170 | + foreach($courses as $course) { |
|
171 | + $result_tmp = array(); |
|
172 | + //reinitialize variables just in case |
|
173 | + $title = $category_code = $wanted_code = $tutor_name = $course_admin_user_id_field_name = $course_admin_user_id_value = $language = $course_id_field_name = $course_id_value = $extras = null; |
|
174 | + extract($course); |
|
175 | + $result = $this->createCourseHelper($title, $category_code, $wanted_code, $tutor_name, $course_admin_user_id_field_name, $course_admin_user_id_value, $language, $course_id_field_name, $course_id_value, $extras); |
|
176 | + if($result instanceof WSCMError) { |
|
177 | + $result_tmp['result'] = $result->toArray(); |
|
178 | + $result_tmp['course_id_value'] = $course_id_value; |
|
179 | + $result_tmp['course_id_generated'] = 0; |
|
180 | + } else { |
|
181 | + $result_tmp['result'] = $this->getSuccessfulResult(); |
|
182 | + $result_tmp['course_id_value'] = $course_id_value; |
|
183 | + $result_tmp['course_id_generated'] = $result; |
|
184 | + } |
|
185 | + $results[] = $result_tmp; |
|
186 | + } |
|
187 | + return $results; |
|
188 | + } |
|
189 | + } |
|
190 | + |
|
191 | + /** |
|
192 | + * Edits a course (helper method) |
|
193 | + * |
|
194 | + * @param string Course id field name |
|
195 | + * @param string Course id value |
|
196 | + * @param string Title |
|
197 | + * @param string Category code |
|
198 | + * @param string Department name |
|
199 | + * @param string Department url |
|
200 | + * @param string Course language |
|
201 | + * @param int Visibility |
|
202 | + * @param int Subscribe (0 = denied, 1 = allowed) |
|
203 | + * @param int Unsubscribe (0 = denied, 1 = allowed) |
|
204 | + * @param string Visual code |
|
205 | + * @param array Course extra fields |
|
206 | + * @return mixed True in case of success, WSError otherwise |
|
207 | + */ |
|
208 | + protected function editCourseHelper($course_id_field_name, $course_id_value, $title, $category_code, $department_name, $department_url, $language, $visibility, $subscribe, $unsubscribe, $visual_code, $extras) { |
|
209 | + $course_id = $this->getCourseId($course_id_field_name, $course_id_value); |
|
210 | + if($course_id instanceof WSCMError) { |
|
211 | + return $course_id; |
|
212 | + } else { |
|
213 | + $attributes = array(); |
|
214 | + if(!empty($title)) { |
|
215 | + $attributes['title'] = $title; |
|
216 | + } |
|
217 | + if(!empty($category_code)) { |
|
218 | + $attributes['category_code'] = $category_code; |
|
219 | + } |
|
220 | + if(!empty($department_name)) { |
|
221 | + $attributes['department_name'] = $department_name; |
|
222 | + } |
|
223 | + if(!empty($department_url)) { |
|
224 | + $attributes['department_url'] = $department_url; |
|
225 | + } |
|
226 | + if(!empty($language)) { |
|
227 | + $attributes['course_language'] = $language; |
|
228 | + } |
|
229 | + if($visibility != '') { |
|
230 | + $attributes['visibility'] = (int)$visibility; |
|
231 | + } |
|
232 | + if($subscribe != '') { |
|
233 | + $attributes['subscribe'] = (int)$subscribe; |
|
234 | + } |
|
235 | + if($unsubscribe != '') { |
|
236 | + $attributes['unsubscribe'] = (int)$unsubscribe; |
|
237 | + } |
|
238 | + if(!empty($visual_code)) { |
|
239 | + $attributes['visual_code'] = $visual_code; |
|
240 | + } |
|
241 | + if(!empty($attributes)) { |
|
242 | + CourseManager::update_attributes($course_id, $attributes); |
|
243 | + } |
|
244 | + if(!empty($extras)) { |
|
245 | + $course_code = CourseManager::get_course_code_from_course_id($course_id); |
|
246 | + $extras_associative = array(); |
|
247 | + foreach($extras as $extra) { |
|
248 | + $extras_associative[$extra['field_name']] = $extra['field_value']; |
|
249 | + } |
|
250 | + foreach($extras_associative as $fname => $fvalue) { |
|
251 | + CourseManager::update_extra_field_value($course_code, $fname, $fvalue); |
|
252 | + } |
|
253 | + } |
|
254 | + return true; |
|
255 | + } |
|
256 | + } |
|
257 | + |
|
258 | + /** |
|
259 | + * Edits a course |
|
260 | + * |
|
261 | + * @param string API secret key |
|
262 | + * @param string Course id field name |
|
263 | + * @param string Course id value |
|
264 | + * @param string Title |
|
265 | + * @param string Category code |
|
266 | + * @param string Department name |
|
267 | + * @param string Department url |
|
268 | + * @param string Course language |
|
269 | + * @param int Visibility |
|
270 | + * @param int Subscribe (0 = denied, 1 = allowed) |
|
271 | + * @param int Unsubscribe (0 = denied, 1 = allowed) |
|
272 | + * @param string Visual code |
|
273 | + * @param array Course extra fields |
|
274 | + */ |
|
275 | + public function EditCourse($secret_key, $course_id_field_name, $course_id_value, $title, $category_code, $department_name, $department_url, $language, $visibility, $subscribe, $unsubscribe, $visual_code, $extras) { |
|
276 | + $verifKey = $this->verifyKey($secret_key); |
|
277 | + if($verifKey instanceof WSCMError) { |
|
278 | + $this->handleError($verifKey); |
|
279 | + } else { |
|
280 | + $result = $this->editCourseHelper($course_id_field_name, $course_id_value, $title, $category_code, $department_name, $department_url, $language, $visibility, $subscribe, $unsubscribe, $visual_code, $extras); |
|
281 | + if($result instanceof WSCMError) { |
|
282 | + $this->handleError($result); |
|
283 | + } |
|
284 | + } |
|
285 | + } |
|
286 | + |
|
287 | + /** |
|
288 | + * List courses |
|
289 | + * |
|
290 | + * @param string API secret key |
|
291 | + * @param string Course id field name. Use "chamilo_course_id" to use internal id |
|
292 | + * @return array An array with elements of the form ('id' => 'Course internal id', 'code' => 'Course code', 'title' => 'Course title', 'language' => 'Course language', 'visibility' => 'Course visibility', |
|
293 | + * 'category_name' => 'Name of the category of the course', 'number_students' => 'Number of students in the course', 'external_course_id' => 'External course id') |
|
294 | + */ |
|
295 | + public function ListCourses($secret_key, $course_id_field_name) { |
|
296 | + $verifKey = $this->verifyKey($secret_key); |
|
297 | + if($verifKey instanceof WSError) { |
|
298 | + $this->handleError($verifKey); |
|
299 | + } else { |
|
300 | + $courses_result = array(); |
|
301 | + $category_names = array(); |
|
302 | + |
|
303 | + $courses = CourseManager::get_courses_list(); |
|
304 | + foreach($courses as $course) { |
|
305 | + $course_tmp = array(); |
|
306 | + $course_tmp['id'] = $course['id']; |
|
307 | + $course_tmp['code'] = $course['code']; |
|
308 | + $course_tmp['title'] = $course['title']; |
|
309 | + $course_tmp['language'] = $course['course_language']; |
|
310 | + $course_tmp['visibility'] = $course['visibility']; |
|
311 | + |
|
312 | + // Determining category name |
|
313 | + if($category_names[$course['category_code']]) { |
|
314 | + $course_tmp['category_name'] = $category_names[$course['category_code']]; |
|
315 | + } else { |
|
316 | + $category = CourseManager::get_course_category($course['category_code']); |
|
317 | + $category_names[$course['category_code']] = $category['name']; |
|
318 | + $course_tmp['category_name'] = $category['name']; |
|
319 | + } |
|
320 | + |
|
321 | + // Determining number of students registered in course |
|
322 | + $user_list = CourseManager::get_user_list_from_course_code($course['code']); |
|
323 | + $course_tmp['number_students'] = count($user_list); |
|
324 | + |
|
325 | + // Determining external course id |
|
326 | + $course_tmp['external_course_id'] = CourseManager::get_course_extra_field_value($course_id_field_name, $course['code']); |
|
327 | + |
|
328 | + |
|
329 | + $courses_result[] = $course_tmp; |
|
330 | + } |
|
331 | + |
|
332 | + return $courses_result; |
|
333 | + } |
|
334 | + } |
|
335 | + |
|
336 | + /** |
|
337 | + * Subscribe or unsubscribe user to a course (helper method) |
|
338 | + * |
|
339 | + * @param string Course id field name. Use "chamilo_course_id" to use internal id |
|
340 | + * @param string Course id value. |
|
341 | + * @param string User id field name. Use "chamilo_user_id" to use internal id |
|
342 | + * @param string User id value |
|
343 | + * @param int Set to 1 to subscribe, 0 to unsubscribe |
|
344 | + * @param int Status (STUDENT or TEACHER) Used for subscription only |
|
345 | + * @return mixed True if subscription or unsubscription was successful, false otherwise |
|
346 | + */ |
|
347 | + protected function changeUserSubscription($course_id_field_name, $course_id_value, $user_id_field_name, $user_id_value, $state, $status = STUDENT) { |
|
348 | + $course_id = $this->getCourseId($course_id_field_name, $course_id_value); |
|
349 | + if($course_id instanceof WSError) { |
|
350 | + return $course_id; |
|
351 | + } else { |
|
352 | + $user_id = $this->getUserId($user_id_field_name, $user_id_value); |
|
353 | + if($user_id instanceof WSError) { |
|
354 | + return $user_id; |
|
355 | + } else { |
|
356 | + $course_code = CourseManager::get_course_code_from_course_id($course_id); |
|
357 | + if($state == 0) { |
|
358 | + // Unsubscribe user |
|
359 | + CourseManager::unsubscribe_user($user_id, $course_code); |
|
360 | + return true; |
|
361 | + } else { |
|
362 | + // Subscribe user |
|
363 | + if(CourseManager::subscribe_user($user_id, $course_code, $status)) { |
|
364 | + return true; |
|
365 | + } else { |
|
366 | + return new WSError(203, 'An error occured subscribing to this course'); |
|
367 | + } |
|
368 | + } |
|
369 | + } |
|
370 | + } |
|
371 | + } |
|
372 | + |
|
373 | + /** |
|
374 | + * Subscribe user to a course |
|
375 | + * |
|
376 | + * @param string API secret key |
|
377 | + * @param string Course id field name. Use "chamilo_course_id" to use internal id |
|
378 | + * @param string Course id value. |
|
379 | + * @param string User id field name. Use "chamilo_user_id" to use internal id |
|
380 | + * @param string User id value |
|
381 | + * @param int Status (1 = Teacher, 5 = Student) |
|
382 | + */ |
|
383 | + public function SubscribeUserToCourse($secret_key, $course_id_field_name, $course_id_value, $user_id_field_name, $user_id_value, $status) { |
|
384 | + $verifKey = $this->verifyKey($secret_key); |
|
385 | + if($verifKey instanceof WSError) { |
|
386 | + $this->handleError($verifKey); |
|
387 | + } else { |
|
388 | + $result = $this->changeUserSubscription($course_id_field_name, $course_id_value, $user_id_field_name, $user_id_value, 1, $status); |
|
389 | + if($result instanceof WSError) { |
|
390 | + $this->handleError($result); |
|
391 | + } |
|
392 | + } |
|
393 | + } |
|
394 | + |
|
395 | + /** |
|
396 | + * Unsusbscribe user from course |
|
397 | + * |
|
398 | + * @param string API secret key |
|
399 | + * @param string Course id field name. Use "chamilo_course_id" to use internal id |
|
400 | + * @param string Course id value. |
|
401 | + * @param string User id field name. Use "chamilo_user_id" to use internal id |
|
402 | + * @param string User id value |
|
403 | + */ |
|
404 | + public function UnsubscribeUserFromCourse($secret_key, $course_id_field_name, $course_id_value, $user_id_field_name, $user_id_value) { |
|
405 | + $verifKey = $this->verifyKey($secret_key); |
|
406 | + if($verifKey instanceof WSError) { |
|
407 | + $this->handleError($verifKey); |
|
408 | + } else { |
|
409 | + $result = $this->changeUserSubscription($course_id_field_name, $course_id_value, $user_id_field_name, $user_id_value, 0); |
|
410 | + if($result instanceof WSError) { |
|
411 | + $this->handleError($result); |
|
412 | + } |
|
413 | + } |
|
414 | + } |
|
415 | + |
|
416 | + /** |
|
417 | + * Returns the descriptions of a course, along with their id |
|
418 | + * |
|
419 | + * @param string API secret key |
|
420 | + * @param string Course id field name |
|
421 | + * @param string Course id value |
|
422 | + * @return array Returns an array with elements of the form ('course_desc_id' => 1, 'course_desc_title' => 'Title', 'course_desc_content' => 'Content') |
|
423 | + */ |
|
424 | + public function GetCourseDescriptions($secret_key, $course_id_field_name, $course_id_value) { |
|
425 | + $verifKey = $this->verifyKey($secret_key); |
|
426 | + if($verifKey instanceof WSError) { |
|
427 | + $this->handleError($verifKey); |
|
428 | + } else { |
|
429 | + $course_id = $this->getCourseId($course_id_field_name, $course_id_value); |
|
430 | + if($course_id instanceof WSError) { |
|
431 | + return $course_id; |
|
432 | + } else { |
|
433 | + // Course exists, get its descriptions |
|
434 | + $descriptions = CourseDescription::get_descriptions($course_id); |
|
435 | + $results = array(); |
|
436 | + foreach($descriptions as $description) { |
|
437 | + $results[] = array('course_desc_id' => $description->get_description_type(), |
|
438 | + 'course_desc_title' => $description->get_title(), |
|
439 | + 'course_desc_content' => $description->get_content()); |
|
440 | + } |
|
441 | + return $results; |
|
442 | + } |
|
443 | + } |
|
444 | + } |
|
445 | + |
|
446 | + |
|
447 | + /** |
|
448 | + * Edit course description |
|
449 | + * |
|
450 | + * @param string API secret key |
|
451 | + * @param string Course id field name |
|
452 | + * @param string Course id value |
|
453 | + * @param int Category id from course description |
|
454 | + * @param string Description title |
|
455 | + * @param string Course description content |
|
456 | + */ |
|
457 | + public function EditCourseDescription($secret_key, $course_id_field_name, $course_id_value, $course_desc_id, $course_desc_title, $course_desc_content) { |
|
458 | + $verifKey = $this->verifyKey($secret_key); |
|
459 | + if($verifKey instanceof WSError) { |
|
460 | + $this->handleError($verifKey); |
|
461 | + } else { |
|
462 | + $course_id = $this->getCourseId($course_id_field_name, $course_id_value); |
|
463 | + if($course_id instanceof WSError) { |
|
464 | + return $course_id; |
|
465 | + } else { |
|
466 | + // Create the new course description |
|
467 | + $cd = new CourseDescription(); |
|
468 | + $cd->set_description_type($course_desc_id); |
|
469 | + $cd->set_title($course_desc_title); |
|
470 | + $cd->set_content($course_desc_content); |
|
471 | + $cd->set_session_id(0); |
|
472 | + |
|
473 | + // Get course info |
|
474 | 474 | $course_info = CourseManager::get_course_information( |
475 | 475 | CourseManager::get_course_code_from_course_id($course_id) |
476 | 476 | ); |
477 | - // Check if this course description exists |
|
478 | - $descriptions = CourseDescription::get_descriptions($course_id); |
|
479 | - $exists = false; |
|
480 | - foreach($descriptions as $description) { |
|
481 | - if($description->get_description_type() == $course_desc_id) { |
|
482 | - $exists = true; |
|
483 | - } |
|
484 | - } |
|
477 | + // Check if this course description exists |
|
478 | + $descriptions = CourseDescription::get_descriptions($course_id); |
|
479 | + $exists = false; |
|
480 | + foreach($descriptions as $description) { |
|
481 | + if($description->get_description_type() == $course_desc_id) { |
|
482 | + $exists = true; |
|
483 | + } |
|
484 | + } |
|
485 | 485 | $cd->set_course_id($course_info['real_id']); |
486 | - if (!$exists) { |
|
487 | - $cd->set_progress(0); |
|
488 | - $cd->insert(); |
|
489 | - } else { |
|
490 | - $cd->update(); |
|
491 | - } |
|
492 | - } |
|
493 | - } |
|
494 | - } |
|
495 | - public function unreadMessage($username, $password) |
|
496 | - { |
|
497 | - if($this->verifyUserPass($username, $password) == "valid") |
|
498 | - { |
|
499 | - $table_message = Database::get_main_table(TABLE_MESSAGE); |
|
500 | - $user_id = UserManager::get_user_id_from_username($username); |
|
501 | - $condition_msg_status = ' msg_status = 1 '; // define('MESSAGE_STATUS_UNREAD', '1'); |
|
502 | - |
|
503 | - $sql_query = "SELECT COUNT(*) as number_messages FROM $table_message WHERE $condition_msg_status AND user_receiver_id=".$user_id; |
|
504 | - |
|
505 | - $sql_result = Database::query($sql_query); |
|
506 | - $result = Database::fetch_array($sql_result); |
|
507 | - return $result['number_messages']; |
|
508 | - } |
|
509 | - return "0"; |
|
510 | - } |
|
511 | - |
|
512 | - public function get_message_data($username, $password) |
|
513 | - { |
|
514 | - if($this->verifyUserPass($username, $password) == "valid") |
|
515 | - { |
|
516 | - $user_id = get_user_id_from_username($username); |
|
517 | - |
|
518 | - } |
|
519 | - |
|
520 | - } |
|
521 | - |
|
522 | - public function nada($username, $password) |
|
523 | - { |
|
524 | - if($this->verifyUserPass($username, $password) == "valid") |
|
525 | - return $username.$password; |
|
526 | - return $username; |
|
527 | - } |
|
486 | + if (!$exists) { |
|
487 | + $cd->set_progress(0); |
|
488 | + $cd->insert(); |
|
489 | + } else { |
|
490 | + $cd->update(); |
|
491 | + } |
|
492 | + } |
|
493 | + } |
|
494 | + } |
|
495 | + public function unreadMessage($username, $password) |
|
496 | + { |
|
497 | + if($this->verifyUserPass($username, $password) == "valid") |
|
498 | + { |
|
499 | + $table_message = Database::get_main_table(TABLE_MESSAGE); |
|
500 | + $user_id = UserManager::get_user_id_from_username($username); |
|
501 | + $condition_msg_status = ' msg_status = 1 '; // define('MESSAGE_STATUS_UNREAD', '1'); |
|
502 | + |
|
503 | + $sql_query = "SELECT COUNT(*) as number_messages FROM $table_message WHERE $condition_msg_status AND user_receiver_id=".$user_id; |
|
504 | + |
|
505 | + $sql_result = Database::query($sql_query); |
|
506 | + $result = Database::fetch_array($sql_result); |
|
507 | + return $result['number_messages']; |
|
508 | + } |
|
509 | + return "0"; |
|
510 | + } |
|
511 | + |
|
512 | + public function get_message_data($username, $password) |
|
513 | + { |
|
514 | + if($this->verifyUserPass($username, $password) == "valid") |
|
515 | + { |
|
516 | + $user_id = get_user_id_from_username($username); |
|
517 | + |
|
518 | + } |
|
519 | + |
|
520 | + } |
|
521 | + |
|
522 | + public function nada($username, $password) |
|
523 | + { |
|
524 | + if($this->verifyUserPass($username, $password) == "valid") |
|
525 | + return $username.$password; |
|
526 | + return $username; |
|
527 | + } |
|
528 | 528 | |
529 | 529 | |
530 | 530 |