YetiForceCompany / YetiForceCRM

modules/Reports/ScheduledReports.php

Doc Comments +3 added lines

@@ -340,6 +340,9 @@
 		return $rolesAndSubHTML;
 	}
 
+	/**
+	 * @param Users $user
+	 */
 	public static function getScheduledReports($adb, $user)
 	{
 

Braces +15 added lines, -10 removed lines

@@ -258,8 +258,9 @@ 
 	public static function generateRecipientOption($type, $value, $name = '')
 	{
 		switch ($type) {
-			case 'users' : if (empty($name))
-					$name = \App\Fields\Owner::getUserLabel($value);
+			case 'users' : if (empty($name)) {
+								$name = \App\Fields\Owner::getUserLabel($value);
+			}
 				$optionName = 'User::' . addslashes(decode_html($name));
 				$optionValue = 'users::' . $value;
 				break;
@@ -269,13 +270,15 @@ 
 				$optionName = 'Group::' . addslashes(decode_html($name));
 				$optionValue = 'groups::' . $value;
 				break;
-			case 'roles' : if (empty($name))
-					$name = \App\PrivilegeUtil::getRoleName($value);
+			case 'roles' : if (empty($name)) {
+								$name = \App\PrivilegeUtil::getRoleName($value);
+			}
 				$optionName = 'Roles::' . addslashes(decode_html($name));
 				$optionValue = 'roles::' . $value;
 				break;
-			case 'rs' : if (empty($name))
-					$name = \App\PrivilegeUtil::getRoleName($value);
+			case 'rs' : if (empty($name)) {
+								$name = \App\PrivilegeUtil::getRoleName($value);
+			}
 				$optionName = 'RoleAndSubordinates::' . addslashes(decode_html($name));
 				$optionValue = 'rs::' . $value;
 				break;
@@ -375,10 +378,12 @@ 
 
 		$currentModule = vglobal('currentModule');
 		$current_language = vglobal('current_language');
-		if (empty($currentModule))
-			$currentModule = 'Reports';
-		if (empty($current_language))
-			vglobal('current_language', 'en_us');
+		if (empty($currentModule)) {
+					$currentModule = 'Reports';
+		}
+		if (empty($current_language)) {
+					vglobal('current_language', 'en_us');
+		}
 
 		$scheduledReports = self::getScheduledReports($adb, $adminUser);
 		foreach ($scheduledReports as $scheduledReport) {

modules/Users/CreateUserPrivilegeFile.php

Doc Comments +6 added lines, -6 removed lines

@@ -938,8 +938,8 @@ 
 
 /** Gives an array which contains the information for what all roles, groups and user's related module data that is to be shared  for the specified parent module and shared module 
 
- * @param $par_mod -- parent module name:: Type varchar
- * @param $share_mod -- shared module name:: Type varchar
+ * @param string $par_mod -- parent module name:: Type varchar
+ * @param string $share_mod -- shared module name:: Type varchar
  * @param $userid -- user id:: Type integer
  * @param $def_org_share -- default organization sharing permission array:: Type array
  * @param $mod_sharingrule_members -- Sharing Rule Members array:: Type array
@@ -1355,9 +1355,9 @@ 
 
 /** Function to populate the read/wirte Sharing permissions data for the specified user into the database 
  * @param $userid -- user id:: Type integer
- * @param $enttype -- can have the value of User or Group:: Type varchar
+ * @param string $enttype -- can have the value of User or Group:: Type varchar
  * @param $module -- module name:: Type varchar
- * @param $pertype -- can have the value of read or write:: Type varchar
+ * @param string $pertype -- can have the value of read or write:: Type varchar
  * @param $var_name_arr - Variable to use instead of including the sharing access again
  */
 function populateSharingPrivileges($enttype, $userid, $module, $pertype, $var_name_arr = false)
@@ -1432,10 +1432,10 @@ 
 
 /** Function to populate the read/wirte Sharing permissions related module data for the specified user into the database 
  * @param $userid -- user id:: Type integer
- * @param $enttype -- can have the value of User or Group:: Type varchar
+ * @param string $enttype -- can have the value of User or Group:: Type varchar
  * @param $module -- module name:: Type varchar
  * @param $relmodule -- related module name:: Type varchar
- * @param $pertype -- can have the value of read or write:: Type varchar
+ * @param string $pertype -- can have the value of read or write:: Type varchar
  * @param $var_name_arr - Variable to use instead of including the sharing access again
  */
 function populateRelatedSharingPrivileges($enttype, $userid, $module, $relmodule, $pertype, $var_name_arr = false)

Braces +12 added lines, -8 removed lines

@@ -592,8 +592,9 @@ 
 			$var_name = $module . '_share_write_permission';
 		}
 		// Lookup for the variable if not set through function argument		
-		if (!$var_name_arr)
-			$var_name_arr = $$var_name;
+		if (!$var_name_arr) {
+					$var_name_arr = $$var_name;
+		}
 		$user_arr = [];
 		if (sizeof($var_name_arr['ROLE']) > 0) {
 			foreach ($var_name_arr['ROLE'] as $roleid => $roleusers) {
@@ -627,8 +628,9 @@ 
 			$var_name = $module . '_share_write_permission';
 		}
 		// Lookup for the variable if not set through function argument
-		if (!$var_name_arr)
-			$var_name_arr = $$var_name;
+		if (!$var_name_arr) {
+					$var_name_arr = $$var_name;
+		}
 		$grp_arr = [];
 		if (sizeof($var_name_arr['GROUP']) > 0) {
 
@@ -671,8 +673,9 @@ 
 			$var_name = $module . '_' . $relmodule . '_share_write_permission';
 		}
 		// Lookup for the variable if not set through function argument
-		if (!$var_name_arr)
-			$var_name_arr = $$var_name;
+		if (!$var_name_arr) {
+					$var_name_arr = $$var_name;
+		}
 		$user_arr = [];
 		if (sizeof($var_name_arr['ROLE']) > 0) {
 			foreach ($var_name_arr['ROLE'] as $roleid => $roleusers) {
@@ -706,8 +709,9 @@ 
 			$var_name = $module . '_' . $relmodule . '_share_write_permission';
 		}
 		// Lookup for the variable if not set through function argument
-		if (!$var_name_arr)
-			$var_name_arr = $$var_name;
+		if (!$var_name_arr) {
+					$var_name_arr = $$var_name;
+		}
 		$grp_arr = [];
 		if (sizeof($var_name_arr['GROUP']) > 0) {
 

Indentation -10 removed lines

@@ -150,7 +150,6 @@ 
 }
 
 /** Gives an array which contains the information for what all roles, groups and user's related module data that is to be shared  for the specified parent module and shared module 
-
  * @param $par_mod -- parent module name:: Type varchar
  * @param $share_mod -- shared module name:: Type varchar
  * @param $userid -- user id:: Type integer
@@ -310,7 +309,6 @@ 
 }
 
 /** Converts the input array  to a single string to facilitate the writing of the input array in a flat file 
-
  * @param $var -- input array:: Type array
  * @returns $code -- contains the whole array in a single string:: Type array 
  */
@@ -327,7 +325,6 @@ 
 }
 
 /** Converts the input array  to a single string to facilitate the writing of the input array in a flat file 
-
  * @param $var -- input array:: Type array
  * @returns $code -- contains the whole array in a single string:: Type array 
  */
@@ -352,7 +349,6 @@ 
 }
 
 /** Converts the input array  to a single string to facilitate the writing of the input array in a flat file 
-
  * @param $var -- input array:: Type array
  * @returns $code -- contains the whole array in a single string:: Type array 
  */
@@ -377,7 +373,6 @@ 
 }
 
 /** Converts the input array  to a single string to facilitate the writing of the input array in a flat file 
-
  * @param $var -- input array:: Type array
  * @returns $code -- contains the whole array in a single string:: Type array 
  */
@@ -394,7 +389,6 @@ 
 }
 
 /** Converts the input array  to a single string to facilitate the writing of the input array in a flat file 
-
  * @param $var -- input array:: Type array
  * @returns $code -- contains the whole array in a single string:: Type array 
  */
@@ -411,7 +405,6 @@ 
 }
 
 /** Converts the input array  to a single string to facilitate the writing of the input array in a flat file 
-
  * @param $var -- input array:: Type array
  * @returns $code -- contains the whole array in a single string:: Type array 
  */
@@ -432,7 +425,6 @@ 
 }
 
 /** Converts the input array  to a single string to facilitate the writing of the input array in a flat file 
-
  * @param $var -- input array:: Type array
  * @returns $code -- contains the whole array in a single string:: Type array 
  */
@@ -453,7 +445,6 @@ 
 }
 
 /** Converts the input array  to a single string to facilitate the writing of the input array in a flat file 
-
  * @param $var -- input array:: Type array
  * @returns $code -- contains the whole array in a single string:: Type array 
  */
@@ -474,7 +465,6 @@ 
 }
 
 /** Converts the input array  to a single string to facilitate the writing of the input array in a flat file 
-
  * @param $var -- input array:: Type array
  * @returns $code -- contains the whole array in a single string:: Type array 
  */

modules/Vtiger/actions/GenerateRecords.php

Doc Comments +3 added lines

@@ -17,6 +17,9 @@
 		}
 	}
 
+	/**
+	 * @param Vtiger_Record_Model $recordModel
+	 */
 	public function checkMandatoryFields($recordModel)
 	{
 		$mandatoryFields = $recordModel->getModule()->getMandatoryFieldModels();

modules/Vtiger/actions/PDF.php

Doc Comments +1 added lines, -1 removed lines

@@ -221,7 +221,7 @@
 	/**
 	 * Checks if given record has valid pdf template
 	 * @param Vtiger_Request $request
-	 * @return boolean true if valid template exists for this record
+	 * @return boolean|null true if valid template exists for this record
 	 */
 	public function hasValidTemplate(Vtiger_Request $request)
 	{

modules/Vtiger/models/ChartFilter.php

Doc Comments +6 added lines

@@ -113,6 +113,9 @@ 
 		return [];
 	}
 
+	/**
+	 * @param Vtiger_Widget_Model $widgetModel
+	 */
 	public function setWidgetModel($widgetModel)
 	{
 		$this->widgetModel = $widgetModel;
@@ -127,6 +130,9 @@ 
 		}
 	}
 
+	/**
+	 * @return string
+	 */
 	public function getType()
 	{
 		return $this->extraData['chartType'];

Spacing +2 added lines, -2 removed lines

@@ -110,7 +110,7 @@ 
 					if (!isset($groupData[$displayValue]['count'])) {
 						$groupData[$displayValue]['count'] = 1;
 					} else {
-						$groupData[$displayValue]['count'] ++;
+						$groupData[$displayValue]['count']++;
 					}
 					if (!isset($groupData[$displayValue]['link'])) {
 						$moduleModel = $this->getTargetModuleModel();
@@ -127,7 +127,7 @@ 
 					if (!isset($count[$sectorId])) {
 						$count[$sectorId] = 1;
 					} else {
-						$count[$sectorId] ++;
+						$count[$sectorId]++;
 					}
 				}
 			}

modules/Vtiger/models/ExportToXml.php

Doc Comments +6 added lines

@@ -122,6 +122,9 @@ 
 		return html_entity_decode($value);
 	}
 
+	/**
+	 * @param string $fileName
+	 */
 	public function outputFile($fileName)
 	{
 		header("Content-Disposition:attachment;filename=$fileName.xml");
@@ -133,6 +136,9 @@ 
 		readfile($this->tmpXmlPath);
 	}
 
+	/**
+	 * @param string $fileName
+	 */
 	protected function outputZipFile($fileName)
 	{
 

modules/Vtiger/models/InventoryField.php

Doc Comments -5 removed lines

@@ -16,8 +16,6 @@ 
 
 	/**
 	 * Create the name of the Inventory data table
-	 * @param string $module Module name
-	 * @param string $prefix Prefix table
 	 * @return string Table name
 	 */
 	public function getTableName($type = 'data')
@@ -118,8 +116,6 @@ 
 
 	/**
 	 * Get inventory columns
-	 * @param string $module Module name
-	 * @param boolean $returnInBlock Should the result be divided into blocks
 	 * @return array Inventory columns
 	 */
 	public function getColumns()
@@ -164,7 +160,6 @@ 
 
 	/**
 	 * Retrieve list of all fields
-	 * @param string $moduleName Module name
 	 * @return array Fields instance Vtiger_Basic_InventoryField
 	 */
 	public function getAllFields()

Braces +6 added lines, -4 removed lines

@@ -133,8 +133,9 @@ 
 		$columns = [];
 		foreach ($this->getFields() as $key => $field) {
 			$column = $field->getColumnName();
-			if (!empty($column) && $column != '-')
-				$columns[] = $column;
+			if (!empty($column) && $column != '-') {
+							$columns[] = $column;
+			}
 			foreach ($field->getCustomColumn() as $name => $field) {
 				$columns[] = $name;
 			}
@@ -187,8 +188,9 @@ 
 		}
 		$fields = [];
 		foreach ($fieldPaths as $fieldPath) {
-			if (!is_dir($fieldPath))
-				continue;
+			if (!is_dir($fieldPath)) {
+							continue;
+			}
 			foreach (new DirectoryIterator($fieldPath) as $fileinfo) {
 				if ($fileinfo->isFile() && $fileinfo->getFilename() != 'Basic.php') {
 					$fieldName = str_replace('.php', '', $fileinfo->getFilename());

modules/Vtiger/models/ModuleMeta.php

Doc Comments +1 added lines, -1 removed lines

@@ -42,7 +42,7 @@
 
 	/**
 	 * Functions returns webservices meta object
-	 * @return webservices meta
+	 * @return boolean meta
 	 */
 	public function getMeta()
 	{

modules/Vtiger/views/Detail.php

Doc Comments +3 added lines

@@ -302,6 +302,9 @@
 		return $viewer->view('DetailViewFullContents.tpl', $moduleName, true);
 	}
 
+	/**
+	 * @param Vtiger_Request $request
+	 */
 	public function showModuleSummaryView($request)
 	{
 		$recordId = $request->get('record');

Braces +3 added lines, -2 removed lines

@@ -686,8 +686,9 @@
 			$sortImage = 'glyphicon glyphicon-chevron-up';
 		}
 		if (empty($orderBy) && empty($sortOrder)) {
-			if (is_numeric($relatedModuleName))
-				$relatedModuleName = vtlib\Functions::getModuleName($relatedModuleName);
+			if (is_numeric($relatedModuleName)) {
+							$relatedModuleName = vtlib\Functions::getModuleName($relatedModuleName);
+			}
 			$relatedInstance = CRMEntity::getInstance($relatedModuleName);
 			$orderBy = $relatedInstance->default_order_by;
 			$sortOrder = $relatedInstance->default_sort_order;