Settings_Search_Module_Model::getFieldInstanceByName() - Code Metrics - Inspection of "Improved panel for setting labels and search mecha..." - YetiForceCompany/YetiForceCRM - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — developer ( a1cff0...4caea0 )

by Radosław

created 2023-04-06 05:29 UTC

getFieldInstanceByName() A

↳ Parent: Settings_Search_Module_Model

Complexity

Conditions	4
Paths	4

Size

Total Lines	28
Code Lines	24

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	20

Importance

Changes

Metric	Value
eloc	24
dl	0
loc	28
ccs	0
cts	0
cp	0
rs	9.536
c	0
b	0
f	0
cc	4
nc	4
nop	1
crap	20

<?php

/**
 * Settings search Module model class.
 *
 * @copyright YetiForce S.A.
 * @license   YetiForce Public License 5.0 (licenses/LicenseEN.txt or yetiforce.com)
 */
class Settings_Search_Module_Model extends Settings_Vtiger_Module_Model
{
	/** @var string */
	public $name = 'Search';

	/**
	 * Get entity modules.
	 *
	 * @param int  $tabId
	 * @param bool $onlyActive
	 *
	 * @return array
	 */
	public static function getModulesEntity($tabId = false, $onlyActive = false)
	{
		$query = (new \App\Db\Query());
		if ($onlyActive) {
			$query->select(['vtiger_entityname.*'])->from('vtiger_entityname')->leftJoin('vtiger_tab', 'vtiger_entityname.tabid = vtiger_tab.tabid')
				->where(['vtiger_tab.presence' => 0]);
		} else {
			$query->from(('vtiger_entityname'));

			if ($tabId) {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
				$query->where(['tabid' => $tabId]);
			}
		}
		$query->orderBy('vtiger_entityname.sequence');
		$dataReader = $query->createCommand()->query();
		$moduleEntity = [];
		while ($row = $dataReader->read()) {
			$moduleEntity[$row['tabid']] = $row;
		}
		$dataReader->close();
		return $moduleEntity;
	}

	/**
	 * Get fields.
	 *
	 * @param mixed $blocks
	 *
	 * @return array
	 */
	public static function getFieldFromModule($blocks = true)
	{
		$fields = [];
		$dataReader = (new \App\Db\Query())->select(['vtiger_field.tabid', 'vtiger_field.columnname', 'vtiger_field.fieldlabel', 'vtiger_blocks.blocklabel'])
			->from('vtiger_field')
			->innerJoin('vtiger_blocks', 'vtiger_blocks.blockid = vtiger_field.block')
			->where(['not in', 'uitype', [15, 16, 52, 53, 56, 70, 99, 120]])
			->andWhere(['presence' => [0, 2]])
			->createCommand()
			->query();
		while ($row = $dataReader->read()) {
			if ($blocks) {
				$fields[$row['tabid']][$row['blocklabel']][$row['columnname']] = $row;
			} else {
				$fields[$row['tabid']][$row['columnname']] = $row;
			}
		}
		$dataReader->close();

		return $fields;
	}

	/**
	 * Save parameters.
	 *
	 * @param array $params
	 *
	 * @return bool
	 */
	public function save($params)
	{
		$db = App\Db::getInstance();
		$name = $params['name'];
		$tabId = (int) $params['tabid'];
		$value = $params['value'];

		if (('searchcolumn' === $name || 'fieldname' === $name) && (empty($value) || array_diff($value, array_keys(self::getFieldFromModule(false)[$tabId])))) {
			throw new \App\Exceptions\AppException('ERR_NOT_ALLOWED_VALUE');
		}
		$value = \is_array($value) ? implode(',', $value) : $value;
		$fieldModel = $this->getFieldInstanceByName($name);
		$fieldModel->getUITypeModel()->validate($value, true);
		$value = $fieldModel->getUITypeModel()->getDBValue($value);

		$db->createCommand()
			->update('vtiger_entityname', [$name => $value], ['tabid' => $tabId])
			->execute();

		\App\Cache::delete('ModuleEntityInfo', '');

		return true;
	}

	/**
	 * Update labels.
	 *
	 * @param array $params
	 *
	 * @return void
	 */
	public static function updateLabels($params): void
	{
		$moduleName = App\Module::getModuleName((int) $params['tabid']);
		$db = App\Db::getInstance();
		if ('Users' === $moduleName) {
			(new \App\BatchMethod(['method' => '\App\User::updateLabels', 'params' => [0]]))->save();
		} else {
			$db->createCommand()->delete('u_#__crmentity_search_label', ['tabid' => $params['tabid']])->execute();
			$subQuery = (new \App\Db\Query())->select(['crmid'])->from('vtiger_crmentity')->where(['setype' => $moduleName]);
			$db->createCommand()->delete('u_#__crmentity_label', ['crmid' => $subQuery])->execute();
		}
	}

	/**
	 * Update sequence number.
	 *
	 * @param array $modulesSequence
	 */
	public static function updateSequenceNumber($modulesSequence)
	{
		\App\Log::trace('Entering Settings_Search_Module_Model::updateSequenceNumber() method ...');
		$tabIdList = [];
		$db = App\Db::getInstance();
		$case = ' CASE ';
		foreach ($modulesSequence as $newModuleSequence) {
			$tabId = $newModuleSequence['tabid'];
			$tabIdList[] = $tabId;
			$case .= " WHEN tabid = {$db->quoteValue($tabId)} THEN {$db->quoteValue($newModuleSequence['sequence'])}";
		}
		$case .= ' END ';
		$db->createCommand()->update('vtiger_entityname', ['sequence' => new yii\db\Expression($case)], ['tabid' => $tabIdList])->execute();
		\App\Log::trace('Exiting Settings_Search_Module_Model::updateSequenceNumber() method ...');
	}

	/**
	 * Function determines fields available in edition view.
	 *
	 * @param string $name
	 *
	 * @return \Vtiger_Field_Model
	 */
	public function getFieldInstanceByName($name)
	{
		$moduleName = $this->getName(true);
		$params = ['column' => $name, 'name' => $name, 'displaytype' => 1, 'typeofdata' => 'V~M', 'presence' => 0, 'isEditableReadOnly' => false];
		switch ($name) {
			case 'searchcolumn':
				$params['uitype'] = 33;
				$params['picklistValues'] = [];
				$params['purifyType'] = \App\Purifier::ALNUM;
				$params['maximumlength'] = '150';
				break;
			case 'fieldname':
				$params['uitype'] = 33;
				$params['picklistValues'] = [];
				$params['purifyType'] = \App\Purifier::ALNUM;
				$params['maximumlength'] = '100';
				break;
			case 'turn_off':
				$params['uitype'] = 56;
				$params['purifyType'] = \App\Purifier::BOOL;
				$params['maximumlength'] = '1';
				$params['typeofdata'] = 'C~O';
				break;
			default:
				break;
		}

		return Settings_Vtiger_Field_Model::init($moduleName, $params);
	}
}


1			<?php
2
3			/**
4			* Settings search Module model class.
5			*
6			* @copyright YetiForce S.A.
7			* @license YetiForce Public License 5.0 (licenses/LicenseEN.txt or yetiforce.com)
8			*/
9			class Settings_Search_Module_Model extends Settings_Vtiger_Module_Model
10			{
11			/** @var string */
12			public $name = 'Search';
13
14			/**
15			* Get entity modules.
16			*
17			* @param int $tabId
18			* @param bool $onlyActive
19			*
20			* @return array
21			*/
22			public static function getModulesEntity($tabId = false, $onlyActive = false)
23			{
24			$query = (new \App\Db\Query());
25			if ($onlyActive) {
26			$query->select(['vtiger_entityname.*'])->from('vtiger_entityname')->leftJoin('vtiger_tab', 'vtiger_entityname.tabid = vtiger_tab.tabid')
27			->where(['vtiger_tab.presence' => 0]);
28			} else {
29			$query->from(('vtiger_entityname'));
30
31			if ($tabId) {
			0 ignored issues – show Bug Best Practice introduced 2021-04-24 21:59 UTC by Report Bug Copy Issue Report The expression `$tabId` of type `false\|integer` is loosely compared to `true`; this is ambiguous if the integer can be 0. You might want to explicitly use `!== false` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `integer` values, zero is a special case, in particular the following results might be unexpected: 0 == false // true 0 == null // true 123 == false // false 123 == null // false // It is often better to use strict comparison 0 === false // false 0 === null // false Loading history...
32			$query->where(['tabid' => $tabId]);
33			}
34			}
35			$query->orderBy('vtiger_entityname.sequence');
36			$dataReader = $query->createCommand()->query();
37			$moduleEntity = [];
38			while ($row = $dataReader->read()) {
39			$moduleEntity[$row['tabid']] = $row;
40			}
41			$dataReader->close();
42			return $moduleEntity;
43			}
44
45			/**
46			* Get fields.
47			*
48			* @param mixed $blocks
49			*
50			* @return array
51			*/
52			public static function getFieldFromModule($blocks = true)
53			{
54			$fields = [];
55			$dataReader = (new \App\Db\Query())->select(['vtiger_field.tabid', 'vtiger_field.columnname', 'vtiger_field.fieldlabel', 'vtiger_blocks.blocklabel'])
56			->from('vtiger_field')
57			->innerJoin('vtiger_blocks', 'vtiger_blocks.blockid = vtiger_field.block')
58			->where(['not in', 'uitype', [15, 16, 52, 53, 56, 70, 99, 120]])
59			->andWhere(['presence' => [0, 2]])
60			->createCommand()
61			->query();
62			while ($row = $dataReader->read()) {
63			if ($blocks) {
64			$fields[$row['tabid']][$row['blocklabel']][$row['columnname']] = $row;
65			} else {
66			$fields[$row['tabid']][$row['columnname']] = $row;
67			}
68			}
69			$dataReader->close();
70
71			return $fields;
72			}
73
74			/**
75			* Save parameters.
76			*
77			* @param array $params
78			*
79			* @return bool
80			*/
81			public function save($params)
82			{
83			$db = App\Db::getInstance();
84			$name = $params['name'];
85			$tabId = (int) $params['tabid'];
86			$value = $params['value'];
87
88			if (('searchcolumn' === $name \|\| 'fieldname' === $name) && (empty($value) \|\| array_diff($value, array_keys(self::getFieldFromModule(false)[$tabId])))) {
89			throw new \App\Exceptions\AppException('ERR_NOT_ALLOWED_VALUE');
90			}
91			$value = \is_array($value) ? implode(',', $value) : $value;
92			$fieldModel = $this->getFieldInstanceByName($name);
93			$fieldModel->getUITypeModel()->validate($value, true);
94			$value = $fieldModel->getUITypeModel()->getDBValue($value);
95
96			$db->createCommand()
97			->update('vtiger_entityname', [$name => $value], ['tabid' => $tabId])
98			->execute();
99
100			\App\Cache::delete('ModuleEntityInfo', '');
101
102			return true;
103			}
104
105			/**
106			* Update labels.
107			*
108			* @param array $params
109			*
110			* @return void
111			*/
112			public static function updateLabels($params): void
113			{
114			$moduleName = App\Module::getModuleName((int) $params['tabid']);
115			$db = App\Db::getInstance();
116			if ('Users' === $moduleName) {
117			(new \App\BatchMethod(['method' => '\App\User::updateLabels', 'params' => [0]]))->save();
118			} else {
119			$db->createCommand()->delete('u_#__crmentity_search_label', ['tabid' => $params['tabid']])->execute();
120			$subQuery = (new \App\Db\Query())->select(['crmid'])->from('vtiger_crmentity')->where(['setype' => $moduleName]);
121			$db->createCommand()->delete('u_#__crmentity_label', ['crmid' => $subQuery])->execute();
122			}
123			}
124
125			/**
126			* Update sequence number.
127			*
128			* @param array $modulesSequence
129			*/
130			public static function updateSequenceNumber($modulesSequence)
131			{
132			\App\Log::trace('Entering Settings_Search_Module_Model::updateSequenceNumber() method ...');
133			$tabIdList = [];
134			$db = App\Db::getInstance();
135			$case = ' CASE ';
136			foreach ($modulesSequence as $newModuleSequence) {
137			$tabId = $newModuleSequence['tabid'];
138			$tabIdList[] = $tabId;
139			$case .= " WHEN tabid = {$db->quoteValue($tabId)} THEN {$db->quoteValue($newModuleSequence['sequence'])}";
140			}
141			$case .= ' END ';
142			$db->createCommand()->update('vtiger_entityname', ['sequence' => new yii\db\Expression($case)], ['tabid' => $tabIdList])->execute();
143			\App\Log::trace('Exiting Settings_Search_Module_Model::updateSequenceNumber() method ...');
144			}
145
146			/**
147			* Function determines fields available in edition view.
148			*
149			* @param string $name
150			*
151			* @return \Vtiger_Field_Model
152			*/
153			public function getFieldInstanceByName($name)
154			{
155			$moduleName = $this->getName(true);
156			$params = ['column' => $name, 'name' => $name, 'displaytype' => 1, 'typeofdata' => 'V~M', 'presence' => 0, 'isEditableReadOnly' => false];
157			switch ($name) {
158			case 'searchcolumn':
159			$params['uitype'] = 33;
160			$params['picklistValues'] = [];
161			$params['purifyType'] = \App\Purifier::ALNUM;
162			$params['maximumlength'] = '150';
163			break;
164			case 'fieldname':
165			$params['uitype'] = 33;
166			$params['picklistValues'] = [];
167			$params['purifyType'] = \App\Purifier::ALNUM;
168			$params['maximumlength'] = '100';
169			break;
170			case 'turn_off':
171			$params['uitype'] = 56;
172			$params['purifyType'] = \App\Purifier::BOOL;
173			$params['maximumlength'] = '1';
174			$params['typeofdata'] = 'C~O';
175			break;
176			default:
177			break;
178			}
179
180			return Settings_Vtiger_Field_Model::init($moduleName, $params);
181			}
182			}
183

YetiForceCompany / YetiForceCRM

Push — developer ( a1cff0...4caea0 )

getFieldInstanceByName() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like