chamilo / chamilo-lms

main/permissions/permissions_functions.inc.php

Doc Comments +2 added lines, -2 removed lines

@@ -118,7 +118,7 @@ 
 
 /**
 * This function retrieves the existing permissions of a user, group or role.
-* @param $content are we retrieving the rights of a user, a group or a role (the database depends on it)
+* @param string $content are we retrieving the rights of a user, a group or a role (the database depends on it)
 * @param $id the id of the user, group or role
 * @author Patrick Cool <patrick.cool@ugent.be>, Ghent University
 * @version 1.0
@@ -526,7 +526,7 @@ 
 
 /**
 * This function gets all the roles that are defined
-* @param $content are we finding the roles for a user or a group (the database depends on it)
+* @param string $content are we finding the roles for a user or a group (the database depends on it)
 * @param $id the id of the user or group
 * @param string	Deprecated parameter allowing use of 'platform' scope - the corresponding tables don't exist anymore so the scope is always set to 'course'
 * @return array that contains the name of the roles the user has

main/user/user.php

Doc Comments -1 removed lines

@@ -735,7 +735,6 @@
  * lock = the user can no longer use this account
  * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
  * @param int $active the current state of the account
- * @param int $user_id The user id
  * @param string $urlParams
  *
  * @return string Some HTML-code with the lock/unlock button

main/webservices/additional_webservices.php

Doc Comments +1 added lines, -1 removed lines

@@ -84,7 +84,7 @@
 }
 
 /**
- * @param $directoryPath
+ * @param string $directoryPath
  * @return bool
  */
 function deleteDirectory($directoryPath)

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) {