adamjakab / SuiteCRM

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;
 

soap/SoapSugarUsers.php

Doc Comments +10 added lines, -8 removed lines

@@ -168,8 +168,8 @@ 
  * Check to see if the soap server and client are on the same machine.
  * We don't allow a server to sync to itself.
  *
- * @return true -- if the SOAP server and client are on the same machine
- * @return false -- if the SOAP server and client are not on the same machine.
+ * @return integer -- if the SOAP server and client are on the same machine
+ * @return integer -- if the SOAP server and client are not on the same machine.
  */
 function is_loopback(){
 	if(query_client_ip() == $_SERVER['SERVER_ADDR'])
@@ -181,8 +181,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){
 	if(!empty($session_id)){
@@ -261,8 +261,8 @@ 
  * Perform a seamless login.  This is used internally during the sync process.
  *
  * @param String $session -- Session ID returned by a previous call to login.
- * @return true -- if the session was authenticated
- * @return false -- if the session could not be authenticated
+ * @return integer -- if the session was authenticated
+ * @return integer -- if the session could not be authenticated
  */
 function seamless_login($session){
 		if(!validate_authenticated($session)){
@@ -464,7 +464,7 @@ 
  *
  * @param String $session -- Session ID returned by a previous call to login.
  * @param String $module_name -- The name of the module to return records from.  This name should be the name the module was developed under (changing a tab name is studio does not affect the name that should be passed into this method)..
- * @param Array $ids -- An array of SugarBean IDs.
+ * @param string[] $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.
  * @return Array 'field_list' -- Var def information about the returned fields
  *               'entry_list' -- The records that were retrieved
@@ -680,7 +680,6 @@ 
 /**
  * Retrieve an attachment from a note
  * @param String $session -- Session ID returned by a previous call to login.
- * @param Binary $note -- The flie contents of the attachment.
  * @return Array 'id' -- The ID of the new note or -1 on error
  *               'error' -- The SOAP error if any.
  *
@@ -2152,6 +2151,9 @@ 
 }
 
 // INTERNAL FUNCTION NOT EXPOSED THROUGH API
+/**
+ * @param string $module_name
+ */
 function handle_set_entries($module_name, $name_value_lists, $select_fields = FALSE) {
 	global $beanList, $beanFiles, $app_list_strings, $current_user;
 

src/SuiteCrm/Command/CacheClearCommand.php

Doc Comments +1 added lines, -1 removed lines

@@ -32,7 +32,7 @@
     /**
      * @param InputInterface $input
      * @param OutputInterface $output
-     * @return bool
+     * @return boolean|null
      */
     protected function execute(InputInterface $input, OutputInterface $output) {
         parent::_execute($input, $output);

SugarSecurity.php

Doc Comments +3 added lines

@@ -72,6 +72,9 @@
 		}
 	}
 	
+	/**
+	 * @param string $contents
+	 */
 	function scanContents($contents){
 		return;	
 	}

XTemplate/xtpl.php

Doc Comments +9 added lines

@@ -278,6 +278,9 @@ 
 /*
 	returns true if a block exists otherwise returns false.
 */
+/**
+ * @param string $bname
+ */
 function exists($bname){
 	return (!empty($this->parsed_blocks[$bname])) || (!empty($this->blocks[$bname]));
 }
@@ -325,6 +328,9 @@ 
 	returns the parsed text for a block
 */
 
+/**
+ * @return string
+ */
 function text($bname) {
 
     if(!empty($this->parsed_blocks)){
@@ -446,6 +452,9 @@ 
 */
 
 
+/**
+ * @param string $block
+ */
 function maketree($con,$block) {
 	$con2=explode($this->block_start_delim,$con);
 	$level=0;

include/generic/SugarWidgets/SugarWidgetField.php

Doc Comments +3 added lines

@@ -361,6 +361,9 @@
 		return $this->recursiveVariableReplace($defs, $module, $var_values);
 	}
 
+	/**
+	 * @return string
+	 */
 	public function getModuleDir(){
 		return $this->module_dir;
 	}