adamjakab / SuiteCRM

modules/ModuleBuilder/views/view.dashlet.php

Doc Comments +3 added lines

@@ -177,6 +177,9 @@
         return $ajax ;
     }
 
+    /**
+     * @param AbstractMetaDataParser|null $parser
+     */
     function constructSmarty ($parser)
     {
         global $mod_strings;

data/Link.php

Doc Comments +16 added lines

@@ -386,6 +386,9 @@ 
 		else return '';
 	}
 
+	/**
+	 * @param string $optional_array
+	 */
 	function _add_optional_where_clause($optional_array, $add_and='',$prefix='') {
 
 		if (!empty($prefix)) $prefix.='.';
@@ -612,6 +615,9 @@ 
 		return $this->_bean->build_related_list($query, $template);
 	}
 
+	/**
+	 * @param boolean $bean_is_lhs
+	 */
 	function _add_one_to_many_table_based($key,$bean_is_lhs) {
 
 		if ($bean_is_lhs) {
@@ -825,6 +831,9 @@ 
 		$result=$this->_db->query($query, true);
 	}
 
+	/**
+	 * @param string $where
+	 */
 	function _update_row(&$value_array,$table_name,$where) {
 
 		$query='UPDATE '.$table_name.' SET ';
@@ -1052,6 +1061,9 @@ 
 	}
 
 
+	/**
+	 * @param string $def_name
+	 */
 	function _get_link_table_definition($table_name,$def_name) {
 	    global $dictionary;
 
@@ -1103,6 +1115,10 @@ 
      * Return the name of the role field for the passed many to many table.
      * if there is no role filed : return false
      */
+
+    /**
+     * @return string
+     */
     function _get_link_table_role_field($table_name) {
         $varDefs = $this->_get_link_table_definition($table_name, 'fields');
         $role_field = false;

data/SugarBean.php

Doc Comments +14 added lines, -6 removed lines

@@ -736,6 +736,11 @@ 
         return $parentbean->process_union_list_query($parentbean, $final_query, $row_offset, $limit, $max, '', $subpanel_def, $final_query_rows, $secondary_queries);
     }
 
+    /**
+     * @param aSubPanel $subpanel_def
+     * @param SugarBean $parentbean
+     * @param string $order_by
+     */
     protected static function build_sub_queries_for_union($subpanel_list, $subpanel_def, $parentbean, $order_by)
     {
         global $beanList;
@@ -833,7 +838,7 @@ 
      * executes the query and returns fetched data.
      *
      * Internal function, do not override.
-     * @param object $parent_bean
+     * @param SugarBean $parent_bean
      * @param string $query query to be processed.
      * @param int $row_offset
      * @param int $limit optional, default -1
@@ -3792,7 +3797,7 @@ 
      * The fetched data is then set into the bean. The function also processes the fetched data by formatting
      * date/time and numeric values.
      *
-     * @param string|int $id Optional, default -1, is set to -1 id value from the bean is used, else, passed value is used
+     * @param integer $id Optional, default -1, is set to -1 id value from the bean is used, else, passed value is used
      * @param bool $encode Optional, default true, encodes the values fetched from the database.
      * @param bool $deleted Optional, default true, if set to false deleted filter will not be added.
      * @return SugarBean
@@ -4633,7 +4638,7 @@ 
     /**
      * Returns path for files of bean or false on error
      *
-     * @return bool|string
+     * @return false|string
      */
     public function deleteFileDirectory()
     {
@@ -4885,8 +4890,8 @@ 
      * Internal function, do not override.
      *
      * @param string $query - the query that should be executed to build the list
-     * @param object $template - The object that should be used to copy the records
-     * @param array $field_list List of  fields.
+     * @param Contact $template - The object that should be used to copy the records
+     * @param string[] $field_list List of  fields.
      * @return array
      */
     public function build_related_list2($query, &$template, &$field_list)
@@ -4999,7 +5004,7 @@ 
      * @param array @fields_array  array of name value pairs used to construct query.
      * @param bool $encode Optional, default true, encode fetched data.
      * @param bool $deleted Optional, default true, if set to false deleted filter will not be added.
-     * @return object Instance of this bean with fetched data.
+     * @return null|SugarBean Instance of this bean with fetched data.
      */
     public function retrieve_by_string_fields($fields_array, $encode = true, $deleted = true)
     {
@@ -5139,6 +5144,9 @@ 
         }
     }
 
+    /**
+     * @param string $table
+     */
     public function set_relationship($table, $relate_values, $check_duplicates = true, $do_update = false, $data_values = null)
     {
         $where = '';

include/HTTP_WebDAV_Server/Tools/_parse_proppatch.php

Doc Comments +1 added lines

@@ -73,6 +73,7 @@
      * constructor
      *
      * @param  string  path of input stream
+     * @param string $path
      * @access public
      */
     function __construct($path)

include/ListView/ListViewDisplay.php

Doc Comments +3 added lines

@@ -75,6 +75,9 @@
 		$this->searchColumns = array () ;
 	}
 
+	/**
+	 * @param string $moduleDir
+	 */
 	function shouldProcess($moduleDir){
 		$searching = false;
 		$sessionSearchQuery = "{$moduleDir}2_QUERY_QUERY";

include/resource/ResourceManager.php

Doc Comments +1 added lines, -1 removed lines

@@ -72,7 +72,7 @@
  * It will create a SoapResourceObserver instance if the $module parameter is set to
  * 'Soap'; otherwise, it will try to create a WebResourceObserver instance.
  * @param $module The module value used to create the corresponding observer
- * @return boolean value indicating whether or not an observer was successfully setup
+ * @return null|boolean value indicating whether or not an observer was successfully setup
  */
 public function setup($module) {
 	//Check if config.php exists

include/SuiteMozaik.php

Doc Comments +6 added lines

@@ -86,6 +86,9 @@ 
         return 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Etiam tempus odio ante, in feugiat ex pretium eu. In pharetra tincidunt urna et malesuada. Etiam aliquet auctor justo eu placerat. In nec sollicitudin enim. Nulla facilisi. In viverra velit turpis, et lobortis nunc eleifend id. Curabitur semper tincidunt vulputate. Nullam fermentum pellentesque ullamcorper.';
     }
 
+    /**
+     * @param integer $width
+     */
     private function getContentImageSample($width = null) {
         if(is_numeric($width)) {
             $width = ' width="' . $width . '"';
@@ -190,6 +193,9 @@ 
         return $mozaikHTML;
     }
 
+    /**
+     * @param string $elementId
+     */
     private function getRefreshTextareaScript($textareaId, $elementId, $width = 'initial') {
         if(is_numeric($width)) {
             $width .= 'px';

include/utils.php

Doc Comments +72 added lines, -7 removed lines

@@ -823,6 +823,7 @@ 
  * Portions created by SugarCRM are Copyright (C) SugarCRM, Inc.
  * All Rights Reserved.
  * Contributor(s): ______________________________________..
+ * @param boolean $always_copy
  */
 function safe_map_named($request_var, &$focus, $member_var, $always_copy)
 {
@@ -1245,6 +1246,7 @@ 
  * Portions created by SugarCRM are Copyright (C) SugarCRM, Inc.
  * All Rights Reserved.
  * Contributor(s): ______________________________________..
+ * @param string $varname
  */
 function return_session_value_or_default($varname, $default)
 {
@@ -1357,6 +1359,9 @@ 
     return $guid;
 }
 
+/**
+ * @param integer $characters
+ */
 function create_guid_section($characters)
 {
     $return = '';
@@ -1367,6 +1372,10 @@ 
     return $return;
 }
 
+/**
+ * @param string $string
+ * @param integer $length
+ */
 function ensure_length(&$string, $length)
 {
     $strlen = strlen($string);
@@ -1477,6 +1486,9 @@ 
 }
 
 // Check if user is admin for a specific module.
+/**
+ * @param string $module
+ */
 function is_admin_for_module($user, $module)
 {
     if (!isset($user)) {
@@ -1539,6 +1551,7 @@ 
  * Portions created by SugarCRM are Copyright (C) SugarCRM, Inc.
  * All Rights Reserved.
  * Contributor(s): ______________________________________..
+ * @param string $selected
  */
 function get_select_options($option_list, $selected)
 {
@@ -1833,7 +1846,7 @@ 
 /**
  * returns a default array of XSS tags to clean.
  *
- * @return array
+ * @return string
  */
 function getDefaultXssTags()
 {
@@ -1862,6 +1875,7 @@ 
  * Remove potential xss vectors from strings.
  *
  * @param string str String to search for XSS attack vectors
+ * @param string $str
  *
  * @deprecated
  *
@@ -1879,6 +1893,7 @@ 
  *
  * @param string str String to search for XSS attack vectors
  * @param bool cleanImg Flag to allow <img> tags to survive - only used by InboundEmail for inline images.
+ * @param string $str
  *
  * @return array Array of matches, empty on clean string
  */
@@ -1959,6 +1974,7 @@ 
  *
  * @param string pattern Regex pattern to use
  * @param string str String to parse for badness
+ * @param string $pattern
  *
  * @return array
  */
@@ -2082,6 +2098,7 @@ 
 
 /**
  * cleans the given key in superglobals $_GET, $_POST, $_REQUEST.
+ * @param string $key
  */
 function clean_superglobals($key, $filter = 'STANDARD')
 {
@@ -2096,6 +2113,9 @@ 
     }
 }
 
+/**
+ * @param string $key
+ */
 function set_superglobals($key, $val)
 {
     $_GET[$key] = $val;
@@ -2203,12 +2223,19 @@ 
 }
 
 // Returns TRUE if $str begins with $begin
+/**
+ * @param string $begin
+ */
 function str_begin($str, $begin)
 {
     return substr($str, 0, strlen($begin)) == $begin;
 }
 
 // Returns TRUE if $str ends with $end
+/**
+ * @param string $str
+ * @param string $end
+ */
 function str_end($str, $end)
 {
     return substr($str, strlen($str) - strlen($end)) == $end;
@@ -2273,16 +2300,25 @@ 
     return $value;
 }
 
+/**
+ * @param string $category
+ */
 function set_register_value($category, $name, $value)
 {
     return sugar_cache_put("{$category}:{$name}", $value);
 }
 
+/**
+ * @param string $category
+ */
 function get_register_value($category, $name)
 {
     return sugar_cache_retrieve("{$category}:{$name}");
 }
 
+/**
+ * @param string $category
+ */
 function clear_register_value($category, $name)
 {
     return sugar_cache_clear("{$category}:{$name}");
@@ -2486,6 +2522,11 @@ 
     return $new_array;
 }
 
+/**
+ * @param DBManager $db
+ * @param string $from_column
+ * @param string $to_id
+ */
 function clone_relationship(&$db, $tables = array(), $from_column, $from_id, $to_id)
 {
     foreach ($tables as $table) {
@@ -2660,6 +2701,10 @@ 
     return empty($value) && $value != '0';
 }
 
+/**
+ * @param string $bean_name
+ * @param string $display_columns
+ */
 function get_bean_select_array($add_blank = true, $bean_name, $display_columns, $where = '', $order_by = '', $blank_is_none = false)
 {
     global $beanFiles;
@@ -2841,6 +2886,11 @@ 
     //end function js_escape
 }
 
+/**
+ * @param string $str
+ *
+ * @return string
+ */
 function br2nl($str)
 {
     $regex = '#<[^>]+br.+?>#i';
@@ -3368,6 +3418,9 @@ 
 if (isset($sugar_config['stack_trace_errors']) && $sugar_config['stack_trace_errors']) {
     set_error_handler('StackTraceErrorHandler');
 }
+/**
+ * @param string $name
+ */
 function get_sub_cookies($name)
 {
     $cookies = array();
@@ -3407,6 +3460,7 @@ 
 
 /**
  * For translating the php.ini memory values into bytes.  e.g. input value of '8M' will return 8388608.
+ * @param string $val
  */
 function return_bytes($val)
 {
@@ -3527,6 +3581,9 @@ 
  * Given the bean_name which may be plural or singular return the singular
  * bean_name. This is important when you need to include files.
  */
+/**
+ * @return string
+ */
 function get_singular_bean_name($bean_name)
 {
     global $beanFiles, $beanList;
@@ -3570,6 +3627,9 @@ 
     return $singular;
 }
 
+/**
+ * @return string
+ */
 function get_label($label_tag, $temp_module_strings)
 {
     global $app_strings;
@@ -3671,7 +3731,7 @@ 
 /**
  * In order to have one place to obtain the proper object name. aCase for example causes issues throughout the application.
  *
- * @param string $moduleName
+ * @param string $module_name
  */
 function get_valid_bean_name($module_name)
 {
@@ -4277,6 +4337,9 @@ 
  * @return string Relative pathname of the located icon, or '' if not found
  */
 
+/**
+ * @param string $iconFileName
+ */
 function _getIcon($iconFileName)
 {
     $iconName = "icon_{$iconFileName}.gif";
@@ -4305,7 +4368,7 @@ 
  * Function to grab the correct icon image for Studio.
  *
  * @param string $iconFileName Name of the icon file
- * @param string $altfilename  Name of a fallback icon file (displayed if the imagefilename doesn't exist)
+ * @param string $altFileName  Name of a fallback icon file (displayed if the imagefilename doesn't exist)
  * @param string $width        Width of image
  * @param string $height       Height of image
  * @param string $align        Alignment of image
@@ -4331,7 +4394,6 @@ 
 /**
  * Function to grab the correct icon image for Dashlets Dialog.
  *
- * @param string $filename Location of the icon file
  * @param string $module   Name of the module to fall back onto if file does not exist
  * @param string $width    Width of image
  * @param string $height   Height of image
@@ -4776,7 +4838,7 @@ 
  *
  * @param string $version
  *
- * @return version
+ * @return string
  */
 function getMajorMinorVersion($version)
 {
@@ -4941,6 +5003,9 @@ 
     }
 }
 
+/**
+ * @param string $field_name
+ */
 function order_beans($beans, $field_name)
 {
     //Since php 5.2 doesn't include closures, we must use a global to pass the order field to cmp_beans.
@@ -5086,7 +5151,7 @@ 
  *
  * @param $file String of filename to check
  *
- * @return $file String of filename including custom directory if found
+ * @return string String of filename including custom directory if found
  */
 function get_custom_file_if_exists($file)
 {
@@ -5243,7 +5308,7 @@ 
 /**
  * Gets the list of "*type_display*".
  *
- * @return array
+ * @return string[]
  */
 function getTypeDisplayList()
 {

modules/Administration/Administration.php

Doc Comments +4 added lines

@@ -160,6 +160,10 @@
         $this->retrieveSettings(false, true);
     }
 
+    /**
+     * @param string|false $category
+     * @param string|false $key
+     */
     function saveSetting($category, $key, $value) {
         $result = $this->db->query("SELECT count(*) AS the_count FROM config WHERE category = '{$category}' AND name = '{$key}'");
         $row = $this->db->fetchByAssoc($result);