diff --git a/main/inc/lib/course.lib.php b/main/inc/lib/course.lib.php index d5411760e9..0f02cebe40 100755 --- a/main/inc/lib/course.lib.php +++ b/main/inc/lib/course.lib.php @@ -434,14 +434,14 @@ class CourseManager { * @param string Original field name * @return int Course id */ - public static function get_course_id_from_original_id($original_course_id_value, $original_course_id_name) { + public static function get_course_code_from_original_id($original_course_id_value, $original_course_id_name) { $t_cfv = Database::get_main_table(TABLE_MAIN_COURSE_FIELD_VALUES); $table_field = Database::get_main_table(TABLE_MAIN_COURSE_FIELD); - $sql_course = "SELECT id FROM $table_field cf INNER JOIN $t_cfv cfv ON cfv.field_id=cf.id WHERE field_variable='$original_course_id_name' AND field_value='$original_course_id_value'"; + $sql_course = "SELECT course_code FROM $table_field cf INNER JOIN $t_cfv cfv ON cfv.field_id=cf.id WHERE field_variable='$original_course_id_name' AND field_value='$original_course_id_value'"; $res = Database::query($sql_course); $row = Database::fetch_object($res_course); if($row != false) { - return $row->id; + return $row->course_code; } else { return 0; } diff --git a/main/inc/lib/course_description.lib.php b/main/inc/lib/course_description.lib.php index 102b20dbe9..97c905cf8c 100755 --- a/main/inc/lib/course_description.lib.php +++ b/main/inc/lib/course_description.lib.php @@ -6,6 +6,8 @@ * @author Christian Fasanando * @package chamilo.course_description */ +require_once(dirname(__FILE__).'/course.lib.php'); +require_once(dirname(__FILE__).'/database.lib.php'); /** * CourseDescription can be used to instanciate objects or as a library to manage course descriptions @@ -24,6 +26,36 @@ class CourseDescription * Constructor */ public function __construct() {} + + /** + * Returns an array of objects of type CourseDescription corresponding to a specific course, without session ids (session id = 0) + * + * @param int Course id + * @return array Array of CourseDescriptions + */ + public static function get_descriptions($course_id) { + // Get course code + $course_id = (int)$course_id; + $course_code = CourseManager::get_course_code_from_course_id($course_id); + // Get course info + $course_info = CourseManager::get_course_information($course_code); + $t_course_desc = Database::get_course_table(TABLE_COURSE_DESCRIPTION, $course_info['dbName']); + $sql = "SELECT * FROM $t_course_desc WHERE session_id = '0';"; + $sql_result = Database::query($sql); + $results = array(); + while($row = Database::fetch_array($sql_result)) { + $desc_tmp = new CourseDescription(); + $desc_tmp->set_id($row['id']); + $desc_tmp->set_title($row['title']); + $desc_tmp->set_content($row['content']); + $desc_tmp->set_session_id($row['session_id']); + $desc_tmp->set_description_type($row['description_type']); + $desc_tmp->set_progress($row['progress']); + $results[] = $desc_tmp; + } + return $results; + } + /** * Get all data of course description by session id, @@ -125,8 +157,12 @@ class CourseDescription * first you must set description_type, title, content, progress and session_id properties with the object CourseDescription * @return int affected rows */ - public function insert() { - $tbl_course_description = Database::get_course_table(TABLE_COURSE_DESCRIPTION); + public function insert($course_db = null) { + if($course_db === null) { + $tbl_course_description = Database::get_course_table(TABLE_COURSE_DESCRIPTION); + } else { + $tbl_course_description = Database::get_course_table(TABLE_COURSE_DESCRIPTION, $course_db); + } $sql = "INSERT IGNORE INTO $tbl_course_description SET description_type='".intval($this->description_type)."', title = '".Database::escape_string($this->title)."', content = '".Database::escape_string($this->content)."', progress = '".intval($this->progress)."', session_id = '".intval($this->session_id)."' "; Database::query($sql); $last_id = Database::insert_id(); @@ -170,8 +206,12 @@ class CourseDescription * and session_id properties with the object CourseDescription * @return int affected rows */ - public function update() { - $tbl_course_description = Database::get_course_table(TABLE_COURSE_DESCRIPTION); + public function update($course_db = null) { + if($course_db === null) { + $tbl_course_description = Database::get_course_table(TABLE_COURSE_DESCRIPTION); + } else { + $tbl_course_description = Database::get_course_table(TABLE_COURSE_DESCRIPTION, $course_db); + } $sql = "UPDATE $tbl_course_description SET title = '".Database::escape_string($this->title)."', content = '".Database::escape_string($this->content)."', progress = '".$this->progress."' WHERE description_type='".intval($this->description_type)."' AND session_id = '".$this->session_id."'"; Database::query($sql); $affected_rows = Database::affected_rows(); @@ -187,8 +227,12 @@ class CourseDescription * Delete a description, first you must set description_type and session_id properties with the object CourseDescription * @return int affected rows */ - public function delete() { - $tbl_course_description = Database::get_course_table(TABLE_COURSE_DESCRIPTION); + public function delete($course_db = null) { + if($course_db === null) { + $tbl_course_description = Database::get_course_table(TABLE_COURSE_DESCRIPTION); + } else { + $tbl_course_description = Database::get_course_table(TABLE_COURSE_DESCRIPTION, $course_db); + } $description_id = $this->get_id_by_description_type($this->description_type); $sql = "DELETE FROM $tbl_course_description WHERE description_type = '".intval($this->description_type)."' AND session_id = '".intval($this->session_id)."'"; Database::query($sql); @@ -426,4 +470,4 @@ class CourseDescription } } -?> \ No newline at end of file +?> diff --git a/main/inc/lib/sessionmanager.lib.php b/main/inc/lib/sessionmanager.lib.php index a757a908de..feb8821959 100755 --- a/main/inc/lib/sessionmanager.lib.php +++ b/main/inc/lib/sessionmanager.lib.php @@ -65,17 +65,21 @@ class SessionManager { $tbl_user = Database::get_main_table(TABLE_MAIN_USER); $tbl_session = Database::get_main_table(TABLE_MAIN_SESSION); - $sql = 'SELECT user_id FROM '.$tbl_user.' WHERE username="'.Database::escape_string($coach_username).'"'; - $rs = Database::query($sql); - $id_coach = Database::result($rs,0,'user_id'); + if(is_int($coach_username)) { + $id_coach = $coach_username; + } else { + $sql = 'SELECT user_id FROM '.$tbl_user.' WHERE username="'.Database::escape_string($coach_username).'"'; + $rs = Database::query($sql); + $id_coach = Database::result($rs,0,'user_id'); + } if (empty($nolimit)) { $date_start="$year_start-".(($month_start < 10)?"0$month_start":$month_start)."-".(($day_start < 10)?"0$day_start":$day_start); $date_end="$year_end-".(($month_end < 10)?"0$month_end":$month_end)."-".(($day_end < 10)?"0$day_end":$day_end); } else { $id_visibility = 1; // by default is read only - $date_start="000-00-00"; - $date_end="000-00-00"; + $date_start="0000-00-00"; + $date_end="0000-00-00"; } if (empty($name)) { $msg=get_lang('SessionNameIsRequired'); @@ -1085,4 +1089,24 @@ class SessionManager { } return $courses; } + + /** + * Get the session id based on the original id and field name in the extra fields. Returns 0 if session was not found + * + * @param string Original session id + * @param string Original field name + * @return int Session id + */ + public static function get_session_id_from_original_id($original_session_id_value, $original_session_id_name) { + $t_sfv = Database::get_main_table(TABLE_MAIN_SESSION_FIELD_VALUES); + $table_field = Database::get_main_table(TABLE_MAIN_SESSION_FIELD); + $sql_session = "SELECT session_id FROM $table_field sf INNER JOIN $t_sfv sfv ON sfv.field_id=sf.id WHERE field_variable='$original_session_id_name' AND field_value='$original_session_id_value'"; + $res_session = Database::query($sql_session); + $row = Database::fetch_object($res_session); + if($row != false) { + return $row->session_id; + } else { + return 0; + } + } } diff --git a/main/webservices/webservice.php b/main/webservices/webservice.php index c70104396a..ae780eb615 100644 --- a/main/webservices/webservice.php +++ b/main/webservices/webservice.php @@ -157,11 +157,38 @@ class WS { return new WSError(200, "Course not found"); } } else { - $course_id = CourseManager::get_course_id_from_original_id($course_id_value, $course_id_field_name); - if($course_id == 0) { + $course_code = CourseManager::get_course_code_from_original_id($course_id_value, $course_id_field_name); + if($course_code == 0) { return new WSError(200, "Course not found"); } else { - return $course_id; + $course_info = CourseManager::get_course_information($course_code); + return $course_info['id']; + } + } + } + + /** + * Gets the real session id based on the session id field name and value. Note that if the session id field name is "chamilo_session_id", it will use the session id + * in the system database + * + * @param string Session id field name + * @param string Session id value + * @return mixed System session id if the session was found, WSError otherwise + */ + protected function getSessionId($session_id_field_name, $session_id_value) { + if($session_id_field_name == "chamilo_session_id") { + $session = SessionManager::fetch((int)$session_id_value); + if(!empty($session)) { + return intval($session_id_value); + } else { + return new WSError(300, "Session not found"); + } + } else { + $session_id = SessionManager::get_session_id_from_original_id($session_id_value, $session_id_field_name); + if($session_id == 0) { + return new WSError(300, "Session not found"); + } else { + return $session_id; } } } diff --git a/main/webservices/webservice_course.php b/main/webservices/webservice_course.php index 7785a5a6be..8e2482ca87 100644 --- a/main/webservices/webservice_course.php +++ b/main/webservices/webservice_course.php @@ -4,6 +4,7 @@ require_once(dirname(__FILE__).'/../inc/global.inc.php'); $libpath = api_get_path(LIBRARY_PATH); require_once $libpath.'course.lib.php'; require_once $libpath.'add_course.lib.inc.php'; +require_once $libpath.'course_description.lib.php'; require_once(dirname(__FILE__).'/webservice.php'); /** @@ -105,6 +106,9 @@ class WSCourse extends WS { $extras_associative[$extra['field_name']] = $extra['field_value']; } $course_admin_id = $this->getUserId($course_admin_user_id_field_name, $course_admin_user_id_value); + if($course_admin_id instanceof WSError) { + return $course_admin_id; + } if($wanted_code == '') { $wanted_code = generate_course_code($title); } @@ -191,8 +195,145 @@ class WSCourse extends WS { * * @param string Course id field name * @param string Course id value - * @param ... + * @param string Title + * @param string Category code + * @param string Department name + * @param string Department url + * @param string Course language + * @param int Visibility + * @param int Subscribe (0 = denied, 1 = allowed) + * @param int Unsubscribe (0 = denied, 1 = allowed) + * @param string Visual code + * @param array Course extra fields + * @return mixed True in case of success, WSError otherwise */ + protected function editCourseHelper($course_id_field_name, $course_id_value, $title, $category_code, $department_name, $department_url, $language, $visibility, $subscribe, $unsubscribe, $visual_code, $extras) { + $course_id = $this->getCourseId($course_id_field_name, $course_id_value); + if($course_id instanceof WSError) { + return $course_id; + } else { + $attributes = array(); + if(!is_empty($title)) { + $attributes['title'] = $title; + } + if(!is_empty($category_code)) { + $attributes['category_code'] = $category_code; + } + if(!is_empty($department_name)) { + $attributes['department_name'] = $department_name; + } + if(!is_empty($department_url)) { + $attributes['department_url'] = $department_url; + } + if(!is_empty($language)) { + $attributes['course_language'] = $language; + } + if($visibility != '') { + $attributes['visibility'] = (int)$visibility; + } + if($subscribe != '') { + $attributes['subscribe'] = (int)$subscribe; + } + if($unsubscribe != '') { + $attributes['unsubscribe'] = (int)$unsubscribe; + } + if(!is_empty($visual_code)) { + $attributes['visual_code'] = $visual_code; + } + if(!is_empty($attributes)) { + CourseManager::update_attributes($course_id, $attributes); + } + if(!empty($extras)) { + $course_code = CourseManager::get_course_code_from_course_id($course_id); + $extras_associative = array(); + foreach($extras as $extra) { + $extras_associative[$extra['field_name']] = $extra['field_value']; + } + foreach($extras_associative as $fname => $fvalue) { + CourseManager::update_extra_field_value($course_code, $fname, $fvalue); + } + } + return true; + } + } + + /** + * Edits a course + * + * @param string API secret key + * @param string Course id field name + * @param string Course id value + * @param string Title + * @param string Category code + * @param string Department name + * @param string Department url + * @param string Course language + * @param int Visibility + * @param int Subscribe (0 = denied, 1 = allowed) + * @param int Unsubscribe (0 = denied, 1 = allowed) + * @param string Visual code + * @param array Course extra fields + */ + 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) { + $verifKey = $this->verifyKey($secret_key); + if($verifKey instanceof WSError) { + $this->handleError($verifKey); + } else { + $result = $this->editCourseHelper($course_id_field_name, $course_id_value, $title, $category_code, $department_name, $department_url, $language, $visibility, $subscribe, $unsubscribe, $visual_code, $extras); + if($result instanceof WSError) { + $this->handleError($result); + } + } + } + + /** + * List courses + * + * @param string API secret key + * @param string Course id field name. Use "chamilo_course_id" to use internal id + * @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', + * 'category_name' => 'Name of the category of the course', 'number_students' => 'Number of students in the course', 'external_course_id' => 'External course id') + */ + public function ListCourses($secret_key, $course_id_field_name) { + $verifKey = $this->verifyKey($secret_key); + if($verifKey instanceof WSError) { + $this->handleError($verifKey); + } else { + $courses_result = array(); + $category_names = array(); + + $courses = CourseManager::get_courses_list(); + foreach($courses as $course) { + $course_tmp = array(); + $course_tmp['id'] = $course['id']; + $course_tmp['code'] = $course['code']; + $course_tmp['title'] = $course['title']; + $course_tmp['language'] = $course['language']; + $course_tmp['visibility'] = $course['visibility']; + + // Determining category name + if($category_names[$course['category_code']]) { + $course_tmp['category_name'] = $category_names[$course['category_code']]; + } else { + $category = CourseManager::get_course_category($course['category_code']); + $category_names[$course['category_code']] = $category['name']; + $course_tmp['category_name'] = $category['name']; + } + + // Determining number of students registered in course + $user_list = CourseManager::get_user_list_from_course_code($course['code'], false); + $course_tmp['number_students'] = count($user_list); + + // Determining external course id + $course_tmp['external_course_id'] = CourseManager::get_course_extra_field_value($course_field_name, $course['code']); + + + $courses_result[] = $course_tmp; + } + + return $courses_result; + } + } /** * Subscribe or unsubscribe user to a course (helper method) @@ -274,16 +415,81 @@ class WSCourse extends WS { } } + /** + * Returns the descriptions of a course, along with their id + * + * @param string API secret key + * @param string Course id field name + * @param string Course id value + * @return array Returns an array with elements of the form ('course_desc_id' => 1, 'course_desc_title' => 'Title', 'course_desc_content' => 'Content') + */ + public function GetCourseDescriptions($secret_key, $course_id_field_name, $course_id_value) { + $verifKey = $this->verifyKey($secret_key); + if($verifKey instanceof WSError) { + $this->handleError($verifKey); + } else { + $course_id = $this->getCourseId($course_id_field_name, $course_id_value); + if($course_id instanceof WSError) { + return $course_id; + } else { + // Course exists, get its descriptions + $descriptions = CourseDescription::get_descriptions($course_id); + $results = array(); + foreach($descriptions as $description) { + $results[] = array('course_desc_id' => $description->get_description_type(), + 'course_desc_title' => $description->get_title(), + 'course_desc_content' => $description->get_content()); + } + return $results; + } + } + } + + /** * Edit course description * * @param string API secret key * @param string Course id field name * @param string Course id value - * @param int Course description id + * @param int Category id from course description * @param string Description title * @param string Course description content */ + public function EditCourseDescription($secret_key, $course_id_field_name, $course_id_value, $course_desc_id, $course_desc_title, $course_desc_content) { + $verifKey = $this->verifyKey($secret_key); + if($verifKey instanceof WSError) { + $this->handleError($verifKey); + } else { + $course_id = $this->getCourseId($course_id_field_name, $course_id_value); + if($course_id instanceof WSError) { + return $course_id; + } else { + // Create the new course description + $cd = new CourseDescription(); + $cd->set_description_type($course_desc_id); + $cd->set_title($course_desc_title); + $cd->set_content($course_desc_content); + $cd->set_session_id(0); + // Get course info + $course_info = CourseManager::get_course_information(CourseManager::get_course_code_from_course_id($course_id)); + // Check if this course description exists + $descriptions = CourseDescription::get_descriptions($course_id); + $exists = false; + foreach($descriptions as $description) { + if($description->get_description_type() == $course_desc_id) { + $exists = true; + } + } + if($exists == false) { + $cd->set_progress(0); + $cd->insert($course_info['dbName']); + } else { + $cd->update($course_info['dbName']); + } + } + } + } diff --git a/main/webservices/webservice_session.php b/main/webservices/webservice_session.php new file mode 100644 index 0000000000..d942943ae3 --- /dev/null +++ b/main/webservices/webservice_session.php @@ -0,0 +1,291 @@ +getUserId($user_id_field_name, $user_id_value); + if($user_id instanceof WSError) { + return $user_id; + } + // Build the date + $start_date_array = explode('-', $start_date); + foreach($start_date_array as &$sd_element) { + $sd_element = intval($sd_element); + } + $end_date_array = explode('-', $end_date); + foreach($end_date_array as &$ed_element) { + $ed_element = intval($ed_element); + } + // Try to create the session + $session_id = SessionManager::create_session($name, $start_date_array[0], $start_date_array[1], $start_date_array[2], $end_date_array[0], $end_date_array[1], $end_date_array[2], (int)$nb_days_acess_before, (int)$nb_days_acess_after, (int)$nolimit, $user_id, 0, (int)$visibility); + if(!is_int($session_id)) { + return new WSError(301, 'Could not create the session'); + } else { + // Add the Original session id to the extra fields + $extras_associative = array(); + if($session_id_field_name != "chamilo_session_id") { + $extras_associative[$session_id_field_name] = $session_id_value; + } + foreach($extras as $extra) { + $extras_associative[$extra['field_name']] = $extra['field_value']; + } + // Create the extra fields + foreach($extras_associative as $fname => $fvalue) { + SessionManager::create_session_extra_field($fname, 1, $fname); + SessionManager::update_session_extra_field_value($session_id, $fname, $fvalue); + } + return $session_id; + } + } + + /** + * Creates a session + * + * @param string API secret key + * @param string Name of the session + * @param string Start date, use the 'YYYY-MM-DD' format + * @param string End date, use the 'YYYY-MM-DD' format + * @param int Access delays of the coach (days before) + * @param int Access delays of the coach (days after) + * @param int Nolimit (0 = no limit of time, 1 = limit of time) + * @param int Visibility + * @param string User id field name for the coach + * @param string User id value for the coach + * @param string Original session id field name (use "chamilo_session_id" to use internal id) + * @param string Original session id value + * @param array Array of extra fields + * @return int Session id generated + */ + public function CreateSession($secret_key, $name, $start_date, $end_date, $nb_days_access_before, $nb_days_access_after, $nolimit, $visibility, $user_id_field_name, $user_id_value, $session_id_field_name, $session_id_value, $extras) { + $verifKey = $this->verifyKey($secret_key); + if($verifKey instanceof WSError) { + $this->handleError($verifKey); + } else { + $session_id = $this->createSessionHelper($name, $start_date, $end_date, $nb_days_access_before, $nb_days_access_after, $nolimit, $visibility, $user_id_field_name, $user_id_value, $session_id_field_name, $session_id_value, $extras); + if($session_id instanceof WSError) { + $this->handleError($session_id); + } else { + return $session_id; + } + } + } + + /** + * Deletes a session (helper method) + * + * @param string Session id field name + * @param string Session id value + * @return mixed True in case of success, WSError otherwise + */ + protected function deleteSessionHelper($session_id_field_name, $session_id_value) { + $session_id = $this->getSessionId($session_id_field_name, $session_id_value); + if($session_id instanceof WSError) { + return $session_id; + } else { + SessionManager::delete_session($session_id, true); + return true; + } + } + + /** + * Deletes a session + * + * @param string API secret key + * @param string Session id field name + * @param string Session id value + */ + public function DeleteSession($secret_key, $session_id_field_name, $session_id_value) { + $verifKey = $this->verifyKey($secret_key); + if($verifKey instanceof WSError) { + $this->handleError($verifKey); + } else { + $result = $this->deleteSessionHelper($session_id_field_name, $session_id_value); + if($result instanceof WSError) { + $this->handleError($result); + } + } + } + + /** + * Edits a session (helper method) + * + * @param string Name of the session + * @param string Start date, use the 'YYYY-MM-DD' format + * @param string End date, use the 'YYYY-MM-DD' format + * @param int Access delays of the coach (days before) + * @param int Access delays of the coach (days after) + * @param int Nolimit (0 = no limit of time, 1 = limit of time) + * @param int Visibility + * @param string User id field name for the coach + * @param string User id value for the coach + * @param string Original session id field name (use "chamilo_session_id" to use internal id) + * @param string Original session id value + * @param array Array of extra fields + * @return mixed True on success, WSError otherwise + */ + protected function editSessionHelper($name, $start_date, $end_date, $nb_days_access_before, $nb_days_access_after, $nolimit, $visibility, $user_id_field_name, $user_id_value, $session_id_field_name, $session_id_value, $extras) { + $session_id = $this->getSessionId($session_id_field_name, $session_id_value); + if($session_id instanceof WSError) { + return $session_id; + } else { + // Verify that coach exists and get its id + $user_id = $this->getUserId($user_id_field_name, $user_id_value); + if($user_id instanceof WSError) { + return $user_id; + } + // Build the date + $start_date_array = explode('-', $start_date); + foreach($start_date_array as &$sd_element) { + $sd_element = intval($sd_element); + } + $end_date_array = explode('-', $end_date); + foreach($end_date_array as &$ed_element) { + $ed_element = intval($ed_element); + } + $result_id = SessionManager::edit_session($session_id, $name, $start_date_array[0], $start_date_array[1], $start_date_array[2], $end_date_array[0], $end_date_array[1], $end_date_array[2], (int)$nb_days_acess_before, (int)$nb_days_acess_after, (int)$nolimit, $user_id, 0, (int)$visibility); + if(!is_int($result_id)) { + return new WSError(302, 'Could not edit the session'); + } else { + if(!empty($extras)) { + $extras_associative = array(); + foreach($extras as $extra) { + $extras_associative[$extra['field_name']] = $extra['field_value']; + } + // Create the extra fields + foreach($extras_associative as $fname => $fvalue) { + SessionManager::create_session_extra_field($fname, 1, $fname); + SessionManager::update_session_extra_field_value($session_id, $fname, $fvalue); + } + } + return true; + } + } + } + + /** + * Edits a session + * + * @param string API secret key + * @param string Name of the session + * @param string Start date, use the 'YYYY-MM-DD' format + * @param string End date, use the 'YYYY-MM-DD' format + * @param int Access delays of the coach (days before) + * @param int Access delays of the coach (days after) + * @param int Nolimit (0 = no limit of time, 1 = limit of time) + * @param int Visibility + * @param string User id field name for the coach + * @param string User id value for the coach + * @param string Original session id field name (use "chamilo_session_id" to use internal id) + * @param string Original session id value + * @param array Array of extra fields + */ + public function EditSession($secret_key, $name, $start_date, $end_date, $nb_days_access_before, $nb_days_access_after, $nolimit, $visibility, $user_id_field_name, $user_id_value, $session_id_field_name, $session_id_value, $extras) { + $verifKey = $this->verifyKey($secret_key); + if($verifKey instanceof WSError) { + $this->handleError($verifKey); + } else { + $result = $this->editSessionHelper($name, $start_date, $end_date, $nb_days_access_before, $nb_days_access_after, $nolimit, $visibility, $user_id_field_name, $user_id_value, $session_id_field_name, $session_id_value, $extras); + if($session_id instanceof WSError) { + $this->handleError($result); + } + } + } + + /** + * Change user subscription (helper method) + * + * @param string User id field name + * @param string User id value + * @param string Session id field name + * @param string Session id value + * @param int State (1 to subscribe, 0 to unsubscribe) + * @return mixed True on success, WSError otherwise + */ + protected function changeUserSubscription($user_id_field_name, $user_id_value, $session_id_field_name, $session_id_value, $state) { + $session_id = $this->getSessionId($session_id_field_name, $session_id_value); + if($session_id instanceof WSError) { + return $session_id; + } else { + $user_id = $this->getUserId($user_id_field_name, $user_id_value); + if($user_id instanceof WSError) { + return $user_id; + } else { + if($state == 1) { + SessionManager::subscribe_users_to_session($session_id, array($user_id)); + } else { + // TODO: unsubscribe user + } + return true; + } + } + } + + /** + * Subscribe user to a session + * + * @param string API secret key + * @param string User id field name + * @param string User id value + * @param string Session id field name + * @param string Session id value + */ + public function SubscribeUserToSession($secret_key, $user_id_field_name, $user_id_value, $session_id_field_name, $session_id_value) { + $verifKey = $this->verifyKey($secret_key); + if($verifKey instanceof WSError) { + $this->handleError($verifKey); + } else { + $result = $this->changeUserSubscription($user_id_field_name, $user_id_value, $session_id_field_name, $session_id_value, 1); + if($result instanceof WSError) { + $this->handleError($result); + } + } + } + + /** + * Subscribe user to a session + * + * @param string API secret key + * @param string User id field name + * @param string User id value + * @param string Session id field name + * @param string Session id value + */ + public function UnsubscribeUserFromSession($secret_key, $user_id_field_name, $user_id_value, $session_id_field_name, $session_id_value) { + $verifKey = $this->verifyKey($secret_key); + if($verifKey instanceof WSError) { + $this->handleError($verifKey); + } else { + $result = $this->changeUserSubscription($user_id_field_name, $user_id_value, $session_id_field_name, $session_id_value, 0); + if($result instanceof WSError) { + $this->handleError($result); + } + } + } + +}