chamilo / chamilo-lms

main/webservices/cm_webservice.php

Doc Comments +5 added lines, -1 removed lines

@@ -32,6 +32,8 @@ 
 	 *
 	 * @param int Error code
 	 * @param string Error message
+	 * @param integer $code
+	 * @param string $message
 	 */
 	public function __construct($code, $message) {
 		$this->code = $code;
@@ -42,6 +44,7 @@ 
 	 * Sets the error handler
 	 *
 	 * @param WSErrorHandler Error handler
+	 * @param WSCMSoapErrorHandler $handler
 	 */
 	public static function setErrorHandler($handler) {
 		if($handler instanceof WSErrorHandler) {
@@ -76,6 +79,7 @@ 
 	 * Handle method
 	 *
 	 * @param WSError Error
+	 * @return void
 	 */
 	public function handle($error);
 }
@@ -102,7 +106,7 @@ 
 	 * Verifies the API key
 	 *
 	 * @param string Secret key
-	 * @return mixed WSError in case of failure, null in case of success
+	 * @return WSCMError|null WSError in case of failure, null in case of success
 	 */
 	protected function verifyKey($secret_key) {
 		$ip = trim($_SERVER['REMOTE_ADDR']);

main/webservices/cm_webservice_course.php

Doc Comments +1 added lines

@@ -342,6 +342,7 @@
 	 * @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
+	 * @param integer $state
 	 * @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) {

main/webservices/cm_webservice_inbox.php

Doc Comments +3 added lines

@@ -204,6 +204,9 @@
 
     }
 
+    /**
+     * @param integer $user_id
+     */
     protected function set_message_as_read($user_id, $message_id){
         $table_message = Database::get_main_table(TABLE_MESSAGE);
         $query = "UPDATE $table_message SET msg_status = '".MESSAGE_STATUS_NEW."' WHERE user_receiver_id=".$user_id." AND id='".$message_id."';";

main/webservices/cm_webservice_user.php

Doc Comments +1 added lines, -1 removed lines

@@ -137,7 +137,7 @@
     /**
     * Get a list of users of which the given conditions match with a LIKE '%cond%'
     * @param array $conditions a list of condition (exemple : status=>STUDENT)
-    * @param array $order_by a list of fields on which sort
+    * @param string[] $order_by a list of fields on which sort
     * @return array An array with all users of the platform.
     * @todo optional course code parameter, optional sorting parameters...
      *@todo Use the UserManager class

main/webservices/lp.php

Doc Comments +3 added lines

@@ -20,6 +20,9 @@
 
 define('WS_ERROR_SECRET_KEY', 1);
 
+/**
+ * @param integer $code
+ */
 function return_error($code) {
     $fault = null;
     switch ($code) {

main/webservices/registration.soap.php

Doc Comments +3 added lines

@@ -2617,6 +2617,9 @@
     )
 );
 
+/**
+ * @param string $type
+ */
 function WSHelperActionOnUsers($params, $type) {
     if(!WSHelperVerifyKey($params)) {
         return returnError(WS_ERROR_SECRET_KEY);

main/webservices/webservice.php

Doc Comments +5 added lines, -1 removed lines

@@ -37,6 +37,8 @@ 
 	 *
 	 * @param int Error code
 	 * @param string Error message
+	 * @param integer $code
+	 * @param string $message
 	 */
 	public function __construct($code, $message) {
 		$this->code = $code;
@@ -47,6 +49,7 @@ 
 	 * Sets the error handler
 	 *
 	 * @param WSErrorHandler Error handler
+	 * @param WSSoapErrorHandler $handler
 	 */
 	public static function setErrorHandler($handler) {
 		if($handler instanceof WSErrorHandler) {
@@ -81,6 +84,7 @@ 
 	 * Handle method
 	 *
 	 * @param WSError Error
+	 * @return void
 	 */
 	public function handle($error);
 }
@@ -107,7 +111,7 @@ 
 	 * Verifies the API key
 	 *
 	 * @param string Secret key
-	 * @return mixed WSError in case of failure, null in case of success
+	 * @return WSError|null WSError in case of failure, null in case of success
 	 */
 	protected function verifyKey($secret_key) {
 		$ip = trim($_SERVER['REMOTE_ADDR']);

main/webservices/webservice_session.php

Doc Comments +1 added lines

@@ -453,6 +453,7 @@
 	 * @param string Session id field name
 	 * @param string Session id value
 	 * @param int State (1 to subscribe, 0 to unsubscribe)
+	 * @param integer $state
 	 * @return mixed True on success, WSError otherwise
 	 */
 	protected function changeCourseSubscription($course_id_field_name, $course_id_value, $session_id_field_name, $session_id_value, $state) {

main/webservices/webservice_user.php

Doc Comments +6 added lines

@@ -36,6 +36,7 @@ 
 	 *
 	 * @param array Users
 	 * @param int Set to 1 to enable and to 0 to disable
+	 * @param integer $state
 	 * @return array Array of results
 	 */
 	protected function changeUsersActiveState($users, $state) {
@@ -217,6 +218,11 @@ 
 	 * @param string Phone.
 	 * @param string Expiration date
 	 * @param array Extra fields. An array with elements of the form ('field_name' => 'name_of_the_field', 'field_value' => 'value_of_the_field').
+	 * @param integer|null $visibility
+	 * @param string|null $email
+	 * @param string|null $language
+	 * @param string|null $phone
+	 * @param string|null $expiration_date
 	 * @return mixed New user id generated by the system, WSError otherwise
 	 */
 	protected function createUserHelper($firstname, $lastname, $status, $login, $password, $encrypt_method, $user_id_field_name, $user_id_value, $visibility, $email, $language, $phone, $expiration_date, $extras = array()) {