YetiForceCompany / YetiForceCRM

include/utils/ListViewUtils.php

Doc Comments +5 added lines

@@ -378,6 +378,11 @@
  * Returns an string value
  */
 
+/**
+ * @param string $url_qry
+ * @param string $module
+ * @param string $related_module
+ */
 function getRelatedTableHeaderNavigation($navigation_array, $url_qry, $module, $related_module, $recordid)
 {
 	$log = LoggerManager::getInstance();

Spacing +5 added lines, -5 removed lines

@@ -194,15 +194,15 @@ 
 
 			//added to fix #5135
 			if (AppRequest::get('from_homepage') == 'upcoming_activities' || AppRequest::get('from_homepage') == 'pending_activities') {
-				$query.=' LEFT OUTER JOIN vtiger_recurringevents ON vtiger_recurringevents.activityid=vtiger_activity.activityid';
+				$query .= ' LEFT OUTER JOIN vtiger_recurringevents ON vtiger_recurringevents.activityid=vtiger_activity.activityid';
 			}
 			//end
 			$instance = CRMEntity::getInstance($module);
-			$query.=" WHERE vtiger_crmentity.deleted = 0 && activitytype != 'Emails' ";
+			$query .= " WHERE vtiger_crmentity.deleted = 0 && activitytype != 'Emails' ";
 			$securityParameter = $instance->getUserAccessConditionsQuerySR($module, $current_user);
 			if ($securityParameter != '')
-				$query.= $securityParameter;
-			$query.= ' ' . $where;
+				$query .= $securityParameter;
+			$query .= ' ' . $where;
 			break;
 		Case "Emails":
 			$query = "SELECT DISTINCT vtiger_crmentity.crmid, vtiger_crmentity.smownerid,
@@ -616,7 +616,7 @@ 
 	$chars = preg_split('/(&[^;\s]+;)|/', $str, -1, PREG_SPLIT_NO_EMPTY | PREG_SPLIT_DELIM_CAPTURE | PREG_SPLIT_OFFSET_CAPTURE);
 	$html_length = count($chars);
 	// check if we can predict the return value and save some processing time
-	if (($html_length === 0) || ( $start >= $html_length) || ( isset($length) && ( $length <= -$html_length)))
+	if (($html_length === 0) || ($start >= $html_length) || (isset($length) && ($length <= -$html_length)))
 		return "";
 
 	//calculate start position

Braces +52 added lines, -39 removed lines

@@ -200,8 +200,9 @@ 
 			$instance = CRMEntity::getInstance($module);
 			$query.=" WHERE vtiger_crmentity.deleted = 0 && activitytype != 'Emails' ";
 			$securityParameter = $instance->getUserAccessConditionsQuerySR($module, $current_user);
-			if ($securityParameter != '')
-				$query.= $securityParameter;
+			if ($securityParameter != '') {
+							$query.= $securityParameter;
+			}
 			$query.= ' ' . $where;
 			break;
 		Case "Emails":
@@ -355,18 +356,21 @@ 
 			$start = $_SESSION['rlvs'][$module][$related]['start'];
 		}
 	}
-	if (AppRequest::has('viewname') && AppRequest::get('viewname') != '')
-		$lv_array['viewname'] = AppRequest::get('viewname');
+	if (AppRequest::has('viewname') && AppRequest::get('viewname') != '') {
+			$lv_array['viewname'] = AppRequest::get('viewname');
+	}
 
-	if ($related == '')
-		$_SESSION['lvs'][AppRequest::get('module')] = $lv_array;
-	else
-		$_SESSION['rlvs'][$module][$related] = $lv_array;
+	if ($related == '') {
+			$_SESSION['lvs'][AppRequest::get('module')] = $lv_array;
+	} else {
+			$_SESSION['rlvs'][$module][$related] = $lv_array;
+	}
 
 	if ($start < ceil($noofrows / $max_ent) && $start != '') {
 		$start = ceil($noofrows / $max_ent);
-		if ($related == '')
-			$_SESSION['lvs'][$currentModule]['start'] = $start;
+		if ($related == '') {
+					$_SESSION['lvs'][$currentModule]['start'] = $start;
+		}
 	}
 }
 /* * Function to get the table headers for related listview
@@ -389,8 +393,9 @@ 
 
 	$relatedListResult = $adb->pquery('SELECT * FROM vtiger_relatedlists WHERE tabid=? AND
 		related_tabid=?', array($tabid, $relatedTabId));
-	if (empty($relatedListResult))
-		return;
+	if (empty($relatedListResult)) {
+			return;
+	}
 	$relatedListRow = $adb->fetchByAssoc($relatedListResult);
 	$header = $relatedListRow['label'];
 	$actions = $relatedListRow['actions'];
@@ -439,11 +444,12 @@ 
 	}
 	$output .= '</td>';
 	$log->debug("Exiting getTableHeaderNavigation method ...");
-	if ($navigation_array['first'] == '')
-		return;
-	else
-		return $output;
-}
+	if ($navigation_array['first'] == '') {
+			return;
+	} else {
+			return $output;
+	}
+	}
 /* Function to get the Entity Id of a given Entity Name */
 
 function getEntityId($module, $entityName)
@@ -473,23 +479,26 @@ 
 			$entityId = $adb->query_result($result, 0, $entityidfield);
 		}
 	}
-	if (!empty($entityId))
-		return $entityId;
-	else
-		return 0;
-}
+	if (!empty($entityId)) {
+			return $entityId;
+	} else {
+			return 0;
+	}
+	}
 
 function decode_html($str)
 {
 	$defaultCharset = AppConfig::main('default_charset');
-	if (empty($default_charset))
-		$defaultCharset = 'UTF-8';
+	if (empty($default_charset)) {
+			$defaultCharset = 'UTF-8';
+	}
 	// Direct Popup action or Ajax Popup action should be treated the same.
-	if (AppRequest::get('action') == 'Popup' || (AppRequest::has('action') && AppRequest::get('file') == 'Popup'))
-		return html_entity_decode($str);
-	else
-		return html_entity_decode($str, ENT_QUOTES, $defaultCharset);
-}
+	if (AppRequest::get('action') == 'Popup' || (AppRequest::has('action') && AppRequest::get('file') == 'Popup')) {
+			return html_entity_decode($str);
+	} else {
+			return html_entity_decode($str, ENT_QUOTES, $defaultCharset);
+	}
+	}
 
 function popup_decode_html($str)
 {
@@ -602,22 +611,25 @@ 
 
 function html_substr($str, $start, $length = NULL)
 {
-	if ($length === 0)
-		return "";
+	if ($length === 0) {
+			return "";
+	}
 	//check if we can simply use the built-in functions
 	if (strpos($str, '&') === false) { //No entities. Use built-in functions
-		if ($length === NULL)
-			return substr($str, $start);
-		else
-			return substr($str, $start, $length);
+		if ($length === NULL) {
+					return substr($str, $start);
+		} else {
+					return substr($str, $start, $length);
+		}
 	}
 
 	// create our array of characters and html entities
 	$chars = preg_split('/(&[^;\s]+;)|/', $str, -1, PREG_SPLIT_NO_EMPTY | PREG_SPLIT_DELIM_CAPTURE | PREG_SPLIT_OFFSET_CAPTURE);
 	$html_length = count($chars);
 	// check if we can predict the return value and save some processing time
-	if (($html_length === 0) || ( $start >= $html_length) || ( isset($length) && ( $length <= -$html_length)))
-		return "";
+	if (($html_length === 0) || ( $start >= $html_length) || ( isset($length) && ( $length <= -$html_length))) {
+			return "";
+	}
 
 	//calculate start position
 	if ($start >= 0) {
@@ -626,9 +638,10 @@ 
 		$start = max($start, -$html_length);
 		$real_start = $chars[$html_length + $start][1];
 	}
-	if (!isset($length)) // no $length argument passed, return all remaining characters
+	if (!isset($length)) {
+		// no $length argument passed, return all remaining characters
 		return substr($str, $real_start);
-	else if ($length > 0) { // copy $length chars
+	} else if ($length > 0) { // copy $length chars
 		if ($start + $length >= $html_length) { // return all remaining characters
 			return substr($str, $real_start);
 		} else { //return $length characters

include/utils/UserInfoUtil.php

Doc Comments +8 added lines, -1 removed lines

@@ -188,7 +188,7 @@ 
 
 /** Function to update user to vtiger_role mapping based on the userid
  * @param $roleid -- Role Id:: Type varchar
- * @param $userid User Id:: Type integer
+ * @param integer $userid User Id:: Type integer
  *
  */
 function updateUser2RoleMapping($roleid, $userid)
@@ -233,6 +233,7 @@ 
  * @param $recordid -- Record Id:: Type integer
  * @returns yes or no. If Yes means this action is allowed for the currently logged in user. If no means this action is not allowed for the currently logged in user
  *
+ * @return string
  */
 function isPermitted($module, $actionname, $record_id = '')
 {
@@ -450,6 +451,9 @@ 
 	return $permission;
 }
 
+/**
+ * @return string
+ */
 function isPermittedBySharing($module, $tabid, $actionid, $record_id)
 {
 	$userPrivilegesModel = Users_Privileges_Model::getCurrentUserPrivilegesModel();
@@ -1525,6 +1529,9 @@ 
 	return $shareGrpList;
 }
 
+/**
+ * @param string $data_type
+ */
 function constructList($array, $data_type)
 {
 	$log = LoggerManager::getInstance();

Spacing +3 added lines, -3 removed lines

@@ -405,7 +405,7 @@ 
 		if (\AppConfig::security('PERMITTED_BY_RECORD_HIERARCHY')) {
 			$userPrivilegesModel = Users_Privileges_Model::getCurrentUserPrivilegesModel();
 			$role = $userPrivilegesModel->getRoleDetail();
-			if ((($actionid == 3 || $actionid == 4) && $role->get('previewrelatedrecord') != 0 ) || (($actionid == 0 || $actionid == 1) && $role->get('editrelatedrecord') != 0 )) {
+			if ((($actionid == 3 || $actionid == 4) && $role->get('previewrelatedrecord') != 0) || (($actionid == 0 || $actionid == 1) && $role->get('editrelatedrecord') != 0)) {
 				$parentRecord = Users_Privileges_Model::getParentRecord($record_id, $module, $role->get('previewrelatedrecord'), $actionid);
 				if ($parentRecord) {
 					$recordMetaData = vtlib\Functions::getCRMRecordMetadata($parentRecord);
@@ -1084,7 +1084,7 @@ 
 		$query = sprintf("SELECT shareid FROM %s WHERE %s = ?", $tablename, $colNameArr[0]);
 		$params = array($grpId);
 		if (sizeof($colNameArr) > 1) {
-			$query .=" or " . $colNameArr[1] . "=?";
+			$query .= " or " . $colNameArr[1] . "=?";
 			array_push($params, $grpId);
 		}
 
@@ -1120,7 +1120,7 @@ 
 		$query = sprintf("SELECT shareid FROM %s WHERE %s = ?", $tablename, $colNameArr[0]);
 		$params = array($grpId);
 		if (sizeof($colNameArr) > 1) {
-			$query .=" or " . $colNameArr[1] . "=?";
+			$query .= " or " . $colNameArr[1] . "=?";
 			array_push($params, $grpId);
 		}
 

Braces +9 added lines, -6 removed lines

@@ -1732,8 +1732,9 @@ 
 			$params = array($tabid, $fieldname);
 		}
 		//Postgres 8 fixes
-		if ($adb->isPostgres())
-			$query = fixPostgresQuery($query, $log, 0);
+		if ($adb->isPostgres()) {
+					$query = fixPostgresQuery($query, $log, 0);
+		}
 
 
 		$result = $adb->pquery($query, $params);
@@ -1741,8 +1742,9 @@ 
 		$log->debug('Exiting getFieldVisibilityPermission method ...');
 
 		// Returns value as a string
-		if ($adb->num_rows($result) == 0)
-			return '1';
+		if ($adb->num_rows($result) == 0) {
+					return '1';
+		}
 		return ($adb->query_result($result, "0", "visible") . "");
 	}
 }
@@ -1867,8 +1869,9 @@ 
 	$adb = PearDatabase::getInstance();
 	$sharingModuleArray = [];
 
-	if (empty($eliminateModules))
-		$eliminateModules = [];
+	if (empty($eliminateModules)) {
+			$eliminateModules = [];
+	}
 
 	$query = 'SELECT name FROM vtiger_tab WHERE presence=0 && ownedby = 0 && isentitytype = 1';
 	$query .= " && name NOT IN('" . implode("','", $eliminateModules) . "')";

include/utils/VTCacheUtils.php

Doc Comments +28 added lines

@@ -395,6 +395,9 @@ 
 	/** Report module information based on used. */
 	static $_reportmodule_infoperuser_cache = [];
 
+	/**
+	 * @param string $reportid
+	 */
 	static function lookupReport_Info($userid, $reportid)
 	{
 
@@ -406,6 +409,9 @@ 
 		return false;
 	}
 
+	/**
+	 * @param string $reportid
+	 */
 	static function updateReport_Info($userid, $reportid, $primarymodule, $secondarymodules, $reporttype, $reportname, $description, $folderid, $owner)
 	{
 		if (!isset(self::$_reportmodule_infoperuser_cache[$userid])) {
@@ -428,6 +434,9 @@ 
 	/** Report module sub-ordinate users information. */
 	static $_reportmodule_subordinateuserid_cache = [];
 
+	/**
+	 * @param string $reportid
+	 */
 	static function lookupReport_SubordinateUsers($reportid)
 	{
 		if (isset(self::$_reportmodule_subordinateuserid_cache[$reportid])) {
@@ -436,6 +445,9 @@ 
 		return false;
 	}
 
+	/**
+	 * @param string $reportid
+	 */
 	static function updateReport_SubordinateUsers($reportid, $userids)
 	{
 		self::$_reportmodule_subordinateuserid_cache[$reportid] = $userids;
@@ -444,6 +456,9 @@ 
 	/** Report module information based on used. */
 	static $_reportmodule_scheduledinfoperuser_cache = [];
 
+	/**
+	 * @param string $reportid
+	 */
 	static function lookupReport_ScheduledInfo($userid, $reportid)
 	{
 
@@ -455,6 +470,10 @@ 
 		return false;
 	}
 
+	/**
+	 * @param string $reportid
+	 * @param boolean $isScheduled
+	 */
 	static function updateReport_ScheduledInfo($userid, $reportid, $isScheduled, $scheduledFormat, $scheduledInterval, $scheduledRecipients, $scheduledTime)
 	{
 		if (!isset(self::$_reportmodule_scheduledinfoperuser_cache[$userid])) {
@@ -479,6 +498,9 @@ 
 		self::$_userSignature[$userName] = $signature;
 	}
 
+	/**
+	 * @return string
+	 */
 	public static function getUserSignature($userName)
 	{
 		return self::$_userSignature[$userName];
@@ -491,6 +513,9 @@ 
 		self::$_userFullName[$userName] = $fullName;
 	}
 
+	/**
+	 * @return string
+	 */
 	public static function getUserFullName($userName)
 	{
 		return self::$_userFullName[$userName];
@@ -503,6 +528,9 @@ 
 		return self::$_report_field_bylabel[$module][$label];
 	}
 
+	/**
+	 * @param string $label
+	 */
 	public static function setReportFieldByLabel($module, $label, $fieldInfo)
 	{
 		self::$_report_field_bylabel[$module][$label] = $fieldInfo;

include/utils/VtlibUtils.php

Doc Comments +6 added lines, -1 removed lines

@@ -18,6 +18,9 @@ 
 	$__cache_vtiger_imagepath = [];
 }
 
+/**
+ * @param string $imagename
+ */
 function vtiger_imageurl($imagename, $themename)
 {
 	global $__cache_vtiger_imagepath;
@@ -200,6 +203,9 @@ 
 	}
 }
 
+/**
+ * @param string $varname
+ */
 function __vtlib_get_modulevar_value($module, $varname)
 {
 	$mod_var_mapping = Array(
@@ -497,7 +503,6 @@ 
 /**
  * Purify (Cleanup) malicious snippets of code from the input
  *
- * @param String $value
  * @param Boolean $ignore Skip cleaning of the input
  * @return String
  */

Braces +26 added lines, -18 removed lines

@@ -156,10 +156,11 @@ 
 	$old_dieOnError = $adb->dieOnError;
 	$adb->dieOnError = false;
 
-	if ($enable_disable === true)
-		$enable_disable = 1;
-	else if ($enable_disable === false)
-		$enable_disable = 0;
+	if ($enable_disable === true) {
+			$enable_disable = 1;
+	} else if ($enable_disable === false) {
+			$enable_disable = 0;
+	}
 
 	$adb->pquery('UPDATE vtiger_language set active = ? WHERE prefix = ?', Array($enable_disable, $langprefix));
 
@@ -195,8 +196,9 @@ 
 
 	$checkfor = Array('table_name', 'table_index', 'related_tables', 'popup_fields', 'IsCustomModule');
 	foreach ($checkfor as $check) {
-		if (!isset($focus->$check))
-			$focus->$check = __vtlib_get_modulevar_value($module, $check);
+		if (!isset($focus->$check)) {
+					$focus->$check = __vtlib_get_modulevar_value($module, $check);
+		}
 	}
 }
 
@@ -356,8 +358,9 @@ 
 function vtlib_tosingular($text)
 {
 	$lastpos = strripos($text, 's');
-	if ($lastpos == strlen($text) - 1)
-		return substr($text, 0, -1);
+	if ($lastpos == strlen($text) - 1) {
+			return substr($text, 0, -1);
+	}
 	return $text;
 }
 
@@ -377,8 +380,9 @@ 
 	$roleresCount = $adb->num_rows($roleres);
 	$allroles = [];
 	if ($roleresCount) {
-		for ($index = 0; $index < $roleresCount; ++$index)
-			$allroles[] = $adb->query_result($roleres, $index, 'roleid');
+		for ($index = 0; $index < $roleresCount; ++$index) {
+					$allroles[] = $adb->query_result($roleres, $index, 'roleid');
+		}
 	}
 	sort($allroles);
 
@@ -401,8 +405,9 @@ 
 	foreach ($picklistval_roles as $picklistval => $pickvalroles) {
 		sort($pickvalroles);
 		$diff = array_diff($pickvalroles, $allroles);
-		if (empty($diff))
-			$allrolevalues[] = $picklistval;
+		if (empty($diff)) {
+					$allrolevalues[] = $picklistval;
+		}
 	}
 
 	$log->debug('Exiting ' . __METHOD__ . ' method ...');
@@ -479,8 +484,9 @@ 
 			$tmpfile = 'vtiger' . time() . '-' . rand(1, 1000) . '.tmp';
 			// Continue the loop unless we find a name that does not exists already.
 			$usefilename = "$dirpath/$tmpfile";
-			if (!file_exists($usefilename))
-				break;
+			if (!file_exists($usefilename)) {
+							break;
+			}
 		} while (true);
 		$fh = @fopen($usefilename, 'a');
 		if ($fh) {
@@ -522,8 +528,9 @@ 
 	if (!$ignore) {
 		// Initialize the instance if it has not yet done
 		if ($__htmlpurifier_instance == false) {
-			if (empty($use_charset))
-				$use_charset = 'UTF-8';
+			if (empty($use_charset)) {
+							$use_charset = 'UTF-8';
+			}
 
 			include_once ('libraries/htmlpurifier/library/HTMLPurifier.auto.php');
 
@@ -590,8 +597,9 @@ 
 	if (!$ignore) {
 		// Initialize the instance if it has not yet done
 		if ($htmlPurifierForHtml == false) {
-			if (empty($use_charset))
-				$use_charset = 'UTF-8';
+			if (empty($use_charset)) {
+							$use_charset = 'UTF-8';
+			}
 
 			include_once ('libraries/htmlpurifier/library/HTMLPurifier.auto.php');
 

include/Webservices/DataTransform.php

Doc Comments +3 added lines

@@ -48,6 +48,9 @@
 		return $row;
 	}
 
+	/**
+	 * @param boolean $t
+	 */
 	public static function sanitizeData($newRow, $meta, $t = null)
 	{
 

Braces +6 added lines, -4 removed lines

@@ -24,8 +24,9 @@ 
 		$fieldColumnMapping = $meta->getFieldColumnMapping();
 		$columnFieldMapping = array_flip($fieldColumnMapping);
 		foreach ($row as $col => $val) {
-			if (array_key_exists($col, $columnFieldMapping))
-				$newRow[$columnFieldMapping[$col]] = $val;
+			if (array_key_exists($col, $columnFieldMapping)) {
+							$newRow[$columnFieldMapping[$col]] = $val;
+			}
 		}
 		$newRow = DataTransform::sanitizeData($newRow, $meta, true);
 		return $newRow;
@@ -149,8 +150,9 @@ 
 		$allFields = $meta->getFieldColumnMapping();
 		$newRow = [];
 		foreach ($allFields as $field => $col) {
-			if (isset($row[$field]))
-				$newRow[$field] = $row[$field];
+			if (isset($row[$field])) {
+							$newRow[$field] = $row[$field];
+			}
 		}
 		if (isset($row[$recordString])) {
 			$newRow[$recordString] = $row[$recordString];

include/Webservices/PreserveGlobal.php

Doc Comments +3 added lines

@@ -41,6 +41,9 @@
 		$$name;
 	}
 
+	/**
+	 * @param string $name
+	 */
 	static function getGlobal($name)
 	{
 		global $$name;

include/Webservices/Query.php

Doc Comments +3 added lines

@@ -10,6 +10,9 @@
 
 require_once("include/Webservices/QueryParser.php");
 
+/**
+ * @param string $q
+ */
 function vtws_query($q, $user)
 {
 

Braces +3 added lines, -2 removed lines

@@ -21,8 +21,9 @@
 	// Cache the instance for re-use		
 	$moduleRegex = "/[fF][rR][Oo][Mm]\s+([^\s;]+)/";
 	$moduleName = '';
-	if (preg_match($moduleRegex, $q, $m))
-		$moduleName = trim($m[1]);
+	if (preg_match($moduleRegex, $q, $m)) {
+			$moduleName = trim($m[1]);
+	}
 
 	if (!isset($vtws_create_cache[$moduleName]['webserviceobject'])) {
 		$webserviceObject = VtigerWebserviceObject::fromQuery($adb, $q);

include/Webservices/QueryRelated.php

Doc Comments +3 added lines

@@ -12,6 +12,9 @@
 include_once 'include/Webservices/Query.php';
 include_once 'include/Webservices/RelatedTypes.php';
 
+/**
+ * @param string $query
+ */
 function vtws_query_related($query, $id, $relatedLabel, $user, $filterClause = null)
 {
 

Spacing +1 added lines, -1 removed lines

@@ -71,7 +71,7 @@
 		if (!empty($filterClause)) {
 			$query .= " " . $filterClause;
 		}
-		$query.=";";
+		$query .= ";";
 		$relatedRecords = vtws_query($query, $user);
 	}
 

include/Webservices/RelatedModuleMeta.php

Doc Comments +3 added lines

@@ -46,6 +46,9 @@
 		}
 	}
 
+	/**
+	 * @param integer $relationId
+	 */
 	private function getRelationMetaInfo($relationId)
 	{
 		return [