adamjakab / SuiteCRM

service/v3_1/SugarWebServiceImplv3_1.php

Doc Comments +2 added lines, -2 removed lines

@@ -61,7 +61,7 @@ 
     * @param String $id -- The SugarBean's ID value.
     * @param Array  $select_fields -- A list of the fields to be included in the results. This optional parameter allows for only needed fields to be retrieved.
     * @param Array $link_name_to_fields_array -- A list of link_names and for each link_name, what fields value to be returned. For ex.'link_name_to_fields_array' => array(array('name' =>  'email_addresses', 'value' => array('id', 'email_address', 'opt_out', 'primary_address')))
-    * @param bool $trackView -- Should we track the record accessed.
+    * @param bool $track_view -- Should we track the record accessed.
     * @return Array
     *        'entry_list' -- Array - The records name value pair for the simple data types excluding link field data.
     *	     'relationship_list' -- Array - The records link field data. The example is if asked about accounts email address then return data would look like Array ( [0] => Array ( [name] => email_addresses [records] => Array ( [0] => Array ( [0] => Array ( [name] => id [value] => 3fb16797-8d90-0a94-ac12-490b63a6be67 ) [1] => Array ( [name] => email_address [value] => hr.kid.qa@example.com ) [2] => Array ( [name] => opt_out [value] => 0 ) [3] => Array ( [name] => primary_address [value] => 1 ) ) [1] => Array ( [0] => Array ( [name] => id [value] => 403f8da1-214b-6a88-9cef-490b63d43566 ) [1] => Array ( [name] => email_address [value] => kid.hr@example.name ) [2] => Array ( [name] => opt_out [value] => 0 ) [3] => Array ( [name] => primary_address [value] => 0 ) ) ) ) )
@@ -125,7 +125,7 @@ 
     * @param Array $ids -- An array of SugarBean IDs.
     * @param Array $select_fields -- A list of the fields to be included in the results. This optional parameter allows for only needed fields to be retrieved.
     * @param Array $link_name_to_fields_array -- A list of link_names and for each link_name, what fields value to be returned. For ex.'link_name_to_fields_array' => array(array('name' =>  'email_addresses', 'value' => array('id', 'email_address', 'opt_out', 'primary_address')))
-    * @param bool $trackView -- Should we track the record accessed.
+    * @param bool $track_view -- Should we track the record accessed.
     * @return Array
     *        'entry_list' -- Array - The records name value pair for the simple data types excluding link field data.
     *	     'relationship_list' -- Array - The records link field data. The example is if asked about accounts email address then return data would look like Array ( [0] => Array ( [name] => email_addresses [records] => Array ( [0] => Array ( [0] => Array ( [name] => id [value] => 3fb16797-8d90-0a94-ac12-490b63a6be67 ) [1] => Array ( [name] => email_address [value] => hr.kid.qa@example.com ) [2] => Array ( [name] => opt_out [value] => 0 ) [3] => Array ( [name] => primary_address [value] => 1 ) ) [1] => Array ( [0] => Array ( [name] => id [value] => 403f8da1-214b-6a88-9cef-490b63d43566 ) [1] => Array ( [name] => email_address [value] => kid.hr@example.name ) [2] => Array ( [name] => opt_out [value] => 0 ) [3] => Array ( [name] => primary_address [value] => 0 ) ) ) ) )

service/v4/SugarWebServiceUtilv4.php

Doc Comments +7 added lines, -1 removed lines

@@ -143,7 +143,7 @@ 
 	/**
 	 * Processes the filter_fields attribute to use with SugarBean::create_new_list_query()
 	 *
-	 * @param object $value SugarBean
+	 * @param SugarBean $value SugarBean
 	 * @param array $fields
 	 * @return array
 	 */
@@ -454,6 +454,12 @@ 
 	}
 
 
+    /**
+     * @param string $login_error_key
+     * @param string $access_level
+     * @param string $module_access_level_error_key
+     * @param SoapError $errorObject
+     */
     function checkSessionAndModuleAccess($session, $login_error_key, $module_name, $access_level, $module_access_level_error_key, $errorObject)
     {
           if(isset($_REQUEST['oauth_token'])) {

service/v4_1/SugarWebServiceImplv4_1.php

Doc Comments +1 added lines, -1 removed lines

@@ -75,7 +75,7 @@
      * @param Array $related_module_link_name_to_fields_array - For every related bean returrned, specify link fields name to fields info for that bean to be returned. For ex.'link_name_to_fields_array' => array(array('name' =>  'email_addresses', 'value' => array('id', 'email_address', 'opt_out', 'primary_address'))).
      * @param Number $deleted -- false if deleted records should not be include, true if deleted records should be included.
      * @param String $order_by -- field to order the result sets by
-     * @param Number $offset -- where to start in the return
+     * @param integer $offset -- where to start in the return
      * @param Number $limit -- number of results to return (defaults to all)
      * @return Array 'entry_list' -- Array - The records that were retrieved
      *               'relationship_list' -- Array - The records link field data. The example is if asked about accounts contacts email address then return data would look like Array ( [0] => Array ( [name] => email_addresses [records] => Array ( [0] => Array ( [0] => Array ( [name] => id [value] => 3fb16797-8d90-0a94-ac12-490b63a6be67 ) [1] => Array ( [name] => email_address [value] => hr.kid.qa@example.com ) [2] => Array ( [name] => opt_out [value] => 0 ) [3] => Array ( [name] => primary_address [value] => 1 ) ) [1] => Array ( [0] => Array ( [name] => id [value] => 403f8da1-214b-6a88-9cef-490b63d43566 ) [1] => Array ( [name] => email_address [value] => kid.hr@example.name ) [2] => Array ( [name] => opt_out [value] => 0 ) [3] => Array ( [name] => primary_address [value] => 0 ) ) ) ) )

service/v4_1/SugarWebServiceUtilv4_1.php

Doc Comments +4 added lines, -4 removed lines

@@ -45,8 +45,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)
     {
@@ -103,12 +103,12 @@ 
      * getRelationshipResults
      * Returns the
      *
-     * @param Mixed $bean The SugarBean instance to retrieve relationships from
+     * @param SugarBean $bean The SugarBean instance to retrieve relationships from
      * @param String $link_field_name The name of the relationship entry to fetch relationships for
      * @param Array $link_module_fields Array of fields of relationship entries to return
      * @param string $optional_where String containing an optional WHERE select clause
      * @param string $order_by String containing field to order results by
-     * @param Number $offset -- where to start in the return (defaults to 0)
+     * @param integer $offset -- where to start in the return (defaults to 0)
      * @param Number $limit -- number of results to return (defaults to all)
      * @return array|bool Returns an Array of relationship results; false if relationship could not be retrieved
      */

soap/SoapDeprecated.php

Doc Comments +3 added lines, -8 removed lines

@@ -208,8 +208,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){
 	global $server, $current_user, $sugar_config, $system_config;
@@ -479,7 +479,6 @@ 
 /**
  * Internal: convert a bean into an array
  *
- * @param Bean $bean -- The bean to convert
  * @param int $msi_id -- Russult array index
  * @return An associated array containing the detail fields.
  */
@@ -573,7 +572,6 @@ 
 /**
  * Internal: convert a bean into an array
  *
- * @param Bean $bean -- The bean to convert
  * @param int $msi_id -- Russult array index
  * @return An associated array containing the detail fields.
  */
@@ -612,7 +610,6 @@ 
 /**
  * Internal: convert a bean into an array
  *
- * @param Bean $bean -- The bean to convert
  * @param int $msi_id -- Russult array index
  * @return An associated array containing the detail fields.
  */
@@ -651,7 +648,6 @@ 
 /**
  * Internal: convert a bean into an array
  *
- * @param Bean $bean -- The bean to convert
  * @param int $msi_id -- Russult array index
  * @return An associated array containing the detail fields.
  */
@@ -691,8 +687,8 @@ 
 /**
  * Internal: convert a bean into an array
  *
- * @param Bean $bean -- The bean to convert
  * @param int $msi_id -- Russult array index
+ * @param string $type
  * @return An associated array containing the detail fields.
  */
 function get_bean_array($value, $msi_id, $type){
@@ -708,7 +704,6 @@ 
 /**
  * Internal: convert a bean into an array
  *
- * @param Bean $bean -- The bean to convert
  * @param int $msi_id -- Russult array index
  * @return An associated array containing the detail fields.
  */

soap/SoapError.php

Doc Comments +3 added lines

@@ -48,6 +48,9 @@
 		$this->set_error('no_error');
 	}
 
+	/**
+	 * @param string $error_name
+	 */
 	function set_error($error_name){
 		global $error_defs;
 		if(!isset($error_defs[$error_name])){

soap/SoapHelperFunctions.php

Doc Comments +4 added lines, -1 removed lines

@@ -611,7 +611,7 @@ 
  * @param String $module_id -- The ID of the bean in the specified module
  * @param String $link_field_name - The relationship name for which to create realtionships.
  * @param Array $related_ids -- The array of ids for which we want to create relationships
- * @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) {
     global  $beanList, $beanFiles;
@@ -1037,6 +1037,9 @@ 
         return false;
 }
 
+/**
+ * @param string $file_in_zip
+ */
 function getFile( $zip_file, $file_in_zip ){
     $base_upgrade_dir = sugar_cached("/upgrades");
     $base_tmp_upgrade_dir   = "$base_upgrade_dir/temp";

soap/SoapPortalHelper.php

Doc Comments +15 added lines

@@ -125,6 +125,9 @@ 
 */
 
 
+/**
+ * @param string $in
+ */
 function get_notes_in_contacts($in, $orderBy = '')
     {
         //bail if the in is empty
@@ -140,6 +143,9 @@ 
         return $contact->build_related_list($query, $note);
     }
 
+/**
+ * @param string $in
+ */
 function get_notes_in_module($in, $module, $orderBy = '')
     {
         //bail if the in is empty
@@ -163,6 +169,9 @@ 
         return $sugar->build_related_list($query, $note);
     }
 
+    /**
+     * @param string $in
+     */
     function get_related_in_module($in, $module, $rel_module, $orderBy = '', $row_offset = 0, $limit= -1)
     {
         global $beanList, $beanFiles;
@@ -245,6 +254,9 @@ 
         set_module_in($sugar->build_related_in($query), 'Contacts');
     }
 
+/**
+ * @param string $in
+ */
 function get_related_list($in, $template, $where, $order_by, $row_offset = 0, $limit = ""){
 
         $q = '';
@@ -271,6 +283,9 @@ 
 
     }
 
+/**
+ * @param Contact $contact
+ */
 function build_relationship_tree($contact){
     global $sugar_config;
     $contact->retrieve($contact->id);

soap/SoapRelationshipHelper.php

Doc Comments +8 added lines

@@ -146,6 +146,9 @@ 
  *         error Mixed Array containing the SOAP errors if found, empty otherwise
  *
  */
+/**
+ * @param integer $show_deleted
+ */
 function retrieve_modified_relationships($module_name, $related_module, $relationship_query, $show_deleted, $offset, $max_results, $select_fields = array(), $relationship_name = ''){
 
     global  $beanList, $beanFiles, $dictionary, $current_user;
@@ -480,6 +483,11 @@ 
 
 // Retrieves array of ids for records of $get_module linked to $from_module by $get_id
 // Example: to retrieve list of Contacts associated to Account X: $return = get_linked_records("Contacts", "Accounts", "X");
+/**
+ * @param string $get_module
+ * @param string $from_module
+ * @param string $get_id
+ */
 function get_linked_records($get_module, $from_module, $get_id) {
 	global $beanList, $beanFiles;