adamjakab / SuiteCRM

modules/Users/authentication/SAMLAuthenticate/SAMLAuthenticateUser.php

Doc Comments +1 added lines, -1 removed lines

@@ -338,7 +338,7 @@
     /**
      * Fetches user by provided ID and field name
      *
-     * @param mixed $id
+     * @param string $id
      * @param string $field
      * @return User
      */

modules/Users/password_utils.php

Doc Comments +3 added lines

@@ -79,6 +79,9 @@
 		return $mod_strings['LBL_EMAIL_NOT_SENT'];
 }
 
+/**
+ * @param string $username
+ */
 function  hasPasswordExpired($username){
     $current_user= new user();
     $usr_id=$current_user->retrieve_user_id($username);

modules/Users/UserViewHelper.php

Doc Comments +1 added lines, -1 removed lines

@@ -760,7 +760,7 @@
      * setUserType
      * This function is used to set the user_type variable for a given User instance
      *
-     * @param Mixed $user The user instance to set the user_type variable on
+     * @param SugarBean $user The user instance to set the user_type variable on
      * @return String value representing the user type
      */
     function setUserType($user)

modules/Users/views/view.wizard.php

Doc Comments +2 added lines, -2 removed lines

@@ -267,7 +267,7 @@ 
      * in the array.
      *
      * @param array $currenciesArray Array of currencies to sort
-     * @return array|string Array of sorted currencies with the US Dollar as the first
+     * @return string Array of sorted currencies with the US Dollar as the first
      */
     public function correctCurrenciesSymbolsSort($currenciesArray)
     {
@@ -289,7 +289,7 @@ 
      *
      * @see correctCurrenciesSymbolsSort
      * @param $array
-     * @return array|string Javascript code snippet of currencies array
+     * @return string Javascript code snippet of currencies array
      */
     public function pushCurrencyArrayToString($array)
     {

modules/vCals/HTTP_WebDAV_Server_vCal.php

Doc Comments +2 added lines, -2 removed lines

@@ -392,7 +392,7 @@ 
          * PUT method handler
          *
          * @param  array  parameter passing array
-         * @return bool   true on success
+         * @return boolean|null   true on success
          */
         function PUT(&$options)
         {
@@ -416,7 +416,7 @@ 
          * UNLOCK method handler
          *
          * @param  array  general parameter passing array
-         * @return bool   true on success
+         * @return string   true on success
          */
         function unlock(&$options)
         {

modules/vCals/vCal.php

Doc Comments +2 added lines, -2 removed lines

@@ -314,7 +314,7 @@ 
      * escape iCal chars as per RFC 5545: http://tools.ietf.org/html/rfc5545#section-3.3.11
      *
      * @param string $string string to escape chars
-     * @return escaped string
+     * @return string string
      */
     public static function escape_ical_chars($string)
     {
@@ -326,7 +326,7 @@ 
      * unescape iCal chars as per RFC 5545: http://tools.ietf.org/html/rfc5545#section-3.3.11
      *
      * @param string $string string to escape chars
-     * @return unescaped string
+     * @return string string
      */
     public static function unescape_ical_chars($string)
     {

service/core/PHP5Soap.php

Doc Comments +3 added lines

@@ -106,6 +106,9 @@
 		} // if
 	} // fn
 
+	/**
+	 * @param boolean $generateWSDL
+	 */
 	public function getWSDLPath($generateWSDL) {
 		$wsdlURL = $this->getSoapURL().'?wsdl';
 		$wsdlCacheFile = 'upload://wsdlcache-' . md5($wsdlURL);

service/core/REST/SugarRestRSS.php

Doc Comments +3 added lines

@@ -64,6 +64,9 @@
 		$this->generateResponseFooter();
 	} // fn
 
+	/**
+	 * @param integer $count
+	 */
 	protected function generateResponseHeader($count)
 	{
 	    global $app_strings, $sugar_version, $sugar_flavor;

service/core/SoapHelperWebService.php

Doc Comments +19 added lines, -5 removed lines

@@ -154,8 +154,8 @@ 
  *
  * @param string $user_name -- The user name to create a session for
  * @param string $password -- The MD5 sum of the user's password
- * @return true -- If the session is created
- * @return false -- If the session is not created
+ * @return boolean|null -- If the session is created
+ * @return boolean|null -- If the session is not created
  */
 function validate_user($user_name, $password){
 	$GLOBALS['log']->info('Begin: SoapHelperWebServices->validate_user');
@@ -193,8 +193,8 @@ 
 	 * Validate the provided session information is correct and current.  Load the session.
 	 *
 	 * @param String $session_id -- The session ID that was returned by a call to login.
-	 * @return true -- If the session is valid and loaded.
-	 * @return false -- if the session is not valid.
+	 * @return boolean -- If the session is valid and loaded.
+	 * @return boolean -- if the session is not valid.
 	 */
 	function validate_authenticated($session_id){
 		$GLOBALS['log']->info('Begin: SoapHelperWebServices->validate_authenticated');
@@ -303,6 +303,11 @@ 
 		return true;
 	} // fn
 
+	/**
+	 * @param string $viewType
+	 * @param SoapError $errorObject
+	 * @param string $error_key
+	 */
 	function checkACLAccess($bean, $viewType, $errorObject, $error_key) {
 		$GLOBALS['log']->info('Begin: SoapHelperWebServices->checkACLAccess');
 		if(!$bean->ACLAccess($viewType)) {
@@ -316,6 +321,9 @@ 
 		return true;
 	} // fn
 
+	/**
+	 * @param SoapError $errorObject
+	 */
 	function checkQuery($errorObject, $query, $order_by = '')
     {
         require_once 'include/SugarSQLValidate.php';
@@ -695,7 +703,7 @@ 
 	 * @param Array $related_ids -- The array of ids for which we want to create relationships
 	 * @param Array $name_value_list -- The array of name value pair of additional attributes to be set when adding this relationship
 	 * @param int delete -- If 0 then add relationship else delete this relationship data
-	 * @return true on success, false on failure
+	 * @return boolean on success, false on failure
 	 */
 	function new_handle_set_relationship($module_name, $module_id, $link_field_name, $related_ids, $name_value_list, $delete) {
 		$GLOBALS['log']->info('Begin: SoapHelperWebServices->new_handle_set_relationship');
@@ -743,6 +751,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $module_name
+	 */
 	function new_handle_set_entries($module_name, $name_value_lists, $select_fields = FALSE) {
 		$GLOBALS['log']->info('Begin: SoapHelperWebServices->new_handle_set_entries');
 		global $beanList, $beanFiles, $current_user, $app_list_strings;
@@ -907,6 +918,9 @@ 
 	}
 
 
+	/**
+	 * @param string $module
+	 */
 	function get_return_module_fields($value, $module,$fields, $translate=true){
 		$GLOBALS['log']->info('Begin: SoapHelperWebServices->get_return_module_fields');
 		global $module_name;