chamilo / chamilo-lms

main/webservices/user_import/service.php

Indentation +39 added lines, -39 removed lines

@@ -14,45 +14,45 @@
  */
 function import_users_from_file($filepath, $security_key) {
 
-	global $_configuration;
-
-   	$errors_returned = array(
-	   	0 => 'success',
-	   	1 => 'file import does not exist',
-	   	2 => 'no users to import',
-	   	3 => 'wrong datas in file',
-	   	4 => 'security error'
-   	);
-
-   	// Check whether this script is launch by server and security key is ok.
-   	if (empty($_SERVER['REMOTE_ADDR']) || $_SERVER['REMOTE_ADDR'] != $_SERVER['SERVER_ADDR'] || $security_key != $_configuration['security_key']) {
-   		return $errors_returned[4];
-   	}
-
-   	// Libraries
-   	require_once 'import.lib.php';
-
-	// Check is users file exists.
-	if (!is_file($filepath)) {
-		return $errors_returned[1];
-	}
-
-	// Get list of users
-	$users = parse_csv_data($filepath);
-	if (count($users) == 0) {
-		return $errors_returned[2];
-	}
-
-	// Check the datas for each user
-	$errors = validate_data($users);
-	if (count($errors) > 0) {
-		return $errors_returned[3];
-	}
-
-	// Apply modifications in database
-	save_data($users);
-
-   	return $errors_returned[0]; // Import successfull
+    global $_configuration;
+
+        $errors_returned = array(
+            0 => 'success',
+            1 => 'file import does not exist',
+            2 => 'no users to import',
+            3 => 'wrong datas in file',
+            4 => 'security error'
+        );
+
+        // Check whether this script is launch by server and security key is ok.
+        if (empty($_SERVER['REMOTE_ADDR']) || $_SERVER['REMOTE_ADDR'] != $_SERVER['SERVER_ADDR'] || $security_key != $_configuration['security_key']) {
+            return $errors_returned[4];
+        }
+
+        // Libraries
+        require_once 'import.lib.php';
+
+    // Check is users file exists.
+    if (!is_file($filepath)) {
+        return $errors_returned[1];
+    }
+
+    // Get list of users
+    $users = parse_csv_data($filepath);
+    if (count($users) == 0) {
+        return $errors_returned[2];
+    }
+
+    // Check the datas for each user
+    $errors = validate_data($users);
+    if (count($errors) > 0) {
+        return $errors_returned[3];
+    }
+
+    // Apply modifications in database
+    save_data($users);
+
+        return $errors_returned[0]; // Import successfull
 }
 
 $server = new soap_server();

main/webservices/cm_soap_courses.php

Indentation +12 added lines, -12 removed lines

@@ -11,12 +11,12 @@ 
 
 
 $s->register(
-	'WSCMCourses.get_courses_code',
-	array(
-		'username' => 'xsd:string',
-		'password' => 'xsd:string'
-	),
-	array('return' => 'xsd:string'),
+    'WSCMCourses.get_courses_code',
+    array(
+        'username' => 'xsd:string',
+        'password' => 'xsd:string'
+    ),
+    array('return' => 'xsd:string'),
         'urn:WSCMService',
         '',
         '',
@@ -26,13 +26,13 @@ 
 );
 
 $s->register(
-	'WSCMCourses.get_course_title',
-	array(
-		'username' => 'xsd:string',
-		'password' => 'xsd:string',
+    'WSCMCourses.get_course_title',
+    array(
+        'username' => 'xsd:string',
+        'password' => 'xsd:string',
                 'course_code' => 'xsd:string',
-	),
-	array('return' => 'xsd:string'),
+    ),
+    array('return' => 'xsd:string'),
         'urn:WSCMService',
         '',
         '',

main/webservices/cm_webservice_course.php

Indentation +511 added lines, -511 removed lines

@@ -10,521 +10,521 @@
  */
 class WSCMCourse extends WSCM
 {
-	/**
-	 * Deletes a course (helper method)
-	 *
-	 * @param string Course id field name
-	 * @param string Course id value
-	 * @return mixed True if the course was successfully deleted, WSError otherwise
-	 */
-	protected function deleteCourseHelper($course_id_field_name, $course_id_value) {
-		$course_id = $this->getCourseId($course_id_field_name, $course_id_value);
-		if($course_id instanceof WSCMError) {
-			return $course_id;
-		} else {
-			$course_code = CourseManager::get_course_code_from_course_id($course_id);
-			CourseManager::delete_course($course_code);
-			return true;
-		}
-	}
-
-	/**
-	 * Deletes a course
-	 *
-	 * @param string API secret key
-	 * @param string Course id field name
-	 * @param string Course id value
-	 */
-	public function DeleteCourse($secret_key, $course_id_field_name, $course_id_value) {
-		$verifKey = $this->verifyKey($secret_key);
-		if($verifKey instanceof WSError) {
-			$this->handleError($verifKey);
-		} else {
-			$result = $this->deleteCourseHelper($course_id_field_name, $course_id_value);
-			if($result instanceof WSError) {
-				$this->handleError($result);
-			}
-		}
-	}
-
-	/**
-	 * Deletes multiple courses
-	 *
-	 * @param string API secret key
-	 * @param array Array of courses with elements of the form array('course_id_field_name' => 'name_of_field', 'course_id_value' => 'value')
-	 * @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
-	 * than 0, an error occured
-	 */
-	public function DeleteCourses($secret_key, $courses) {
-		$verifKey = $this->verifyKey($secret_key);
-		if($verifKey instanceof WSError) {
-			$this->handleError($verifKey);
-		} else {
-			$results = array();
-			foreach($courses as $course) {
-				$result_tmp = array();
-				$result_op = $this->deleteCourseHelper($course['course_id_field_name'], $course['course_id_value']);
-				$result_tmp['course_id_value'] = $course['course_id_value'];
-				if($result_op instanceof WSCMError) {
-					// Return the error in the results
-					$result_tmp['result'] = $result_op->toArray();
-				} else {
-					$result_tmp['result'] = $this->getSuccessfulResult();
-				}
-				$results[] = $result_tmp;
-			}
-			return $results;
-		}
-	}
-
-	/**
-	 * Creates a course (helper method)
-	 *
-	 * @param string Title
-	 * @param string Category code
-	 * @param string Wanted code. If it's not defined, it will be generated automatically
-	 * @param string Tutor name
-	 * @param string Course admin user id field name
-	 * @param string Course admin user id value
-	 * @param string Course language
-	 * @param string Course id field name
-	 * @param string Course id value
-	 * @param array Course extra fields
-	 * @return mixed Generated id if creation was successful, WSError otherwise
-	 */
-	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) {
-		// Add the original course id field name and value to the extra fields if needed
-		$extras_associative = array();
-		if($course_id_field_name != "chamilo_course_id") {
-			$extras_associative[$course_id_field_name] = $course_id_value;
-		}
-		foreach($extras as $extra) {
-			$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 = CourseManager::generate_course_code($title);
-		}
-		$result = create_course($wanted_code, $title, $tutor_name, $category_code, $language, $course_admin_id, $this->_configuration['db_prefix'], 0);
-		if (!$result) {
-			return new WSError(202, 'There was an error creating the course');
-		} else {
-			// Update extra fields
-			foreach($extras_associative as $fname => $fvalue) {
-				CourseManager::update_course_extra_field_value($result, $fname, $fvalue);
-			}
-			// Get course id
-			$course_info = CourseManager::get_course_information($result);
-			return $course_info['real_id'];
-		}
-	}
-
-	/**
-	 * Creates a course
-	 *
-	 * @param string API secret key
-	 * @param string Title
-	 * @param string Category code
-	 * @param string Wanted code. If it's not defined, it will be generated automatically
-	 * @param string Tutor name
-	 * @param string Course admin user id field name
-	 * @param string Course admin user id value
-	 * @param string Course language
-	 * @param string Course id field name
-	 * @param string Course id value
-	 * @param array Course extra fields
-	 * @return int Course id generated
-	 */
-	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) {
-		// First, verify the secret key
-		$verifKey = $this->verifyKey($secret_key);
-		if($verifKey instanceof WSError) {
-			$this->handleError($verifKey);
-		} else {
-			$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);
-			if($result instanceof WSError) {
-				$this->handleError($result);
-			} else {
-				return $result;
-			}
-		}
-	}
-
-	/**
-	 * Create multiple courses
-	 *
-	 * @param string API secret key
-	 * @param array Courses to be created, with elements following the structure presented in CreateCourse
-	 * @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'))
-	 */
-	public function CreateCourses($secret_key, $courses) {
-		// First, verify the secret key
-		$verifKey = $this->verifyKey($secret_key);
-		if($verifKey instanceof WSCMError) {
-			$this->handleError($verifKey);
-		} else {
-			$results = array();
-			foreach($courses as $course) {
-				$result_tmp = array();
-				//reinitialize variables just in case
-				$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;
-				extract($course);
-				$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);
-				if($result instanceof WSCMError) {
-					$result_tmp['result'] = $result->toArray();
-					$result_tmp['course_id_value'] = $course_id_value;
-					$result_tmp['course_id_generated'] = 0;
-				} else {
-					$result_tmp['result'] = $this->getSuccessfulResult();
-					$result_tmp['course_id_value'] = $course_id_value;
-					$result_tmp['course_id_generated'] = $result;
-				}
-				$results[] = $result_tmp;
-			}
-			return $results;
-		}
-	}
-
-	/**
-	 * Edits a course (helper method)
-	 *
-	 * @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
-	 * @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 WSCMError) {
-			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 WSCMError) {
-			$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 WSCMError) {
-				$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['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']);
-				$course_tmp['number_students'] = count($user_list);
-
-				// Determining external course id
-				$course_tmp['external_course_id'] = CourseManager::get_course_extra_field_value($course_id_field_name, $course['code']);
-
-
-				$courses_result[] = $course_tmp;
-			}
-
-			return $courses_result;
-		}
-	}
-
-	/**
-	 * Subscribe or unsubscribe user to a course (helper method)
-	 *
-	 * @param string Course id field name. Use "chamilo_course_id" to use internal id
-	 * @param string Course id value.
-	 * @param string User id field name. Use "chamilo_user_id" to use internal id
-	 * @param string User id value
-	 * @param int Set to 1 to subscribe, 0 to unsubscribe
-	 * @param int Status (STUDENT or TEACHER) Used for subscription only
-	 * @return mixed True if subscription or unsubscription was successful, false otherwise
-	 */
-	protected function changeUserSubscription($course_id_field_name, $course_id_value, $user_id_field_name, $user_id_value, $state, $status = STUDENT) {
-		$course_id = $this->getCourseId($course_id_field_name, $course_id_value);
-		if($course_id instanceof WSError) {
-			return $course_id;
-		} else {
-			$user_id = $this->getUserId($user_id_field_name, $user_id_value);
-			if($user_id instanceof WSError) {
-				return $user_id;
-			} else {
-				$course_code = CourseManager::get_course_code_from_course_id($course_id);
-				if($state == 0) {
-					// Unsubscribe user
-					CourseManager::unsubscribe_user($user_id, $course_code);
-					return true;
-				} else {
-					// Subscribe user
-					if(CourseManager::subscribe_user($user_id, $course_code, $status)) {
-						return true;
-					} else {
-						return new WSError(203, 'An error occured subscribing to this course');
-					}
-				}
-			}
-		}
-	}
-
-	/**
-	 * Subscribe user to a course
-	 *
-	 * @param string API secret key
-	 * @param string Course id field name. Use "chamilo_course_id" to use internal id
-	 * @param string Course id value.
-	 * @param string User id field name. Use "chamilo_user_id" to use internal id
-	 * @param string User id value
-	 * @param int Status (1 = Teacher, 5 = Student)
-	 */
-	public function SubscribeUserToCourse($secret_key, $course_id_field_name, $course_id_value, $user_id_field_name, $user_id_value, $status) {
-		$verifKey = $this->verifyKey($secret_key);
-		if($verifKey instanceof WSError) {
-			$this->handleError($verifKey);
-		} else {
-			$result = $this->changeUserSubscription($course_id_field_name, $course_id_value, $user_id_field_name, $user_id_value, 1, $status);
-			if($result instanceof WSError) {
-				$this->handleError($result);
-			}
-		}
-	}
-
-	/**
-	 * Unsusbscribe user from course
-	 *
-	 * @param string API secret key
-	 * @param string Course id field name. Use "chamilo_course_id" to use internal id
-	 * @param string Course id value.
-	 * @param string User id field name. Use "chamilo_user_id" to use internal id
-	 * @param string User id value
-	 */
-	public function UnsubscribeUserFromCourse($secret_key, $course_id_field_name, $course_id_value, $user_id_field_name, $user_id_value) {
-		$verifKey = $this->verifyKey($secret_key);
-		if($verifKey instanceof WSError) {
-			$this->handleError($verifKey);
-		} else {
-			$result = $this->changeUserSubscription($course_id_field_name, $course_id_value, $user_id_field_name, $user_id_value, 0);
-			if($result instanceof WSError) {
-				$this->handleError($result);
-			}
-		}
-	}
-
-	/**
-	 * 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 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
+    /**
+     * Deletes a course (helper method)
+     *
+     * @param string Course id field name
+     * @param string Course id value
+     * @return mixed True if the course was successfully deleted, WSError otherwise
+     */
+    protected function deleteCourseHelper($course_id_field_name, $course_id_value) {
+        $course_id = $this->getCourseId($course_id_field_name, $course_id_value);
+        if($course_id instanceof WSCMError) {
+            return $course_id;
+        } else {
+            $course_code = CourseManager::get_course_code_from_course_id($course_id);
+            CourseManager::delete_course($course_code);
+            return true;
+        }
+    }
+
+    /**
+     * Deletes a course
+     *
+     * @param string API secret key
+     * @param string Course id field name
+     * @param string Course id value
+     */
+    public function DeleteCourse($secret_key, $course_id_field_name, $course_id_value) {
+        $verifKey = $this->verifyKey($secret_key);
+        if($verifKey instanceof WSError) {
+            $this->handleError($verifKey);
+        } else {
+            $result = $this->deleteCourseHelper($course_id_field_name, $course_id_value);
+            if($result instanceof WSError) {
+                $this->handleError($result);
+            }
+        }
+    }
+
+    /**
+     * Deletes multiple courses
+     *
+     * @param string API secret key
+     * @param array Array of courses with elements of the form array('course_id_field_name' => 'name_of_field', 'course_id_value' => 'value')
+     * @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
+     * than 0, an error occured
+     */
+    public function DeleteCourses($secret_key, $courses) {
+        $verifKey = $this->verifyKey($secret_key);
+        if($verifKey instanceof WSError) {
+            $this->handleError($verifKey);
+        } else {
+            $results = array();
+            foreach($courses as $course) {
+                $result_tmp = array();
+                $result_op = $this->deleteCourseHelper($course['course_id_field_name'], $course['course_id_value']);
+                $result_tmp['course_id_value'] = $course['course_id_value'];
+                if($result_op instanceof WSCMError) {
+                    // Return the error in the results
+                    $result_tmp['result'] = $result_op->toArray();
+                } else {
+                    $result_tmp['result'] = $this->getSuccessfulResult();
+                }
+                $results[] = $result_tmp;
+            }
+            return $results;
+        }
+    }
+
+    /**
+     * Creates a course (helper method)
+     *
+     * @param string Title
+     * @param string Category code
+     * @param string Wanted code. If it's not defined, it will be generated automatically
+     * @param string Tutor name
+     * @param string Course admin user id field name
+     * @param string Course admin user id value
+     * @param string Course language
+     * @param string Course id field name
+     * @param string Course id value
+     * @param array Course extra fields
+     * @return mixed Generated id if creation was successful, WSError otherwise
+     */
+    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) {
+        // Add the original course id field name and value to the extra fields if needed
+        $extras_associative = array();
+        if($course_id_field_name != "chamilo_course_id") {
+            $extras_associative[$course_id_field_name] = $course_id_value;
+        }
+        foreach($extras as $extra) {
+            $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 = CourseManager::generate_course_code($title);
+        }
+        $result = create_course($wanted_code, $title, $tutor_name, $category_code, $language, $course_admin_id, $this->_configuration['db_prefix'], 0);
+        if (!$result) {
+            return new WSError(202, 'There was an error creating the course');
+        } else {
+            // Update extra fields
+            foreach($extras_associative as $fname => $fvalue) {
+                CourseManager::update_course_extra_field_value($result, $fname, $fvalue);
+            }
+            // Get course id
+            $course_info = CourseManager::get_course_information($result);
+            return $course_info['real_id'];
+        }
+    }
+
+    /**
+     * Creates a course
+     *
+     * @param string API secret key
+     * @param string Title
+     * @param string Category code
+     * @param string Wanted code. If it's not defined, it will be generated automatically
+     * @param string Tutor name
+     * @param string Course admin user id field name
+     * @param string Course admin user id value
+     * @param string Course language
+     * @param string Course id field name
+     * @param string Course id value
+     * @param array Course extra fields
+     * @return int Course id generated
+     */
+    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) {
+        // First, verify the secret key
+        $verifKey = $this->verifyKey($secret_key);
+        if($verifKey instanceof WSError) {
+            $this->handleError($verifKey);
+        } else {
+            $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);
+            if($result instanceof WSError) {
+                $this->handleError($result);
+            } else {
+                return $result;
+            }
+        }
+    }
+
+    /**
+     * Create multiple courses
+     *
+     * @param string API secret key
+     * @param array Courses to be created, with elements following the structure presented in CreateCourse
+     * @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'))
+     */
+    public function CreateCourses($secret_key, $courses) {
+        // First, verify the secret key
+        $verifKey = $this->verifyKey($secret_key);
+        if($verifKey instanceof WSCMError) {
+            $this->handleError($verifKey);
+        } else {
+            $results = array();
+            foreach($courses as $course) {
+                $result_tmp = array();
+                //reinitialize variables just in case
+                $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;
+                extract($course);
+                $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);
+                if($result instanceof WSCMError) {
+                    $result_tmp['result'] = $result->toArray();
+                    $result_tmp['course_id_value'] = $course_id_value;
+                    $result_tmp['course_id_generated'] = 0;
+                } else {
+                    $result_tmp['result'] = $this->getSuccessfulResult();
+                    $result_tmp['course_id_value'] = $course_id_value;
+                    $result_tmp['course_id_generated'] = $result;
+                }
+                $results[] = $result_tmp;
+            }
+            return $results;
+        }
+    }
+
+    /**
+     * Edits a course (helper method)
+     *
+     * @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
+     * @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 WSCMError) {
+            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 WSCMError) {
+            $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 WSCMError) {
+                $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['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']);
+                $course_tmp['number_students'] = count($user_list);
+
+                // Determining external course id
+                $course_tmp['external_course_id'] = CourseManager::get_course_extra_field_value($course_id_field_name, $course['code']);
+
+
+                $courses_result[] = $course_tmp;
+            }
+
+            return $courses_result;
+        }
+    }
+
+    /**
+     * Subscribe or unsubscribe user to a course (helper method)
+     *
+     * @param string Course id field name. Use "chamilo_course_id" to use internal id
+     * @param string Course id value.
+     * @param string User id field name. Use "chamilo_user_id" to use internal id
+     * @param string User id value
+     * @param int Set to 1 to subscribe, 0 to unsubscribe
+     * @param int Status (STUDENT or TEACHER) Used for subscription only
+     * @return mixed True if subscription or unsubscription was successful, false otherwise
+     */
+    protected function changeUserSubscription($course_id_field_name, $course_id_value, $user_id_field_name, $user_id_value, $state, $status = STUDENT) {
+        $course_id = $this->getCourseId($course_id_field_name, $course_id_value);
+        if($course_id instanceof WSError) {
+            return $course_id;
+        } else {
+            $user_id = $this->getUserId($user_id_field_name, $user_id_value);
+            if($user_id instanceof WSError) {
+                return $user_id;
+            } else {
+                $course_code = CourseManager::get_course_code_from_course_id($course_id);
+                if($state == 0) {
+                    // Unsubscribe user
+                    CourseManager::unsubscribe_user($user_id, $course_code);
+                    return true;
+                } else {
+                    // Subscribe user
+                    if(CourseManager::subscribe_user($user_id, $course_code, $status)) {
+                        return true;
+                    } else {
+                        return new WSError(203, 'An error occured subscribing to this course');
+                    }
+                }
+            }
+        }
+    }
+
+    /**
+     * Subscribe user to a course
+     *
+     * @param string API secret key
+     * @param string Course id field name. Use "chamilo_course_id" to use internal id
+     * @param string Course id value.
+     * @param string User id field name. Use "chamilo_user_id" to use internal id
+     * @param string User id value
+     * @param int Status (1 = Teacher, 5 = Student)
+     */
+    public function SubscribeUserToCourse($secret_key, $course_id_field_name, $course_id_value, $user_id_field_name, $user_id_value, $status) {
+        $verifKey = $this->verifyKey($secret_key);
+        if($verifKey instanceof WSError) {
+            $this->handleError($verifKey);
+        } else {
+            $result = $this->changeUserSubscription($course_id_field_name, $course_id_value, $user_id_field_name, $user_id_value, 1, $status);
+            if($result instanceof WSError) {
+                $this->handleError($result);
+            }
+        }
+    }
+
+    /**
+     * Unsusbscribe user from course
+     *
+     * @param string API secret key
+     * @param string Course id field name. Use "chamilo_course_id" to use internal id
+     * @param string Course id value.
+     * @param string User id field name. Use "chamilo_user_id" to use internal id
+     * @param string User id value
+     */
+    public function UnsubscribeUserFromCourse($secret_key, $course_id_field_name, $course_id_value, $user_id_field_name, $user_id_value) {
+        $verifKey = $this->verifyKey($secret_key);
+        if($verifKey instanceof WSError) {
+            $this->handleError($verifKey);
+        } else {
+            $result = $this->changeUserSubscription($course_id_field_name, $course_id_value, $user_id_field_name, $user_id_value, 0);
+            if($result instanceof WSError) {
+                $this->handleError($result);
+            }
+        }
+    }
+
+    /**
+     * 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 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;
-					}
-				}
+                // 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;
+                    }
+                }
                 $cd->set_course_id($course_info['real_id']);
-				if (!$exists) {
-					$cd->set_progress(0);
-					$cd->insert();
-				} else {
-					$cd->update();
-				}
-			}
-		}
-	}
-	public function unreadMessage($username, $password)
-	{
-		if($this->verifyUserPass($username, $password) == "valid")
-		{
-			$table_message = Database::get_main_table(TABLE_MESSAGE);
-			$user_id = UserManager::get_user_id_from_username($username);
-			$condition_msg_status = ' msg_status = 1 '; // define('MESSAGE_STATUS_UNREAD', '1');
-
-			$sql_query = "SELECT COUNT(*) as number_messages FROM $table_message WHERE $condition_msg_status AND user_receiver_id=".$user_id;
-
-			$sql_result = Database::query($sql_query);
-			$result = Database::fetch_array($sql_result);
-			return $result['number_messages'];
-		}
-		return "0";
-	}
-
-	public function get_message_data($username, $password)
-	{
-		if($this->verifyUserPass($username, $password) == "valid")
-		{
-			$user_id = get_user_id_from_username($username);
-
-		}
-
-	}
-
-	public function nada($username, $password)
-	{
-		if($this->verifyUserPass($username, $password) == "valid")
-			return $username.$password;
-		return $username;
-	}
+                if (!$exists) {
+                    $cd->set_progress(0);
+                    $cd->insert();
+                } else {
+                    $cd->update();
+                }
+            }
+        }
+    }
+    public function unreadMessage($username, $password)
+    {
+        if($this->verifyUserPass($username, $password) == "valid")
+        {
+            $table_message = Database::get_main_table(TABLE_MESSAGE);
+            $user_id = UserManager::get_user_id_from_username($username);
+            $condition_msg_status = ' msg_status = 1 '; // define('MESSAGE_STATUS_UNREAD', '1');
+
+            $sql_query = "SELECT COUNT(*) as number_messages FROM $table_message WHERE $condition_msg_status AND user_receiver_id=".$user_id;
+
+            $sql_result = Database::query($sql_query);
+            $result = Database::fetch_array($sql_result);
+            return $result['number_messages'];
+        }
+        return "0";
+    }
+
+    public function get_message_data($username, $password)
+    {
+        if($this->verifyUserPass($username, $password) == "valid")
+        {
+            $user_id = get_user_id_from_username($username);
+
+        }
+
+    }
+
+    public function nada($username, $password)
+    {
+        if($this->verifyUserPass($username, $password) == "valid")
+            return $username.$password;
+        return $username;
+    }
 
 
 

main/webservices/cm_soap.php

Indentation +60 added lines, -60 removed lines

@@ -8,83 +8,83 @@ 
  * SOAP error handler. Handles an error sending a SOAP fault
  */
 class WSCMSoapErrorHandler implements WSCMErrorHandler {
-	/**
-	 * Handles the error by sending a SOAP fault through the server
-	 *
-	 * @param WSError Error to handle
-	 */
-	public function handle($error) {
-		$server = WSCMSoapServer::singleton();
-		$server->fault(strval($error->code), $error->message);
-	}
+    /**
+     * Handles the error by sending a SOAP fault through the server
+     *
+     * @param WSError Error to handle
+     */
+    public function handle($error) {
+        $server = WSCMSoapServer::singleton();
+        $server->fault(strval($error->code), $error->message);
+    }
 }
 
 /**
  * SOAP server wrapper implementing a Singleton
  */
 class WSCMSoapServer {
-	/**
-	 * SOAP server instance
-	 *
-	 * @var soap_server
-	 */
-	private static $_instance;
+    /**
+     * SOAP server instance
+     *
+     * @var soap_server
+     */
+    private static $_instance;
 
-	/**
-	 * Private constructor
-	 */
-	private function __construct() {
-	}
+    /**
+     * Private constructor
+     */
+    private function __construct() {
+    }
 
-	/**
-	 * Singleton method
-	 */
-	public static function singleton() {
-		if(!isset(self::$_instance)) {
-			self::$_instance = new soap_server();
-			// Set the error handler
-			WSCMError::setErrorHandler(new WSCMSoapErrorHandler());
-			// Configure the service
-			self::$_instance->configureWSDL('WSCMService', 'urn:WSCMService');
-		}
+    /**
+     * Singleton method
+     */
+    public static function singleton() {
+        if(!isset(self::$_instance)) {
+            self::$_instance = new soap_server();
+            // Set the error handler
+            WSCMError::setErrorHandler(new WSCMSoapErrorHandler());
+            // Configure the service
+            self::$_instance->configureWSDL('WSCMService', 'urn:WSCMService');
+        }
 
-		return self::$_instance;
-	}
+        return self::$_instance;
+    }
 }
 
 $s = WSCMSoapServer::singleton();
 
 $s->wsdl->addComplexType(
-	'result',
-	'complexType',
-	'struct',
-	'all',
-	'',
-	array(
-		'code' => array('name' => 'code', 'type' => 'xsd:int'),
-		'message' => array('name' => 'message', 'type' => 'xsd:string')
-	)
+    'result',
+    'complexType',
+    'struct',
+    'all',
+    '',
+    array(
+        'code' => array('name' => 'code', 'type' => 'xsd:int'),
+        'message' => array('name' => 'message', 'type' => 'xsd:string')
+    )
 );
 
 $s->wsdl->addComplexType(
-	'extra_field',
-	'complexType',
-	'struct',
-	'all',
-	'',
-	array(
-		'field_name' => array('name' => 'field_name', 'type' => 'xsd:string'),
-		'field_value' => array('name' => 'field_value', 'type' => 'xsd:string')
-	)
+    'extra_field',
+    'complexType',
+    'struct',
+    'all',
+    '',
+    array(
+        'field_name' => array('name' => 'field_name', 'type' => 'xsd:string'),
+        'field_value' => array('name' => 'field_value', 'type' => 'xsd:string')
+    )
 );
 
 $s->register(
-	'WSCM.verifyUserPass',
-	array(
-		'username' => 'xsd:string',
-		'password' => 'xsd:string',
-	),
-	array('return' => 'xsd:string')
+    'WSCM.verifyUserPass',
+    array(
+        'username' => 'xsd:string',
+        'password' => 'xsd:string',
+    ),
+    array('return' => 'xsd:string')
 );
 
 $s->register(
@@ -94,9 +94,9 @@ 
 );
 
 $s->register(
-	'WSCM.test',
-	array(),
-	array('return' => 'xsd:string'),
+    'WSCM.test',
+    array(),
+    array('return' => 'xsd:string'),
         'urn:WSCMService',
         '',
         '',

main/webservices/soap_user.php

Indentation +168 added lines, -168 removed lines

@@ -1,9 +1,9 @@ 
 <?php
 /* For licensing terms, see /license.txt */
 /**
- * Configures the WSUser SOAP service
- * @package chamilo.webservices
- */
+     * Configures the WSUser SOAP service
+     * @package chamilo.webservices
+     */
 require_once(dirname(__FILE__).'/webservice_user.php');
 require_once(dirname(__FILE__).'/soap.php');
 
@@ -14,223 +14,223 @@ 
 $s = WSSoapServer::singleton();
 
 $s->wsdl->addComplexType(
-	'user_id',
-	'complexType',
-	'struct',
-	'all',
-	'',
-	array(
-		'user_id_field_name' => array('name' => 'user_id_field_name', 'type' => 'xsd:string'),
-		'user_id_value' => array('name' => 'user_id_value', 'type' => 'xsd:string')
-	)
+    'user_id',
+    'complexType',
+    'struct',
+    'all',
+    '',
+    array(
+        'user_id_field_name' => array('name' => 'user_id_field_name', 'type' => 'xsd:string'),
+        'user_id_value' => array('name' => 'user_id_value', 'type' => 'xsd:string')
+    )
 );
 
 $s->wsdl->addComplexType(
-	'user_result',
-	'complexType',
-	'struct',
-	'all',
-	'',
-	array(
-		'user_id_value' => array('name' => 'user_id_value', 'type' => 'xsd:string'),
-		'result' => array('name' => 'result', 'type' => 'tns:result')
-	)
+    'user_result',
+    'complexType',
+    'struct',
+    'all',
+    '',
+    array(
+        'user_id_value' => array('name' => 'user_id_value', 'type' => 'xsd:string'),
+        'result' => array('name' => 'result', 'type' => 'tns:result')
+    )
 );
 
 $s->wsdl->addComplexType(
-	'user_result_array',
-	'complexType',
-	'array',
-	'',
-	'SOAP-ENC:Array',
-	array(),
-	array(array('ref'=>'SOAP-ENC:arrayType', 'wsdl:arrayType' => 'tns:user_result[]')),
-	'tns:user_result'
+    'user_result_array',
+    'complexType',
+    'array',
+    '',
+    'SOAP-ENC:Array',
+    array(),
+    array(array('ref'=>'SOAP-ENC:arrayType', 'wsdl:arrayType' => 'tns:user_result[]')),
+    'tns:user_result'
 );
 
 $s->register(
-	'WSUser.DisableUser',
-	array('secret_key' => 'xsd:string', 'user_id_field_name' => 'xsd:string', 'user_id_value' => 'xsd:string')
+    'WSUser.DisableUser',
+    array('secret_key' => 'xsd:string', 'user_id_field_name' => 'xsd:string', 'user_id_value' => 'xsd:string')
 );
 
 $s->register(
-	'WSUser.DisableUsers',
-	array('secret_key' => 'xsd:string', 'users' => 'tns:user_id[]'),
-	array('return' => 'tns:user_result_array')
+    'WSUser.DisableUsers',
+    array('secret_key' => 'xsd:string', 'users' => 'tns:user_id[]'),
+    array('return' => 'tns:user_result_array')
 );
 
 $s->register(
-	'WSUser.EnableUser',
-	array('secret_key' => 'xsd:string', 'user_id_field_name' => 'xsd:string', 'user_id_value' => 'xsd:string')
+    'WSUser.EnableUser',
+    array('secret_key' => 'xsd:string', 'user_id_field_name' => 'xsd:string', 'user_id_value' => 'xsd:string')
 );
 
 $s->register(
-	'WSUser.EnableUsers',
-	array('secret_key' => 'xsd:string', 'users' => 'tns:user_id[]'),
-	array('return' => 'tns:user_result_array')
+    'WSUser.EnableUsers',
+    array('secret_key' => 'xsd:string', 'users' => 'tns:user_id[]'),
+    array('return' => 'tns:user_result_array')
 );
 
 $s->register(
-	'WSUser.DeleteUser',
-	array('secret_key' => 'xsd:string', 'user_id_field_name' => 'xsd:string', 'user_id_value' => 'xsd:string')
+    'WSUser.DeleteUser',
+    array('secret_key' => 'xsd:string', 'user_id_field_name' => 'xsd:string', 'user_id_value' => 'xsd:string')
 );
 
 $s->register(
-	'WSUser.DeleteUsers',
-	array('secret_key' => 'xsd:string', 'users' => 'tns:user_id[]'),
-	array('return' => 'tns:user_result_array')
+    'WSUser.DeleteUsers',
+    array('secret_key' => 'xsd:string', 'users' => 'tns:user_id[]'),
+    array('return' => 'tns:user_result_array')
 );
 
 $s->register(
-	'WSUser.CreateUser',
-	array(
-		'secret_key' => 'xsd:string',
-		'firstname' => 'xsd:string',
-		'lastname' => 'xsd:string',
-		'status' => 'xsd:int',
-		'loginname' => 'xsd:string',
-		'password' => 'xsd:string',
-		'encrypt_method' => 'xsd:string',
-		'user_id_field_name' => 'xsd:string',
-		'user_id_value' => 'xsd:string',
-		'visibility' => 'xsd:int',
-		'email' => 'xsd:string',
-		'language' => 'xsd:string',
-		'phone' => 'xsd:string',
-		'expiration_date' => 'xsd:string',
-		'extras' => 'tns:extra_field'
-	),
-	array('return' => 'xsd:int')
+    'WSUser.CreateUser',
+    array(
+        'secret_key' => 'xsd:string',
+        'firstname' => 'xsd:string',
+        'lastname' => 'xsd:string',
+        'status' => 'xsd:int',
+        'loginname' => 'xsd:string',
+        'password' => 'xsd:string',
+        'encrypt_method' => 'xsd:string',
+        'user_id_field_name' => 'xsd:string',
+        'user_id_value' => 'xsd:string',
+        'visibility' => 'xsd:int',
+        'email' => 'xsd:string',
+        'language' => 'xsd:string',
+        'phone' => 'xsd:string',
+        'expiration_date' => 'xsd:string',
+        'extras' => 'tns:extra_field'
+    ),
+    array('return' => 'xsd:int')
 );
 
 $s->wsdl->addComplexType(
-	'user_create',
-	'complexType',
-	'struct',
-	'all',
-	'',
-	array(
-		'firstname' => array('name' => 'firstname', 'type' => 'xsd:string'),
-		'lastname' => array('name' => 'lastname', 'type' => 'xsd:string'),
-		'status' => array('name' => 'status', 'type' => 'xsd:int'),
-		'loginname' => array('name' => 'loginname', 'type' => 'xsd:string'),
-		'password' => array('name' => 'password', 'type' => 'xsd:string'),
-		'encrypt_method' => array('name' => 'encrypt_method', 'type' => 'xsd:string'),
-		'user_id_field_name' => array('name' => 'user_id_field_name', 'type' => 'xsd:string'),
-		'user_id_value' => array('name' => 'user_id_value', 'type' => 'xsd:string'),
-		'visibility' => array('name' => 'visibility', 'type' => 'xsd:int'),
-		'email' => array('name' => 'email', 'type' => 'xsd:string'),
-		'language' => array('name' => 'language', 'type' => 'xsd:string'),
-		'phone' => array('name' => 'phone', 'type' => 'xsd:string'),
-		'expiration_date' => array('name' => 'expiration_date', 'type' => 'xsd:string'),
-		'extras' => array('name' => 'extras', 'type' => 'tns:extra_field')
-	)
+    'user_create',
+    'complexType',
+    'struct',
+    'all',
+    '',
+    array(
+        'firstname' => array('name' => 'firstname', 'type' => 'xsd:string'),
+        'lastname' => array('name' => 'lastname', 'type' => 'xsd:string'),
+        'status' => array('name' => 'status', 'type' => 'xsd:int'),
+        'loginname' => array('name' => 'loginname', 'type' => 'xsd:string'),
+        'password' => array('name' => 'password', 'type' => 'xsd:string'),
+        'encrypt_method' => array('name' => 'encrypt_method', 'type' => 'xsd:string'),
+        'user_id_field_name' => array('name' => 'user_id_field_name', 'type' => 'xsd:string'),
+        'user_id_value' => array('name' => 'user_id_value', 'type' => 'xsd:string'),
+        'visibility' => array('name' => 'visibility', 'type' => 'xsd:int'),
+        'email' => array('name' => 'email', 'type' => 'xsd:string'),
+        'language' => array('name' => 'language', 'type' => 'xsd:string'),
+        'phone' => array('name' => 'phone', 'type' => 'xsd:string'),
+        'expiration_date' => array('name' => 'expiration_date', 'type' => 'xsd:string'),
+        'extras' => array('name' => 'extras', 'type' => 'tns:extra_field')
+    )
 );
 
 $s->wsdl->addComplexType(
-	'user_create_result',
-	'complexType',
-	'struct',
-	'all',
-	'',
-	array(
-		'user_id_value' => array('name' => 'user_id_value', 'type' => 'xsd:string'),
-		'user_id_generated' => array('name' => 'user_id_generated', 'type' => 'xsd:int'),
-		'result' => array('name' => 'result', 'type' => 'tns:result')
-	)
+    'user_create_result',
+    'complexType',
+    'struct',
+    'all',
+    '',
+    array(
+        'user_id_value' => array('name' => 'user_id_value', 'type' => 'xsd:string'),
+        'user_id_generated' => array('name' => 'user_id_generated', 'type' => 'xsd:int'),
+        'result' => array('name' => 'result', 'type' => 'tns:result')
+    )
 );
 
 $s->wsdl->addComplexType(
-	'user_create_result_array',
-	'complexType',
-	'array',
-	'',
-	'SOAP-ENC:Array',
-	array(),
-	array(array('ref'=>'SOAP-ENC:arrayType', 'wsdl:arrayType' => 'tns:user_create_result[]')),
-	'tns:user_create_result'
+    'user_create_result_array',
+    'complexType',
+    'array',
+    '',
+    'SOAP-ENC:Array',
+    array(),
+    array(array('ref'=>'SOAP-ENC:arrayType', 'wsdl:arrayType' => 'tns:user_create_result[]')),
+    'tns:user_create_result'
 );
 
 $s->register(
-	'WSUser.CreateUsers',
-	array(
-		'secret_key' => 'xsd:string',
-		'users' => 'tns:user_create[]'
-	),
-	array('return' => 'tns:user_create_result_array')
+    'WSUser.CreateUsers',
+    array(
+        'secret_key' => 'xsd:string',
+        'users' => 'tns:user_create[]'
+    ),
+    array('return' => 'tns:user_create_result_array')
 );
 
 $s->register(
-	'WSUser.EditUser',
-	array(
-		'secret_key' => 'xsd:string',
-		'user_id_field_name' => 'xsd:string',
-		'user_id_value' => 'xsd:string',
-		'firstname' => 'xsd:string',
-		'lastname' => 'xsd:string',
-		'status' => 'xsd:int',
-		'loginname' => 'xsd:string',
-		'password' => 'xsd:string',
-		'encrypt_method' => 'xsd:string',
-		'email' => 'xsd:string',
-		'language' => 'xsd:string',
-		'phone' => 'xsd:string',
-		'expiration_date' => 'xsd:string',
-		'extras' => 'tns:extra_field'
-	)
+    'WSUser.EditUser',
+    array(
+        'secret_key' => 'xsd:string',
+        'user_id_field_name' => 'xsd:string',
+        'user_id_value' => 'xsd:string',
+        'firstname' => 'xsd:string',
+        'lastname' => 'xsd:string',
+        'status' => 'xsd:int',
+        'loginname' => 'xsd:string',
+        'password' => 'xsd:string',
+        'encrypt_method' => 'xsd:string',
+        'email' => 'xsd:string',
+        'language' => 'xsd:string',
+        'phone' => 'xsd:string',
+        'expiration_date' => 'xsd:string',
+        'extras' => 'tns:extra_field'
+    )
 );
 
 $s->wsdl->addComplexType(
-	'user_edit',
-	'complexType',
-	'struct',
-	'all',
-	'',
-	array(
-		'user_id_field_name' => array('name' => 'user_id_field_name', 'type' => 'xsd:string'),
-		'user_id_value' => array('name' => 'user_id_value', 'type' => 'xsd:string'),
-		'firstname' => array('name' => 'firstname', 'type' => 'xsd:string'),
-		'lastname' => array('name' => 'lastname', 'type' => 'xsd:string'),
-		'status' => array('name' => 'status', 'type' => 'xsd:int'),
-		'loginname' => array('name' => 'loginname', 'type' => 'xsd:string'),
-		'password' => array('name' => 'password', 'type' => 'xsd:string'),
-		'encrypt_method' => array('name' => 'encrypt_method', 'type' => 'xsd:string'),
-		'email' => array('name' => 'email', 'type' => 'xsd:string'),
-		'language' => array('name' => 'language', 'type' => 'xsd:string'),
-		'phone' => array('name' => 'phone', 'type' => 'xsd:string'),
-		'expiration_date' => array('name' => 'expiration_date', 'type' => 'xsd:string'),
-		'extras' => array('name' => 'extras', 'type' => 'tns:extra_field')
-	)
+    'user_edit',
+    'complexType',
+    'struct',
+    'all',
+    '',
+    array(
+        'user_id_field_name' => array('name' => 'user_id_field_name', 'type' => 'xsd:string'),
+        'user_id_value' => array('name' => 'user_id_value', 'type' => 'xsd:string'),
+        'firstname' => array('name' => 'firstname', 'type' => 'xsd:string'),
+        'lastname' => array('name' => 'lastname', 'type' => 'xsd:string'),
+        'status' => array('name' => 'status', 'type' => 'xsd:int'),
+        'loginname' => array('name' => 'loginname', 'type' => 'xsd:string'),
+        'password' => array('name' => 'password', 'type' => 'xsd:string'),
+        'encrypt_method' => array('name' => 'encrypt_method', 'type' => 'xsd:string'),
+        'email' => array('name' => 'email', 'type' => 'xsd:string'),
+        'language' => array('name' => 'language', 'type' => 'xsd:string'),
+        'phone' => array('name' => 'phone', 'type' => 'xsd:string'),
+        'expiration_date' => array('name' => 'expiration_date', 'type' => 'xsd:string'),
+        'extras' => array('name' => 'extras', 'type' => 'tns:extra_field')
+    )
 );
 
 $s->wsdl->addComplexType(
-	'user_edit_result',
-	'complexType',
-	'struct',
-	'all',
-	'',
-	array(
-		'user_id_value' => array('name' => 'user_id_value', 'type' => 'xsd:string'),
-		'result' => array('name' => 'result', 'type' => 'tns:result')
-	)
+    'user_edit_result',
+    'complexType',
+    'struct',
+    'all',
+    '',
+    array(
+        'user_id_value' => array('name' => 'user_id_value', 'type' => 'xsd:string'),
+        'result' => array('name' => 'result', 'type' => 'tns:result')
+    )
 );
 
 $s->wsdl->addComplexType(
-	'user_edit_result_array',
-	'complexType',
-	'array',
-	'',
-	'SOAP-ENC:Array',
-	array(),
-	array(array('ref'=>'SOAP-ENC:arrayType', 'wsdl:arrayType' => 'tns:user_edit_result[]')),
-	'tns:user_edit_result'
+    'user_edit_result_array',
+    'complexType',
+    'array',
+    '',
+    'SOAP-ENC:Array',
+    array(),
+    array(array('ref'=>'SOAP-ENC:arrayType', 'wsdl:arrayType' => 'tns:user_edit_result[]')),
+    'tns:user_edit_result'
 );
 
 $s->register(
-	'WSUser.EditUsers',
-	array(
-		'secret_key' => 'xsd:string',
-		'users' => 'tns:user_edit[]'
-	),
-	array('return' => 'tns:user_edit_result_array')
+    'WSUser.EditUsers',
+    array(
+        'secret_key' => 'xsd:string',
+        'users' => 'tns:user_edit[]'
+    ),
+    array('return' => 'tns:user_edit_result_array')
 );

main/webservices/cm_soap_announcements.php

Indentation +12 added lines, -12 removed lines

@@ -11,13 +11,13 @@ 
 
 
 $s->register(
-	'WSCMAnnouncements.get_announcements_id',
-	array(
-		'username' => 'xsd:string',
-		'password' => 'xsd:string',
+    'WSCMAnnouncements.get_announcements_id',
+    array(
+        'username' => 'xsd:string',
+        'password' => 'xsd:string',
                 'course_code' => 'xsd:string'
-	),
-	array('return' => 'xsd:string'),
+    ),
+    array('return' => 'xsd:string'),
         'urn:WSCMService',
         '',
         '',
@@ -27,15 +27,15 @@ 
 );
 
 $s->register(
-	'WSCMAnnouncements.get_announcement_data',
-	array(
-		'username' => 'xsd:string',
-		'password' => 'xsd:string',
+    'WSCMAnnouncements.get_announcement_data',
+    array(
+        'username' => 'xsd:string',
+        'password' => 'xsd:string',
                 'course_code' => 'xsd:string',
                 'announcement_id' => 'xsd:string',
                 'field' => 'xsd:string'
-	),
-	array('return' => 'xsd:string'),
+    ),
+    array('return' => 'xsd:string'),
         'urn:WSCMService',
         '',
         '',

main/webservices/cm_soap_inbox.php

Indentation +36 added lines, -36 removed lines

@@ -11,12 +11,12 @@ 
 
 
 $s->register(
-	'WSCMInbox.unreadMessage',
-	array(
-		'username' => 'xsd:string',
-		'password' => 'xsd:string',
-	),
-	array('return' => 'xsd:string'),
+    'WSCMInbox.unreadMessage',
+    array(
+        'username' => 'xsd:string',
+        'password' => 'xsd:string',
+    ),
+    array('return' => 'xsd:string'),
         'urn:WSCMService',
         '',
         '',
@@ -26,14 +26,14 @@ 
 );
 
 $s->register(
-	'WSCMInbox.get_message_id',
-	array(
-		'username' => 'xsd:string',
-		'password' => 'xsd:string',
+    'WSCMInbox.get_message_id',
+    array(
+        'username' => 'xsd:string',
+        'password' => 'xsd:string',
                 'from' => 'xsd:string',
                 'number_of_items' => 'xsd:string'
-	),
-	array('return' => 'xsd:string'),
+    ),
+    array('return' => 'xsd:string'),
         'urn:WSCMService',
         '',
         '',
@@ -44,14 +44,14 @@ 
 
 
 $s->register(
-	'WSCMInbox.get_message_data',
-	array(
-		'username' => 'xsd:string',
-		'password' => 'xsd:string',
+    'WSCMInbox.get_message_data',
+    array(
+        'username' => 'xsd:string',
+        'password' => 'xsd:string',
                 'id' => 'xsd:string',
                 'field' => 'xsd:string'
-	),
-	array('return' => 'xsd:string'),
+    ),
+    array('return' => 'xsd:string'),
         'urn:WSCMService',
         '',
         '',
@@ -61,14 +61,14 @@ 
 );
 
 $s->register(
-	'WSCMInbox.get_message_id_sent',
-	array(
-		'username' => 'xsd:string',
-		'password' => 'xsd:string',
+    'WSCMInbox.get_message_id_sent',
+    array(
+        'username' => 'xsd:string',
+        'password' => 'xsd:string',
                 'from' => 'xsd:string',
                 'number_of_items' => 'xsd:string'
-	),
-	array('return' => 'xsd:string'),
+    ),
+    array('return' => 'xsd:string'),
         'urn:WSCMService',
         '',
         '',
@@ -78,14 +78,14 @@ 
 );
 
 $s->register(
-	'WSCMInbox.get_message_data_sent',
-	array(
-		'username' => 'xsd:string',
-		'password' => 'xsd:string',
+    'WSCMInbox.get_message_data_sent',
+    array(
+        'username' => 'xsd:string',
+        'password' => 'xsd:string',
                 'id' => 'xsd:string',
                 'field' => 'xsd:string'
-	),
-	array('return' => 'xsd:string'),
+    ),
+    array('return' => 'xsd:string'),
         'urn:WSCMService',
         '',
         '',
@@ -95,15 +95,15 @@ 
 );
 
 $s->register(
-	'WSCMInbox.message_send',
-	array(
-		'username' => 'xsd:string',
-		'password' => 'xsd:string',
+    'WSCMInbox.message_send',
+    array(
+        'username' => 'xsd:string',
+        'password' => 'xsd:string',
                 'receiver_user_id' => 'xsd:string',
                 'subject' => 'xsd:string',
                 'content' => 'xsd:string'
-	),
-	array('return' => 'xsd:string'),
+    ),
+    array('return' => 'xsd:string'),
         'urn:WSCMService',
         '',
         '',

main/webservices/http-auth.php

Indentation +6 added lines, -6 removed lines

@@ -26,11 +26,11 @@ 
 $validResponse = md5("{$A1}:{$digestParts['nonce']}:{$digestParts['nc']}:{$digestParts['cnonce']}:{$digestParts['qop']}:{$A2}");
 
 if ($digestParts['response'] != $validResponse)
-  requireLogin($realm,$nonce);
+    requireLogin($realm,$nonce);
 else {
-  // We're in!
-  echo 'a7532ae474e5e66a0c16eddab02e02a7';
-  die();
+    // We're in!
+    echo 'a7532ae474e5e66a0c16eddab02e02a7';
+    die();
 }
 
 // This function returns the digest string
@@ -42,11 +42,11 @@ 
     // most other servers
     }
     elseif (isset($_SERVER['HTTP_AUTHENTICATION'])) {
-      if (strpos(strtolower($_SERVER['HTTP_AUTHENTICATION']),'digest')===0)
+        if (strpos(strtolower($_SERVER['HTTP_AUTHENTICATION']),'digest')===0)
         $digest = substr($_SERVER['HTTP_AUTHORIZATION'], 7);
     }
     elseif (isset($_SERVER['HTTP_WWW_AUTHENTICATE'])) {
-      $digest = $_SERVER['HTTP_WWW_AUTHENTICATE'];
+        $digest = $_SERVER['HTTP_WWW_AUTHENTICATE'];
     }
     return $digest;
 

main/webservices/cm_webservice.php

Indentation +198 added lines, -198 removed lines

@@ -6,120 +6,120 @@ 
  * Error returned by one of the methods of the web service. Contains an error code and an error message
  */
 class WSCMError {
-	/**
-	 * Error handler. This needs to be a class that implements the interface WSErrorHandler
-	 *
-	 * @var WSErrorHandler
-	 */
-	protected static $_handler;
+    /**
+     * Error handler. This needs to be a class that implements the interface WSErrorHandler
+     *
+     * @var WSErrorHandler
+     */
+    protected static $_handler;
 
-	/**
-	 * Error code
-	 *
-	 * @var int
-	 */
-	public $code;
+    /**
+     * Error code
+     *
+     * @var int
+     */
+    public $code;
 
-	/**
-	 * Error message
-	 *
-	 * @var string
-	 */
-	public $message;
+    /**
+     * Error message
+     *
+     * @var string
+     */
+    public $message;
 
-	/**
-	 * Constructor
-	 *
-	 * @param int Error code
-	 * @param string Error message
-	 */
-	public function __construct($code, $message) {
-		$this->code = $code;
-		$this->message = $message;
-	}
+    /**
+     * Constructor
+     *
+     * @param int Error code
+     * @param string Error message
+     */
+    public function __construct($code, $message) {
+        $this->code = $code;
+        $this->message = $message;
+    }
 
-	/**
-	 * Sets the error handler
-	 *
-	 * @param WSErrorHandler Error handler
-	 */
-	public static function setErrorHandler($handler) {
-		if($handler instanceof WSErrorHandler) {
-			self::$_handler = $handler;
-		}
-	}
+    /**
+     * Sets the error handler
+     *
+     * @param WSErrorHandler Error handler
+     */
+    public static function setErrorHandler($handler) {
+        if($handler instanceof WSErrorHandler) {
+            self::$_handler = $handler;
+        }
+    }
 
-	/**
-	 * Returns the error handler
-	 *
-	 * @return WSErrorHandler Error handler
-	 */
-	public static function getErrorHandler() {
-		return self::$_handler;
-	}
+    /**
+     * Returns the error handler
+     *
+     * @return WSErrorHandler Error handler
+     */
+    public static function getErrorHandler() {
+        return self::$_handler;
+    }
 
-	/**
-	 * Transforms the error into an array
-	 *
-	 * @return array Associative array with code and message
-	 */
-	public function toArray() {
-		return array('code' => $this->code, 'message' => $this->message);
-	}
+    /**
+     * Transforms the error into an array
+     *
+     * @return array Associative array with code and message
+     */
+    public function toArray() {
+        return array('code' => $this->code, 'message' => $this->message);
+    }
 }
 
 /**
  * Interface that must be implemented by any error handler
  */
 interface WSCMErrorHandler {
-	/**
-	 * Handle method
-	 *
-	 * @param WSError Error
-	 */
-	public function handle($error);
+    /**
+     * Handle method
+     *
+     * @param WSError Error
+     */
+    public function handle($error);
 }
 
 /**
  * Main class of the webservice. Webservice classes extend this class
  */
 class WSCM {
-	/**
-	 * Chamilo configuration
-	 *
-	 * @var array
-	 */
-	protected $_configuration;
+    /**
+     * Chamilo configuration
+     *
+     * @var array
+     */
+    protected $_configuration;
 
-	/**
-	 * Constructor
-	 */
-	public function __construct() {
-		$this->_configuration = $GLOBALS['_configuration'];
-	}
+    /**
+     * Constructor
+     */
+    public function __construct() {
+        $this->_configuration = $GLOBALS['_configuration'];
+    }
 
-	/**
-	 * Verifies the API key
-	 *
-	 * @param string Secret key
-	 * @return mixed WSError in case of failure, null in case of success
-	 */
-	protected function verifyKey($secret_key) {
-		$ip = trim($_SERVER['REMOTE_ADDR']);
-		// if we are behind a reverse proxy, assume it will send the
-		// HTTP_X_FORWARDED_FOR header and use this IP instead
-		if (!empty($_SERVER['HTTP_X_FORWARDED_FOR'])) {
-		  list($ip1,$ip2) = split(',',$_SERVER['HTTP_X_FORWARDED_FOR']);
-		  $ip = trim($ip1);
-		}
-		$security_key = $ip.$this->_configuration['security_key'];
+    /**
+     * Verifies the API key
+     *
+     * @param string Secret key
+     * @return mixed WSError in case of failure, null in case of success
+     */
+    protected function verifyKey($secret_key) {
+        $ip = trim($_SERVER['REMOTE_ADDR']);
+        // if we are behind a reverse proxy, assume it will send the
+        // HTTP_X_FORWARDED_FOR header and use this IP instead
+        if (!empty($_SERVER['HTTP_X_FORWARDED_FOR'])) {
+            list($ip1,$ip2) = split(',',$_SERVER['HTTP_X_FORWARDED_FOR']);
+            $ip = trim($ip1);
+        }
+        $security_key = $ip.$this->_configuration['security_key'];
 
-		if(!api_is_valid_secret_key($secret_key, $security_key)) {
-			return new WSCMError(1, "API key is invalid");
-		} else {
-			return null;
-		}
-	}
+        if(!api_is_valid_secret_key($secret_key, $security_key)) {
+            return new WSCMError(1, "API key is invalid");
+        } else {
+            return null;
+        }
+    }
 
         /**
          * Verifies if the user is valid
@@ -134,12 +134,12 @@ 
             $login = $username;
             $password = $pass;
 
-	    //lookup the user in the main database
+        //lookup the user in the main database
             $user_table = Database::get_main_table(TABLE_MAIN_USER);
-	    $sql = "SELECT user_id, username, password, auth_source, active, expiration_date
+        $sql = "SELECT user_id, username, password, auth_source, active, expiration_date
 	            FROM $user_table
 	            WHERE username = '".trim(addslashes($login))."'";
-	    $result = Database::query($sql);
+        $result = Database::query($sql);
 
             if (Database::num_rows($result) > 0) {
                 $uData = Database::fetch_array($result);
@@ -171,7 +171,7 @@ 
 
         /**
          * Return the encrypted pass
-		 * @deprecated
+         * @deprecated
          * @param <String> $pass
          * @return <String> $pass encrypted
          */
@@ -180,112 +180,112 @@ 
         }*/
 
         /**
-	 * Gets the real user id based on the user id field name and value. Note that if the user id field name is "chamilo_user_id", it will use the user id
-	 * in the system database
-	 *
-	 * @param string User id field name
-	 * @param string User id value
-	 * @return mixed System user id if the user was found, WSError otherwise
-	 */
-	protected function getUserId($user_id_field_name, $user_id_value) {
-		if($user_id_field_name == "chamilo_user_id") {
-			if(UserManager::is_user_id_valid(intval($user_id_value))) {
-				return intval($user_id_value);
-			} else {
-				return new WSCMError(100, "User not found");
-			}
-		} else {
-			$user_id = UserManager::get_user_id_from_original_id($user_id_value, $user_id_field_name);
-			if($user_id == 0) {
-				return new WSCMError(100, "User not found");
-			} else {
-				return $user_id;
-			}
-		}
-	}
+         * Gets the real user id based on the user id field name and value. Note that if the user id field name is "chamilo_user_id", it will use the user id
+         * in the system database
+         *
+         * @param string User id field name
+         * @param string User id value
+         * @return mixed System user id if the user was found, WSError otherwise
+         */
+    protected function getUserId($user_id_field_name, $user_id_value) {
+        if($user_id_field_name == "chamilo_user_id") {
+            if(UserManager::is_user_id_valid(intval($user_id_value))) {
+                return intval($user_id_value);
+            } else {
+                return new WSCMError(100, "User not found");
+            }
+        } else {
+            $user_id = UserManager::get_user_id_from_original_id($user_id_value, $user_id_field_name);
+            if($user_id == 0) {
+                return new WSCMError(100, "User not found");
+            } else {
+                return $user_id;
+            }
+        }
+    }
 
-	/**
-	 * Gets the real course id based on the course id field name and value. Note that if the course id field name is "chamilo_course_id", it will use the course id
-	 * in the system database
-	 *
-	 * @param string Course id field name
-	 * @param string Course id value
-	 * @return mixed System course id if the course was found, WSError otherwise
-	 */
-	protected function getCourseId($course_id_field_name, $course_id_value) {
-		if($course_id_field_name == "chamilo_course_id") {
-			if(CourseManager::get_course_code_from_course_id(intval($course_id_value)) != null) {
-				return intval($course_id_value);
-			} else {
-				return new WSCMError(200, "Course not found");
-			}
-		} else {
-			$courseId = CourseManager::get_course_code_from_original_id($course_id_value, $course_id_field_name);
-			if (empty($courseId)) {
-				return new WSCMError(200, "Course not found");
-			} else {
-				return $courseId;
-			}
-		}
-	}
+    /**
+     * Gets the real course id based on the course id field name and value. Note that if the course id field name is "chamilo_course_id", it will use the course id
+     * in the system database
+     *
+     * @param string Course id field name
+     * @param string Course id value
+     * @return mixed System course id if the course was found, WSError otherwise
+     */
+    protected function getCourseId($course_id_field_name, $course_id_value) {
+        if($course_id_field_name == "chamilo_course_id") {
+            if(CourseManager::get_course_code_from_course_id(intval($course_id_value)) != null) {
+                return intval($course_id_value);
+            } else {
+                return new WSCMError(200, "Course not found");
+            }
+        } else {
+            $courseId = CourseManager::get_course_code_from_original_id($course_id_value, $course_id_field_name);
+            if (empty($courseId)) {
+                return new WSCMError(200, "Course not found");
+            } else {
+                return $courseId;
+            }
+        }
+    }
 
-	/**
-	 * 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 WSCMError(300, "Session not found");
-			}
-		} else {
-			$session_id = SessionManager::getSessionIdFromOriginalId(
-				$session_id_value,
-				$session_id_field_name
-			);
-			if($session_id == 0) {
-				return new WSCMError(300, "Session not found");
-			} else {
-				return $session_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 WSCMError(300, "Session not found");
+            }
+        } else {
+            $session_id = SessionManager::getSessionIdFromOriginalId(
+                $session_id_value,
+                $session_id_field_name
+            );
+            if($session_id == 0) {
+                return new WSCMError(300, "Session not found");
+            } else {
+                return $session_id;
+            }
+        }
+    }
 
-	/**
-	 * Handles an error by calling the WSError error handler
-	 *
-	 * @param WSError Error
-	 */
-	protected function handleError($error) {
-		$handler = WSCMError::getErrorHandler();
-		$handler->handle($error);
-	}
+    /**
+     * Handles an error by calling the WSError error handler
+     *
+     * @param WSError Error
+     */
+    protected function handleError($error) {
+        $handler = WSCMError::getErrorHandler();
+        $handler->handle($error);
+    }
 
-	/**
-	 * Gets a successful result
-	 *
-	 * @return array Array with a code of 0 and a message 'Operation was successful'
-	 */
-	protected function getSuccessfulResult() {
-		return array('code' => 0, 'message' => 'Operation was successful');
-	}
+    /**
+     * Gets a successful result
+     *
+     * @return array Array with a code of 0 and a message 'Operation was successful'
+     */
+    protected function getSuccessfulResult() {
+        return array('code' => 0, 'message' => 'Operation was successful');
+    }
 
-	/**
-	 * Test function. Returns the string success
-	 *
-	 * @return string Success
-	 */
-	public function test() {
-		return "success";
-	}
+    /**
+     * Test function. Returns the string success
+     *
+     * @return string Success
+     */
+    public function test() {
+        return "success";
+    }
 
         /**
          * *Strictly* reverts PHP's nl2br() effects (whether it was used in XHTML mode or not)