chamilo / chamilo-lms

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

Indentation +426 added lines, -426 removed lines

@@ -11,458 +11,458 @@
  */
 class WSUser extends WS {
 
-	/**
-	 * Enables or disables a user
-	 *
-	 * @param string User id field name
-	 * @param string User id value
-	 * @param int Set to 1 to enable and to 0 to disable
-	 */
-	protected function changeUserActiveState($user_id_field_name, $user_id_value, $state) {
-		$user_id = $this->getUserId($user_id_field_name, $user_id_value);
-		if($user_id instanceof WSError) {
-			return $user_id;
-		} else {
-			if($state == 0) {
-				UserManager::disable($user_id);
-			} else if($state == 1) {
-				UserManager::enable($user_id);
-			}
-		}
-	}
+    /**
+     * Enables or disables a user
+     *
+     * @param string User id field name
+     * @param string User id value
+     * @param int Set to 1 to enable and to 0 to disable
+     */
+    protected function changeUserActiveState($user_id_field_name, $user_id_value, $state) {
+        $user_id = $this->getUserId($user_id_field_name, $user_id_value);
+        if($user_id instanceof WSError) {
+            return $user_id;
+        } else {
+            if($state == 0) {
+                UserManager::disable($user_id);
+            } else if($state == 1) {
+                UserManager::enable($user_id);
+            }
+        }
+    }
 
-	/**
-	 * Enables or disables multiple users
-	 *
-	 * @param array Users
-	 * @param int Set to 1 to enable and to 0 to disable
-	 * @return array Array of results
-	 */
-	protected function changeUsersActiveState($users, $state) {
-		$results = array();
-		foreach($users as $user) {
-			$result_tmp = array();
-			$result_op = $this->changeUserActiveState($user['user_id_field_name'], $user['user_id_value'], $state);
-			$result_tmp['user_id_value'] = $user['user_id_value'];
-			if($result_op instanceof WSError) {
-				// Return the error in the results
-				$result_tmp['result'] = $result_op->toArray();
-			} else {
-				$result_tmp['result'] = $this->getSuccessfulResult();
-			}
-			$results[] = $result_tmp;
-		}
-		return $results;
-	}
+    /**
+     * Enables or disables multiple users
+     *
+     * @param array Users
+     * @param int Set to 1 to enable and to 0 to disable
+     * @return array Array of results
+     */
+    protected function changeUsersActiveState($users, $state) {
+        $results = array();
+        foreach($users as $user) {
+            $result_tmp = array();
+            $result_op = $this->changeUserActiveState($user['user_id_field_name'], $user['user_id_value'], $state);
+            $result_tmp['user_id_value'] = $user['user_id_value'];
+            if($result_op instanceof WSError) {
+                // Return the error in the results
+                $result_tmp['result'] = $result_op->toArray();
+            } else {
+                $result_tmp['result'] = $this->getSuccessfulResult();
+            }
+            $results[] = $result_tmp;
+        }
+        return $results;
+    }
 
-	/**
-	 * Disables a user
-	 *
-	 * @param string API secret key
-	 * @param string User id field name. Use "chamilo_user_id" as the field name if you want to use the internal user_id
-	 * @param string User id value
-	 */
-	public function DisableUser($secret_key, $user_id_field_name, $user_id_value) {
-		$verifKey = $this->verifyKey($secret_key);
-		if($verifKey instanceof WSError) {
-			// Let the implementation handle it
-			$this->handleError($verifKey);
-		} else {
-			$result = $this->changeUserActiveState($user_id_field_name, $user_id_value, 0);
-			if($result instanceof WSError) {
-				$this->handleError($result);
-			}
-		}
-	}
+    /**
+     * Disables a user
+     *
+     * @param string API secret key
+     * @param string User id field name. Use "chamilo_user_id" as the field name if you want to use the internal user_id
+     * @param string User id value
+     */
+    public function DisableUser($secret_key, $user_id_field_name, $user_id_value) {
+        $verifKey = $this->verifyKey($secret_key);
+        if($verifKey instanceof WSError) {
+            // Let the implementation handle it
+            $this->handleError($verifKey);
+        } else {
+            $result = $this->changeUserActiveState($user_id_field_name, $user_id_value, 0);
+            if($result instanceof WSError) {
+                $this->handleError($result);
+            }
+        }
+    }
 
-	/**
-	 * Disables multiple users
-	 *
-	 * @param string API secret key
-	 * @param array Array of users with elements of the form array('user_id_field_name' => 'name_of_field', 'user_id_value' => 'value')
-	 * @return array Array with elements like array('user_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 DisableUsers($secret_key, $users) {
-		$verifKey = $this->verifyKey($secret_key);
-		if($verifKey instanceof WSError) {
-			// Let the implementation handle it
-			$this->handleError($verifKey);
-		} else {
-			return $this->changeUsersActiveState($users, 0);
-		}
-	}
+    /**
+     * Disables multiple users
+     *
+     * @param string API secret key
+     * @param array Array of users with elements of the form array('user_id_field_name' => 'name_of_field', 'user_id_value' => 'value')
+     * @return array Array with elements like array('user_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 DisableUsers($secret_key, $users) {
+        $verifKey = $this->verifyKey($secret_key);
+        if($verifKey instanceof WSError) {
+            // Let the implementation handle it
+            $this->handleError($verifKey);
+        } else {
+            return $this->changeUsersActiveState($users, 0);
+        }
+    }
 
-	/**
-	 * Enables a user
-	 *
-	 * @param string API secret key
-	 * @param string User id field name. Use "chamilo_user_id" as the field name if you want to use the internal user_id
-	 * @param string User id value
-	 */
-	public function EnableUser($secret_key, $user_id_field_name, $user_id_value) {
-		$verifKey = $this->verifyKey($secret_key);
-		if($verifKey instanceof WSError) {
-			$this->handleError($verifKey);
-		} else {
-			$result = $this->changeUserActiveState($user_id_field_name, $user_id_value, 1);
-			if($result instanceof WSError) {
-				$this->handleError($result);
-			}
-		}
-	}
+    /**
+     * Enables a user
+     *
+     * @param string API secret key
+     * @param string User id field name. Use "chamilo_user_id" as the field name if you want to use the internal user_id
+     * @param string User id value
+     */
+    public function EnableUser($secret_key, $user_id_field_name, $user_id_value) {
+        $verifKey = $this->verifyKey($secret_key);
+        if($verifKey instanceof WSError) {
+            $this->handleError($verifKey);
+        } else {
+            $result = $this->changeUserActiveState($user_id_field_name, $user_id_value, 1);
+            if($result instanceof WSError) {
+                $this->handleError($result);
+            }
+        }
+    }
 
-	/**
-	 * Enables multiple users
-	 *
-	 * @param string API secret key
-	 * @param array Array of users with elements of the form array('user_id_field_name' => 'name_of_field', 'user_id_value' => 'value')
-	 * @return array Array with elements like array('user_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 EnableUsers($secret_key, $users) {
-		$verifKey = $this->verifyKey($secret_key);
-		if($verifKey instanceof WSError) {
-			// Let the implementation handle it
-			$this->handleError($verifKey);
-		} else {
-			return $this->changeUsersActiveState($users, 1);
-		}
-	}
+    /**
+     * Enables multiple users
+     *
+     * @param string API secret key
+     * @param array Array of users with elements of the form array('user_id_field_name' => 'name_of_field', 'user_id_value' => 'value')
+     * @return array Array with elements like array('user_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 EnableUsers($secret_key, $users) {
+        $verifKey = $this->verifyKey($secret_key);
+        if($verifKey instanceof WSError) {
+            // Let the implementation handle it
+            $this->handleError($verifKey);
+        } else {
+            return $this->changeUsersActiveState($users, 1);
+        }
+    }
 
-	/**
-	 * Deletes a user (helper method)
-	 *
-	 * @param string User id field name. Use "chamilo_user_id" as the field name if you want to use the internal user_id
-	 * @param string User id value
-	 * @return mixed True if user was successfully deleted, WSError otherwise
-	 */
-	protected function deleteUserHelper($user_id_field_name, $user_id_value) {
-		$user_id = $this->getUserId($user_id_field_name, $user_id_value);
-		if($user_id instanceof WSError) {
-			return $user_id;
-		} else {
-			if(!UserManager::delete_user($user_id)) {
-				return new WSError(101, "There was a problem while deleting this user");
-			} else {
-				return true;
-			}
-		}
-	}
+    /**
+     * Deletes a user (helper method)
+     *
+     * @param string User id field name. Use "chamilo_user_id" as the field name if you want to use the internal user_id
+     * @param string User id value
+     * @return mixed True if user was successfully deleted, WSError otherwise
+     */
+    protected function deleteUserHelper($user_id_field_name, $user_id_value) {
+        $user_id = $this->getUserId($user_id_field_name, $user_id_value);
+        if($user_id instanceof WSError) {
+            return $user_id;
+        } else {
+            if(!UserManager::delete_user($user_id)) {
+                return new WSError(101, "There was a problem while deleting this user");
+            } else {
+                return true;
+            }
+        }
+    }
 
-	/**
-	 * Deletes a user
-	 *
-	 * @param string API secret key
-	 * @param string User id field name. Use "chamilo_user_id" as the field name if you want to use the internal user_id
-	 * @param string User id value
-	 */
-	public function DeleteUser($secret_key, $user_id_field_name, $user_id_value) {
-		$verifKey = $this->verifyKey($secret_key);
-		if($verifKey instanceof WSError) {
-			$this->handleError($verifKey);
-		} else {
-			$result = $this->deleteUserHelper($user_id_field_name, $user_id_value);
-			if($result instanceof WSError) {
-				$this->handleError($result);
-			}
-		}
-	}
+    /**
+     * Deletes a user
+     *
+     * @param string API secret key
+     * @param string User id field name. Use "chamilo_user_id" as the field name if you want to use the internal user_id
+     * @param string User id value
+     */
+    public function DeleteUser($secret_key, $user_id_field_name, $user_id_value) {
+        $verifKey = $this->verifyKey($secret_key);
+        if($verifKey instanceof WSError) {
+            $this->handleError($verifKey);
+        } else {
+            $result = $this->deleteUserHelper($user_id_field_name, $user_id_value);
+            if($result instanceof WSError) {
+                $this->handleError($result);
+            }
+        }
+    }
 
-	/**
-	 * Deletes multiple users
-	 *
-	 * @param string API secret key
-	 * @param array Array of users with elements of the form array('user_id_field_name' => 'name_of_field', 'user_id_value' => 'value')
-	 * @return array Array with elements like array('user_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 DeleteUsers($secret_key, $users) {
-		$verifKey = $this->verifyKey($secret_key);
-		if($verifKey instanceof WSError) {
-			$this->handleError($verifKey);
-		} else {
-			$results = array();
-			foreach($users as $user) {
-				$result_tmp = array();
-				$result_op = $this->deleteUserHelper($user['user_id_field_name'], $user['user_id_value']);
-				$result_tmp['user_id_value'] = $user['user_id_value'];
-				if($result_op instanceof WSError) {
-					// Return the error in the results
-					$result_tmp['result'] = $result_op->toArray();
-				} else {
-					$result_tmp['result'] = $this->getSuccessfulResult();
-				}
-				$results[] = $result_tmp;
-			}
-			return $results;
-		}
-	}
+    /**
+     * Deletes multiple users
+     *
+     * @param string API secret key
+     * @param array Array of users with elements of the form array('user_id_field_name' => 'name_of_field', 'user_id_value' => 'value')
+     * @return array Array with elements like array('user_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 DeleteUsers($secret_key, $users) {
+        $verifKey = $this->verifyKey($secret_key);
+        if($verifKey instanceof WSError) {
+            $this->handleError($verifKey);
+        } else {
+            $results = array();
+            foreach($users as $user) {
+                $result_tmp = array();
+                $result_op = $this->deleteUserHelper($user['user_id_field_name'], $user['user_id_value']);
+                $result_tmp['user_id_value'] = $user['user_id_value'];
+                if($result_op instanceof WSError) {
+                    // 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 user (helper method)
-	 *
-	 * @param string User first name
-	 * @param string User last name
-	 * @param int User status
-	 * @param string Login name
-	 * @param string Password (encrypted or not)
-	 * @param string Encrypt method. Leave blank if you are passing the password in clear text, set to the encrypt method used to encrypt the password otherwise. Remember
-	 * to include the salt in the extra fields if you are encrypting the password
-	 * @param string User id field name. Use "chamilo_user_id" as the field name if you want to use the internal user_id
-	 * @param string User id value. Leave blank if you are using the internal user_id
-	 * @param int Visibility.
-	 * @param string User email.
-	 * @param string Language.
-	 * @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').
-	 * @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()) {
+    /**
+     * Creates a user (helper method)
+     *
+     * @param string User first name
+     * @param string User last name
+     * @param int User status
+     * @param string Login name
+     * @param string Password (encrypted or not)
+     * @param string Encrypt method. Leave blank if you are passing the password in clear text, set to the encrypt method used to encrypt the password otherwise. Remember
+     * to include the salt in the extra fields if you are encrypting the password
+     * @param string User id field name. Use "chamilo_user_id" as the field name if you want to use the internal user_id
+     * @param string User id value. Leave blank if you are using the internal user_id
+     * @param int Visibility.
+     * @param string User email.
+     * @param string Language.
+     * @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').
+     * @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()) {
         global $api_failureList;
-		// Add the original user id field name and value to the extra fields if needed
-		$extras_associative = array();
-		if($user_id_field_name != "chamilo_user_id") {
-			$extras_associative[$user_id_field_name] = $user_id_value;
-		}
+        // Add the original user id field name and value to the extra fields if needed
+        $extras_associative = array();
+        if($user_id_field_name != "chamilo_user_id") {
+            $extras_associative[$user_id_field_name] = $user_id_value;
+        }
                 if (!empty($extras)) {
                     foreach($extras as $extra) {
                         $extras_associative[$extra['field_name']] = $extra['field_value'];
                     }
                 }
-		$result = UserManager::create_user($firstname, $lastname, $status, $email, $login, $password, '', $language, $phone, '', PLATFORM_AUTH_SOURCE, $expiration_date, $visibility, 0, $extras_associative, $encrypt_method);
-		if (!$result) {
-			$failure = $api_failureList[0];
-			if($failure == 'login-pass already taken') {
-				return new WSError(102, 'This username is already taken');
-			} else if($failure == 'encrypt_method invalid') {
-				return new WSError(103, 'The encryption of the password is invalid');
-			} else {
-				return new WSError(104, 'There was an error creating the user');
-			}
-		} else {
-			return $result;
-		}
-	}
+        $result = UserManager::create_user($firstname, $lastname, $status, $email, $login, $password, '', $language, $phone, '', PLATFORM_AUTH_SOURCE, $expiration_date, $visibility, 0, $extras_associative, $encrypt_method);
+        if (!$result) {
+            $failure = $api_failureList[0];
+            if($failure == 'login-pass already taken') {
+                return new WSError(102, 'This username is already taken');
+            } else if($failure == 'encrypt_method invalid') {
+                return new WSError(103, 'The encryption of the password is invalid');
+            } else {
+                return new WSError(104, 'There was an error creating the user');
+            }
+        } else {
+            return $result;
+        }
+    }
 
-	/**
-	 * Creates a user
-	 *
-	 * @param string API secret key
-	 * @param string User first name
-	 * @param string User last name
-	 * @param int User status
-	 * @param string Login name
-	 * @param string Password (encrypted or not)
-	 * @param string Encrypt method. Leave blank if you are passing the password in clear text, set to the encrypt method used to encrypt the password otherwise. Remember
-	 * to include the salt in the extra fields if you are encrypting the password
-	 * @param string User id field name. Use "chamilo_user_id" as the field name if you want to use the internal user_id
-	 * @param string User id value. Leave blank if you are using the internal user_id
-	 * @param int Visibility. Set by default to 1
-	 * @param string User email. Set by default to an empty string
-	 * @param string Language. Set by default to english
-	 * @param string Phone. Set by default to an empty string
-	 * @param string Expiration date. Set to null by default
-	 * @param array Extra fields. An array with elements of the form ('field_name' => 'name_of_the_field', 'field_value' => 'value_of_the_field'). Set to an empty array by default
-	 * @return int New user id generated by the system
-	 */
-	public function CreateUser($secret_key, $firstname, $lastname, $status, $login, $password, $encrypt_method, $user_id_field_name, $user_id_value, $visibility = 1, $email = '', $language = 'english', $phone = '', $expiration_date = '0000-00-00 00:00:00', $extras = array()) {
-		// First, verify the secret key
-		$verifKey = $this->verifyKey($secret_key);
-		if($verifKey instanceof WSError) {
-			$this->handleError($verifKey);
-		} else {
-			$result = $this->createUserHelper($firstname, $lastname, $status, $login, $password, $encrypt_method, $user_id_field_name, $user_id_value, $visibility, $email, $language, $phone, $expiration_date, $extras);
-			if($result instanceof WSError) {
-				$this->handleError($result);
-			} else {
-				return $result;
-			}
-		}
-	}
+    /**
+     * Creates a user
+     *
+     * @param string API secret key
+     * @param string User first name
+     * @param string User last name
+     * @param int User status
+     * @param string Login name
+     * @param string Password (encrypted or not)
+     * @param string Encrypt method. Leave blank if you are passing the password in clear text, set to the encrypt method used to encrypt the password otherwise. Remember
+     * to include the salt in the extra fields if you are encrypting the password
+     * @param string User id field name. Use "chamilo_user_id" as the field name if you want to use the internal user_id
+     * @param string User id value. Leave blank if you are using the internal user_id
+     * @param int Visibility. Set by default to 1
+     * @param string User email. Set by default to an empty string
+     * @param string Language. Set by default to english
+     * @param string Phone. Set by default to an empty string
+     * @param string Expiration date. Set to null by default
+     * @param array Extra fields. An array with elements of the form ('field_name' => 'name_of_the_field', 'field_value' => 'value_of_the_field'). Set to an empty array by default
+     * @return int New user id generated by the system
+     */
+    public function CreateUser($secret_key, $firstname, $lastname, $status, $login, $password, $encrypt_method, $user_id_field_name, $user_id_value, $visibility = 1, $email = '', $language = 'english', $phone = '', $expiration_date = '0000-00-00 00:00:00', $extras = array()) {
+        // First, verify the secret key
+        $verifKey = $this->verifyKey($secret_key);
+        if($verifKey instanceof WSError) {
+            $this->handleError($verifKey);
+        } else {
+            $result = $this->createUserHelper($firstname, $lastname, $status, $login, $password, $encrypt_method, $user_id_field_name, $user_id_value, $visibility, $email, $language, $phone, $expiration_date, $extras);
+            if($result instanceof WSError) {
+                $this->handleError($result);
+            } else {
+                return $result;
+            }
+        }
+    }
 
-	/**
-	 * Creates multiple users
-	 *
-	 * @param string API secret key
-	 * @param array Users array. Each member of this array must follow the structure imposed by the CreateUser method
-	 * @return array Array with elements of the form array('user_id_value' => 'original value sent', 'user_id_generated' => 'value_generated', 'result' => array('code' => 0, 'message' => 'Operation was successful'))
-	 */
-	public function CreateUsers($secret_key, $users) {
-		$verifKey = $this->verifyKey($secret_key);
-		if($verifKey instanceof WSError) {
-			$this->handleError($verifKey);
-		} else {
-			$results = array();
-			foreach($users as $user) {
-				$result_tmp = array();
+    /**
+     * Creates multiple users
+     *
+     * @param string API secret key
+     * @param array Users array. Each member of this array must follow the structure imposed by the CreateUser method
+     * @return array Array with elements of the form array('user_id_value' => 'original value sent', 'user_id_generated' => 'value_generated', 'result' => array('code' => 0, 'message' => 'Operation was successful'))
+     */
+    public function CreateUsers($secret_key, $users) {
+        $verifKey = $this->verifyKey($secret_key);
+        if($verifKey instanceof WSError) {
+            $this->handleError($verifKey);
+        } else {
+            $results = array();
+            foreach($users as $user) {
+                $result_tmp = array();
                 // re-initialize variables just in case
                 $firstname = $lastname = $status = $login = $password = $encrypt_method = $user_id_field_name = $user_id_value = $visibility = $email = $language = $phone = $expiration_date = $extras = null;
-				extract($user);
-				$result = $this->createUserHelper($firstname, $lastname, $status, $login, $password, $encrypt_method, $user_id_field_name, $user_id_value, $visibility, $email, $language, $phone, $expiration_date, $extras);
-				if($result instanceof WSError) {
-					$result_tmp['result'] = $result->toArray();
-					$result_tmp['user_id_value'] = $user_id_value;
-					$result_tmp['user_id_generated'] = 0;
-				} else {
-					$result_tmp['result'] = $this->getSuccessfulResult();
-					$result_tmp['user_id_value'] = $user_id_value;
-					$result_tmp['user_id_generated'] = $result;
-				}
-				$results[] = $result_tmp;
-			}
-			return $results;
-		}
-	}
+                extract($user);
+                $result = $this->createUserHelper($firstname, $lastname, $status, $login, $password, $encrypt_method, $user_id_field_name, $user_id_value, $visibility, $email, $language, $phone, $expiration_date, $extras);
+                if($result instanceof WSError) {
+                    $result_tmp['result'] = $result->toArray();
+                    $result_tmp['user_id_value'] = $user_id_value;
+                    $result_tmp['user_id_generated'] = 0;
+                } else {
+                    $result_tmp['result'] = $this->getSuccessfulResult();
+                    $result_tmp['user_id_value'] = $user_id_value;
+                    $result_tmp['user_id_generated'] = $result;
+                }
+                $results[] = $result_tmp;
+            }
+            return $results;
+        }
+    }
 
-	/**
-	 * Edits user info (helper method)
-	 *
-	 * @param string User id field name. Use "chamilo_user_id" in order to use internal system id
-	 * @param string User id value
-	 * @param string First name
-	 * @param string Last name
-	 * @param int User status
-	 * @param string Login name
-	 * @param string Password. Leave blank if you don't want to update it
-	 * @param string Encrypt method
-	 * @param string User email
-	 * @param string Language. Set by default to english
-	 * @param string Phone. Set by default to an empty string
-	 * @param string Expiration date. Set to null by default
-	 * @param array Extra fields. An array with elements of the form ('field_name' => 'name_of_the_field', 'field_value' => 'value_of_the_field'). Leave empty if you don't want to update
-	 * @return mixed True if user was successfully updated, WSError otherwise
-	 */
-	protected function editUserHelper(
-		$user_id_field_name,
-		$user_id_value,
-		$firstname,
-		$lastname,
-		$status,
-		$loginname,
-		$password,
-		$encrypt_method,
-		$email,
-		$language,
-		$phone,
-		$expiration_date,
-		$extras
-	) {
+    /**
+     * Edits user info (helper method)
+     *
+     * @param string User id field name. Use "chamilo_user_id" in order to use internal system id
+     * @param string User id value
+     * @param string First name
+     * @param string Last name
+     * @param int User status
+     * @param string Login name
+     * @param string Password. Leave blank if you don't want to update it
+     * @param string Encrypt method
+     * @param string User email
+     * @param string Language. Set by default to english
+     * @param string Phone. Set by default to an empty string
+     * @param string Expiration date. Set to null by default
+     * @param array Extra fields. An array with elements of the form ('field_name' => 'name_of_the_field', 'field_value' => 'value_of_the_field'). Leave empty if you don't want to update
+     * @return mixed True if user was successfully updated, WSError otherwise
+     */
+    protected function editUserHelper(
+        $user_id_field_name,
+        $user_id_value,
+        $firstname,
+        $lastname,
+        $status,
+        $loginname,
+        $password,
+        $encrypt_method,
+        $email,
+        $language,
+        $phone,
+        $expiration_date,
+        $extras
+    ) {
         global $api_failureList;
-		$user_id = $this->getUserId($user_id_field_name, $user_id_value);
-		if($user_id instanceof WSError) {
-			return $user_id;
-		} else {
-			if($password == '') {
-				$password = null;
-			}
-			$user_info = api_get_user_info($user_id);
-			if (count($extras) == 0) {
-				$extras = null;
-			}
+        $user_id = $this->getUserId($user_id_field_name, $user_id_value);
+        if($user_id instanceof WSError) {
+            return $user_id;
+        } else {
+            if($password == '') {
+                $password = null;
+            }
+            $user_info = api_get_user_info($user_id);
+            if (count($extras) == 0) {
+                $extras = null;
+            }
 
-			$result = UserManager::update_user(
-				$user_id,
-				$firstname,
-				$lastname,
-				$loginname,
-				$password,
-				PLATFORM_AUTH_SOURCE,
-				$email,
-				$status,
-				'',
-				$phone,
-				$user_info['picture_uri'],
-				$expiration_date,
-				$user_info['active'],
-				null,
-				$user_info['hr_dept_id'],
-				$extras,
-				$encrypt_method
-			);
-			if (!$result) {
-				$failure = $api_failureList[0];
-				if($failure == 'encrypt_method invalid') {
-					return new WSError(103, 'The encryption of the password is invalid');
-				} else {
-					return new WSError(105, 'There was an error updating the user');
-				}
-			} else {
-				return $result;
-			}
-		}
-	}
+            $result = UserManager::update_user(
+                $user_id,
+                $firstname,
+                $lastname,
+                $loginname,
+                $password,
+                PLATFORM_AUTH_SOURCE,
+                $email,
+                $status,
+                '',
+                $phone,
+                $user_info['picture_uri'],
+                $expiration_date,
+                $user_info['active'],
+                null,
+                $user_info['hr_dept_id'],
+                $extras,
+                $encrypt_method
+            );
+            if (!$result) {
+                $failure = $api_failureList[0];
+                if($failure == 'encrypt_method invalid') {
+                    return new WSError(103, 'The encryption of the password is invalid');
+                } else {
+                    return new WSError(105, 'There was an error updating the user');
+                }
+            } else {
+                return $result;
+            }
+        }
+    }
 
-	/**
-	 * Edits user info
-	 *
-	 * @param string API secret key
-	 * @param string User id field name. Use "chamilo_user_id" in order to use internal system id
-	 * @param string User id value
-	 * @param string First name
-	 * @param string Last name
-	 * @param int User status
-	 * @param string Login name
-	 * @param string Password. Leave blank if you don't want to update it
-	 * @param string Encrypt method
-	 * @param string User email
-	 * @param string Language. Set by default to english
-	 * @param string Phone. Set by default to an empty string
-	 * @param string Expiration date. Set to null by default
-	 * @param array Extra fields. An array with elements of the form ('field_name' => 'name_of_the_field', 'field_value' => 'value_of_the_field'). Leave empty if you don't want to update
-	 */
-	public function EditUser($secret_key, $user_id_field_name, $user_id_value, $firstname, $lastname, $status, $loginname, $password, $encrypt_method, $email, $language, $phone, $expiration_date, $extras) {
-		// First, verify the secret key
-		$verifKey = $this->verifyKey($secret_key);
-		if($verifKey instanceof WSError) {
-			$this->handleError($verifKey);
-		} else {
+    /**
+     * Edits user info
+     *
+     * @param string API secret key
+     * @param string User id field name. Use "chamilo_user_id" in order to use internal system id
+     * @param string User id value
+     * @param string First name
+     * @param string Last name
+     * @param int User status
+     * @param string Login name
+     * @param string Password. Leave blank if you don't want to update it
+     * @param string Encrypt method
+     * @param string User email
+     * @param string Language. Set by default to english
+     * @param string Phone. Set by default to an empty string
+     * @param string Expiration date. Set to null by default
+     * @param array Extra fields. An array with elements of the form ('field_name' => 'name_of_the_field', 'field_value' => 'value_of_the_field'). Leave empty if you don't want to update
+     */
+    public function EditUser($secret_key, $user_id_field_name, $user_id_value, $firstname, $lastname, $status, $loginname, $password, $encrypt_method, $email, $language, $phone, $expiration_date, $extras) {
+        // First, verify the secret key
+        $verifKey = $this->verifyKey($secret_key);
+        if($verifKey instanceof WSError) {
+            $this->handleError($verifKey);
+        } else {
 
-			$extras_associative = array();
-			if (!empty($extras)) {
-				foreach($extras as $extra) {
-					$extras_associative[$extra['field_name']] = $extra['field_value'];
-				}
-			}
+            $extras_associative = array();
+            if (!empty($extras)) {
+                foreach($extras as $extra) {
+                    $extras_associative[$extra['field_name']] = $extra['field_value'];
+                }
+            }
 
-			$result = $this->editUserHelper($user_id_field_name, $user_id_value, $firstname, $lastname, $status, $loginname, $password, $encrypt_method, $email, $language, $phone, $expiration_date, $extras_associative);
-			if($result instanceof WSError) {
-				$this->handleError($result);
-			}
-		}
-	}
+            $result = $this->editUserHelper($user_id_field_name, $user_id_value, $firstname, $lastname, $status, $loginname, $password, $encrypt_method, $email, $language, $phone, $expiration_date, $extras_associative);
+            if($result instanceof WSError) {
+                $this->handleError($result);
+            }
+        }
+    }
 
-	/**
-	 * Edits multiple users
-	 *
-	 * @param string API secret key
-	 * @param array Users array. Each member of this array must follow the structure imposed by the EditUser method
-	 * @return array Array with elements like array('user_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 EditUsers($secret_key, $users) {
-		$verifKey = $this->verifyKey($secret_key);
-		if($verifKey instanceof WSError) {
-			$this->handleError($verifKey);
-		} else {
-			$results = array();
-			foreach($users as $user) {
-				$result_tmp = array();
+    /**
+     * Edits multiple users
+     *
+     * @param string API secret key
+     * @param array Users array. Each member of this array must follow the structure imposed by the EditUser method
+     * @return array Array with elements like array('user_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 EditUsers($secret_key, $users) {
+        $verifKey = $this->verifyKey($secret_key);
+        if($verifKey instanceof WSError) {
+            $this->handleError($verifKey);
+        } else {
+            $results = array();
+            foreach($users as $user) {
+                $result_tmp = array();
                 // re-initialize variables just in case
                 $user_id_field_name = $user_id_value = $firstname = $lastname = $status = $loginname = $password = $encrypt_method = $email = $language = $phone = $expiration_date = $extras = null;
-				extract($user);
-				$result_op = $this->editUserHelper($user_id_field_name, $user_id_value, $firstname, $lastname, $status, $loginname, $password, $encrypt_method, $email, $language, $phone, $expiration_date, $extras);
-				$result_tmp['user_id_value'] = $user['user_id_value'];
-				if($result_op instanceof WSError) {
-					// Return the error in the results
-					$result_tmp['result'] = $result_op->toArray();
-				} else {
-					$result_tmp['result'] = $this->getSuccessfulResult();
-				}
-				$results[] = $result_tmp;
-			}
-			return $results;
-		}
-	}
+                extract($user);
+                $result_op = $this->editUserHelper($user_id_field_name, $user_id_value, $firstname, $lastname, $status, $loginname, $password, $encrypt_method, $email, $language, $phone, $expiration_date, $extras);
+                $result_tmp['user_id_value'] = $user['user_id_value'];
+                if($result_op instanceof WSError) {
+                    // Return the error in the results
+                    $result_tmp['result'] = $result_op->toArray();
+                } else {
+                    $result_tmp['result'] = $this->getSuccessfulResult();
+                }
+                $results[] = $result_tmp;
+            }
+            return $results;
+        }
+    }
 }

Spacing +36 added lines, -36 removed lines

@@ -20,12 +20,12 @@ 
 	 */
 	protected function changeUserActiveState($user_id_field_name, $user_id_value, $state) {
 		$user_id = $this->getUserId($user_id_field_name, $user_id_value);
-		if($user_id instanceof WSError) {
+		if ($user_id instanceof WSError) {
 			return $user_id;
 		} else {
-			if($state == 0) {
+			if ($state == 0) {
 				UserManager::disable($user_id);
-			} else if($state == 1) {
+			} else if ($state == 1) {
 				UserManager::enable($user_id);
 			}
 		}
@@ -40,11 +40,11 @@ 
 	 */
 	protected function changeUsersActiveState($users, $state) {
 		$results = array();
-		foreach($users as $user) {
+		foreach ($users as $user) {
 			$result_tmp = array();
 			$result_op = $this->changeUserActiveState($user['user_id_field_name'], $user['user_id_value'], $state);
 			$result_tmp['user_id_value'] = $user['user_id_value'];
-			if($result_op instanceof WSError) {
+			if ($result_op instanceof WSError) {
 				// Return the error in the results
 				$result_tmp['result'] = $result_op->toArray();
 			} else {
@@ -64,12 +64,12 @@ 
 	 */
 	public function DisableUser($secret_key, $user_id_field_name, $user_id_value) {
 		$verifKey = $this->verifyKey($secret_key);
-		if($verifKey instanceof WSError) {
+		if ($verifKey instanceof WSError) {
 			// Let the implementation handle it
 			$this->handleError($verifKey);
 		} else {
 			$result = $this->changeUserActiveState($user_id_field_name, $user_id_value, 0);
-			if($result instanceof WSError) {
+			if ($result instanceof WSError) {
 				$this->handleError($result);
 			}
 		}
@@ -85,7 +85,7 @@ 
 	 */
 	public function DisableUsers($secret_key, $users) {
 		$verifKey = $this->verifyKey($secret_key);
-		if($verifKey instanceof WSError) {
+		if ($verifKey instanceof WSError) {
 			// Let the implementation handle it
 			$this->handleError($verifKey);
 		} else {
@@ -102,11 +102,11 @@ 
 	 */
 	public function EnableUser($secret_key, $user_id_field_name, $user_id_value) {
 		$verifKey = $this->verifyKey($secret_key);
-		if($verifKey instanceof WSError) {
+		if ($verifKey instanceof WSError) {
 			$this->handleError($verifKey);
 		} else {
 			$result = $this->changeUserActiveState($user_id_field_name, $user_id_value, 1);
-			if($result instanceof WSError) {
+			if ($result instanceof WSError) {
 				$this->handleError($result);
 			}
 		}
@@ -122,7 +122,7 @@ 
 	 */
 	public function EnableUsers($secret_key, $users) {
 		$verifKey = $this->verifyKey($secret_key);
-		if($verifKey instanceof WSError) {
+		if ($verifKey instanceof WSError) {
 			// Let the implementation handle it
 			$this->handleError($verifKey);
 		} else {
@@ -139,10 +139,10 @@ 
 	 */
 	protected function deleteUserHelper($user_id_field_name, $user_id_value) {
 		$user_id = $this->getUserId($user_id_field_name, $user_id_value);
-		if($user_id instanceof WSError) {
+		if ($user_id instanceof WSError) {
 			return $user_id;
 		} else {
-			if(!UserManager::delete_user($user_id)) {
+			if (!UserManager::delete_user($user_id)) {
 				return new WSError(101, "There was a problem while deleting this user");
 			} else {
 				return true;
@@ -159,11 +159,11 @@ 
 	 */
 	public function DeleteUser($secret_key, $user_id_field_name, $user_id_value) {
 		$verifKey = $this->verifyKey($secret_key);
-		if($verifKey instanceof WSError) {
+		if ($verifKey instanceof WSError) {
 			$this->handleError($verifKey);
 		} else {
 			$result = $this->deleteUserHelper($user_id_field_name, $user_id_value);
-			if($result instanceof WSError) {
+			if ($result instanceof WSError) {
 				$this->handleError($result);
 			}
 		}
@@ -179,15 +179,15 @@ 
 	 */
 	public function DeleteUsers($secret_key, $users) {
 		$verifKey = $this->verifyKey($secret_key);
-		if($verifKey instanceof WSError) {
+		if ($verifKey instanceof WSError) {
 			$this->handleError($verifKey);
 		} else {
 			$results = array();
-			foreach($users as $user) {
+			foreach ($users as $user) {
 				$result_tmp = array();
 				$result_op = $this->deleteUserHelper($user['user_id_field_name'], $user['user_id_value']);
 				$result_tmp['user_id_value'] = $user['user_id_value'];
-				if($result_op instanceof WSError) {
+				if ($result_op instanceof WSError) {
 					// Return the error in the results
 					$result_tmp['result'] = $result_op->toArray();
 				} else {
@@ -223,20 +223,20 @@ 
         global $api_failureList;
 		// Add the original user id field name and value to the extra fields if needed
 		$extras_associative = array();
-		if($user_id_field_name != "chamilo_user_id") {
+		if ($user_id_field_name != "chamilo_user_id") {
 			$extras_associative[$user_id_field_name] = $user_id_value;
 		}
                 if (!empty($extras)) {
-                    foreach($extras as $extra) {
+                    foreach ($extras as $extra) {
                         $extras_associative[$extra['field_name']] = $extra['field_value'];
                     }
                 }
 		$result = UserManager::create_user($firstname, $lastname, $status, $email, $login, $password, '', $language, $phone, '', PLATFORM_AUTH_SOURCE, $expiration_date, $visibility, 0, $extras_associative, $encrypt_method);
 		if (!$result) {
 			$failure = $api_failureList[0];
-			if($failure == 'login-pass already taken') {
+			if ($failure == 'login-pass already taken') {
 				return new WSError(102, 'This username is already taken');
-			} else if($failure == 'encrypt_method invalid') {
+			} else if ($failure == 'encrypt_method invalid') {
 				return new WSError(103, 'The encryption of the password is invalid');
 			} else {
 				return new WSError(104, 'There was an error creating the user');
@@ -270,11 +270,11 @@ 
 	public function CreateUser($secret_key, $firstname, $lastname, $status, $login, $password, $encrypt_method, $user_id_field_name, $user_id_value, $visibility = 1, $email = '', $language = 'english', $phone = '', $expiration_date = '0000-00-00 00:00:00', $extras = array()) {
 		// First, verify the secret key
 		$verifKey = $this->verifyKey($secret_key);
-		if($verifKey instanceof WSError) {
+		if ($verifKey instanceof WSError) {
 			$this->handleError($verifKey);
 		} else {
 			$result = $this->createUserHelper($firstname, $lastname, $status, $login, $password, $encrypt_method, $user_id_field_name, $user_id_value, $visibility, $email, $language, $phone, $expiration_date, $extras);
-			if($result instanceof WSError) {
+			if ($result instanceof WSError) {
 				$this->handleError($result);
 			} else {
 				return $result;
@@ -291,17 +291,17 @@ 
 	 */
 	public function CreateUsers($secret_key, $users) {
 		$verifKey = $this->verifyKey($secret_key);
-		if($verifKey instanceof WSError) {
+		if ($verifKey instanceof WSError) {
 			$this->handleError($verifKey);
 		} else {
 			$results = array();
-			foreach($users as $user) {
+			foreach ($users as $user) {
 				$result_tmp = array();
                 // re-initialize variables just in case
                 $firstname = $lastname = $status = $login = $password = $encrypt_method = $user_id_field_name = $user_id_value = $visibility = $email = $language = $phone = $expiration_date = $extras = null;
 				extract($user);
 				$result = $this->createUserHelper($firstname, $lastname, $status, $login, $password, $encrypt_method, $user_id_field_name, $user_id_value, $visibility, $email, $language, $phone, $expiration_date, $extras);
-				if($result instanceof WSError) {
+				if ($result instanceof WSError) {
 					$result_tmp['result'] = $result->toArray();
 					$result_tmp['user_id_value'] = $user_id_value;
 					$result_tmp['user_id_generated'] = 0;
@@ -351,10 +351,10 @@ 
 	) {
         global $api_failureList;
 		$user_id = $this->getUserId($user_id_field_name, $user_id_value);
-		if($user_id instanceof WSError) {
+		if ($user_id instanceof WSError) {
 			return $user_id;
 		} else {
-			if($password == '') {
+			if ($password == '') {
 				$password = null;
 			}
 			$user_info = api_get_user_info($user_id);
@@ -383,7 +383,7 @@ 
 			);
 			if (!$result) {
 				$failure = $api_failureList[0];
-				if($failure == 'encrypt_method invalid') {
+				if ($failure == 'encrypt_method invalid') {
 					return new WSError(103, 'The encryption of the password is invalid');
 				} else {
 					return new WSError(105, 'There was an error updating the user');
@@ -415,19 +415,19 @@ 
 	public function EditUser($secret_key, $user_id_field_name, $user_id_value, $firstname, $lastname, $status, $loginname, $password, $encrypt_method, $email, $language, $phone, $expiration_date, $extras) {
 		// First, verify the secret key
 		$verifKey = $this->verifyKey($secret_key);
-		if($verifKey instanceof WSError) {
+		if ($verifKey instanceof WSError) {
 			$this->handleError($verifKey);
 		} else {
 
 			$extras_associative = array();
 			if (!empty($extras)) {
-				foreach($extras as $extra) {
+				foreach ($extras as $extra) {
 					$extras_associative[$extra['field_name']] = $extra['field_value'];
 				}
 			}
 
 			$result = $this->editUserHelper($user_id_field_name, $user_id_value, $firstname, $lastname, $status, $loginname, $password, $encrypt_method, $email, $language, $phone, $expiration_date, $extras_associative);
-			if($result instanceof WSError) {
+			if ($result instanceof WSError) {
 				$this->handleError($result);
 			}
 		}
@@ -443,18 +443,18 @@ 
 	 */
 	public function EditUsers($secret_key, $users) {
 		$verifKey = $this->verifyKey($secret_key);
-		if($verifKey instanceof WSError) {
+		if ($verifKey instanceof WSError) {
 			$this->handleError($verifKey);
 		} else {
 			$results = array();
-			foreach($users as $user) {
+			foreach ($users as $user) {
 				$result_tmp = array();
                 // re-initialize variables just in case
                 $user_id_field_name = $user_id_value = $firstname = $lastname = $status = $loginname = $password = $encrypt_method = $email = $language = $phone = $expiration_date = $extras = null;
 				extract($user);
 				$result_op = $this->editUserHelper($user_id_field_name, $user_id_value, $firstname, $lastname, $status, $loginname, $password, $encrypt_method, $email, $language, $phone, $expiration_date, $extras);
 				$result_tmp['user_id_value'] = $user['user_id_value'];
-				if($result_op instanceof WSError) {
+				if ($result_op instanceof WSError) {
 					// Return the error in the results
 					$result_tmp['result'] = $result_op->toArray();
 				} else {

main/work/downloadfolder.inc.php

Doc Comments +1 added lines, -1 removed lines

@@ -212,7 +212,7 @@
  * @param array $arr1 first array
  * @param array $arr2 second array
  *
- * @return array difference between the two arrays
+ * @return string difference between the two arrays
  */
 function diff($arr1, $arr2)
 {

Indentation +1 added lines, -1 removed lines

@@ -62,7 +62,7 @@
 
 if (api_is_allowed_to_edit() || api_is_coach()) {
     //Search for all files that are not deleted => visibility != 2
-   $sql = "SELECT DISTINCT
+    $sql = "SELECT DISTINCT
                 url,
                 title,
                 description,

Spacing +3 added lines, -3 removed lines

@@ -9,7 +9,7 @@ 
 
 $work_id = $_GET['id'];
 require_once '../inc/global.inc.php';
-$current_course_tool  = TOOL_STUDENTPUBLICATION;
+$current_course_tool = TOOL_STUDENTPUBLICATION;
 $_course = api_get_course_info();
 
 // Protection
@@ -178,10 +178,10 @@ 
 if (!empty($files)) {
     $fileName = api_replace_dangerous_char($work_data['title']);
     // Logging
-    Event::event_download($fileName .'.zip (folder)');
+    Event::event_download($fileName.'.zip (folder)');
 
     //start download of created file
-    $name = $fileName .'.zip';
+    $name = $fileName.'.zip';
     if (Security::check_abs_path($temp_zip_file, api_get_path(SYS_ARCHIVE_PATH))) {
         DocumentManager::file_send_for_download($temp_zip_file, true, $name);
         @unlink($temp_zip_file);

main/work/work.lib.php

Doc Comments +18 added lines, -17 removed lines

@@ -158,7 +158,7 @@ 
  * Create a group of select from a date
  * @param FormValidator $form
  * @param string $prefix
- * @return array
+ * @return HTML_QuickForm_element[]
  */
 function create_group_date_select($form, $prefix = '')
 {
@@ -752,7 +752,7 @@ 
  * @author Bert Vanderkimpen
  * @author Yannick Warnier <ywarnier@beeznest.org> Adaptation for work tool
  * @param   string $base_work_dir Base work dir (.../work)
- * @param   string $desiredDirName complete path of the desired name
+ * @param   string $desired_dir_name complete path of the desired name
  *
  * @return  string actual directory name if it succeeds, boolean false otherwise
  */
@@ -774,7 +774,7 @@ 
 /**
  * Delete a work-tool directory
  * @param   int  $id work directory id to delete
- * @return  integer -1 on error
+ * @return  boolean|null -1 on error
  */
 function deleteDirWork($id)
 {
@@ -917,7 +917,7 @@ 
  * Update the url of a dir in the student_publication table
  * @param  array $work_data work original data
  * @param  string $newPath Example: "folder1"
- * @return bool
+ * @return boolean|null
  */
 function updateDirName($work_data, $newPath)
 {
@@ -974,6 +974,7 @@ 
 /**
  * Transform an all directory structure (only directories) in an array
  * @param   string path of the directory
+ * @param string $directory
  * @return  array the directory structure into an array
  * @author  Julio Montoya Dokeos
  * @version April 2008
@@ -1043,7 +1044,7 @@ 
  * @param   string the path of the directory
  * @param   boolean true if we want the total quantity of files
  * include in others child directories, false only  files in the directory
- * @return  array the first element is an integer with the number of files
+ * @return  integer[] the first element is an integer with the number of files
  * in the folder, the second element is the number of directories
  * @author  Julio Montoya
  * @version April 2008
@@ -2319,7 +2320,7 @@ 
 }
 
 /**
- * @param $name
+ * @param string $name
  * @param $values
  * @param string $checked
  * @return string
@@ -2845,7 +2846,7 @@ 
  * @param int $userId
  * @param int $workId
  * @param int $courseId
- * @return bool
+ * @return boolean|null
  */
 function allowOnlySubscribedUser($userId, $workId, $courseId)
 {
@@ -2963,7 +2964,7 @@ 
 /**
  * Get total score from a work list
  * @param $workList
- * @return int|null
+ * @return integer
  */
 function getTotalWorkScore($workList)
 {
@@ -2979,7 +2980,7 @@ 
  * Get comment count from a work list (docs sent by students)
  * @param array $workList
  * @param array $courseInfo
- * @return int|null
+ * @return integer
  */
 function getTotalWorkComment($workList, $courseInfo = array())
 {
@@ -3122,6 +3123,7 @@ 
  * @param int $parentId
  * @param array $courseInfo
  * @param int $sessionId
+ * @param integer $userId
  * @return int
  */
 function getLastWorkStudentFromParentByUser(
@@ -3738,12 +3740,11 @@ 
 
 /**
  * Creates a new task (directory) in the assignment tool
- * @param array $params
  * @param int $user_id
  * @param array $courseInfo
  * @param int $group_id
  * @param int $session_id
- * @return bool|int
+ * @return string|false
  * @note $params can have the following elements, but should at least have the 2 first ones: (
  *       'new_dir' => 'some-name',
  *       'description' => 'some-desc',
@@ -4239,7 +4240,7 @@ 
 }
 
 /**
- * @return array
+ * @return string[]
  */
 function getUploadDocumentType()
 {
@@ -4611,7 +4612,7 @@ 
  * @param int Session ID
  * @param $correction
  *
- * @return array|bool
+ * @return boolean
  */
 function getFileContents($id, $course_info, $sessionId = 0, $correction = false)
 {
@@ -4729,7 +4730,7 @@ 
  * @param int $userId
  * @param array $courseInfo
  * @param string $format
- * @return bool
+ * @return false|null
  */
 function exportAllWork($userId, $courseInfo, $format = 'pdf')
 {
@@ -4777,7 +4778,7 @@ 
  * @param array $courseInfo
  * @param int $sessionId
  * @param string $format
- * @return bool
+ * @return false|null
  */
 function exportAllStudentWorkFromPublication(
     $workId,
@@ -4915,7 +4916,7 @@ 
  * Downloads all user files per user
  * @param int $userId
  * @param array $courseInfo
- * @return bool
+ * @return false|null
  */
 function downloadAllFilesPerUser($userId, $courseInfo)
 {
@@ -5029,7 +5030,7 @@ 
 /**
  * @param array $courseInfo
  * @param int $workId
- * @return bool
+ * @return boolean|null
  */
 function protectWork($courseInfo, $workId)
 {

Spacing +84 added lines, -84 removed lines

@@ -35,27 +35,27 @@ 
 
     if (!empty($id)) {
         $display_output .= '<a href="'.api_get_self().'?'.api_get_cidreq().'&origin='.$origin.'&gradebook='.$gradebook.'&id='.$my_back_id.'">'.
-            Display::return_icon('back.png', get_lang('BackToWorksList'),'',ICON_SIZE_MEDIUM).'</a>';
+            Display::return_icon('back.png', get_lang('BackToWorksList'), '', ICON_SIZE_MEDIUM).'</a>';
     }
 
     if (api_is_allowed_to_edit(null, true) && $origin != 'learnpath') {
         // Create dir
         if (empty($id)) {
             $display_output .= '<a href="'.api_get_self().'?'.api_get_cidreq().'&action=create_dir&origin='.$origin.'&gradebook='.$gradebook.'">';
-            $display_output .= Display::return_icon('new_work.png', get_lang('CreateAssignment'),'',ICON_SIZE_MEDIUM).'</a>';
+            $display_output .= Display::return_icon('new_work.png', get_lang('CreateAssignment'), '', ICON_SIZE_MEDIUM).'</a>';
         }
         if (empty($id)) {
             // Options
             $display_output .= '<a href="'.api_get_self().'?'.api_get_cidreq().'&action=settings&origin='.$origin.'&gradebook='.$gradebook.'">';
-            $display_output .= Display::return_icon('settings.png', get_lang('EditToolOptions'),'',ICON_SIZE_MEDIUM).'</a>';
+            $display_output .= Display::return_icon('settings.png', get_lang('EditToolOptions'), '', ICON_SIZE_MEDIUM).'</a>';
         }
-        $display_output .= '<a id="open-view-list" href="#">' . Display::return_icon('listwork.png', get_lang('ViewStudents'),'',ICON_SIZE_MEDIUM) . '</a>';
+        $display_output .= '<a id="open-view-list" href="#">'.Display::return_icon('listwork.png', get_lang('ViewStudents'), '', ICON_SIZE_MEDIUM).'</a>';
 
     }
 
     if (api_is_allowed_to_edit(null, true) && $origin != 'learnpath' && api_is_allowed_to_session_edit(false, true)) {
         // Delete all files
-        if (api_get_setting('permanently_remove_deleted_files') == 'true'){
+        if (api_get_setting('permanently_remove_deleted_files') == 'true') {
             $message = get_lang('ConfirmYourChoiceDeleteAllfiles');
         } else {
             $message = get_lang('ConfirmYourChoice');
@@ -112,7 +112,7 @@ 
  */
 function two_digits($number)
 {
-    $number = (int)$number;
+    $number = (int) $number;
     return ($number < 10) ? '0'.$number : $number;
 }
 
@@ -547,11 +547,11 @@ 
     );
 
     $columnModel = array(
-        array('name'=>'type', 'index'=>'type', 'width'=>'30',   'align'=>'center', 'sortable' => 'false'),
-        array('name'=>'title', 'index'=>'title', 'width'=>'250',   'align'=>'left'),
-        array('name'=>'expires_on', 'index'=>'expires_on', 'width'=>'80',  'align'=>'center', 'sortable'=>'false'),
-        array('name'=>'feedback', 'index'=>'feedback', 'width'=>'80',  'align'=>'center'),
-        array('name'=>'last_upload', 'index'=>'feedback', 'width'=>'125',  'align'=>'center'),
+        array('name'=>'type', 'index'=>'type', 'width'=>'30', 'align'=>'center', 'sortable' => 'false'),
+        array('name'=>'title', 'index'=>'title', 'width'=>'250', 'align'=>'left'),
+        array('name'=>'expires_on', 'index'=>'expires_on', 'width'=>'80', 'align'=>'center', 'sortable'=>'false'),
+        array('name'=>'feedback', 'index'=>'feedback', 'width'=>'80', 'align'=>'center'),
+        array('name'=>'last_upload', 'index'=>'feedback', 'width'=>'125', 'align'=>'center'),
     );
 
     if ($courseInfo['show_score'] == 0) {
@@ -588,10 +588,10 @@ 
 {
     $columnModel = array(
         array('name'=>'type', 'index'=>'type', 'width'=>'35', 'align'=>'center', 'sortable' => 'false'),
-        array('name'=>'title', 'index'=>'title',  'width'=>'300',   'align'=>'left', 'wrap_cell' => "true"),
-        array('name'=>'sent_date', 'index'=>'sent_date', 'width'=>'125',  'align'=>'center'),
-        array('name'=>'expires_on', 'index'=>'expires_on', 'width'=>'125',  'align'=>'center'),
-        array('name'=>'amount', 'index'=>'end_on', 'width'=>'110',  'align'=>'center'),
+        array('name'=>'title', 'index'=>'title', 'width'=>'300', 'align'=>'left', 'wrap_cell' => "true"),
+        array('name'=>'sent_date', 'index'=>'sent_date', 'width'=>'125', 'align'=>'center'),
+        array('name'=>'expires_on', 'index'=>'expires_on', 'width'=>'125', 'align'=>'center'),
+        array('name'=>'amount', 'index'=>'end_on', 'width'=>'110', 'align'=>'center'),
         array('name'=>'actions', 'index'=>'actions', 'width'=>'110', 'align'=>'left', 'sortable'=>'false')
     );
 
@@ -793,7 +793,7 @@ 
         return false;
     }
 
-    $base_work_dir = api_get_path(SYS_COURSE_PATH) .$_course['path'].'/work';
+    $base_work_dir = api_get_path(SYS_COURSE_PATH).$_course['path'].'/work';
     $work_data_url = $base_work_dir.$work_data['url'];
     $check = Security::check_abs_path($work_data_url.'/', $base_work_dir.'/');
 
@@ -863,7 +863,7 @@ 
 function get_work_path($id)
 {
     $table = Database::get_course_table(TABLE_STUDENT_PUBLICATION);
-    $course_id  = api_get_course_int_id();
+    $course_id = api_get_course_int_id();
     $sql = 'SELECT url FROM '.$table.'
             WHERE c_id = '.$course_id.' AND id='.intval($id);
     $res = Database::query($sql);
@@ -984,9 +984,9 @@ 
     if ($handle = @opendir($directory)) {
         while (false !== ($file = readdir($handle))) {
             if ($file != '.' && $file != '..') {
-                if (is_dir($directory. '/' . $file)) {
-                    $array_items = array_merge($array_items, directory_to_array($directory. '/' . $file));
-                    $file = $directory . '/' . $file;
+                if (is_dir($directory.'/'.$file)) {
+                    $array_items = array_merge($array_items, directory_to_array($directory.'/'.$file));
+                    $file = $directory.'/'.$file;
                     $array_items[] = preg_replace("/\/\//si", '/', $file);
                 }
             }
@@ -1018,7 +1018,7 @@ 
 
     $work_table = Database :: get_course_table(TABLE_STUDENT_PUBLICATION);
 
-    for($i = 0; $i < count($only_dir); $i++) {
+    for ($i = 0; $i < count($only_dir); $i++) {
         $url = $only_dir[$i];
 
         $params = [
@@ -1058,7 +1058,7 @@ 
             if (is_dir($path_dir.'/'.$entry)) {
                 $count_dir++;
                 if ($recurse) {
-                    $count += count_dir($path_dir . '/' . $entry, $recurse);
+                    $count += count_dir($path_dir.'/'.$entry, $recurse);
                 }
             } else {
                 $count++;
@@ -1323,11 +1323,11 @@ 
         $courseInfo
     );
 
-    if (!in_array($direction, array('asc','desc'))) {
+    if (!in_array($direction, array('asc', 'desc'))) {
         $direction = 'desc';
     }
     if (!empty($where_condition)) {
-        $where_condition = ' AND ' . $where_condition;
+        $where_condition = ' AND '.$where_condition;
     }
 
     $column = !empty($column) ? Database::escape_string($column) : 'sent_date';
@@ -1470,7 +1470,7 @@ 
         $direction = 'desc';
     }
     if (!empty($where_condition)) {
-        $where_condition = ' AND ' . $where_condition;
+        $where_condition = ' AND '.$where_condition;
     }
 
     $column = !empty($column) ? Database::escape_string($column) : 'sent_date';
@@ -1527,7 +1527,7 @@ 
             );
 
             $work['amount'] = Display::label(
-                $countUniqueAttempts . '/' .
+                $countUniqueAttempts.'/'.
                 $totalUsers,
                 'success'
             );
@@ -1576,7 +1576,7 @@ 
                         array(),
                         ICON_SIZE_SMALL
                     ),
-                    api_get_path(WEB_CODE_PATH) . 'work/downloadfolder.inc.php?id=' . $workId . '&' . api_get_cidreq()
+                    api_get_path(WEB_CODE_PATH).'work/downloadfolder.inc.php?id='.$workId.'&'.api_get_cidreq()
                 );
             } else {
                 $downloadLink = Display::url(
@@ -1660,7 +1660,7 @@ 
     $userCondition = " AND u.user_id = $studentId ";
     $sessionCondition = " AND w.session_id = $sessionId ";
     $workCondition = " AND w_rel.work_id = $workId";
-    $workParentCondition  = " AND w.parent_id = $workId";
+    $workParentCondition = " AND w.parent_id = $workId";
 
     $sql = "(
                 $select1 FROM $userTable u
@@ -1768,7 +1768,7 @@ 
         }
 
         if ($allowEdition && !empty($itemId)) {
-            $deleteLink  = Display::url($deleteIcon, $urlDelete.'&item_id='.$itemId.'&id='.$workId);
+            $deleteLink = Display::url($deleteIcon, $urlDelete.'&item_id='.$itemId.'&id='.$workId);
         } else {
             $deleteLink = null;
         }
@@ -1849,7 +1849,7 @@ 
     $start = intval($start);
     $limit = intval($limit);
 
-    if (!in_array($direction, array('asc','desc'))) {
+    if (!in_array($direction, array('asc', 'desc'))) {
         $direction = 'desc';
     }
 
@@ -1917,13 +1917,13 @@ 
         $work_assignment = get_work_assignment_by_id($work_id);
 
         if (!empty($studentId)) {
-            $where_condition.= " AND u.user_id = ".intval($studentId);
+            $where_condition .= " AND u.user_id = ".intval($studentId);
         }
 
         $sql = " $select
                 FROM $work_condition  $user_condition
                 WHERE $extra_conditions $where_condition $condition_session
-                    AND u.status != " . INVITEE . "
+                    AND u.status != ".INVITEE."
                 ORDER BY $column $direction";
 
         if (!empty($start) && !empty($limit)) {
@@ -1980,7 +1980,7 @@ 
                     $qualification_string = Display::label('-');
                 } else {
                     $label = 'info';
-                    $relativeScore = $work['qualification']/$work_data['qualification'];
+                    $relativeScore = $work['qualification'] / $work_data['qualification'];
                     if ($relativeScore < 0.5) {
                         $label = 'important';
                     } elseif ($relativeScore < 0.75) {
@@ -2036,10 +2036,10 @@ 
                 // If URL is present then there's a file to download keep BC.
                 if ($work['contains_file'] || !empty($work['url'])) {
                     $link_to_download = '<a href="'.$url.'download.php?id='.$item_id.'&'.api_get_cidreq().'">'.
-                        Display::return_icon('save.png', get_lang('Save'),array(), ICON_SIZE_SMALL).'</a> ';
+                        Display::return_icon('save.png', get_lang('Save'), array(), ICON_SIZE_SMALL).'</a> ';
                 }
 
-                $send_to = Portfolio::share('work', $work['id'],  array('style' => 'white-space:nowrap;'));
+                $send_to = Portfolio::share('work', $work['id'], array('style' => 'white-space:nowrap;'));
 
                 $feedback = null;
                 $count = getWorkCommentCount($item_id, $course_info);
@@ -2058,7 +2058,7 @@ 
                 $work_date = api_convert_and_format_date($work['sent_date']);
 
                 $work['sent_date_from_db'] = $work['sent_date'];
-                $work['sent_date'] = '<div class="date-time">' . date_to_str_ago(api_get_local_time($work['sent_date'])) . ' ' . $add_string . ' ' . $work_date . '</div>';
+                $work['sent_date'] = '<div class="date-time">'.date_to_str_ago(api_get_local_time($work['sent_date'])).' '.$add_string.' '.$work_date.'</div>';
 
                 // Actions.
                 $correction = '';
@@ -2076,8 +2076,8 @@ 
                         Display::return_icon('default.png', get_lang('View'), array(), ICON_SIZE_SMALL).'</a> ';
 
                     if ($unoconv && empty($work['contains_file'])) {
-                        $action .=  '<a href="'.$url.'work_list_all.php?'.api_get_cidreq().'&id='.$work_id.'&action=export_to_doc&item_id='.$item_id.'" title="'.get_lang('ExportToDoc').'" >'.
-                            Display::return_icon('export_doc.png', get_lang('ExportToDoc'),array(), ICON_SIZE_SMALL).'</a> ';
+                        $action .= '<a href="'.$url.'work_list_all.php?'.api_get_cidreq().'&id='.$work_id.'&action=export_to_doc&item_id='.$item_id.'" title="'.get_lang('ExportToDoc').'" >'.
+                            Display::return_icon('export_doc.png', get_lang('ExportToDoc'), array(), ICON_SIZE_SMALL).'</a> ';
                     }
 
                     $correction = '
@@ -2120,9 +2120,9 @@ 
 
                     if ($locked) {
                         if ($qualification_exists) {
-                            $action .= Display::return_icon('rate_work_na.png', get_lang('CorrectAndRate'),array(), ICON_SIZE_SMALL);
+                            $action .= Display::return_icon('rate_work_na.png', get_lang('CorrectAndRate'), array(), ICON_SIZE_SMALL);
                         } else {
-                            $action .= Display::return_icon('edit_na.png', get_lang('Comment'),array(), ICON_SIZE_SMALL);
+                            $action .= Display::return_icon('edit_na.png', get_lang('Comment'), array(), ICON_SIZE_SMALL);
                         }
                     } else {
                         if ($qualification_exists) {
@@ -2136,45 +2136,45 @@ 
 
                     if ($work['contains_file']) {
                         if ($locked) {
-                            $action .= Display::return_icon('move_na.png', get_lang('Move'),array(), ICON_SIZE_SMALL);
+                            $action .= Display::return_icon('move_na.png', get_lang('Move'), array(), ICON_SIZE_SMALL);
                         } else {
                             $action .= '<a href="'.$url.'work.php?'.api_get_cidreq().'&action=move&item_id='.$item_id.'&id='.$work['parent_id'].'" title="'.get_lang('Move').'">'.
-                                Display::return_icon('move.png', get_lang('Move'),array(), ICON_SIZE_SMALL).'</a>';
+                                Display::return_icon('move.png', get_lang('Move'), array(), ICON_SIZE_SMALL).'</a>';
                         }
                     }
 
                     if ($work['accepted'] == '1') {
                         $action .= '<a href="'.$url.'work_list_all.php?'.api_get_cidreq().'&id='.$work_id.'&action=make_invisible&item_id='.$item_id.'" title="'.get_lang('Invisible').'" >'.
-                            Display::return_icon('visible.png', get_lang('Invisible'),array(), ICON_SIZE_SMALL).'</a>';
+                            Display::return_icon('visible.png', get_lang('Invisible'), array(), ICON_SIZE_SMALL).'</a>';
                     } else {
                         $action .= '<a href="'.$url.'work_list_all.php?'.api_get_cidreq().'&id='.$work_id.'&action=make_visible&item_id='.$item_id.'" title="'.get_lang('Visible').'" >'.
-                            Display::return_icon('invisible.png', get_lang('Visible'),array(), ICON_SIZE_SMALL).'</a> ';
+                            Display::return_icon('invisible.png', get_lang('Visible'), array(), ICON_SIZE_SMALL).'</a> ';
                     }
 
                     if ($locked) {
                         $action .= Display::return_icon('delete_na.png', get_lang('Delete'), '', ICON_SIZE_SMALL);
                     } else {
-                        $action .= '<a href="'.$url.'work_list_all.php?'.api_get_cidreq().'&id='.$work_id.'&action=delete&item_id='.$item_id.'" onclick="javascript:if(!confirm('."'".addslashes(api_htmlentities(get_lang('ConfirmYourChoice'),ENT_QUOTES))."'".')) return false;" title="'.get_lang('Delete').'" >'.
-                            Display::return_icon('delete.png', get_lang('Delete'),'',ICON_SIZE_SMALL).'</a>';
+                        $action .= '<a href="'.$url.'work_list_all.php?'.api_get_cidreq().'&id='.$work_id.'&action=delete&item_id='.$item_id.'" onclick="javascript:if(!confirm('."'".addslashes(api_htmlentities(get_lang('ConfirmYourChoice'), ENT_QUOTES))."'".')) return false;" title="'.get_lang('Delete').'" >'.
+                            Display::return_icon('delete.png', get_lang('Delete'), '', ICON_SIZE_SMALL).'</a>';
                     }
                 } elseif ($is_author && (empty($work['qualificator_id']) || $work['qualificator_id'] == 0)) {
                     $action .= '<a href="'.$url.'view.php?'.api_get_cidreq().'&id='.$item_id.'" title="'.get_lang('View').'">'.
-                        Display::return_icon('default.png', get_lang('View'),array(), ICON_SIZE_SMALL).'</a>';
+                        Display::return_icon('default.png', get_lang('View'), array(), ICON_SIZE_SMALL).'</a>';
 
                     if (api_get_course_setting('student_delete_own_publication') == 1) {
                         if (api_is_allowed_to_session_edit(false, true)) {
                             $action .= '<a href="'.$url.'edit.php?'.api_get_cidreq().'&item_id='.$item_id.'&id='.$work['parent_id'].'" title="'.get_lang('Modify').'">'.
-                                Display::return_icon('edit.png', get_lang('Comment'),array(), ICON_SIZE_SMALL).'</a>';
+                                Display::return_icon('edit.png', get_lang('Comment'), array(), ICON_SIZE_SMALL).'</a>';
                         }
-                        $action .= ' <a href="'.$url.'work_list.php?'.api_get_cidreq().'&action=delete&item_id='.$item_id.'&id='.$work['parent_id'].'" onclick="javascript:if(!confirm('."'".addslashes(api_htmlentities(get_lang('ConfirmYourChoice'),ENT_QUOTES))."'".')) return false;" title="'.get_lang('Delete').'"  >'.
-                            Display::return_icon('delete.png',get_lang('Delete'),'',ICON_SIZE_SMALL).'</a>';
+                        $action .= ' <a href="'.$url.'work_list.php?'.api_get_cidreq().'&action=delete&item_id='.$item_id.'&id='.$work['parent_id'].'" onclick="javascript:if(!confirm('."'".addslashes(api_htmlentities(get_lang('ConfirmYourChoice'), ENT_QUOTES))."'".')) return false;" title="'.get_lang('Delete').'"  >'.
+                            Display::return_icon('delete.png', get_lang('Delete'), '', ICON_SIZE_SMALL).'</a>';
                     } else {
-                        $action .= Display::return_icon('edit_na.png', get_lang('Modify'),array(), ICON_SIZE_SMALL);
+                        $action .= Display::return_icon('edit_na.png', get_lang('Modify'), array(), ICON_SIZE_SMALL);
                     }
                 } else {
                     $action .= '<a href="'.$url.'view.php?'.api_get_cidreq().'&id='.$item_id.'" title="'.get_lang('View').'">'.
-                        Display::return_icon('default.png', get_lang('View'),array(), ICON_SIZE_SMALL).'</a>';
-                    $action .= Display::return_icon('edit_na.png', get_lang('Modify'),array(), ICON_SIZE_SMALL);
+                        Display::return_icon('default.png', get_lang('View'), array(), ICON_SIZE_SMALL).'</a>';
+                    $action .= Display::return_icon('edit_na.png', get_lang('Modify'), array(), ICON_SIZE_SMALL);
                 }
 
                 // Status.
@@ -2207,7 +2207,7 @@ 
     $_course = api_get_course_info();
     $task_id = $task_data['id'];
     $task_title = !empty($task_data['title']) ? $task_data['title'] : basename($task_data['url']);
-    $subject = '[' . api_get_setting('siteName') . '] ';
+    $subject = '['.api_get_setting('siteName').'] ';
 
     // The body can be as long as you wish, and any combination of text and variables
     $content = get_lang('ReminderToSubmitPendingTask')."\n".get_lang('CourseName').' : '.$_course['name']."\n";
@@ -2218,7 +2218,7 @@ 
     $mails_sent_to = array();
     foreach ($list_users as $user) {
         $name_user = api_get_person_name($user[1], $user[0], null, PERSON_NAME_EMAIL_ADDRESS);
-        $dear_line = get_lang('Dear')." ".api_get_person_name($user[1], $user[0]) .", \n\n";
+        $dear_line = get_lang('Dear')." ".api_get_person_name($user[1], $user[0]).", \n\n";
         $body      = $dear_line.$content;
         MessageManager::send_message($user[3], $subject, $body);
         $mails_sent_to[] = $name_user;
@@ -2247,22 +2247,22 @@ 
     } else {
         $students = CourseManager::get_student_list_from_course_code($courseCode, true, $sessionId);
     }
-    $emailsubject = '[' . api_get_setting('siteName') . '] '.get_lang('HomeworkCreated');
+    $emailsubject = '['.api_get_setting('siteName').'] '.get_lang('HomeworkCreated');
     $currentUser = api_get_user_info(api_get_user_id());
     if (!empty($students)) {
-        foreach($students as $student) {
+        foreach ($students as $student) {
             $user_info = api_get_user_info($student["user_id"]);
-            if(!empty($user_info["mail"])) {
+            if (!empty($user_info["mail"])) {
                 $name_user = api_get_person_name(
                     $user_info["firstname"],
                     $user_info["lastname"],
                     null,
                     PERSON_NAME_EMAIL_ADDRESS
                 );
-                $link = api_get_path(WEB_CODE_PATH) . 'work/work_list_all.php?' . api_get_cidreq() . '&id=' . $workId;
+                $link = api_get_path(WEB_CODE_PATH).'work/work_list_all.php?'.api_get_cidreq().'&id='.$workId;
                 $emailbody = get_lang('Dear')." ".$name_user.",\n\n";
                 $emailbody .= get_lang('HomeworkHasBeenCreatedForTheCourse')." ".$courseCode.". "."\n\n".
-                    '<a href="'. $link . '">' . get_lang('PleaseCheckHomeworkPage') . '</a>';
+                    '<a href="'.$link.'">'.get_lang('PleaseCheckHomeworkPage').'</a>';
                 $emailbody .= "\n\n".api_get_person_name($currentUser["firstname"], $currentUser["lastname"]);
 
                 $additionalParameters = array(
@@ -2304,7 +2304,7 @@ 
     $url = Database::escape_string($url);
     $sql = "SELECT id FROM $work_table WHERE url='$url'";
     $result = Database::query($sql);
-    if (Database::num_rows($result)> 0) {
+    if (Database::num_rows($result) > 0) {
         $row = Database::fetch_row($result);
         if (empty($row)) {
             return false;
@@ -2326,7 +2326,7 @@ 
 {
     $output = '<select name="'.$name.'" id="'.$name.'">';
     foreach ($values as $key => $value) {
-        $output .= '<option value="'.$key.'" '.(($checked==$key) ? 'selected="selected"' : '').'>'.$value.'</option>';
+        $output .= '<option value="'.$key.'" '.(($checked == $key) ? 'selected="selected"' : '').'>'.$value.'</option>';
     }
     $output .= '</select>';
     return $output;
@@ -2340,9 +2340,9 @@ 
  */
 function make_checkbox($name, $checked = '', $label = null)
 {
-    $check = '<input id ="'.$name.'" type="checkbox" value="1" name="'.$name.'" '.((!empty($checked))?'checked="checked"':'').'/>';
+    $check = '<input id ="'.$name.'" type="checkbox" value="1" name="'.$name.'" '.((!empty($checked)) ? 'checked="checked"' : '').'/>';
     if (!empty($label)) {
-        $check .="<label for ='$name'>$label</label>";
+        $check .= "<label for ='$name'>$label</label>";
     }
     return $check;
 }
@@ -2496,7 +2496,7 @@ 
     }
 
     if (!empty($studentId)) {
-        $sql_users.= " AND u.user_id = ".intval($studentId);
+        $sql_users .= " AND u.user_id = ".intval($studentId);
     }
 
     $group_id = api_get_group_id();
@@ -2506,7 +2506,7 @@ 
     if ($group_id) {
         $group_user_list = GroupManager::get_subscribed_users($group_id);
         if (!empty($group_user_list)) {
-            foreach($group_user_list as $group_user) {
+            foreach ($group_user_list as $group_user) {
                 $new_group_user_list[] = $group_user['user_id'];
             }
         }
@@ -2927,7 +2927,7 @@ 
 function getWorkComments($work)
 {
     $commentTable = Database::get_course_table(TABLE_STUDENT_PUBLICATION_ASSIGNMENT_COMMENT);
-    $userTable= Database::get_main_table(TABLE_MAIN_USER);
+    $userTable = Database::get_main_table(TABLE_MAIN_USER);
 
     $courseId = intval($work['c_id']);
     $workId = intval($work['id']);
@@ -3610,7 +3610,7 @@ 
             null,
             PERSON_NAME_EMAIL_ADDRESS
         );
-        $subject = "[" . api_get_setting('siteName') . "] ".get_lang('SendMailBody')."\n ".get_lang('CourseName').": ".$courseInfo['name']."  ";
+        $subject = "[".api_get_setting('siteName')."] ".get_lang('SendMailBody')."\n ".get_lang('CourseName').": ".$courseInfo['name']."  ";
         foreach ($user_list as $user_data) {
             $to_user_id = $user_data['user_id'];
             $user_info = api_get_user_info($to_user_id);
@@ -3659,7 +3659,7 @@ 
 
     $title = $values['title'];
     $description = $values['description'];
-    $contains_file = isset($values['contains_file']) && !empty($values['contains_file']) ? intval($values['contains_file']): 0;
+    $contains_file = isset($values['contains_file']) && !empty($values['contains_file']) ? intval($values['contains_file']) : 0;
 
     $saveWork = true;
     $message = null;
@@ -4026,8 +4026,8 @@ 
                     LINK_STUDENTPUBLICATION,
                     $workId,
                     $params['new_dir'],
-                    (float)$params['weight'],
-                    (float)$params['qualification'],
+                    (float) $params['weight'],
+                    (float) $params['qualification'],
                     $params['description'],
                     1,
                     api_get_session_id()
@@ -4287,15 +4287,15 @@ 
     // changing the tool setting: is a student allowed to delete his/her own document
 
     // counting the number of occurrences of this setting (if 0 => add, if 1 => update)
-    $query = "SELECT * FROM " . $table_course_setting . "
+    $query = "SELECT * FROM ".$table_course_setting."
               WHERE c_id = $courseId AND variable = 'student_delete_own_publication'";
 
     $result = Database::query($query);
     $number_of_setting = Database::num_rows($result);
 
     if ($number_of_setting == 1) {
-        $query = "UPDATE " . $table_course_setting . " SET
-                  value='" . Database::escape_string($studentDeleteOwnPublication) . "'
+        $query = "UPDATE ".$table_course_setting." SET
+                  value='" . Database::escape_string($studentDeleteOwnPublication)."'
                   WHERE variable = 'student_delete_own_publication' AND c_id = $courseId";
         Database::query($query);
     } else {
@@ -4334,9 +4334,9 @@ 
     $work_table = Database :: get_course_table(TABLE_STUDENT_PUBLICATION);
     $item_id = intval($item_id);
     $course_id = $course_info['real_id'];
-    $sql = "UPDATE  " . $work_table . "
+    $sql = "UPDATE  ".$work_table."
             SET accepted = 0
-            WHERE c_id = $course_id AND id = '" . $item_id . "'";
+            WHERE c_id = $course_id AND id = '".$item_id."'";
     Database::query($sql);
     api_item_property_update(
         $course_info,
@@ -4480,7 +4480,7 @@ 
                 $courseCode,
                 $sessionId,
                 $limitString,
-                $orderBy ,
+                $orderBy,
                 STUDENT,
                 $getCount
             );
@@ -4817,8 +4817,8 @@ 
     if (!empty($sessionId)) {
         $sessionInfo = api_get_session_info($sessionId);
         if (!empty($sessionInfo)) {
-            $header .= ' - ' . $sessionInfo['name'];
-            $header .= '<br />' . $sessionInfo['description'];
+            $header .= ' - '.$sessionInfo['name'];
+            $header .= '<br />'.$sessionInfo['description'];
             $teachers = SessionManager::getCoachesByCourseSessionToString(
                 $sessionId,
                 $courseInfo['real_id']
@@ -4834,12 +4834,12 @@ 
     $expiresOn = null;
 
     if (!empty($assignment) && isset($assignment['expires_on'])) {
-        $content .= '<br /><strong>' . get_lang('ExpirationDate') . '</strong>: ' . api_get_local_time($assignment['expires_on']);
+        $content .= '<br /><strong>'.get_lang('ExpirationDate').'</strong>: '.api_get_local_time($assignment['expires_on']);
         $expiresOn = api_get_local_time($assignment['expires_on']);
     }
 
     if (!empty($workData['description'])) {
-        $content .= '<br /><strong>' . get_lang('Description') . '</strong>: ' . $workData['description'];
+        $content .= '<br /><strong>'.get_lang('Description').'</strong>: '.$workData['description'];
     }
 
     $workList = get_work_user_list(null, null, null, null, $workId);
@@ -4860,7 +4860,7 @@ 
                 );
 
                 $column = 0;
-                foreach($headers as $header) {
+                foreach ($headers as $header) {
                     $table->setHeaderContents(0, $column, $header);
                     $column++;
                 }
@@ -4908,7 +4908,7 @@ 
 
                 if (!empty($content)) {
                     $params = array(
-                        'filename' => $workData['title'] . '_' . api_get_local_time(),
+                        'filename' => $workData['title'].'_'.api_get_local_time(),
                         'pdf_title' => api_replace_dangerous_char($workData['title']),
                         'course_code' => $courseInfo['code'],
                         'add_signatures' => false
@@ -4939,7 +4939,7 @@ 
     $tempZipFile = api_get_path(SYS_ARCHIVE_PATH).api_get_unique_id().".zip";
     $coursePath = api_get_path(SYS_COURSE_PATH).$courseInfo['path'].'/work/';
 
-    $zip  = new PclZip($tempZipFile);
+    $zip = new PclZip($tempZipFile);
 
     $workPerUser = getWorkPerUser($userId);
 

plugin/advanced_subscription/src/AdvancedSubscriptionPlugin.php

Doc Comments +7 added lines, -7 removed lines

@@ -370,7 +370,7 @@ 
      * Register a user into a queue for a session
      * @param $userId
      * @param $sessionId
-     * @return bool|int
+     * @return false|string
      */
     public function addToQueue($userId, $sessionId)
     {
@@ -396,7 +396,7 @@ 
      * Register message with type and status
      * @param $mailId
      * @param $userId
-     * @param $sessionId
+     * @param integer $sessionId
      * @return bool|int
      */
     public function saveLastMessage($mailId, $userId, $sessionId)
@@ -509,7 +509,7 @@ 
 
     /**
      * Check if session is open for subscription
-     * @param $sessionId
+     * @param integer $sessionId
      * @param string $fieldVariable
      * @return bool
      */
@@ -531,8 +531,8 @@ 
 
     /**
      * Check if user is in the session's target group based on its area
-     * @param $userId
-     * @param $sessionId
+     * @param integer $userId
+     * @param integer $sessionId
      * @param string $userFieldVariable
      * @param string $sessionFieldVariable
      * @return bool
@@ -1002,7 +1002,7 @@ 
     /**
      * Return the session details data from a session ID (including the extra
      * fields used for the advanced subscription mechanism)
-     * @param $sessionId
+     * @param integer $sessionId
      * @return bool|mixed
      */
     public function getSessionDetails($sessionId)
@@ -1102,7 +1102,7 @@ 
 
     /**
      * Return the url to go to session
-     * @param $sessionId
+     * @param integer $sessionId
      *
      * @return string
      */

Indentation +1 added lines, -1 removed lines

@@ -1069,7 +1069,7 @@
      */
     public function getStatusMessage($status, $isAble = true)
     {
-	$message = '';
+    $message = '';
         switch ($status) {
             case ADVANCED_SUBSCRIPTION_QUEUE_STATUS_NO_QUEUE:
                 if ($isAble) {

Spacing +41 added lines, -42 removed lines

@@ -106,15 +106,15 @@ 
     {
         $advancedSubscriptionQueueTable = Database::get_main_table(TABLE_ADVANCED_SUBSCRIPTION_QUEUE);
 
-        $sql = "CREATE TABLE IF NOT EXISTS $advancedSubscriptionQueueTable (" .
-            "id int UNSIGNED NOT NULL AUTO_INCREMENT, " .
-            "session_id int UNSIGNED NOT NULL, " .
-            "user_id int UNSIGNED NOT NULL, " .
-            "status int UNSIGNED NOT NULL, " .
-            "last_message_id int UNSIGNED NOT NULL, " .
-            "created_at datetime NOT NULL, " .
-            "updated_at datetime NULL, " .
-            "PRIMARY KEY PK_advanced_subscription_queue (id), " .
+        $sql = "CREATE TABLE IF NOT EXISTS $advancedSubscriptionQueueTable (".
+            "id int UNSIGNED NOT NULL AUTO_INCREMENT, ".
+            "session_id int UNSIGNED NOT NULL, ".
+            "user_id int UNSIGNED NOT NULL, ".
+            "status int UNSIGNED NOT NULL, ".
+            "last_message_id int UNSIGNED NOT NULL, ".
+            "created_at datetime NOT NULL, ".
+            "updated_at datetime NULL, ".
+            "PRIMARY KEY PK_advanced_subscription_queue (id), ".
             "UNIQUE KEY UK_advanced_subscription_queue (user_id, session_id)); ";
         Database::query($sql);
     }
@@ -265,11 +265,10 @@ 
         $now = new DateTime(api_get_utc_datetime());
         $newYearDate = $plugin->get('course_session_credit_year_start_date');
         $newYearDate = !empty($newYearDate) ?
-            new \DateTime($newYearDate . $now->format('/Y')) :
-            $now;
+            new \DateTime($newYearDate.$now->format('/Y')) : $now;
         $extra = new ExtraFieldValue('session');
-        $joinSessionTable = Database::get_main_table(TABLE_MAIN_SESSION_USER) . ' su INNER JOIN ' .
-            Database::get_main_table(TABLE_MAIN_SESSION) . ' s ON s.id = su.session_id';
+        $joinSessionTable = Database::get_main_table(TABLE_MAIN_SESSION_USER).' su INNER JOIN '.
+            Database::get_main_table(TABLE_MAIN_SESSION).' s ON s.id = su.session_id';
         $whereSessionParams = 'su.relation_type = ? AND s.access_start_date >= ? AND su.user_id = ?';
         $whereSessionParamsValues = array(
             0,
@@ -734,14 +733,14 @@ 
                     $tpl->assign('termsContent', $termsAndConditions);
                     $termsAndConditions = $tpl->fetch('/advanced_subscription/views/terms_and_conditions_to_pdf.tpl');
                     $pdf = new PDF();
-                    $filename = 'terms' . sha1(rand(0,99999));
+                    $filename = 'terms'.sha1(rand(0, 99999));
                     $pdf->content_to_pdf($termsAndConditions, null, $filename, null, 'F');
                     $fileAttachments['file'][] = array(
-                        'name' => $filename . '.pdf',
-                        'application/pdf' => $filename . '.pdf',
-                        'tmp_name' => api_get_path(SYS_ARCHIVE_PATH) . $filename . '.pdf',
+                        'name' => $filename.'.pdf',
+                        'application/pdf' => $filename.'.pdf',
+                        'tmp_name' => api_get_path(SYS_ARCHIVE_PATH).$filename.'.pdf',
                         'error' => UPLOAD_ERR_OK,
-                        'size' => filesize(api_get_path(SYS_ARCHIVE_PATH) . $filename . '.pdf'),
+                        'size' => filesize(api_get_path(SYS_ARCHIVE_PATH).$filename.'.pdf'),
                     );
                     $fileAttachments['comments'][] = get_lang('TermsAndConditions');
                 }
@@ -1032,7 +1031,7 @@ 
 
             $mergedArray = array_merge(array($sessionId), array_keys($fields));
 
-            $sql = "SELECT * FROM " . Database::get_main_table(TABLE_EXTRA_FIELD_VALUES) ."
+            $sql = "SELECT * FROM ".Database::get_main_table(TABLE_EXTRA_FIELD_VALUES)."
                     WHERE item_id = %d AND field_id IN (%d, %d, %d, %d, %d, %d, %d)";
             $sql = vsprintf($sql, $mergedArray);
             $sessionFieldValueList = Database::query($sql);
@@ -1048,10 +1047,10 @@ 
             $sessionArray['description'] = SessionManager::getDescriptionFromSessionId($sessionId);
 
             if (isset($sessionArray['brochure'])) {
-                $sessionArray['brochure'] = api_get_path(WEB_UPLOAD_PATH) . $sessionArray['brochure'];
+                $sessionArray['brochure'] = api_get_path(WEB_UPLOAD_PATH).$sessionArray['brochure'];
             }
             if (isset($sessionArray['banner'])) {
-                $sessionArray['banner'] = api_get_path(WEB_UPLOAD_PATH) . $sessionArray['banner'];
+                $sessionArray['banner'] = api_get_path(WEB_UPLOAD_PATH).$sessionArray['banner'];
             }
 
             return $sessionArray;
@@ -1108,7 +1107,7 @@ 
      */
     public function getSessionUrl($sessionId)
     {
-        $url = api_get_path(WEB_CODE_PATH) . 'session/?session_id=' . intval($sessionId);
+        $url = api_get_path(WEB_CODE_PATH).'session/?session_id='.intval($sessionId);
 
         return $url;
     }
@@ -1157,16 +1156,16 @@ 
      */
     public function getQueueUrl($params)
     {
-        $url = api_get_path(WEB_PLUGIN_PATH) . 'advanced_subscription/ajax/advanced_subscription.ajax.php?' .
-            'a=' . Security::remove_XSS($params['action']) . '&' .
-            's=' . intval($params['sessionId']) . '&' .
-            'current_user_id=' . intval($params['currentUserId']) . '&' .
-            'e=' . intval($params['newStatus']) . '&' .
-            'u=' . intval($params['studentUserId']) . '&' .
-            'q=' . intval($params['queueId']) . '&' .
-            'is_connected=' . 1 . '&' .
-            'profile_completed=' . intval($params['profile_completed']) . '&' .
-            'v=' . $this->generateHash($params);
+        $url = api_get_path(WEB_PLUGIN_PATH).'advanced_subscription/ajax/advanced_subscription.ajax.php?'.
+            'a='.Security::remove_XSS($params['action']).'&'.
+            's='.intval($params['sessionId']).'&'.
+            'current_user_id='.intval($params['currentUserId']).'&'.
+            'e='.intval($params['newStatus']).'&'.
+            'u='.intval($params['studentUserId']).'&'.
+            'q='.intval($params['queueId']).'&'.
+            'is_connected='.1.'&'.
+            'profile_completed='.intval($params['profile_completed']).'&'.
+            'v='.$this->generateHash($params);
 
         return $url;
     }
@@ -1219,7 +1218,7 @@ 
         }
         $queueTable = Database::get_main_table(TABLE_ADVANCED_SUBSCRIPTION_QUEUE);
         $userTable = Database::get_main_table(TABLE_MAIN_USER);
-        $userJoinTable = $queueTable . ' q INNER JOIN ' . $userTable . ' u ON q.user_id = u.user_id';
+        $userJoinTable = $queueTable.' q INNER JOIN '.$userTable.' u ON q.user_id = u.user_id';
         $where = array(
             'where' => array(
                 'q.session_id = ?' => array(
@@ -1232,7 +1231,7 @@ 
         $students = Database::select($select, $userJoinTable, $where);
         foreach ($students as &$student) {
             $status = intval($student['status']);
-            switch($status) {
+            switch ($status) {
                 case ADVANCED_SUBSCRIPTION_QUEUE_STATUS_NO_QUEUE:
                 case ADVANCED_SUBSCRIPTION_QUEUE_STATUS_START:
                     $student['validation'] = '';
@@ -1246,7 +1245,7 @@ 
                     $student['validation'] = 'Yes';
                     break;
                 default:
-                    error_log(__FILE__ . ' ' . __FUNCTION__ . ' Student status no detected');
+                    error_log(__FILE__.' '.__FUNCTION__.' Student status no detected');
             }
         }
         $return = array(
@@ -1295,7 +1294,7 @@ 
         $dataPrepared['queueId'] = intval($data['queueId']);
         $dataPrepared['newStatus'] = intval($data['newStatus']);
         $dataPrepared = serialize($dataPrepared);
-        return sha1($dataPrepared . $key);
+        return sha1($dataPrepared.$key);
     }
 
     /**
@@ -1350,12 +1349,12 @@ 
                 break;
         }
 
-        $url = api_get_path(WEB_PLUGIN_PATH) . "advanced_subscription/src/terms_and_conditions.php?";
+        $url = api_get_path(WEB_PLUGIN_PATH)."advanced_subscription/src/terms_and_conditions.php?";
         $url .= http_build_query($urlParams);
 
         // Launch popup
         if ($mode == ADVANCED_SUBSCRIPTION_TERMS_MODE_POPUP) {
-            $url = 'javascript:void(window.open(\'' . $url .'\',\'AdvancedSubscriptionTerms\', \'toolbar=no,location=no,status=no,menubar=no,scrollbars=yes,resizable=yes,width=700px,height=600px\', \'100\' ))';
+            $url = 'javascript:void(window.open(\''.$url.'\',\'AdvancedSubscriptionTerms\', \'toolbar=no,location=no,status=no,menubar=no,scrollbars=yes,resizable=yes,width=700px,height=600px\', \'100\' ))';
         }
         return $url;
     }
@@ -1367,9 +1366,9 @@ 
      */
     public function getRenderMailUrl($params)
     {
-        $url = api_get_path(WEB_PLUGIN_PATH) . 'advanced_subscription/src/render_mail.php?' .
-            'q=' . $params['queueId'] . '&' .
-            'v=' . $this->generateHash($params);
+        $url = api_get_path(WEB_PLUGIN_PATH).'advanced_subscription/src/render_mail.php?'.
+            'q='.$params['queueId'].'&'.
+            'v='.$this->generateHash($params);
         return $url;
     }
 
@@ -1440,7 +1439,7 @@ 
                 sf.extra_field_type = $extraFieldType AND
                 sf.variable = 'is_induction_session' AND
                 su.relation_type = 0 AND
-                su.user_id = " . intval($userId);
+                su.user_id = ".intval($userId);
 
         $result = Database::query($sql);
 

plugin/bbb/lib/bbb.lib.php

Doc Comments +2 added lines, -2 removed lines

@@ -240,7 +240,7 @@ 
     /**
      * Returns a meeting "join" URL
      * @param string The name of the meeting (usually the course code)
-     * @return mixed The URL to join the meeting, or false on error
+     * @return false|string The URL to join the meeting, or false on error
      * @todo implement moderator pass
      * @assert ('') === false
      * @assert ('abcdefghijklmnopqrstuvwxyzabcdefghijklmno') === false
@@ -647,7 +647,7 @@ 
      * Closes a meeting (usually when the user click on the close button from
      * the conferences listing.
      * @param string The internal ID of the meeting (id field for this meeting)
-     * @return void
+     * @return false|null
      * @assert (0) === false
      */
     public function endMeeting($id)

Spacing +35 added lines, -35 removed lines

@@ -166,13 +166,13 @@ 
         }
 
         $params['attendee_pw'] = isset($params['moderator_pw']) ? $params['moderator_pw'] : $courseCode;
-        $attendeePassword =  $params['attendee_pw'];
+        $attendeePassword = $params['attendee_pw'];
         $params['moderator_pw'] = isset($params['moderator_pw']) ? $params['moderator_pw'] : $this->getModMeetingPassword();
         $moderatorPassword = $params['moderator_pw'];
 
         $params['record'] = api_get_course_setting('big_blue_button_record_and_store', $courseCode) == 1 ? true : false;
         $max = api_get_course_setting('big_blue_button_max_students_allowed', $courseCode);
-        $max =  isset($max) ? $max : -1;
+        $max = isset($max) ? $max : -1;
 
         $params['status'] = 1;
         // Generate a pseudo-global-unique-id to avoid clash of conferences on
@@ -203,23 +203,23 @@ 
             $duration = 300;
 
             $bbbParams = array(
-                'meetingId' => $params['remote_id'], 					// REQUIRED
-                'meetingName' => $meetingName, 	// REQUIRED
-                'attendeePw' => $attendeePassword, 					// Match this value in getJoinMeetingURL() to join as attendee.
-                'moderatorPw' => $moderatorPassword, 					// Match this value in getJoinMeetingURL() to join as moderator.
-                'welcomeMsg' => $welcomeMessage, 					// ''= use default. Change to customize.
-                'dialNumber' => '', 					// The main number to call into. Optional.
-                'voiceBridge' => $params['voice_bridge'], 					// PIN to join voice. Required.
-                'webVoice' => '', 						// Alphanumeric to join voice. Optional.
+                'meetingId' => $params['remote_id'], // REQUIRED
+                'meetingName' => $meetingName, // REQUIRED
+                'attendeePw' => $attendeePassword, // Match this value in getJoinMeetingURL() to join as attendee.
+                'moderatorPw' => $moderatorPassword, // Match this value in getJoinMeetingURL() to join as moderator.
+                'welcomeMsg' => $welcomeMessage, // ''= use default. Change to customize.
+                'dialNumber' => '', // The main number to call into. Optional.
+                'voiceBridge' => $params['voice_bridge'], // PIN to join voice. Required.
+                'webVoice' => '', // Alphanumeric to join voice. Optional.
                 'logoutUrl' =>  $this->logoutUrl,
-                'maxParticipants' => $max, 				// Optional. -1 = unlimitted. Not supported in BBB. [number]
-                'record' => $record, 					// New. 'true' will tell BBB to record the meeting.
-                'duration' => $duration, 				// Default = 0 which means no set duration in minutes. [number]
+                'maxParticipants' => $max, // Optional. -1 = unlimitted. Not supported in BBB. [number]
+                'record' => $record, // New. 'true' will tell BBB to record the meeting.
+                'duration' => $duration, // Default = 0 which means no set duration in minutes. [number]
                 //'meta_category' => '', 				// Use to pass additional info to BBB server. See API docs.
             );
 
             if ($this->debug) {
-                error_log("create_meeting params: ".print_r($bbbParams,1));
+                error_log("create_meeting params: ".print_r($bbbParams, 1));
             }
 
             $status = false;
@@ -232,7 +232,7 @@ 
                 if (isset($result) && strval($result['returncode']) == 'SUCCESS') {
                     if ($this->debug) {
                         error_log(
-                            "create_meeting result: " . print_r($result, 1)
+                            "create_meeting result: ".print_r($result, 1)
                         );
                     }
                     $meeting = $this->joinMeeting($meetingName, true);
@@ -263,7 +263,7 @@ 
 
         $courseId = api_get_course_int_id();
         $sessionId = api_get_session_id();
-        $conditions =  array(
+        $conditions = array(
             'where' => array(
                 'c_id = ? AND session_id = ? AND meeting_name = ? AND status = 1 ' =>
                     array($courseId, $sessionId, $meetingName)
@@ -272,7 +272,7 @@ 
 
         if ($this->hasGroupSupport()) {
             $groupId = api_get_group_id();
-            $conditions =  array(
+            $conditions = array(
                 'where' => array(
                     'c_id = ? AND session_id = ? AND meeting_name = ? AND group_id = ? AND status = 1 ' =>
                         array($courseId, $sessionId, $meetingName, $groupId)
@@ -369,7 +369,7 @@ 
 
             if ($this->debug) {
                 error_log(
-                    "meeting is running: " . intval($meetingInfoExists)
+                    "meeting is running: ".intval($meetingInfoExists)
                 );
             }
 
@@ -386,11 +386,11 @@ 
 
         if ($meetingInfoExists) {
             $joinParams = array(
-                'meetingId' => $meetingData['remote_id'],	//	-- REQUIRED - A unique id for the meeting
-                'username' => $this->userCompleteName,	//-- REQUIRED - The name that will display for the user in the meeting
-                'password' => $pass,			//-- REQUIRED - The attendee or moderator password, depending on what's passed here
+                'meetingId' => $meetingData['remote_id'], //	-- REQUIRED - A unique id for the meeting
+                'username' => $this->userCompleteName, //-- REQUIRED - The name that will display for the user in the meeting
+                'password' => $pass, //-- REQUIRED - The attendee or moderator password, depending on what's passed here
                 //'createTime' => api_get_utc_datetime(),			//-- OPTIONAL - string. Leave blank ('') unless you set this correctly.
-                'userID' => api_get_user_id(),				//-- OPTIONAL - string
+                'userID' => api_get_user_id(), //-- OPTIONAL - string
                 'webVoiceConf' => ''	//	-- OPTIONAL - string
             );
             $url = $this->api->getJoinMeetingURL($joinParams);
@@ -399,7 +399,7 @@ 
             $url = $this->logoutUrl;
         }
         if ($this->debug) {
-            error_log("return url :" . $url);
+            error_log("return url :".$url);
         }
 
         return $url;
@@ -441,7 +441,7 @@ 
         $courseId = api_get_course_int_id();
         $sessionId = api_get_session_id();
 
-        $conditions =  array(
+        $conditions = array(
             'where' => array(
                 'c_id = ? AND session_id = ? ' => array(
                     $courseId,
@@ -452,7 +452,7 @@ 
 
         if ($this->hasGroupSupport()) {
             $groupId = api_get_group_id();
-            $conditions =  array(
+            $conditions = array(
                 'where' => array(
                     'c_id = ? AND session_id = ? AND group_id = ? ' =>
                         array($courseId, $sessionId, $groupId)
@@ -487,7 +487,7 @@ 
             }
             $meetingBBB['end_url'] = $this->endUrl($meetingDB);
 
-            if ((string)$meetingBBB['returncode'] == 'FAILED') {
+            if ((string) $meetingBBB['returncode'] == 'FAILED') {
                 if ($meetingDB['status'] == 1 && $this->isConferenceManager()) {
                     $this->endMeeting($meetingDB['id']);
                 }
@@ -657,7 +657,7 @@ 
                     $item['action_links'] = implode('<br />', $actionLinksArray);
                 }
                 //var_dump($recordArray);
-                $item['show_links']  = implode('<br />', $recordArray);
+                $item['show_links'] = implode('<br />', $recordArray);
                 $item['action_links'] = implode('<br />', $actionLinksArray);
             }
 
@@ -670,11 +670,11 @@ 
 
             if ($meetingDB['status'] == 1) {
                 $joinParams = array(
-                    'meetingId' => $meetingDB['remote_id'],		//-- REQUIRED - A unique id for the meeting
-                    'username' => $this->userCompleteName,	//-- REQUIRED - The name that will display for the user in the meeting
-                    'password' => $pass,			//-- REQUIRED - The attendee or moderator password, depending on what's passed here
-                    'createTime' => '',			//-- OPTIONAL - string. Leave blank ('') unless you set this correctly.
-                    'userID' => '',			//	-- OPTIONAL - string
+                    'meetingId' => $meetingDB['remote_id'], //-- REQUIRED - A unique id for the meeting
+                    'username' => $this->userCompleteName, //-- REQUIRED - The name that will display for the user in the meeting
+                    'password' => $pass, //-- REQUIRED - The attendee or moderator password, depending on what's passed here
+                    'createTime' => '', //-- OPTIONAL - string. Leave blank ('') unless you set this correctly.
+                    'userID' => '', //	-- OPTIONAL - string
                     'webVoiceConf' => ''	//	-- OPTIONAL - string
                 );
                 $item['go_url'] = $this->protocol.$this->api->getJoinMeetingURL($joinParams);
@@ -735,8 +735,8 @@ 
         $pass = $this->getUserMeetingPassword();
 
         $endParams = array(
-            'meetingId' => $meetingData['remote_id'],   // REQUIRED - We have to know which meeting to end.
-            'password' => $pass,        // REQUIRED - Must match moderator pass for meeting.
+            'meetingId' => $meetingData['remote_id'], // REQUIRED - We have to know which meeting to end.
+            'password' => $pass, // REQUIRED - Must match moderator pass for meeting.
         );
         $this->api->endMeetingWithXmlResponseArray($endParams);
         Database::update(
@@ -961,7 +961,7 @@ 
      */
     public function redirectToBBB($url)
     {
-        if (file_exists(__DIR__ . '/../config.vm.php')) {
+        if (file_exists(__DIR__.'/../config.vm.php')) {
             // Using VM
             echo Display::url(get_lang('ClickToContinue'), $url);
             exit;

plugin/bbb/lib/bbb_api.php

Doc Comments +3 added lines

@@ -59,6 +59,9 @@
 		$this->_bbbServerBaseUrl 	= CONFIG_SERVER_BASE_URL;
 	}
 
+	/**
+	 * @param string $url
+	 */
 	private function _processXmlResponse($url){
 	/*
 	A private utility method used by other public methods to process XML responses.

Spacing +21 added lines, -21 removed lines

@@ -55,25 +55,25 @@ 
 	*/
 		// BASE CONFIGS - set these for your BBB server in config.php and they will
 		// simply flow in here via the constants:
-		$this->_securitySalt 		= CONFIG_SECURITY_SALT;
-		$this->_bbbServerBaseUrl 	= CONFIG_SERVER_BASE_URL;
+		$this->_securitySalt = CONFIG_SECURITY_SALT;
+		$this->_bbbServerBaseUrl = CONFIG_SERVER_BASE_URL;
 	}
 
-	private function _processXmlResponse($url){
+	private function _processXmlResponse($url) {
 	/*
 	A private utility method used by other public methods to process XML responses.
 	*/
 		if (extension_loaded('curl')) {
-			$ch = curl_init() or die ( curl_error($ch) );
+			$ch = curl_init() or die (curl_error($ch));
 			$timeout = 10;
-			curl_setopt( $ch, CURLOPT_SSL_VERIFYPEER, false);
-			curl_setopt( $ch, CURLOPT_URL, $url );
-			curl_setopt( $ch, CURLOPT_RETURNTRANSFER, 1 );
-			curl_setopt( $ch, CURLOPT_CONNECTTIMEOUT, $timeout);
-			$data = curl_exec( $ch );
-			curl_close( $ch );
-
-			if($data)
+			curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
+			curl_setopt($ch, CURLOPT_URL, $url);
+			curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
+			curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, $timeout);
+			$data = curl_exec($ch);
+			curl_close($ch);
+
+			if ($data)
 				return (new SimpleXMLElement($data));
 			else
 				return false;
@@ -137,10 +137,10 @@ 
 		'&duration='.urlencode($creationParams['duration']);
 		//'&meta_category='.urlencode($creationParams['meta_category']);
 		$welcomeMessage = $creationParams['welcomeMsg'];
-		if(trim($welcomeMessage))
+		if (trim($welcomeMessage))
 			$params .= '&welcome='.urlencode($welcomeMessage);
 		// Return the complete URL:
-		return ( $creationUrl.$params.'&checksum='.sha1("create".$params.$this->_securitySalt) );
+		return ($creationUrl.$params.'&checksum='.sha1("create".$params.$this->_securitySalt));
 	}
 
 	public function createMeetingWithXmlResponseArray($creationParams) {
@@ -165,7 +165,7 @@ 
 		$xml = $this->_processXmlResponse($this->getCreateMeetingURL($creationParams));
 
         if ($xml) {
-			if($xml->meetingID)
+			if ($xml->meetingID)
 				return array(
 					'returncode' => $xml->returncode,
 					'message' => $xml->message,
@@ -283,7 +283,7 @@ 
 		$meetingId = '1234'		-- REQUIRED - The unique id for the meeting
 		*/
 		$xml = $this->_processXmlResponse($this->getIsMeetingRunningUrl($meetingId));
-		if($xml) {
+		if ($xml) {
 			return array(
 				'returncode' => $xml->returncode,
 				'running' => $xml->running 	// -- Returns true/false.
@@ -310,7 +310,7 @@ 
 		and then handle the results that we get in the XML response.
 		*/
 		$xml = $this->_processXmlResponse($this->getGetMeetingsUrl());
-		if($xml) {
+		if ($xml) {
 			// If we don't get a success code, stop processing and return just the returncode:
 			if ($xml->returncode != 'SUCCESS') {
 				$result = array(
@@ -379,7 +379,7 @@ 
 		);
 		*/
 		$xml = $this->_processXmlResponse($this->getMeetingInfoUrl($infoParams));
-		if($xml) {
+		if ($xml) {
 			// If we don't get a success code or messageKey, find out why:
 			if (($xml->returncode != 'SUCCESS') || ($xml->messageKey == null)) {
 				$result = array(
@@ -454,7 +454,7 @@ 
 		probably be required in user code when 'recording' is set to true.
 		*/
 		$xml = $this->_processXmlResponse($this->getRecordingsUrl($recordingParams));
-		if($xml) {
+		if ($xml) {
 			// If we don't get a success code or messageKey, find out why:
 			if (($xml->returncode != 'SUCCESS') || ($xml->messageKey == null)) {
 				$result = array(
@@ -524,7 +524,7 @@ 
 		);
 		*/
 		$xml = $this->_processXmlResponse($this->getPublishRecordingsUrl($recordingParams));
-		if($xml) {
+		if ($xml) {
 			return array(
 				'returncode' => $xml->returncode,
 				'published' => $xml->published 	// -- Returns true/false.
@@ -557,7 +557,7 @@ 
 		*/
 
 		$xml = $this->_processXmlResponse($this->getDeleteRecordingsUrl($recordingParams));
-		if($xml) {
+		if ($xml) {
 			return array(
 				'returncode' => $xml->returncode,
 				'deleted' => $xml->deleted 	// -- Returns true/false.

Braces +28 added lines, -40 removed lines

@@ -73,10 +73,11 @@ 
 			$data = curl_exec( $ch );
 			curl_close( $ch );
 
-			if($data)
-				return (new SimpleXMLElement($data));
-			else
-				return false;
+			if($data) {
+							return (new SimpleXMLElement($data));
+			} else {
+							return false;
+			}
 		}
 		return (simplexml_load_file($url));
 	}
@@ -85,11 +86,9 @@ 
 		/* Process required params and throw errors if we don't get values */
 		if ((isset($param)) && ($param != '')) {
 			return $param;
-		}
-		elseif (!isset($param)) {
+		} elseif (!isset($param)) {
 			throw new Exception('Missing parameter.');
-		}
-		else {
+		} else {
 			throw new Exception(''.$param.' is required.');
 		}
 	}
@@ -99,8 +98,7 @@ 
 		/* Don't know if we'll use this one, but let's build it in case. */
 		if ((isset($param)) && ($param != '')) {
 			return $param;
-		}
-		else {
+		} else {
 			$param = '';
 			return $param;
 		}
@@ -137,8 +135,9 @@ 
 		'&duration='.urlencode($creationParams['duration']);
 		//'&meta_category='.urlencode($creationParams['meta_category']);
 		$welcomeMessage = $creationParams['welcomeMsg'];
-		if(trim($welcomeMessage))
-			$params .= '&welcome='.urlencode($welcomeMessage);
+		if(trim($welcomeMessage)) {
+					$params .= '&welcome='.urlencode($welcomeMessage);
+		}
 		// Return the complete URL:
 		return ( $creationUrl.$params.'&checksum='.sha1("create".$params.$this->_securitySalt) );
 	}
@@ -165,8 +164,8 @@ 
 		$xml = $this->_processXmlResponse($this->getCreateMeetingURL($creationParams));
 
         if ($xml) {
-			if($xml->meetingID)
-				return array(
+			if($xml->meetingID) {
+							return array(
 					'returncode' => $xml->returncode,
 					'message' => $xml->message,
 					'messageKey' => $xml->messageKey,
@@ -176,14 +175,14 @@ 
 					'hasBeenForciblyEnded' => $xml->hasBeenForciblyEnded,
 					'createTime' => $xml->createTime
 					);
-			else
-				return array(
+			} else {
+							return array(
 					'returncode' => $xml->returncode,
 					'message' => $xml->message,
 					'messageKey' => $xml->messageKey
 					);
-		}
-		else {
+			}
+		} else {
 			return null;
 		}
 	}
@@ -253,8 +252,7 @@ 
 				'message' => $xml->message,
 				'messageKey' => $xml->messageKey
 				);
-		}
-		else {
+		} else {
 			return null;
 		}
 
@@ -288,8 +286,7 @@ 
 				'returncode' => $xml->returncode,
 				'running' => $xml->running 	// -- Returns true/false.
 				);
-		}
-		else {
+		} else {
 			return null;
 		}
 
@@ -317,8 +314,7 @@ 
 					'returncode' => $xml->returncode
 				);
 				return $result;
-			}
-			elseif ($xml->messageKey == 'noMeetings') {
+			} elseif ($xml->messageKey == 'noMeetings') {
 				/* No meetings on server, so return just this info: */
 				$result = array(
 					'returncode' => $xml->returncode,
@@ -326,8 +322,7 @@ 
 					'message' => $xml->message
 				);
 				return $result;
-			}
-			else {
+			} else {
 				// In this case, we have success and meetings. First return general response:
 				$result = array(
 					'returncode' => $xml->returncode,
@@ -348,8 +343,7 @@ 
 					}
 				return $result;
 			}
-		}
-		else {
+		} else {
 			return null;
 		}
 
@@ -388,8 +382,7 @@ 
 					'message' => $xml->message
 				);
 				return $result;
-			}
-			else {
+			} else {
 				// In this case, we have success and meeting info:
 				$result = array(
 					'returncode' => $xml->returncode,
@@ -418,8 +411,7 @@ 
 					}
 				return $result;
 			}
-		}
-		else {
+		} else {
 			return null;
 		}
 
@@ -463,8 +455,7 @@ 
 					'message' => $xml->message
 				);
 				return $result;
-			}
-			else {
+			} else {
 				// In this case, we have success and recording info:
 				$result = array(
 					'returncode' => $xml->returncode,
@@ -495,8 +486,7 @@ 
 					}
 				return $result;
 			}
-		}
-		else {
+		} else {
 			return null;
 		}
 	}
@@ -529,8 +519,7 @@ 
 				'returncode' => $xml->returncode,
 				'published' => $xml->published 	// -- Returns true/false.
 				);
-		}
-		else {
+		} else {
 			return null;
 		}
 
@@ -562,8 +551,7 @@ 
 				'returncode' => $xml->returncode,
 				'deleted' => $xml->deleted 	// -- Returns true/false.
 				);
-		}
-		else {
+		} else {
 			return null;
 		}
 

Indentation +403 added lines, -403 removed lines

@@ -44,107 +44,107 @@ 
 
 class BigBlueButtonBN {
 
-	private $_securitySalt;
-	private $_bbbServerBaseUrl;
+    private $_securitySalt;
+    private $_bbbServerBaseUrl;
 
-	/* ___________ General Methods for the BigBlueButton Class __________ */
+    /* ___________ General Methods for the BigBlueButton Class __________ */
 
-	function __construct() {
-	/*
+    function __construct() {
+    /*
 	Establish just our basic elements in the constructor:
 	*/
-		// BASE CONFIGS - set these for your BBB server in config.php and they will
-		// simply flow in here via the constants:
-		$this->_securitySalt 		= CONFIG_SECURITY_SALT;
-		$this->_bbbServerBaseUrl 	= CONFIG_SERVER_BASE_URL;
-	}
-
-	private function _processXmlResponse($url){
-	/*
+        // BASE CONFIGS - set these for your BBB server in config.php and they will
+        // simply flow in here via the constants:
+        $this->_securitySalt 		= CONFIG_SECURITY_SALT;
+        $this->_bbbServerBaseUrl 	= CONFIG_SERVER_BASE_URL;
+    }
+
+    private function _processXmlResponse($url){
+    /*
 	A private utility method used by other public methods to process XML responses.
 	*/
-		if (extension_loaded('curl')) {
-			$ch = curl_init() or die ( curl_error($ch) );
-			$timeout = 10;
-			curl_setopt( $ch, CURLOPT_SSL_VERIFYPEER, false);
-			curl_setopt( $ch, CURLOPT_URL, $url );
-			curl_setopt( $ch, CURLOPT_RETURNTRANSFER, 1 );
-			curl_setopt( $ch, CURLOPT_CONNECTTIMEOUT, $timeout);
-			$data = curl_exec( $ch );
-			curl_close( $ch );
-
-			if($data)
-				return (new SimpleXMLElement($data));
-			else
-				return false;
-		}
-		return (simplexml_load_file($url));
-	}
-
-	private function _requiredParam($param) {
-		/* Process required params and throw errors if we don't get values */
-		if ((isset($param)) && ($param != '')) {
-			return $param;
-		}
-		elseif (!isset($param)) {
-			throw new Exception('Missing parameter.');
-		}
-		else {
-			throw new Exception(''.$param.' is required.');
-		}
-	}
-
-	private function _optionalParam($param) {
-		/* Pass most optional params through as set value, or set to '' */
-		/* Don't know if we'll use this one, but let's build it in case. */
-		if ((isset($param)) && ($param != '')) {
-			return $param;
-		}
-		else {
-			$param = '';
-			return $param;
-		}
-	}
-
-	/* __________________ BBB ADMINISTRATION METHODS _________________ */
-	/* The methods in the following section support the following categories of the BBB API:
+        if (extension_loaded('curl')) {
+            $ch = curl_init() or die ( curl_error($ch) );
+            $timeout = 10;
+            curl_setopt( $ch, CURLOPT_SSL_VERIFYPEER, false);
+            curl_setopt( $ch, CURLOPT_URL, $url );
+            curl_setopt( $ch, CURLOPT_RETURNTRANSFER, 1 );
+            curl_setopt( $ch, CURLOPT_CONNECTTIMEOUT, $timeout);
+            $data = curl_exec( $ch );
+            curl_close( $ch );
+
+            if($data)
+                return (new SimpleXMLElement($data));
+            else
+                return false;
+        }
+        return (simplexml_load_file($url));
+    }
+
+    private function _requiredParam($param) {
+        /* Process required params and throw errors if we don't get values */
+        if ((isset($param)) && ($param != '')) {
+            return $param;
+        }
+        elseif (!isset($param)) {
+            throw new Exception('Missing parameter.');
+        }
+        else {
+            throw new Exception(''.$param.' is required.');
+        }
+    }
+
+    private function _optionalParam($param) {
+        /* Pass most optional params through as set value, or set to '' */
+        /* Don't know if we'll use this one, but let's build it in case. */
+        if ((isset($param)) && ($param != '')) {
+            return $param;
+        }
+        else {
+            $param = '';
+            return $param;
+        }
+    }
+
+    /* __________________ BBB ADMINISTRATION METHODS _________________ */
+    /* The methods in the following section support the following categories of the BBB API:
 	-- create
 	-- join
 	-- end
 	*/
 
-	public function getCreateMeetingUrl($creationParams) {
-		/*
+    public function getCreateMeetingUrl($creationParams) {
+        /*
 		USAGE:
 		(see $creationParams array in createMeetingArray method.)
 		*/
-		$this->_meetingId = $this->_requiredParam($creationParams['meetingId']);
-		$this->_meetingName = $this->_requiredParam($creationParams['meetingName']);
-		// Set up the basic creation URL:
-		$creationUrl = $this->_bbbServerBaseUrl."api/create?";
-		// Add params:
-		$params =
-		'name='.urlencode($this->_meetingName).
-		'&meetingID='.urlencode($this->_meetingId).
-		'&attendeePW='.urlencode($creationParams['attendeePw']).
-		'&moderatorPW='.urlencode($creationParams['moderatorPw']).
-		'&dialNumber='.urlencode($creationParams['dialNumber']).
-		'&voiceBridge='.urlencode($creationParams['voiceBridge']).
-		'&webVoice='.urlencode($creationParams['webVoice']).
-		'&logoutURL='.urlencode($creationParams['logoutUrl']).
-		'&maxParticipants='.urlencode($creationParams['maxParticipants']).
-		'&record='.urlencode($creationParams['record']).
-		'&duration='.urlencode($creationParams['duration']);
-		//'&meta_category='.urlencode($creationParams['meta_category']);
-		$welcomeMessage = $creationParams['welcomeMsg'];
-		if(trim($welcomeMessage))
-			$params .= '&welcome='.urlencode($welcomeMessage);
-		// Return the complete URL:
-		return ( $creationUrl.$params.'&checksum='.sha1("create".$params.$this->_securitySalt) );
-	}
-
-	public function createMeetingWithXmlResponseArray($creationParams) {
-		/*
+        $this->_meetingId = $this->_requiredParam($creationParams['meetingId']);
+        $this->_meetingName = $this->_requiredParam($creationParams['meetingName']);
+        // Set up the basic creation URL:
+        $creationUrl = $this->_bbbServerBaseUrl."api/create?";
+        // Add params:
+        $params =
+        'name='.urlencode($this->_meetingName).
+        '&meetingID='.urlencode($this->_meetingId).
+        '&attendeePW='.urlencode($creationParams['attendeePw']).
+        '&moderatorPW='.urlencode($creationParams['moderatorPw']).
+        '&dialNumber='.urlencode($creationParams['dialNumber']).
+        '&voiceBridge='.urlencode($creationParams['voiceBridge']).
+        '&webVoice='.urlencode($creationParams['webVoice']).
+        '&logoutURL='.urlencode($creationParams['logoutUrl']).
+        '&maxParticipants='.urlencode($creationParams['maxParticipants']).
+        '&record='.urlencode($creationParams['record']).
+        '&duration='.urlencode($creationParams['duration']);
+        //'&meta_category='.urlencode($creationParams['meta_category']);
+        $welcomeMessage = $creationParams['welcomeMsg'];
+        if(trim($welcomeMessage))
+            $params .= '&welcome='.urlencode($welcomeMessage);
+        // Return the complete URL:
+        return ( $creationUrl.$params.'&checksum='.sha1("create".$params.$this->_securitySalt) );
+    }
+
+    public function createMeetingWithXmlResponseArray($creationParams) {
+        /*
 		USAGE:
 		$creationParams = array(
 			'name' => 'Meeting Name',	-- A name for the meeting (or username)
@@ -162,34 +162,34 @@ 
 			'meta_category' => '', 		-- Use to pass additional info to BBB server. See API docs to enable.
 		);
 		*/
-		$xml = $this->_processXmlResponse($this->getCreateMeetingURL($creationParams));
+        $xml = $this->_processXmlResponse($this->getCreateMeetingURL($creationParams));
 
         if ($xml) {
-			if($xml->meetingID)
-				return array(
-					'returncode' => $xml->returncode,
-					'message' => $xml->message,
-					'messageKey' => $xml->messageKey,
-					'meetingId' => $xml->meetingID,
-					'attendeePw' => $xml->attendeePW,
-					'moderatorPw' => $xml->moderatorPW,
-					'hasBeenForciblyEnded' => $xml->hasBeenForciblyEnded,
-					'createTime' => $xml->createTime
-					);
-			else
-				return array(
-					'returncode' => $xml->returncode,
-					'message' => $xml->message,
-					'messageKey' => $xml->messageKey
-					);
-		}
-		else {
-			return null;
-		}
-	}
-
-	public function getJoinMeetingURL($joinParams) {
-		/*
+            if($xml->meetingID)
+                return array(
+                    'returncode' => $xml->returncode,
+                    'message' => $xml->message,
+                    'messageKey' => $xml->messageKey,
+                    'meetingId' => $xml->meetingID,
+                    'attendeePw' => $xml->attendeePW,
+                    'moderatorPw' => $xml->moderatorPW,
+                    'hasBeenForciblyEnded' => $xml->hasBeenForciblyEnded,
+                    'createTime' => $xml->createTime
+                    );
+            else
+                return array(
+                    'returncode' => $xml->returncode,
+                    'message' => $xml->message,
+                    'messageKey' => $xml->messageKey
+                    );
+        }
+        else {
+            return null;
+        }
+    }
+
+    public function getJoinMeetingURL($joinParams) {
+        /*
 		NOTE: At this point, we don't use a corresponding joinMeetingWithXmlResponse here because the API
 		doesn't respond on success, but you can still code that method if you need it. Or, you can take the URL
 		that's returned from this method and simply send your users off to that URL in your code.
@@ -203,249 +203,249 @@ 
 			'webVoiceConf' => ''		-- OPTIONAL - string
 		);
 		*/
-		$this->_meetingId = $this->_requiredParam($joinParams['meetingId']);
-		$this->_username = $this->_requiredParam($joinParams['username']);
-		$this->_password = $this->_requiredParam($joinParams['password']);
-		// Establish the basic join URL:
-		$joinUrl = $this->_bbbServerBaseUrl."api/join?";
-		// Add parameters to the URL:
-		$params =
-		'meetingID='.urlencode($this->_meetingId).
-		'&fullName='.urlencode($this->_username).
-		'&password='.urlencode($this->_password).
-		'&userID='.urlencode($joinParams['userID']).
-		'&webVoiceConf='.urlencode($joinParams['webVoiceConf']);
-		// Only use createTime if we really want to use it. If it's '', then don't pass it:
-		if (((isset($joinParams['createTime'])) && ($joinParams['createTime'] != ''))) {
-			$params .= '&createTime='.urlencode($joinParams['createTime']);
-		}
-		// Return the URL:
-		return ($joinUrl.$params.'&checksum='.sha1("join".$params.$this->_securitySalt));
-	}
-
-	public function getEndMeetingURL($endParams) {
-		/* USAGE:
+        $this->_meetingId = $this->_requiredParam($joinParams['meetingId']);
+        $this->_username = $this->_requiredParam($joinParams['username']);
+        $this->_password = $this->_requiredParam($joinParams['password']);
+        // Establish the basic join URL:
+        $joinUrl = $this->_bbbServerBaseUrl."api/join?";
+        // Add parameters to the URL:
+        $params =
+        'meetingID='.urlencode($this->_meetingId).
+        '&fullName='.urlencode($this->_username).
+        '&password='.urlencode($this->_password).
+        '&userID='.urlencode($joinParams['userID']).
+        '&webVoiceConf='.urlencode($joinParams['webVoiceConf']);
+        // Only use createTime if we really want to use it. If it's '', then don't pass it:
+        if (((isset($joinParams['createTime'])) && ($joinParams['createTime'] != ''))) {
+            $params .= '&createTime='.urlencode($joinParams['createTime']);
+        }
+        // Return the URL:
+        return ($joinUrl.$params.'&checksum='.sha1("join".$params.$this->_securitySalt));
+    }
+
+    public function getEndMeetingURL($endParams) {
+        /* USAGE:
 		$endParams = array (
 			'meetingId' => '1234',		-- REQUIRED - The unique id for the meeting
 			'password' => 'mp'			-- REQUIRED - The moderator password for the meeting
 		);
 		*/
-		$this->_meetingId = $this->_requiredParam($endParams['meetingId']);
-		$this->_password = $this->_requiredParam($endParams['password']);
-		$endUrl = $this->_bbbServerBaseUrl."api/end?";
-		$params =
-		'meetingID='.urlencode($this->_meetingId).
-		'&password='.urlencode($this->_password);
-		return ($endUrl.$params.'&checksum='.sha1("end".$params.$this->_securitySalt));
-	}
-
-	public function endMeetingWithXmlResponseArray($endParams) {
-		/* USAGE:
+        $this->_meetingId = $this->_requiredParam($endParams['meetingId']);
+        $this->_password = $this->_requiredParam($endParams['password']);
+        $endUrl = $this->_bbbServerBaseUrl."api/end?";
+        $params =
+        'meetingID='.urlencode($this->_meetingId).
+        '&password='.urlencode($this->_password);
+        return ($endUrl.$params.'&checksum='.sha1("end".$params.$this->_securitySalt));
+    }
+
+    public function endMeetingWithXmlResponseArray($endParams) {
+        /* USAGE:
 		$endParams = array (
 			'meetingId' => '1234',		-- REQUIRED - The unique id for the meeting
 			'password' => 'mp'			-- REQUIRED - The moderator password for the meeting
 		);
 		*/
-		$xml = $this->_processXmlResponse($this->getEndMeetingURL($endParams));
-		if ($xml) {
-			return array(
-				'returncode' => $xml->returncode,
-				'message' => $xml->message,
-				'messageKey' => $xml->messageKey
-				);
-		}
-		else {
-			return null;
-		}
-
-	}
-
-	/* __________________ BBB MONITORING METHODS _________________ */
-	/* The methods in the following section support the following categories of the BBB API:
+        $xml = $this->_processXmlResponse($this->getEndMeetingURL($endParams));
+        if ($xml) {
+            return array(
+                'returncode' => $xml->returncode,
+                'message' => $xml->message,
+                'messageKey' => $xml->messageKey
+                );
+        }
+        else {
+            return null;
+        }
+
+    }
+
+    /* __________________ BBB MONITORING METHODS _________________ */
+    /* The methods in the following section support the following categories of the BBB API:
 	-- isMeetingRunning
 	-- getMeetings
 	-- getMeetingInfo
 	*/
 
-	public function getIsMeetingRunningUrl($meetingId) {
-		/* USAGE:
+    public function getIsMeetingRunningUrl($meetingId) {
+        /* USAGE:
 		$meetingId = '1234'		-- REQUIRED - The unique id for the meeting
 		*/
-		$this->_meetingId = $this->_requiredParam($meetingId);
-		$runningUrl = $this->_bbbServerBaseUrl."api/isMeetingRunning?";
-		$params =
-		'meetingID='.urlencode($this->_meetingId);
-		return ($runningUrl.$params.'&checksum='.sha1("isMeetingRunning".$params.$this->_securitySalt));
-	}
-
-	public function isMeetingRunningWithXmlResponseArray($meetingId) {
-		/* USAGE:
+        $this->_meetingId = $this->_requiredParam($meetingId);
+        $runningUrl = $this->_bbbServerBaseUrl."api/isMeetingRunning?";
+        $params =
+        'meetingID='.urlencode($this->_meetingId);
+        return ($runningUrl.$params.'&checksum='.sha1("isMeetingRunning".$params.$this->_securitySalt));
+    }
+
+    public function isMeetingRunningWithXmlResponseArray($meetingId) {
+        /* USAGE:
 		$meetingId = '1234'		-- REQUIRED - The unique id for the meeting
 		*/
-		$xml = $this->_processXmlResponse($this->getIsMeetingRunningUrl($meetingId));
-		if($xml) {
-			return array(
-				'returncode' => $xml->returncode,
-				'running' => $xml->running 	// -- Returns true/false.
-				);
-		}
-		else {
-			return null;
-		}
-
-	}
-
-	public function getGetMeetingsUrl() {
-		/* Simply formulate the getMeetings URL
+        $xml = $this->_processXmlResponse($this->getIsMeetingRunningUrl($meetingId));
+        if($xml) {
+            return array(
+                'returncode' => $xml->returncode,
+                'running' => $xml->running 	// -- Returns true/false.
+                );
+        }
+        else {
+            return null;
+        }
+
+    }
+
+    public function getGetMeetingsUrl() {
+        /* Simply formulate the getMeetings URL
 		We do this in a separate function so we have the option to just get this
 		URL and print it if we want for some reason.
 		*/
-		$getMeetingsUrl = $this->_bbbServerBaseUrl."api/getMeetings?checksum=".sha1("getMeetings".$this->_securitySalt);
-		return $getMeetingsUrl;
-	}
+        $getMeetingsUrl = $this->_bbbServerBaseUrl."api/getMeetings?checksum=".sha1("getMeetings".$this->_securitySalt);
+        return $getMeetingsUrl;
+    }
 
-	public function getMeetingsWithXmlResponseArray() {
-		/* USAGE:
+    public function getMeetingsWithXmlResponseArray() {
+        /* USAGE:
 		We don't need to pass any parameters with this one, so we just send the query URL off to BBB
 		and then handle the results that we get in the XML response.
 		*/
-		$xml = $this->_processXmlResponse($this->getGetMeetingsUrl());
-		if($xml) {
-			// If we don't get a success code, stop processing and return just the returncode:
-			if ($xml->returncode != 'SUCCESS') {
-				$result = array(
-					'returncode' => $xml->returncode
-				);
-				return $result;
-			}
-			elseif ($xml->messageKey == 'noMeetings') {
-				/* No meetings on server, so return just this info: */
-				$result = array(
-					'returncode' => $xml->returncode,
-					'messageKey' => $xml->messageKey,
-					'message' => $xml->message
-				);
-				return $result;
-			}
-			else {
-				// In this case, we have success and meetings. First return general response:
-				$result = array(
-					'returncode' => $xml->returncode,
-					'messageKey' => $xml->messageKey,
-					'message' => $xml->message
-				);
-				// Then interate through meeting results and return them as part of the array:
-				foreach ($xml->meetings->meeting as $m) {
-					$result[] = array(
-						'meetingId' => $m->meetingID,
-						'meetingName' => $m->meetingName,
-						'createTime' => $m->createTime,
-						'attendeePw' => $m->attendeePW,
-						'moderatorPw' => $m->moderatorPW,
-						'hasBeenForciblyEnded' => $m->hasBeenForciblyEnded,
-						'running' => $m->running
-						);
-					}
-				return $result;
-			}
-		}
-		else {
-			return null;
-		}
-
-	}
-
-	public function getMeetingInfoUrl($infoParams) {
-		/* USAGE:
+        $xml = $this->_processXmlResponse($this->getGetMeetingsUrl());
+        if($xml) {
+            // If we don't get a success code, stop processing and return just the returncode:
+            if ($xml->returncode != 'SUCCESS') {
+                $result = array(
+                    'returncode' => $xml->returncode
+                );
+                return $result;
+            }
+            elseif ($xml->messageKey == 'noMeetings') {
+                /* No meetings on server, so return just this info: */
+                $result = array(
+                    'returncode' => $xml->returncode,
+                    'messageKey' => $xml->messageKey,
+                    'message' => $xml->message
+                );
+                return $result;
+            }
+            else {
+                // In this case, we have success and meetings. First return general response:
+                $result = array(
+                    'returncode' => $xml->returncode,
+                    'messageKey' => $xml->messageKey,
+                    'message' => $xml->message
+                );
+                // Then interate through meeting results and return them as part of the array:
+                foreach ($xml->meetings->meeting as $m) {
+                    $result[] = array(
+                        'meetingId' => $m->meetingID,
+                        'meetingName' => $m->meetingName,
+                        'createTime' => $m->createTime,
+                        'attendeePw' => $m->attendeePW,
+                        'moderatorPw' => $m->moderatorPW,
+                        'hasBeenForciblyEnded' => $m->hasBeenForciblyEnded,
+                        'running' => $m->running
+                        );
+                    }
+                return $result;
+            }
+        }
+        else {
+            return null;
+        }
+
+    }
+
+    public function getMeetingInfoUrl($infoParams) {
+        /* USAGE:
 		$infoParams = array(
 			'meetingId' => '1234',		-- REQUIRED - The unique id for the meeting
 			'password' => 'mp'			-- REQUIRED - The moderator password for the meeting
 		);
 		*/
-		$this->_meetingId = $this->_requiredParam($infoParams['meetingId']);
-		$this->_password = $this->_requiredParam($infoParams['password']);
-		$infoUrl = $this->_bbbServerBaseUrl."api/getMeetingInfo?";
-		$params =
-		'meetingID='.urlencode($this->_meetingId).
-		'&password='.urlencode($this->_password);
-		return ($infoUrl.$params.'&checksum='.sha1("getMeetingInfo".$params.$this->_securitySalt));
-	}
-
-	public function getMeetingInfoWithXmlResponseArray($infoParams) {
-		/* USAGE:
+        $this->_meetingId = $this->_requiredParam($infoParams['meetingId']);
+        $this->_password = $this->_requiredParam($infoParams['password']);
+        $infoUrl = $this->_bbbServerBaseUrl."api/getMeetingInfo?";
+        $params =
+        'meetingID='.urlencode($this->_meetingId).
+        '&password='.urlencode($this->_password);
+        return ($infoUrl.$params.'&checksum='.sha1("getMeetingInfo".$params.$this->_securitySalt));
+    }
+
+    public function getMeetingInfoWithXmlResponseArray($infoParams) {
+        /* USAGE:
 		$infoParams = array(
 			'meetingId' => '1234',		-- REQUIRED - The unique id for the meeting
 			'password' => 'mp'			-- REQUIRED - The moderator password for the meeting
 		);
 		*/
-		$xml = $this->_processXmlResponse($this->getMeetingInfoUrl($infoParams));
-		if($xml) {
-			// If we don't get a success code or messageKey, find out why:
-			if (($xml->returncode != 'SUCCESS') || ($xml->messageKey == null)) {
-				$result = array(
-					'returncode' => $xml->returncode,
-					'messageKey' => $xml->messageKey,
-					'message' => $xml->message
-				);
-				return $result;
-			}
-			else {
-				// In this case, we have success and meeting info:
-				$result = array(
-					'returncode' => $xml->returncode,
-					'meetingName' => $xml->meetingName,
-					'meetingId' => $xml->meetingID,
-					'createTime' => $xml->createTime,
-					'voiceBridge' => $xml->voiceBridge,
-					'attendeePw' => $xml->attendeePW,
-					'moderatorPw' => $xml->moderatorPW,
-					'running' => $xml->running,
-					'recording' => $xml->recording,
-					'hasBeenForciblyEnded' => $xml->hasBeenForciblyEnded,
-					'startTime' => $xml->startTime,
-					'endTime' => $xml->endTime,
-					'participantCount' => $xml->participantCount,
-					'maxUsers' => $xml->maxUsers,
-					'moderatorCount' => $xml->moderatorCount,
-				);
-				// Then interate through attendee results and return them as part of the array:
-				foreach ($xml->attendees->attendee as $a) {
-					$result[] = array(
-						'userId' => $a->userID,
-						'fullName' => $a->fullName,
-						'role' => $a->role
-						);
-					}
-				return $result;
-			}
-		}
-		else {
-			return null;
-		}
-
-	}
-
-	/* __________________ BBB RECORDING METHODS _________________ */
-	/* The methods in the following section support the following categories of the BBB API:
+        $xml = $this->_processXmlResponse($this->getMeetingInfoUrl($infoParams));
+        if($xml) {
+            // If we don't get a success code or messageKey, find out why:
+            if (($xml->returncode != 'SUCCESS') || ($xml->messageKey == null)) {
+                $result = array(
+                    'returncode' => $xml->returncode,
+                    'messageKey' => $xml->messageKey,
+                    'message' => $xml->message
+                );
+                return $result;
+            }
+            else {
+                // In this case, we have success and meeting info:
+                $result = array(
+                    'returncode' => $xml->returncode,
+                    'meetingName' => $xml->meetingName,
+                    'meetingId' => $xml->meetingID,
+                    'createTime' => $xml->createTime,
+                    'voiceBridge' => $xml->voiceBridge,
+                    'attendeePw' => $xml->attendeePW,
+                    'moderatorPw' => $xml->moderatorPW,
+                    'running' => $xml->running,
+                    'recording' => $xml->recording,
+                    'hasBeenForciblyEnded' => $xml->hasBeenForciblyEnded,
+                    'startTime' => $xml->startTime,
+                    'endTime' => $xml->endTime,
+                    'participantCount' => $xml->participantCount,
+                    'maxUsers' => $xml->maxUsers,
+                    'moderatorCount' => $xml->moderatorCount,
+                );
+                // Then interate through attendee results and return them as part of the array:
+                foreach ($xml->attendees->attendee as $a) {
+                    $result[] = array(
+                        'userId' => $a->userID,
+                        'fullName' => $a->fullName,
+                        'role' => $a->role
+                        );
+                    }
+                return $result;
+            }
+        }
+        else {
+            return null;
+        }
+
+    }
+
+    /* __________________ BBB RECORDING METHODS _________________ */
+    /* The methods in the following section support the following categories of the BBB API:
 	-- getRecordings
 	-- publishRecordings
 	-- deleteRecordings
 	*/
 
-	public function getRecordingsUrl($recordingParams) {
-		/* USAGE:
+    public function getRecordingsUrl($recordingParams) {
+        /* USAGE:
 		$recordingParams = array(
 			'meetingId' => '1234',		-- OPTIONAL - comma separate if multiple ids
 		);
 		*/
-		$recordingsUrl = $this->_bbbServerBaseUrl."api/getRecordings?";
-		$params = 'meetingID='.urlencode($recordingParams['meetingId']);
-		return ($recordingsUrl.$params.'&checksum='.sha1("getRecordings".$params.$this->_securitySalt));
+        $recordingsUrl = $this->_bbbServerBaseUrl."api/getRecordings?";
+        $params = 'meetingID='.urlencode($recordingParams['meetingId']);
+        return ($recordingsUrl.$params.'&checksum='.sha1("getRecordings".$params.$this->_securitySalt));
 
-	}
+    }
 
-	public function getRecordingsWithXmlResponseArray($recordingParams) {
-		/* USAGE:
+    public function getRecordingsWithXmlResponseArray($recordingParams) {
+        /* USAGE:
 		$recordingParams = array(
 			'meetingId' => '1234',		-- OPTIONAL - comma separate if multiple ids
 		);
@@ -453,121 +453,121 @@ 
 		when creating a meeting, it will kick users out after the duration. Should
 		probably be required in user code when 'recording' is set to true.
 		*/
-		$xml = $this->_processXmlResponse($this->getRecordingsUrl($recordingParams));
-		if($xml) {
-			// If we don't get a success code or messageKey, find out why:
-			if (($xml->returncode != 'SUCCESS') || ($xml->messageKey == null)) {
-				$result = array(
-					'returncode' => $xml->returncode,
-					'messageKey' => $xml->messageKey,
-					'message' => $xml->message
-				);
-				return $result;
-			}
-			else {
-				// In this case, we have success and recording info:
-				$result = array(
-					'returncode' => $xml->returncode,
-					'messageKey' => $xml->messageKey,
-					'message' => $xml->message
-				);
-
-				foreach ($xml->recordings->recording as $r) {
-					$result[] = array(
-						'recordId' => $r->recordID,
-						'meetingId' => $r->meetingID,
-						'name' => $r->name,
-						'published' => $r->published,
-						'startTime' => $r->startTime,
-						'endTime' => $r->endTime,
-						'playbackFormatType' => $r->playback->format->type,
-						'playbackFormatUrl' => $r->playback->format->url,
-						'playbackFormatLength' => $r->playback->format->length,
-						'metadataTitle' => $r->metadata->title,
-						'metadataSubject' => $r->metadata->subject,
-						'metadataDescription' => $r->metadata->description,
-						'metadataCreator' => $r->metadata->creator,
-						'metadataContributor' => $r->metadata->contributor,
-						'metadataLanguage' => $r->metadata->language,
-						// Add more here as needed for your app depending on your
-						// use of metadata when creating recordings.
-						);
-					}
-				return $result;
-			}
-		}
-		else {
-			return null;
-		}
-	}
-
-	public function getPublishRecordingsUrl($recordingParams) {
-		/* USAGE:
+        $xml = $this->_processXmlResponse($this->getRecordingsUrl($recordingParams));
+        if($xml) {
+            // If we don't get a success code or messageKey, find out why:
+            if (($xml->returncode != 'SUCCESS') || ($xml->messageKey == null)) {
+                $result = array(
+                    'returncode' => $xml->returncode,
+                    'messageKey' => $xml->messageKey,
+                    'message' => $xml->message
+                );
+                return $result;
+            }
+            else {
+                // In this case, we have success and recording info:
+                $result = array(
+                    'returncode' => $xml->returncode,
+                    'messageKey' => $xml->messageKey,
+                    'message' => $xml->message
+                );
+
+                foreach ($xml->recordings->recording as $r) {
+                    $result[] = array(
+                        'recordId' => $r->recordID,
+                        'meetingId' => $r->meetingID,
+                        'name' => $r->name,
+                        'published' => $r->published,
+                        'startTime' => $r->startTime,
+                        'endTime' => $r->endTime,
+                        'playbackFormatType' => $r->playback->format->type,
+                        'playbackFormatUrl' => $r->playback->format->url,
+                        'playbackFormatLength' => $r->playback->format->length,
+                        'metadataTitle' => $r->metadata->title,
+                        'metadataSubject' => $r->metadata->subject,
+                        'metadataDescription' => $r->metadata->description,
+                        'metadataCreator' => $r->metadata->creator,
+                        'metadataContributor' => $r->metadata->contributor,
+                        'metadataLanguage' => $r->metadata->language,
+                        // Add more here as needed for your app depending on your
+                        // use of metadata when creating recordings.
+                        );
+                    }
+                return $result;
+            }
+        }
+        else {
+            return null;
+        }
+    }
+
+    public function getPublishRecordingsUrl($recordingParams) {
+        /* USAGE:
 		$recordingParams = array(
 			'recordId' => '1234',		-- REQUIRED - comma separate if multiple ids
 			'publish' => 'true',		-- REQUIRED - boolean: true/false
 		);
 		*/
-		$recordingsUrl = $this->_bbbServerBaseUrl."api/publishRecordings?";
-		$params =
-		'recordID='.urlencode($recordingParams['recordId']).
-		'&publish='.urlencode($recordingParams['publish']);
-		return ($recordingsUrl.$params.'&checksum='.sha1("publishRecordings".$params.$this->_securitySalt));
+        $recordingsUrl = $this->_bbbServerBaseUrl."api/publishRecordings?";
+        $params =
+        'recordID='.urlencode($recordingParams['recordId']).
+        '&publish='.urlencode($recordingParams['publish']);
+        return ($recordingsUrl.$params.'&checksum='.sha1("publishRecordings".$params.$this->_securitySalt));
 
-	}
+    }
 
-	public function publishRecordingsWithXmlResponseArray($recordingParams) {
-		/* USAGE:
+    public function publishRecordingsWithXmlResponseArray($recordingParams) {
+        /* USAGE:
 		$recordingParams = array(
 			'recordId' => '1234',		-- REQUIRED - comma separate if multiple ids
 			'publish' => 'true',		-- REQUIRED - boolean: true/false
 		);
 		*/
-		$xml = $this->_processXmlResponse($this->getPublishRecordingsUrl($recordingParams));
-		if($xml) {
-			return array(
-				'returncode' => $xml->returncode,
-				'published' => $xml->published 	// -- Returns true/false.
-				);
-		}
-		else {
-			return null;
-		}
-
-
-	}
-
-	public function getDeleteRecordingsUrl($recordingParams) {
-		/* USAGE:
+        $xml = $this->_processXmlResponse($this->getPublishRecordingsUrl($recordingParams));
+        if($xml) {
+            return array(
+                'returncode' => $xml->returncode,
+                'published' => $xml->published 	// -- Returns true/false.
+                );
+        }
+        else {
+            return null;
+        }
+
+
+    }
+
+    public function getDeleteRecordingsUrl($recordingParams) {
+        /* USAGE:
 		$recordingParams = array(
 			'recordId' => '1234',		-- REQUIRED - comma separate if multiple ids
 		);
 		*/
-		$recordingsUrl = $this->_bbbServerBaseUrl."api/deleteRecordings?";
-		$params =
-		'recordID='.urlencode($recordingParams['recordId']);
-		return ($recordingsUrl.$params.'&checksum='.sha1("deleteRecordings".$params.$this->_securitySalt));
-	}
-
-	public function deleteRecordingsWithXmlResponseArray($recordingParams) {
-		/* USAGE:
+        $recordingsUrl = $this->_bbbServerBaseUrl."api/deleteRecordings?";
+        $params =
+        'recordID='.urlencode($recordingParams['recordId']);
+        return ($recordingsUrl.$params.'&checksum='.sha1("deleteRecordings".$params.$this->_securitySalt));
+    }
+
+    public function deleteRecordingsWithXmlResponseArray($recordingParams) {
+        /* USAGE:
 		$recordingParams = array(
 			'recordId' => '1234',		-- REQUIRED - comma separate if multiple ids
 		);
 		*/
 
-		$xml = $this->_processXmlResponse($this->getDeleteRecordingsUrl($recordingParams));
-		if($xml) {
-			return array(
-				'returncode' => $xml->returncode,
-				'deleted' => $xml->deleted 	// -- Returns true/false.
-				);
-		}
-		else {
-			return null;
-		}
-
-	}
+        $xml = $this->_processXmlResponse($this->getDeleteRecordingsUrl($recordingParams));
+        if($xml) {
+            return array(
+                'returncode' => $xml->returncode,
+                'deleted' => $xml->deleted 	// -- Returns true/false.
+                );
+        }
+        else {
+            return null;
+        }
+
+    }
 
 
 

plugin/buycourses/src/buy_course_plugin.class.php

Doc Comments +10 added lines, -10 removed lines

@@ -32,7 +32,7 @@ 
 

     /**

      *

-     * @return StaticPlugin

+     * @return BuyCoursesPlugin

      */

     static function create()

     {

@@ -199,7 +199,7 @@ 
     /**

      * Save a transfer account information

      * @param array $params The transfer account

-     * @return int Rows affected. Otherwise return false

+     * @return false|string Rows affected. Otherwise return false

      */

     public function saveTransferAccount($params)

     {

@@ -609,7 +609,7 @@ 
     /**

      * Get session info

      * @param array $sessionId The session ID

-     * @return array

+     * @return Chamilo\CoreBundle\Entity\Session

      */

     public function getSessionInfo($sessionId)

     {

@@ -702,7 +702,7 @@ 
      * Register a sale

      * @param int $itemId The product ID

      * @param int $paymentType The payment type

-     * @return boolean

+     * @return false|string

      */

     public function registerSale($itemId, $paymentType)

     {

@@ -884,7 +884,7 @@ 
 

     /**

      * Get payment types

-     * @return array

+     * @return string[]

      */

     public function getPaymentTypes()

     {

@@ -922,7 +922,7 @@ 
 

     /**

      * Get the statuses for sales

-     * @return array

+     * @return string[]

      */

     public function getSaleStatuses()

     {

@@ -935,7 +935,7 @@ 
     

     /**

      * Get the statuses for Payouts

-     * @return array

+     * @return string[]

      */

     public function getPayoutStatuses()

     {

@@ -948,7 +948,7 @@ 
 

     /**

      * Get the list of product types

-     * @return array

+     * @return string[]

      */

     public function getProductTypes()

     {

@@ -1329,7 +1329,7 @@ 
     /**

      * Register a item

      * @param array $itemData The item data

-     * @return int The item ID. Otherwise return false

+     * @return false|string The item ID. Otherwise return false

      */

     public function registerItem(array $itemData)

     {

@@ -1487,7 +1487,7 @@ 
     /**

      * Verify if the beneficiary have a paypal account

      * @param int $userId

-     * @return true if the user have a paypal account, false if not

+     * @return boolean if the user have a paypal account, false if not

      */

     public function verifyPaypalAccountByBeneficiary($userId)

     {

Spacing +9 added lines, -9 removed lines

@@ -87,7 +87,7 @@ 
             return false;

         }

 

-        require_once api_get_path(SYS_PLUGIN_PATH) . 'buycourses/database.php';

+        require_once api_get_path(SYS_PLUGIN_PATH).'buycourses/database.php';

     }

 

     /**

@@ -652,7 +652,7 @@ 
         );

 

         if (!empty($sessionImage)) {

-            $sessionInfo['image'] = api_get_path(WEB_UPLOAD_PATH) . $sessionImage['value'];

+            $sessionInfo['image'] = api_get_path(WEB_UPLOAD_PATH).$sessionImage['value'];

         }

 

         $sessionCourses = $session->getCourses();

@@ -1094,7 +1094,7 @@ 
 

         $str = '';

 

-        srand((double)microtime() * 1000000);

+        srand((double) microtime() * 1000000);

 

         for ($i = 0; $i < $length; $i++) {

             $numbers = rand(0, strlen($salt) - 1);

@@ -1441,8 +1441,8 @@ 
      */

     public function getPayouts($status = self::PAYOUT_STATUS_PENDING, $payoutId = false, $userId = false)

     {

-        $condition = ($payoutId) ? 'AND p.id = '. intval($payoutId) : '';

-        $condition2 = ($userId) ? ' AND p.user_id = ' . intval($userId) : '';

+        $condition = ($payoutId) ? 'AND p.id = '.intval($payoutId) : '';

+        $condition2 = ($userId) ? ' AND p.user_id = '.intval($userId) : '';

         $typeResult = ($condition) ? 'first' : 'all';

         $payoutsTable = Database::get_main_table(BuyCoursesPlugin::TABLE_PAYPAL_PAYOUTS);

         $saleTable = Database::get_main_table(BuyCoursesPlugin::TABLE_SALE);

@@ -1469,14 +1469,14 @@ 
             INNER JOIN $saleTable s ON s.id = p.sale_id

             INNER JOIN $currencyTable c ON s.currency_id = c.id

             LEFT JOIN  $extraFieldValues efv ON p.user_id = efv.item_id 

-            AND field_id = " . intval($paypalExtraField['id']) . "

+            AND field_id = ".intval($paypalExtraField['id'])."

         ";

         

         $payouts = Database::select(

             "p.* , u.firstname, u.lastname, efv.value as paypal_account, s.reference as sale_reference, s.price as item_price, c.iso_code",

             "$payoutsTable p $innerJoins",

             [

-                'where' => ['p.status = ? '.$condition . ' ' .$condition2 => $status]

+                'where' => ['p.status = ? '.$condition.' '.$condition2 => $status]

             ],

             $typeResult

         );

@@ -1540,7 +1540,7 @@ 
         $platformCommission = $this->getPlatformCommission();

 

         $sale = $this->getSale($saleId);

-        $teachersCommission = number_format((floatval($sale['price']) * intval($platformCommission['commission']))/100, 2);

+        $teachersCommission = number_format((floatval($sale['price']) * intval($platformCommission['commission'])) / 100, 2);

         

         

         $beneficiaries = $this->getBeneficiariesBySale($saleId);

@@ -1552,7 +1552,7 @@ 
                     'payout_date' => getdate(),

                     'sale_id' => intval($saleId),

                     'user_id' => $beneficiary['user_id'],

-                    'commission' => number_format((floatval($teachersCommission) * intval($beneficiary['commissions']))/100, 2),

+                    'commission' => number_format((floatval($teachersCommission) * intval($beneficiary['commissions'])) / 100, 2),

                     'status' => self::PAYOUT_STATUS_PENDING

                 ]

             );

plugin/buycourses/src/paypalfunctions.php

Doc Comments +2 added lines

@@ -324,6 +324,8 @@
  * @nvpStr is nvp string.

  * returns an associtive array containing the response from the server.

  *

+ * @param string $methodName
+ * @param string $nvpStr
  */

 function hash_call($methodName, $nvpStr)

 {

Indentation +4 added lines, -4 removed lines

@@ -111,8 +111,8 @@ 
  *		phoneNum:			the phoneNum  entered on the merchant's site

  */

 function CallMarkExpressCheckout($paymentAmount, $currencyCodeType, $paymentType, $returnURL,

-                                 $cancelURL, $shipToName, $shipToStreet, $shipToCity, $shipToState,

-                                 $shipToCountryCode, $shipToZip, $shipToStreet2, $phoneNum

+                                    $cancelURL, $shipToName, $shipToStreet, $shipToCity, $shipToState,

+                                    $shipToCountryCode, $shipToZip, $shipToStreet2, $phoneNum

 )

 {

     // Construct the parameter string that describes the SetExpressCheckout API call in the shortcut implementation

@@ -265,8 +265,8 @@ 
  */

 

 function DirectPayment($paymentType, $paymentAmount, $creditCardType, $creditCardNumber,

-                       $expDate, $cvv2, $firstName, $lastName, $street, $city, $state, $zip,

-                       $countryCode, $currencyCode)

+                        $expDate, $cvv2, $firstName, $lastName, $street, $city, $state, $zip,

+                        $countryCode, $currencyCode)

 {

     //Construct the parameter string that describes DoDirectPayment

     $nvpstr = "&AMT=" . $paymentAmount;

Spacing +44 added lines, -44 removed lines

@@ -67,12 +67,12 @@ 
 function CallShortcutExpressCheckout($paymentAmount, $currencyCodeType, $paymentType, $returnURL, $cancelURL, $extra)

 {

     // Construct the parameter string that describes the SetExpressCheckout API call in the shortcut implementation

-    $nvpstr = "&PAYMENTREQUEST_0_AMT=" . $paymentAmount;

-    $nvpstr .= "&PAYMENTREQUEST_0_ITEMAMT=" . $paymentAmount;

-    $nvpstr .= "&PAYMENTREQUEST_0_PAYMENTACTION=" . $paymentType;

-    $nvpstr .= "&RETURNURL=" . $returnURL;

-    $nvpstr .= "&CANCELURL=" . $cancelURL;

-    $nvpstr .= "&PAYMENTREQUEST_0_CURRENCYCODE=" . $currencyCodeType;

+    $nvpstr = "&PAYMENTREQUEST_0_AMT=".$paymentAmount;

+    $nvpstr .= "&PAYMENTREQUEST_0_ITEMAMT=".$paymentAmount;

+    $nvpstr .= "&PAYMENTREQUEST_0_PAYMENTACTION=".$paymentType;

+    $nvpstr .= "&RETURNURL=".$returnURL;

+    $nvpstr .= "&CANCELURL=".$cancelURL;

+    $nvpstr .= "&PAYMENTREQUEST_0_CURRENCYCODE=".$currencyCodeType;

     $nvpstr .= $extra;

 

     $_SESSION["currencyCodeType"] = $currencyCodeType;

@@ -116,20 +116,20 @@ 
 )

 {

     // Construct the parameter string that describes the SetExpressCheckout API call in the shortcut implementation

-    $nvpstr = "&PAYMENTREQUEST_0_AMT=" . $paymentAmount;

-    $nvpstr = $nvpstr . "&PAYMENTREQUEST_0_PAYMENTACTION=" . $paymentType;

-    $nvpstr = $nvpstr . "&RETURNURL=" . $returnURL;

-    $nvpstr = $nvpstr . "&CANCELURL=" . $cancelURL;

-    $nvpstr = $nvpstr . "&PAYMENTREQUEST_0_CURRENCYCODE=" . $currencyCodeType;

-    $nvpstr = $nvpstr . "&ADDROVERRIDE=1";

-    $nvpstr = $nvpstr . "&PAYMENTREQUEST_0_SHIPTONAME=" . $shipToName;

-    $nvpstr = $nvpstr . "&PAYMENTREQUEST_0_SHIPTOSTREET=" . $shipToStreet;

-    $nvpstr = $nvpstr . "&PAYMENTREQUEST_0_SHIPTOSTREET2=" . $shipToStreet2;

-    $nvpstr = $nvpstr . "&PAYMENTREQUEST_0_SHIPTOCITY=" . $shipToCity;

-    $nvpstr = $nvpstr . "&PAYMENTREQUEST_0_SHIPTOSTATE=" . $shipToState;

-    $nvpstr = $nvpstr . "&PAYMENTREQUEST_0_SHIPTOCOUNTRYCODE=" . $shipToCountryCode;

-    $nvpstr = $nvpstr . "&PAYMENTREQUEST_0_SHIPTOZIP=" . $shipToZip;

-    $nvpstr = $nvpstr . "&PAYMENTREQUEST_0_SHIPTOPHONENUM=" . $phoneNum;

+    $nvpstr = "&PAYMENTREQUEST_0_AMT=".$paymentAmount;

+    $nvpstr = $nvpstr."&PAYMENTREQUEST_0_PAYMENTACTION=".$paymentType;

+    $nvpstr = $nvpstr."&RETURNURL=".$returnURL;

+    $nvpstr = $nvpstr."&CANCELURL=".$cancelURL;

+    $nvpstr = $nvpstr."&PAYMENTREQUEST_0_CURRENCYCODE=".$currencyCodeType;

+    $nvpstr = $nvpstr."&ADDROVERRIDE=1";

+    $nvpstr = $nvpstr."&PAYMENTREQUEST_0_SHIPTONAME=".$shipToName;

+    $nvpstr = $nvpstr."&PAYMENTREQUEST_0_SHIPTOSTREET=".$shipToStreet;

+    $nvpstr = $nvpstr."&PAYMENTREQUEST_0_SHIPTOSTREET2=".$shipToStreet2;

+    $nvpstr = $nvpstr."&PAYMENTREQUEST_0_SHIPTOCITY=".$shipToCity;

+    $nvpstr = $nvpstr."&PAYMENTREQUEST_0_SHIPTOSTATE=".$shipToState;

+    $nvpstr = $nvpstr."&PAYMENTREQUEST_0_SHIPTOCOUNTRYCODE=".$shipToCountryCode;

+    $nvpstr = $nvpstr."&PAYMENTREQUEST_0_SHIPTOZIP=".$shipToZip;

+    $nvpstr = $nvpstr."&PAYMENTREQUEST_0_SHIPTOPHONENUM=".$phoneNum;

 

     $_SESSION["currencyCodeType"] = $currencyCodeType;

     $_SESSION["PaymentType"] = $paymentType;

@@ -172,7 +172,7 @@ 
      * Build a second API request to PayPal, using the token as the

      * ID to get the details on the payment authorization

      */

-    $nvpstr = "&TOKEN=" . $token;

+    $nvpstr = "&TOKEN=".$token;

 

     /**

      * Make the API call and store the results in an array.

@@ -213,9 +213,9 @@ 
     $payerID = urlencode($_SESSION['payer_id']);

     $serverName = urlencode($_SERVER['SERVER_NAME']);

 

-    $nvpstr = '&TOKEN=' . $token . '&PAYERID=' . $payerID . '&PAYMENTREQUEST_0_PAYMENTACTION=' . $paymentType . '&PAYMENTREQUEST_0_AMT=' . $FinalPaymentAmt;

-    $nvpstr .= '&PAYMENTREQUEST_0_CURRENCYCODE=' . $currencyCodeType . '&IPADDRESS=' . $serverName;

-    $nvpstr = '&' . http_build_query([

+    $nvpstr = '&TOKEN='.$token.'&PAYERID='.$payerID.'&PAYMENTREQUEST_0_PAYMENTACTION='.$paymentType.'&PAYMENTREQUEST_0_AMT='.$FinalPaymentAmt;

+    $nvpstr .= '&PAYMENTREQUEST_0_CURRENCYCODE='.$currencyCodeType.'&IPADDRESS='.$serverName;

+    $nvpstr = '&'.http_build_query([

         'TOKEN' => $token,

         'PAYERID' => $payerID,

         'PAYMENTACTION' => $paymentType,

@@ -269,20 +269,20 @@ 
                        $countryCode, $currencyCode)

 {

     //Construct the parameter string that describes DoDirectPayment

-    $nvpstr = "&AMT=" . $paymentAmount;

-    $nvpstr = $nvpstr . "&CURRENCYCODE=" . $currencyCode;

-    $nvpstr = $nvpstr . "&PAYMENTACTION=" . $paymentType;

-    $nvpstr = $nvpstr . "&CREDITCARDTYPE=" . $creditCardType;

-    $nvpstr = $nvpstr . "&ACCT=" . $creditCardNumber;

-    $nvpstr = $nvpstr . "&EXPDATE=" . $expDate;

-    $nvpstr = $nvpstr . "&CVV2=" . $cvv2;

-    $nvpstr = $nvpstr . "&FIRSTNAME=" . $firstName;

-    $nvpstr = $nvpstr . "&LASTNAME=" . $lastName;

-    $nvpstr = $nvpstr . "&STREET=" . $street;

-    $nvpstr = $nvpstr . "&CITY=" . $city;

-    $nvpstr = $nvpstr . "&STATE=" . $state;

-    $nvpstr = $nvpstr . "&COUNTRYCODE=" . $countryCode;

-    $nvpstr = $nvpstr . "&IPADDRESS=" . $_SERVER['REMOTE_ADDR'];

+    $nvpstr = "&AMT=".$paymentAmount;

+    $nvpstr = $nvpstr."&CURRENCYCODE=".$currencyCode;

+    $nvpstr = $nvpstr."&PAYMENTACTION=".$paymentType;

+    $nvpstr = $nvpstr."&CREDITCARDTYPE=".$creditCardType;

+    $nvpstr = $nvpstr."&ACCT=".$creditCardNumber;

+    $nvpstr = $nvpstr."&EXPDATE=".$expDate;

+    $nvpstr = $nvpstr."&CVV2=".$cvv2;

+    $nvpstr = $nvpstr."&FIRSTNAME=".$firstName;

+    $nvpstr = $nvpstr."&LASTNAME=".$lastName;

+    $nvpstr = $nvpstr."&STREET=".$street;

+    $nvpstr = $nvpstr."&CITY=".$city;

+    $nvpstr = $nvpstr."&STATE=".$state;

+    $nvpstr = $nvpstr."&COUNTRYCODE=".$countryCode;

+    $nvpstr = $nvpstr."&IPADDRESS=".$_SERVER['REMOTE_ADDR'];

 

     $resArray = hash_call("DoDirectPayment", $nvpstr);

 

@@ -345,13 +345,13 @@ 
     //if USE_PROXY constant set to TRUE in Constants.php, then only proxy will be enabled.

     //Set proxy name to PROXY_HOST and port number to PROXY_PORT in constants.php

     if ($USE_PROXY) {

-        curl_setopt($ch, CURLOPT_PROXY, $PROXY_HOST . ":" . $PROXY_PORT);

+        curl_setopt($ch, CURLOPT_PROXY, $PROXY_HOST.":".$PROXY_PORT);

     }

 

     //NVPRequest for submitting to server

-    $nvpreq = "METHOD=" . urlencode($methodName) . "&VERSION=" . urlencode($version) .

-        "&PWD=" . urlencode($API_Password) . "&USER=" . urlencode($API_UserName) .

-        "&SIGNATURE=" . urlencode($API_Signature) . $nvpStr . "&BUTTONSOURCE=" . urlencode($sBNCode);

+    $nvpreq = "METHOD=".urlencode($methodName)."&VERSION=".urlencode($version).

+        "&PWD=".urlencode($API_Password)."&USER=".urlencode($API_UserName).

+        "&SIGNATURE=".urlencode($API_Signature).$nvpStr."&BUTTONSOURCE=".urlencode($sBNCode);

 

     //setting the nvpreq as POST FIELD to curl

     curl_setopt($ch, CURLOPT_POSTFIELDS, $nvpreq);

@@ -385,8 +385,8 @@ 
 {

     global $PAYPAL_URL;

     // Redirect to paypal.com here

-    $payPalURL = $PAYPAL_URL . $token;

-    header("Location: " . $payPalURL);

+    $payPalURL = $PAYPAL_URL.$token;

+    header("Location: ".$payPalURL);

     exit;

 }

 

plugin/clockworksms/lib/clockworksms_plugin.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -14,7 +14,7 @@
     /**
      * create (a singleton function that ensures ClockworksmsPlugin instance is
      * created only once. If it is already created, it returns the instance)
-     * @return  object  ClockworksmsPlugin instance
+     * @return  ClockworksmsPlugin  ClockworksmsPlugin instance
      */
     public static function create()
     {