adamjakab / SuiteCRM

include/utils.php

Doc Comments +73 added lines, -7 removed lines

@@ -829,6 +829,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)
 {
@@ -1248,6 +1249,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)
 {
@@ -1358,6 +1360,9 @@ 
 
 }
 
+/**
+ * @param integer $characters
+ */
 function create_guid_section($characters)
 {
 	$return = "";
@@ -1368,6 +1373,10 @@ 
 	return $return;
 }
 
+/**
+ * @param string $string
+ * @param integer $length
+ */
 function ensure_length(&$string, $length)
 {
 	$strlen = strlen($string);
@@ -1475,6 +1484,9 @@ 
 
 
 // Check if user is admin for a specific module.
+/**
+ * @param string $module
+ */
 function is_admin_for_module($user,$module) {
     if (!isset($user)) {
         return false;
@@ -1535,6 +1547,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) {
 	return get_select_options_with_id($option_list, $selected);
@@ -1822,7 +1835,7 @@ 
 
 /**
  * returns a default array of XSS tags to clean
- * @return array
+ * @return string
  */
 function getDefaultXssTags() {
 	$tmp = array(
@@ -1849,6 +1862,7 @@ 
 /**
  * Remove potential xss vectors from strings
  * @param string str String to search for XSS attack vectors
+ * @param string $str
  * @deprecated
  * @return string
  */
@@ -1862,6 +1876,7 @@ 
  * @deprecated
  * @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
  */
 function clean_xss($str, $cleanImg=true) {
@@ -1938,6 +1953,7 @@ 
  * Helper function used by clean_xss() to parse for known-bad vectors
  * @param string pattern Regex pattern to use
  * @param string str String to parse for badness
+ * @param string $pattern
  * @return array
  */
 function xss_check_pattern($pattern, $str) {
@@ -2022,6 +2038,7 @@ 
 
 /**
  * cleans the given key in superglobals $_GET, $_POST, $_REQUEST
+ * @param string $key
  */
 function clean_superglobals($key, $filter = 'STANDARD') {
 	if(isset($_GET[$key])) clean_string($_GET[$key], $filter);
@@ -2029,6 +2046,9 @@ 
 	if(isset($_REQUEST[$key])) clean_string($_REQUEST[$key], $filter);
 }
 
+/**
+ * @param string $key
+ */
 function set_superglobals($key, $val){
 	$_GET[$key] = $val;
 	$_POST[$key] = $val;
@@ -2108,11 +2128,18 @@ 
 }
 
 // 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);
 }
@@ -2170,14 +2197,24 @@ 
 }
 
 
+/**
+ * @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
+ * @param string $name
+ */
 function clear_register_value($category,$name){
     return sugar_cache_clear("{$category}:{$name}");
 }
@@ -2379,6 +2416,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)
@@ -2556,6 +2598,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;
@@ -2746,6 +2792,11 @@ 
 	//end function js_escape
 }
 
+/**
+ * @param string $str
+ *
+ * @return string
+ */
 function br2nl($str) {
 	$regex = "#<[^>]+br.+?>#i";
 	preg_match_all($regex, $str, $matches);
@@ -3265,6 +3316,9 @@ 
 
 	set_error_handler('StackTraceErrorHandler');
 }
+/**
+ * @param string $name
+ */
 function get_sub_cookies($name){
 	$cookies = array();
 	if(isset($_COOKIE[$name])){
@@ -3306,6 +3360,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)
 {
@@ -3413,6 +3468,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;
 	if(array_key_exists($bean_name, $beanList)){
@@ -3457,6 +3515,9 @@ 
     return $singular;
 }
 
+/**
+ * @return string
+ */
 function get_label($label_tag, $temp_module_strings){
 	global $app_strings;
 	if(!empty($temp_module_strings[$label_tag])){
@@ -3562,7 +3623,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){
 	global $beanList;
@@ -4139,6 +4200,9 @@ 
  * @return string Relative pathname of the located icon, or '' if not found
  */
 
+/**
+ * @param string $iconFileName
+ */
 function _getIcon($iconFileName)
 {
 
@@ -4163,7 +4227,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
@@ -4188,7 +4252,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
@@ -4601,7 +4664,7 @@ 
  * 5.5.1RC1 then return 5.5.1
  *
  * @param string $version
- * @return version
+ * @return string
  */
 function getMajorMinorVersion($version){
 	if(preg_match('/^([\d\.]+).*$/si', $version, $matches2)){
@@ -4751,6 +4814,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.
@@ -4885,7 +4951,7 @@ 
  * otherwise it return $file
  *
  * @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)
 {
@@ -5037,7 +5103,7 @@ 
 /**
  * Gets the list of "*type_display*".
  * 
- * @return array
+ * @return string[]
  */
 function getTypeDisplayList()
 {

include/utils/activity_utils.php

Doc Comments +4 added lines

@@ -39,6 +39,10 @@
  ********************************************************************************/
 
 
+/**
+ * @param string $user_id
+ * @param string $where
+ */
 function build_related_list_by_user_id($bean, $user_id,$where) {
     $bean_id_name = strtolower($bean->object_name).'_id';
 

include/utils/array_utils.php

Doc Comments +7 added lines

@@ -85,6 +85,9 @@ 
  * 			 $eval - evals the generated string if true, note that the array name must be in the global space!
  * @return : example - string $array_name['a']['b']['c'][.] = 'hello'
  */
+/**
+ * @param string $array_name
+ */
 function override_value_to_string_recursive($key_names, $array_name, $value, $eval=false){
 	if ($eval) return eval( "\${$array_name}". override_recursive_helper($key_names, $array_name, $value));
 	else return "\${$array_name}". override_recursive_helper($key_names, $array_name, $value);
@@ -150,6 +153,7 @@ 
 	 * @param array $array2, the array which 
 	 * @param array $allowEmpty, will return the value if it is empty in $array1 and not in $array2,
 	 * otherwise empty values in $array1 are ignored.
+	 * @param string $array1
 	 * @return array containing the differences between the two arrays
 	 */
 	function deepArrayDiff($array1, $array2, $allowEmpty = false) {
@@ -270,6 +274,9 @@ 
         return $array->get($needle, $default);
     }
 
+    /**
+     * @param string $key
+     */
     private function _getFromSource($key, $default) {
         if (strpos($key, '.') === false) {
             return isset($this[$key]) ? $this[$key] : $default;

include/utils/db_utils.php

Doc Comments +1 added lines

@@ -42,6 +42,7 @@
 
 /**
  * @deprecated use DBManager::convert() instead.
+ * @param string $type
  */
 function db_convert($string, $type, $additional_parameters=array(),$additional_parameters_oracle_only=array())
 	{

include/utils/encryption_utils.php

Doc Comments +6 added lines

@@ -40,6 +40,10 @@ 
 
 require_once('include/Pear/Crypt_Blowfish/Blowfish.php');
 
+/**
+ * @param string $key
+ * @param string $data
+ */
 function sugarEncode($key, $data){
 	return base64_encode($data);
 }
@@ -84,6 +88,7 @@ 
  * Uses blowfish to encrypt data and base 64 encodes it. It stores the iv as part of the data
  * @param STRING key - key to base encoding off of
  * @param STRING data - string to be encrypted and encoded
+ * @param string $key
  * @return string
  */
 function blowfishEncode($key, $data){
@@ -96,6 +101,7 @@ 
  * Uses blowfish to decode data assumes data has been base64 encoded with the iv stored as part of the data
  * @param STRING key - key to base decoding off of
  * @param STRING encoded base64 encoded blowfish encrypted data
+ * @param string $key
  * @return string
  */
 function blowfishDecode($key, $encoded){

include/utils/file_utils.php

Doc Comments +12 added lines, -3 removed lines

@@ -61,6 +61,9 @@ 
     return( $appendpath.$path );
 }
 
+/**
+ * @param string $file
+ */
 function create_cache_directory($file)
 {
     $paths = explode('/',$file);
@@ -170,6 +173,9 @@ 
     return( $write_to_file );
 }
 
+/**
+ * @param string $file
+ */
 function create_custom_directory($file)
 {
     $paths = explode('/',$file);
@@ -241,8 +247,8 @@ 
 /**
  * Function to compare two directory structures and return the items in path_a that didn't match in path_b
  *
- * @param	$path_a The path of the first root directory to scan - must end with '/'
- * @param	$path_b The path of the second root directory to scan - must end with '/'
+ * @param	string $path_a The path of the first root directory to scan - must end with '/'
+ * @param	string $path_b The path of the second root directory to scan - must end with '/'
  * @param	$ignore_dirs array of filenames/directory names to ignore running md5 on - default 'cache' and 'upload'
  * @result	array containing all the md5s of everything in $path_a that didn't have a match in $path_b
  */
@@ -374,7 +380,7 @@ 
  * extension and returns a best guess mime content type.
  *
  * @param $filename String of filename to return mime content type
- * @return mime content type as String value (defaults to 'application/octet-stream' for filenames with extension, empty otherwise)
+ * @return string content type as String value (defaults to 'application/octet-stream' for filenames with extension, empty otherwise)
  *
  */
 function get_mime_content_type_from_filename($filename)
@@ -467,6 +473,9 @@ 
 
 }
 */
+/**
+ * @param string $name
+ */
 function cleanFileName($name)
 {
     return preg_replace('/[^\w-._]+/i', '', $name);

include/utils/layout_utils.php

Doc Comments +4 added lines, -3 removed lines

@@ -50,7 +50,7 @@ 
  *
  * @param  $form_title string to display as the title in the header
  * @param  $other_text string to next to the title.  Typically used for form buttons.
- * @param  $show_help  boolean which determines if the print and help links are shown.
+ * @param  false|string $show_help  boolean which determines if the print and help links are shown.
  * @return string HTML
  */
 function get_form_header(
@@ -165,9 +165,10 @@ 
  *
  * @deprecated use SugarView::getModuleTitle() for MVC modules, or getClassicModuleTitle() for non-MVC modules
  *
- * @param  $module       string  to next to the title.  Typically used for form buttons.
- * @param  $module_title string  to display as the module title
+ * @param  string $module       string  to next to the title.  Typically used for form buttons.
+ * @param  string $module_title string  to display as the module title
  * @param  $show_help    boolean which determines if the print and help links are shown.
+ * @param boolean $show_create
  * @return string HTML
  */
 function get_module_title(

include/utils/LogicHook.php

Doc Comments +4 added lines, -3 removed lines

@@ -73,7 +73,7 @@ 
 	/**
 	 * Static Function which returns and instance of LogicHook
 	 *
-	 * @return unknown
+	 * @return LogicHook
 	 */
 	static function initialize(){
 		if(empty($GLOBALS['logic_hook']))
@@ -153,6 +153,9 @@ 
 		return $hook_array;
 	}
 
+	/**
+	 * @param string $module_dir
+	 */
 	public function getHooks($module_dir, $refresh = false)
 	{
 	    if($refresh || !isset(self::$hooks[$module_dir])) {
@@ -169,7 +172,6 @@ 
 	 * @param string $module_dir
 	 * @param string $event
 	 * @param array $arguments
-	 * @param SugarBean $bean
 	 */
 	function call_custom_logic($module_dir, $event, $arguments = null){
 		// declare the hook array variable, it will be defined in the included file.
@@ -198,7 +200,6 @@ 
 	 * @param array $hook_array
 	 * @param string $event
 	 * @param array $arguments
-	 * @param SugarBean $bean
 	 */
 	function process_hooks($hook_array, $event, $arguments){
 		// Now iterate through the array for the appropriate hook

include/utils/mvc_utils.php

Doc Comments +3 added lines

@@ -38,6 +38,9 @@
  ********************************************************************************/
 
 
+/**
+ * @param string $type
+ */
 function loadParentView($type)
 {
     if(file_exists('custom/include/MVC/View/views/view.'.$type.'.php'))