Record::isRelated() - Code Metrics - Inspection of "Added handlers pre delete and change state for pro..." - YetiForceCompany/YetiForceCRM - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — developer ( 314760...5d405c )

by Radosław
created 2023-02-17 09:21 UTC
Record::isRelated() C

↳ Parent: Record
Complexity

Conditions	13
Paths	20
Size

Total Lines	40
Code Lines	30
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	0
CRAP Score	182
Importance

Changes
Metric	Value
eloc	30
c	0
b	0
f	0
dl	0
loc	40
rs	6.6166
ccs	0
cts	0
cp	0
cc	13
nc	20
nop	3
crap	182
How to fix Complexity

<?php
/**
 * Record basic file.
 *
 * @package App
 *
 * @copyright YetiForce S.A.
 * @license   YetiForce Public License 5.0 (licenses/LicenseEN.txt or yetiforce.com)
 * @author    Mariusz Krzaczkowski <[email protected]>
 * @author    Radosław Skrzypczak <[email protected]>
 */

namespace App;

use vtlib\Functions;

/**
 * Record basic class.
 */
class Record
{
	/** @var int Record state - Deleted permanently */
	public const STATE_DELETED = -1;
	/** @var int Record state - Active */
	public const STATE_ACTIVE = 0;
	/** @var int Record state - Deleted (Recycle bin) */
	public const STATE_TRASH = 1;
	/** @var int Record state - Archived */
	public const STATE_ARCHIVED = 2;

	/** @var string[] Possible record states */
	public const STATES = [
		self::STATE_ACTIVE => 'Active',
		self::STATE_TRASH => 'Trash',
		self::STATE_ARCHIVED => 'Archived'
	];

	/**
	 * Get label.
	 *
	 * @param mixed $mixedId
	 * @param bool  $raw
	 *
	 * @return mixed
	 */
	public static function getLabel($mixedId, bool $raw = false)
	{
		$multiMode = \is_array($mixedId);
		$ids = array_filter($multiMode ? array_unique($mixedId) : [$mixedId]);
		$result = $missing = [];
		foreach ($ids as $id) {
			if (!Cache::has('recordLabel', $id)) {
				$missing[$id] = $id;
			} else {
				$result[$id] = Cache::get('recordLabel', $id);
			}
		}
		if (!empty($missing)) {
			$query = (new \App\Db\Query())->select(['crmid', 'label'])->from('u_#__crmentity_label')->where(['crmid' => $missing]);
			$dataReader = $query->createCommand()->query();
			while ($row = $dataReader->read()) {
				$label = \App\Utils\Completions::decodeEmoji($row['label']);
				Cache::save('recordLabel', $row['crmid'], $label);
				$result[$row['crmid']] = $label;
			}
			foreach (array_diff_key($missing, $result) as $id) {
				$metaInfo = Functions::getCRMRecordMetadata($id);
				$computeLabel = static::computeLabels($metaInfo['setype'] ?? '', $id)[$id] ?? '';
				Cache::save('recordLabel', $id, $computeLabel);
				$result[$id] = $computeLabel;
			}
		}
		if (!$raw && $result) {
			$result = array_map('\App\Purifier::encodeHtml', $result);
		}
		return $multiMode ? $result : reset($result);
	}

	/**
	 * Function searches for record ID with given label.
	 *
	 * @param string $moduleName
	 * @param string $label
	 * @param int    $userId
	 *
	 * @return int
	 */
	public static function getCrmIdByLabel($moduleName, $label, $userId = false)
	{
		$key = $moduleName . $label . '_' . $userId;
		$key = $moduleName . $label . '_' . /** @scrutinizer ignore-type */ $userId;
		if (\App\Cache::staticHas(__METHOD__, $key)) {
			return \App\Cache::staticGet(__METHOD__, $key);
		}
		$query = (new \App\Db\Query())
			->select(['cl.crmid'])
			->from('u_#__crmentity_label cl')
			->innerJoin('vtiger_crmentity', 'cl.crmid = vtiger_crmentity.crmid')
			->where(['vtiger_crmentity.setype' => $moduleName])
			->andWhere(['cl.label' => $label]);
		if ($userId) {
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->andWhere(['like', 'vtiger_crmentity.users', ",$userId,"]);
		}
		$crmId = $query->scalar();
		\App\Cache::staticSave(__METHOD__, $key, $crmId);

		return $crmId;

	}

	/**
	 * Function gets labels for record data.
	 *
	 * @param string    $moduleName
	 * @param array|int $ids
	 * @param bool      $search
	 *
	 * @return string[]|null
	 */
	public static function computeLabels($moduleName, $ids, $search = false): ?array
	{
		if (empty($moduleName) || empty($ids)) {
			return [];
		}
		$metaInfo = \App\Module::getEntityInfo($moduleName);
		if (!$metaInfo || (empty($metaInfo['fieldnameArr']) && empty($metaInfo['searchcolumnArr']))) {
			return null;
		}
		if (!\is_array($ids)) {
			$ids = [$ids];
		}
		$moduleModel = \Vtiger_Module_Model::getInstance($moduleName);
		$entityDisplay = [];
		$cacheName = 'computeLabelsQuery';
		if (!\App\Cache::staticHas($cacheName, $moduleName)) {
			$table = $metaInfo['tablename'];
			$idColumn = $table . '.' . $metaInfo['entityidfield'];
			$columnsName = $metaInfo['fieldnameArr'];
			$columnsSearch = $metaInfo['searchcolumnArr'];
			$columns = array_unique(array_merge($columnsName, $columnsSearch));
			$leftJoinTables = $paramsCol = [];
			$query = new \App\Db\Query();
			$focus = $moduleModel->getEntityInstance();
			$moduleInfoExtend = \App\Field::getModuleFieldInfos($moduleName, true);
			foreach (array_filter($columns) as $column) {
				if (\array_key_exists($column, $moduleInfoExtend)) {
					$otherTable = $moduleInfoExtend[$column]['tablename'];
					$paramsCol[] = $otherTable . '.' . $column;
					if ($otherTable !== $table && !\in_array($otherTable, $leftJoinTables)) {
						$leftJoinTables[] = $otherTable;
						$focusTables = $focus->tab_name_index;
						$query->leftJoin($otherTable, "$table.$focusTables[$table] = $otherTable.$focusTables[$otherTable]");
					}
				}
			}
			$paramsCol['id'] = $idColumn;
			$query->select($paramsCol)->from($table);
			\App\Cache::staticSave($cacheName, $moduleName, clone $query);
		} else {
			$query = \App\Cache::staticGet($cacheName, $moduleName);
			$columnsName = $metaInfo['fieldnameArr'];
			$columnsSearch = $metaInfo['searchcolumnArr'];
			$idColumn = $metaInfo['entityidfield'];
		}
		$separator = $metaInfo['separator'] ?? ' ';
		$ids = array_unique($ids);
		$query->where([$idColumn => $ids]);
		$dataReader = $query->createCommand()->query();
		while ($row = $dataReader->read()) {
			$recordId = $row['id'];
			$labelName = [];
			foreach ($columnsName as $columnName) {
				$fieldModel = $moduleModel->getFieldByColumn($columnName);
				$labelName[] = $fieldModel ? $fieldModel->getDisplayValue($row[$columnName], $recordId, false, true) : '';
			}
			$label = TextUtils::textTruncate(trim(implode($separator, $labelName)), 250, false);
			if ($search) {
				$labelName = [];
				foreach ($columnsSearch as $columnName) {
					$fieldModel = $moduleModel->getFieldByColumn($columnName);
					$labelName[] = $fieldModel ? $fieldModel->getDisplayValue($row[$columnName], $recordId, false, true) : '';
				}
				$searchLabel = TextUtils::textTruncate(trim(implode($separator, $labelName)), 250, false);
				$entityDisplay[$recordId] = ['name' => $label, 'search' => $searchLabel];
			} else {
				$entityDisplay[$recordId] = $label;
			}
		}
		return $entityDisplay;
	}

	/**
	 * Update record label.
	 *
	 * @param string $moduleName
	 * @param int    $id
	 *
	 * @return void
	 */
	public static function updateLabel(string $moduleName, int $id): void
	{
		$dbCommand = \App\Db::getInstance()->createCommand();
		$labelTableName = \App\RecordSearch::LABEL_TABLE_NAME;
		$searchTableName = \App\RecordSearch::SEARCH_TABLE_NAME;

		$metaInfo = static::computeLabels($moduleName, $id, true);
		if (!$metaInfo) {
			$dbCommand->delete($labelTableName, ['crmid' => $id])->execute();
			$dbCommand->delete($searchTableName, ['crmid' => $id])->execute();
		} else {
			$label = $metaInfo[$id]['name'];
			if ((new \App\Db\Query())->from($labelTableName)->where(['crmid' => $id])->exists()) {
				$dbCommand->update($labelTableName, ['label' => $label], ['crmid' => $id])->execute();
			} else {
				$dbCommand->insert($labelTableName, ['crmid' => $id, 'label' => $label])->execute();
			}
			if (isset(\App\RecordSearch::getSearchableModules()[$moduleName])) {
				$label = $metaInfo[$id]['search'];
				if ((new \App\Db\Query())->from($searchTableName)->where(['crmid' => $id])->exists()) {
					$dbCommand->update($searchTableName, ['searchlabel' => $label], ['crmid' => $id])->execute();
				} else {
					$dbCommand->insert($searchTableName, ['crmid' => $id, 'searchlabel' => $label, 'tabid' => \App\Module::getModuleId($moduleName)])->execute();
				}
			}
			Cache::save('recordLabel', $id, $metaInfo[$id]['name']);
		}
	}

	/**
	 * Update record label on save.
	 *
	 * @param \Vtiger_Record_Model $recordModel
	 *
	 * @return void
	 */
	public static function updateLabelOnSave(\Vtiger_Record_Model $recordModel): void
	{
		$label = '';
		$metaInfo = \App\Module::getEntityInfo($recordModel->getModuleName());
		$dbCommand = Db::getInstance()->createCommand();
		if (!$metaInfo || (empty($metaInfo['fieldnameArr']) && empty($metaInfo['searchcolumnArr']))) {
			$dbCommand->delete('u_#__crmentity_label', ['crmid' => $recordModel->getId()])->execute();
			$dbCommand->delete('u_#__crmentity_search_label', ['crmid' => $recordModel->getId()])->execute();
		} else {
			$separator = $metaInfo['separator'] ?? ' ';
			$labelName = [];
			foreach ($metaInfo['fieldnameArr'] as $columnName) {
				$fieldModel = $recordModel->getModule()->getFieldByColumn($columnName);
				$labelName[] = $fieldModel->getDisplayValue($recordModel->get($fieldModel->getName()), $recordModel->getId(), $recordModel, true);
			}
			$label = TextUtils::textTruncate(trim(implode($separator, $labelName)), 250, false) ?: '';
			if ($recordModel->isNew()) {
				$dbCommand->insert('u_#__crmentity_label', ['crmid' => $recordModel->getId(), 'label' => $label])->execute();
			} else {
				$dbCommand->update('u_#__crmentity_label', ['label' => $label], ['crmid' => $recordModel->getId()])->execute();
			}

			if (isset(\App\RecordSearch::getSearchableModules()[$recordModel->getModuleName()])) {
				$labelSearch = [];
				foreach ($metaInfo['searchcolumnArr'] as $columnName) {
					$fieldModel = $recordModel->getModule()->getFieldByColumn($columnName);
					$labelSearch[] = $fieldModel->getDisplayValue($recordModel->get($fieldModel->getName()), $recordModel->getId(), $recordModel, true);
				}
				$search = TextUtils::textTruncate(trim(implode($separator, $labelSearch)), 250, false) ?: '';
				if ($recordModel->isNew()) {
					$dbCommand->insert('u_#__crmentity_search_label', ['crmid' => $recordModel->getId(), 'searchlabel' => $search, 'tabid' => $recordModel->getModule()->getId()])->execute();
				} else {
					$dbCommand->update('u_#__crmentity_search_label', ['searchlabel' => $search], ['crmid' => $recordModel->getId()])->execute();
				}
			}
		}
		$recordModel->label = \App\Purifier::encodeHtml($label);
		Cache::save('recordLabel', $recordModel->getId(), $label);
	}

	/**
	 * Function checks if record exists.
	 *
	 * @param int      $recordId   Record ID
	 * @param string   $moduleName
	 * @param int|null $state      null = [self::STATE_ACTIVE, self::STATE_ARCHIVED]
	 *
	 * @return bool
	 */
	public static function isExists(int $recordId, string $moduleName = '', ?int $state = null)
	{
		$recordMetaData = Functions::getCRMRecordMetadata($recordId);
		return isset($recordMetaData)
			&& (null === $state ? self::STATE_TRASH !== $recordMetaData['deleted'] : $recordMetaData['deleted'] === $state)
			&& ($moduleName ? $recordMetaData['setype'] === $moduleName : true);
	}

	/**
	 * Get record module name.
	 *
	 * @param int $recordId
	 *
	 * @return string|null
	 */
	public static function getType($recordId)
	{
		$metadata = Functions::getCRMRecordMetadata($recordId);
		return $metadata ? $metadata['setype'] : null;
	}

	/**
	 * Get the currency ID for the inventory record.
	 *
	 * @param int    $recordId
	 * @param string $moduleName
	 *
	 * @return int|null
	 */
	public static function getCurrencyIdFromInventory(int $recordId, string $moduleName): ?int
	{
		$invData = \Vtiger_Inventory_Model::getInventoryDataById($recordId, $moduleName);
		return current($invData)['currency'] ?? Fields\Currency::getDefault()['id'] ?? null;
	}

	/**
	 * Get record state.
	 *
	 * @param int $recordId
	 *
	 * @return int
	 */
	public static function getState(int $recordId): int
	{
		$metadata = Functions::getCRMRecordMetadata($recordId);
		return $metadata['deleted'] ?? self::STATE_DELETED;
	}

	/**
	 * Get record state label.
	 *
	 * @param int $recordId
	 *
	 * @return string {@see \App\Record::STATES}
	 */
	public static function getStateLabel(int $recordId): string
	{
		return self::STATES[self::getState($recordId)] ?? '';
	}

	/**
	 * Get parent record.
	 *
	 * @param int         $recordId
	 * @param bool|string $moduleName
	 *
	 * @return int|null
	 */
	public static function getParentRecord($recordId, $moduleName = false): ?int
	{
		if (Cache::has(__METHOD__, $recordId)) {
			return Cache::get(__METHOD__, $recordId);
		}
		if (!$moduleName) {
			$moduleName = static::getType($recordId);
		}
		$parentId = null;
		if ($parentModules = ModuleHierarchy::getModulesMap1M($moduleName)) {
			foreach ($parentModules as $parentModule) {
				if ($field = Field::getRelatedFieldForModule($moduleName, $parentModule)) {
					$entity = \CRMEntity::getInstance($moduleName);
					$index = $entity->tab_name_index[$field['tablename']];
					$parentId = (new \App\Db\Query())->select(["{$field['tablename']}.{$field['columnname']}"])
						->from($field['tablename'])
						->innerJoin('vtiger_crmentity', "{$field['tablename']}.{$index} = vtiger_crmentity.crmid")
						->where(["{$field['tablename']}.{$index}" => $recordId, 'vtiger_crmentity.deleted' => 0])
						->scalar();
				}
			}
		}
		Cache::save(__METHOD__, $recordId, $parentId);
		return $parentId;

	}

	/**
	 * Get record id by record number .
	 *
	 * @param string $recordNumber
	 * @param string $moduleName
	 *
	 * @return int|bool
	 */
	public static function getIdByRecordNumber(string $recordNumber, string $moduleName)
	{
		if (Cache::staticHas(__METHOD__, $recordNumber)) {
			return Cache::staticGet(__METHOD__, $recordNumber);
		}
		$field = Fields\RecordNumber::getSequenceNumberField(Module::getModuleId($moduleName));
		$entity = \CRMEntity::getInstance($moduleName);
		$index = $entity->tab_name_index[$field['tablename']];
		$id = (new \App\Db\Query())->select(['vtiger_crmentity.crmid'])
			->from($field['tablename'])
			->innerJoin('vtiger_crmentity', "{$field['tablename']}.{$index} = vtiger_crmentity.crmid")
			->where(["{$field['tablename']}.{$field['columnname']}" => $recordNumber, 'vtiger_crmentity.deleted' => 0])
			->scalar();
		Cache::staticSave(__METHOD__, $recordNumber, $id);
		return $id;

	}

	/**
	 * Get record link and label.
	 *
	 * @param int         $id
	 * @param string|null $moduleName
	 * @param int|null    $length
	 * @param bool        $fullUrl
	 *
	 * @return string
	 */
	public static function getHtmlLink(int $id, ?string $moduleName = null, ?int $length = null, bool $fullUrl = false): string
	{
		$state = self::getState($id);
		if (null === $state) {

			return '<i class="color-red-500" title="' . $id . '">' . Language::translate('LBL_RECORD_DOES_NOT_EXIST') . '</i>';
		}
		$label = self::getLabel($id, true);
		if (empty($label) && 0 != $label) {
			return '<i class="color-red-500" title="' . $id . '">' . Language::translate('LBL_RECORD_DOES_NOT_EXIST') . '</i>';
		}
		if (null !== $length) {
			$label = TextUtils::textTruncate($label, $length);
		}
		if (empty($moduleName)) {
			$moduleName = self::getType($id);
		}
		$deleted = 'Trash' === $state;
		if ($id && !Privilege::isPermitted($moduleName, 'DetailView', $id)) {
			return $deleted ? "<s>{$label}</s>" : $label;

		}
		$moduleModel = \Vtiger_Module_Model::getInstance($moduleName);
		$url = $moduleModel->getDetailViewUrl($id);
		if ($fullUrl) {
			$url = \Config\Main::$site_URL . $url;
filter:
    dependency_paths: ["lib/*"]
		}
		$label = $moduleModel->getCustomLinkLabel($id, $label);
		$label = "<a class=\"modCT_{$moduleName} showReferenceTooltip js-popover-tooltip--record\" href=\"{$url}\">{$label}</a>";

		return $deleted ? "<s>{$label}</s>" : $label;

	}

	/**
	 * Check if record is related in relations or inventory.
	 *
	 * @param \Vtiger_Record_Model $parentRecordModel
	 * @param bool                 $checkRelations
	 * @param bool                 $checkInventory
	 *
	 * @return string|false|null
	 */
	public static function isRelated(\Vtiger_Record_Model $parentRecordModel, bool $checkRelations = true, bool $checkInventory = false)
	{
		$parentModuleModel = $parentRecordModel->getModule();
		$relatedRecord = false;
		if ($checkRelations) {
			$relations = \Vtiger_Relation_Model::getAllRelations($parentModuleModel, false, true, true);
			foreach ($relations as $relationModel) {
				$relationModel->set('parentRecord', $parentRecordModel);
				$queryGenerator = $relationModel->getQuery();
				$queryGenerator->permissions = false;
				$queryGenerator->clearFields()->setFields(['id']);
				if ($result = $queryGenerator->createQuery()->scalar()) {
					$relatedRecord = $result;
					break;
				}
			}
		}
		if ($checkInventory && !$relatedRecord) {
			$recordId = $parentRecordModel->getId();
			$parentModuleName = $parentModuleModel->getName();
			$allModules = \vtlib\Functions::getAllModules(false, true);
			foreach ($allModules as $moduleData) {
				$moduleModel = \Vtiger_Module_Model::getInstance($moduleData['name']);
				$inventoryModel = \Vtiger_Inventory_Model::getInstance($moduleData['name']);

				if ($moduleModel->isInventory()
				 && ($inventoryModel = \Vtiger_Inventory_Model::getInstance($moduleData['name']))
				 && ($inventoryNameField = $inventoryModel->getField('name'))
				 && ($modules = $inventoryNameField->getModules())
				 && ($modules = $inventoryNameField->/** @scrutinizer ignore-call */ getModules())
				 && \in_array($parentModuleName, $modules)
				 ) {
					$inventoryTable = $inventoryModel->getDataTableName();
					$result = (new \App\Db\Query())->select(['crmid'])->from($inventoryTable)->where(['name' => $recordId])->scalar();
					if ($result) {
						$relatedRecord = $result;
						break;
					}
				}
			}
		}
		return $relatedRecord;
	}
}

YetiForceCompany / YetiForceCRM

Push — developer ( 314760...5d405c )

Record::isRelated() C

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like
