YetiForceCompany / YetiForceCRM

modules/OSSEmployees/OSSEmployees.php

Doc Comments +7 added lines

@@ -152,6 +152,10 @@ 
 		return $hierarchy;
 	}
 
+	/**
+	 * @param integer $id
+	 * @param integer[] $encounteredAccounts
+	 */
 	public function __getParentEmployees($id, &$parentAccounts, &$encounteredAccounts)
 	{
 		\App\Log::trace('Entering __getParentEmployees(' . $id . ',' . $parentAccounts . ') method ...');
@@ -193,6 +197,9 @@ 
 		return $parentAccounts;
 	}
 
+	/**
+	 * @param integer $id
+	 */
 	public function __getChildEmployees($id, &$childAccounts, $depth)
 	{
 		\App\Log::trace('Entering __getChildEmployees(' . $id . ',' . $childAccounts . ',' . $depth . ') method ...');

include/ConfigUtils.php

Doc Comments +28 added lines, -1 removed lines

@@ -24,7 +24,7 @@ 
 	 * Function to get main configuration of system.
 	 *
 	 * @param string $key
-	 * @param mixed  $value
+	 * @param string|false  $value
 	 *
 	 * @return mixed
 	 */
@@ -89,11 +89,17 @@ 
 		}
 	}
 
+	/**
+	 * @param string $key
+	 */
 	public static function api($key, $defvalue = false)
 	{
 		return self::$api[$key] ?? $defvalue;
 	}
 
+	/**
+	 * @param string $key
+	 */
 	public static function debug($key, $defvalue = false)
 	{
 		if (empty(self::$debug)) {
@@ -103,6 +109,9 @@ 
 		return self::$debug[$key] ?? $defvalue;
 	}
 
+	/**
+	 * @param string $key
+	 */
 	public static function developer($key, $defvalue = false)
 	{
 		if (empty(self::$developer)) {
@@ -112,6 +121,9 @@ 
 		return self::$developer[$key] ?? $defvalue;
 	}
 
+	/**
+	 * @param string $key
+	 */
 	public static function security($key, $defvalue = false)
 	{
 		if (empty(self::$security)) {
@@ -121,6 +133,9 @@ 
 		return self::$security[$key] ?? $defvalue;
 	}
 
+	/**
+	 * @param string $key
+	 */
 	public static function securityKeys($key, $defvalue = false)
 	{
 		if (empty(self::$securityKeys)) {
@@ -130,6 +145,9 @@ 
 		return self::$securityKeys[$key] ?? $defvalue;
 	}
 
+	/**
+	 * @param string $key
+	 */
 	public static function performance($key, $defvalue = false)
 	{
 		if (!self::$performance) {
@@ -139,6 +157,9 @@ 
 		return self::$performance[$key] ?? $defvalue;
 	}
 
+	/**
+	 * @param string $key
+	 */
 	public static function relation($key, $defvalue = false)
 	{
 		if (empty(self::$relation)) {
@@ -162,6 +183,9 @@ 
 		return self::$sounds[$key];
 	}
 
+	/**
+	 * @param string $key
+	 */
 	public static function search($key, $defvalue = false)
 	{
 		if (empty(self::$search)) {
@@ -171,6 +195,9 @@ 
 		return self::$search[$key] ?? $defvalue;
 	}
 
+	/**
+	 * @param string $key
+	 */
 	public static function load($key, $config)
 	{
 		self::$$key = $config;

modules/Calendar/models/Record.php

Doc Comments +3 added lines

@@ -24,6 +24,9 @@
 	 */
 	const REMNDER_POPUP_WAIT = 2;
 
+	/**
+	 * @param false|string $refModuleName
+	 */
 	public static function getNameByReference($refModuleName)
 	{
 		$fieldName = Vtiger_Cache::get('NameRelatedField', $refModuleName . '-Calendar');

modules/Vtiger/uitypes/Reminder.php

Doc Comments +1 added lines

@@ -49,6 +49,7 @@
 
 	/**
 	 * {@inheritdoc}
+	 * @param boolean $value
 	 */
 	public function validate($value, $isUserFormat = false)
 	{

modules/Calendar/views/RightPanel.php

Spacing +1 added lines, -1 removed lines

@@ -55,7 +55,7 @@
 		}
 		if (!empty($users) && $favouriteUsers = $currentUser->getFavouritesUsers()) {
 			uksort($users,
-				function ($a, $b) use ($favouriteUsers) {
+				function($a, $b) use ($favouriteUsers) {
 					return !isset($favouriteUsers[$a]) && isset($favouriteUsers[$b]);
 				});
 			$viewer->assign('FAVOURITES_USERS', $favouriteUsers);

modules/ModTracker/models/Record.php

Doc Comments +13 added lines

@@ -237,6 +237,9 @@ 
 		return $this->parent;
 	}
 
+	/**
+	 * @param integer $callerStatus
+	 */
 	public function checkStatus($callerStatus)
 	{
 		$status = $this->get('status');
@@ -414,12 +417,18 @@ 
 		return $relationInstance;
 	}
 
+	/**
+	 * @param integer $recordId
+	 */
 	public static function getTotalRecordCount($recordId, $type = false)
 	{
 		$where = self::getConditionByType($type);
 		return (new \App\Db\Query())->from('vtiger_modtracker_basic')->where(['crmid' => $recordId])->andWhere($where)->count();
 	}
 
+	/**
+	 * @param string|boolean $type
+	 */
 	public static function getConditionByType($type)
 	{
 		$where = [];
@@ -436,6 +445,10 @@ 
 		return $where;
 	}
 
+	/**
+	 * @param string $sourceModule
+	 * @param integer $current_user
+	 */
 	public static function addConvertToAccountRelation($sourceModule, $sourceId, $current_user)
 	{
 		$db = \App\Db::getInstance();

modules/Vtiger/views/Detail.php

Doc Comments +9 added lines, -8 removed lines

@@ -493,7 +493,7 @@ 
 	 *
 	 * @throws \App\Exceptions\NoPermittedToRecord
 	 *
-	 * @return mixed
+	 * @return string|boolean
 	 */
 	public function showChildComments(\App\Request $request)
 	{
@@ -523,7 +523,7 @@ 
 	 *
 	 * @throws \App\Exceptions\NoPermittedToRecord
 	 *
-	 * @return mixed
+	 * @return string|boolean
 	 */
 	public function showParentComments(\App\Request $request)
 	{
@@ -552,7 +552,7 @@ 
 	 *
 	 * @throws \App\Exceptions\NoPermittedToRecord
 	 *
-	 * @return mixed
+	 * @return string|boolean
 	 */
 	public function showThreadComments(\App\Request $request)
 	{
@@ -582,7 +582,7 @@ 
 	 *
 	 * @throws \App\Exceptions\NoPermittedToRecord
 	 *
-	 * @return mixed
+	 * @return string|boolean
 	 */
 	public function showAllComments(\App\Request $request)
 	{
@@ -630,7 +630,7 @@ 
 	 *
 	 * @throws \App\Exceptions\NoPermittedToRecord
 	 *
-	 * @return mixed
+	 * @return string|boolean
 	 */
 	public function showSearchComments(\App\Request $request)
 	{
@@ -698,6 +698,7 @@ 
 	 * Function to get Ajax is enabled or not.
 	 *
 	 * @param Vtiger_Record_Model record model
+	 * @param boolean $recordModel
 	 *
 	 * @return bool true/false
 	 */
@@ -1008,7 +1009,7 @@ 
 	 * @throws \App\Exceptions\IllegalValue
 	 * @throws \App\Exceptions\NoPermittedToRecord
 	 *
-	 * @return \html
+	 * @return string|boolean
 	 */
 	public function showOpenStreetMap(\App\Request $request)
 	{
@@ -1033,7 +1034,7 @@ 
 	 * @throws \App\Exceptions\IllegalValue
 	 * @throws \App\Exceptions\NoPermittedToRecord
 	 *
-	 * @return \html
+	 * @return string|boolean
 	 */
 	public function showSocialMedia(\App\Request $request)
 	{
@@ -1057,7 +1058,7 @@ 
 	 * @throws \App\Exceptions\IllegalValue
 	 * @throws \App\Exceptions\NoPermittedToRecord
 	 *
-	 * @return \html
+	 * @return string|boolean
 	 */
 	public function showChat(\App\Request $request)
 	{

modules/Settings/MarketingProcesses/models/Module.php

Doc Comments +3 added lines

@@ -13,6 +13,9 @@
 		return new self();
 	}
 
+	/**
+	 * @param string $type
+	 */
 	public static function getConfig($type)
 	{
 		$cache = Vtiger_Cache::get('MarketingProcesses', $type);

modules/Vtiger/models/DashBoard.php

Doc Comments +5 added lines, -1 removed lines

@@ -26,7 +26,7 @@ 
 	 *
 	 * @param Vtiger_Module_Model $moduleInstance - module model
 	 *
-	 * @return Vtiger_DetailView_Model
+	 * @return Vtiger_DashBoard_Model
 	 */
 	public function setModule($moduleInstance)
 	{
@@ -137,6 +137,9 @@ 
 		return [];
 	}
 
+	/**
+	 * @param string $moduleName
+	 */
 	public function verifyDashboard($moduleName)
 	{
 		\App\Log::trace('Entering ' . __METHOD__ . '(' . $moduleName . ')');
@@ -203,6 +206,7 @@ 
 	 * Function to get modules with widgets.
 	 *
 	 * @param string $moduleName - module name
+	 * @param integer $dashboard
 	 *
 	 * @return <Array> $modules
 	 */