Synchronizer::findRelationship() - Code Metrics - Inspection of "Comarch integration (#17179)" - YetiForceCompany/YetiForceCRM - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — developer ( b6ebe7...0bf5e9 )

by Mariusz
created 2023-07-06 09:16 UTC
Synchronizer::findRelationship() A

↳ Parent: Synchronizer
Complexity

Conditions	3
Paths	3
Size

Total Lines	9
Code Lines	5
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
eloc	5
c	0
b	0
f	0
dl	0
loc	9
rs	10
cc	3
nc	3
nop	2
<?php
/**
 * WAPRO ERP base synchronizer file.
 *
 * @package App
 *
 * @copyright YetiForce S.A.
 * @license   YetiForce Public License 5.0 (licenses/LicenseEN.txt or yetiforce.com)
 * @author    Mariusz Krzaczkowski <[email protected]>
 */

namespace App\Integrations\Wapro;

/**
 * WAPRO ERP base synchronizer class.
 */
abstract class Synchronizer
{
	/** @var string Provider name | File name. */
	const NAME = null;

	/** @var string Module name. */
	const MODULE_NAME = null;

	/** @var string Priority order. */
	const SEQUENCE = null;

	/** @var string Class name. */
	public $className;

	/** @var string[] Map of fields integrating with WAPRO ERP */
	protected $fieldMap = [];

	/** @var \App\Integrations\Wapro Controller instance. */
	protected $controller;

	/** @var \Vtiger_Record_Model Record model instance. */
	protected $recordModel;

	/** @var array Record row. */
	protected $row;

	/** @var int WAPRO ERP record ID. */
	protected $waproId;

	/** @var bool The flag to skip record creation. */
	protected $skip;

	/** @var bool Information on currency configuration. */
	protected static $currency;

	/**
	 * Synchronizer constructor.
	 *
	 * @param \App\Integrations\Wapro $controller
	 */
	public function __construct(\App\Integrations\Wapro $controller)
	{
		$this->controller = $controller;
		$this->className = substr(static::class, strrpos(static::class, '\\') + 1);
		if (isset($controller->customConfig[$this->className])) {
			$this->fieldMap = $controller->customConfig[$this->className];
		}
	}

	/**
	 * Main function to execute synchronizer.
	 *
	 * @return int
	 */
	abstract public function process(): int;

	/**
	 * Import record.
	 *
	 * @return int
	 */
	abstract public function importRecord(): int;

	/**
	 * Get number of records.
	 *
	 * @return int
	 */
	abstract public function getCounter(): int;

	/**
	 * Function to get provider name.
	 *
	 * @return string provider name
	 */
	public function getName(): string
	{
		return $this::NAME;
	}

	/**
	 * Find the crm ID for the integration record.
	 *
	 * @param int    $id
	 * @param string $table
	 *
	 * @return int|null
	 */
	public function findInMapTable(int $id, string $table): ?int
	{
		$cacheKey = "$id|$table";
		if (\App\Cache::has('WaproMapTable', $cacheKey)) {
			return \App\Cache::get('WaproMapTable', $cacheKey);
		}
		$crmId = (new \App\Db\Query())->select(['crmid'])->from(\App\Integrations\Wapro::RECORDS_MAP_TABLE_NAME)->where(['wtable' => $table, 'wid' => $id])->scalar();
		\App\Cache::save('WaproMapTable', $cacheKey, $crmId);
		return $crmId ?: null;

	}

	/**
	 * Add error log to db.
	 *
	 * @param \Throwable $ex
	 *
	 * @return void
	 */
	public function logError(\Throwable $ex): void
	{
		\App\Log::error("Error during import record in {$this->className}:\n{$ex->__toString()}", 'Integrations/Wapro');
		\App\DB::getInstance('log')->createCommand()
			->insert(\App\Integrations\Wapro::LOG_TABLE_NAME, [
				'time' => date('Y-m-d H:i:s'),
				'category' => $this->className,
				'message' => \App\TextUtils::textTruncate($ex->getMessage(), 255),
				'error' => true,
				'trace' => \App\TextUtils::textTruncate("WAPRO ID: {$this->waproId} \n{$ex->__toString()}", 65535)
			])->execute();
	}

	/**
	 * Add log to db.
	 *
	 * @param string $message
	 *
	 * @return void
	 */
	public function log(string $message): void
	{
		\App\DB::getInstance('log')->createCommand()
			->insert(\App\Integrations\Wapro::LOG_TABLE_NAME, [
				'time' => date('Y-m-d H:i:s'),
				'category' => $this->className,
				'message' => \App\TextUtils::textTruncate($message, 255),
				'error' => false,
			])->execute();
	}

	/**
	 * Load data from DB based on field map.
	 *
	 * @return void
	 */
	protected function loadFromFieldMap(): void
	{
		foreach ($this->fieldMap as $wapro => $crm) {
			if (\array_key_exists($wapro, $this->row)) {
				if (null === $this->row[$wapro]) {
					continue;
				}
				if (\is_array($crm)) {
					$value = $this->{$crm['fn']}($this->row[$wapro], $crm); // it cannot be on the lower line because it is a reference
					if ($this->skip) {
						break;
					}
					$this->recordModel->set($crm['fieldName'], trim($value));
				} else {
					$this->recordModel->set($crm, trim($this->row[$wapro]));
				}
			} else {
				\App\Log::error("No column {$wapro} in the {$this->className}", 'Integrations/Wapro');
			}
		}
	}

	/**
	 * Convert phone to system format.
	 *
	 * @param string $value
	 * @param array  $params
	 *
	 * @return string
	 */
	protected function convertPhone(string $value, array &$params): string
	{
		if ($fieldModel = $this->recordModel->getField($params['fieldName'])) {
			$details = $fieldModel->getUITypeModel()->getPhoneDetails($value, 'PL');
			$details = $fieldModel->getUITypeModel()->/** @scrutinizer ignore-call */ getPhoneDetails($value, 'PL');
			$value = $details['number'];
			if ($params['fieldName'] !== $details['fieldName']) {
				$params['fieldName'] = $details['fieldName'];
			}
		}
		return $value;
	}

	/**
	 * Convert country to system format.
	 *
	 * @param string $value
	 * @param array  $params
	 *
	 * @return string|null
	 */
	protected function convertCountry(string $value, array $params = []): ?string
	{
		$value = trim($value);
		return $value ? \App\Fields\Country::getCountryName($value) : null;
	}

	/**
	 * Convert currency to system format.
	 *
	 * @param string $value
	 * @param array  $params
	 *
	 * @return int
	 */
	protected function convertCurrency(string $value, array $params): int
	{
		$currencyId = \App\Fields\Currency::getIdByCode($value);
		if (empty($currencyId)) {
			$currencyId = \App\Fields\Currency::addCurrency($value);
		}
		return $currencyId ?? 0;
	}

	/**
	 * Find relationship.
	 *
	 * @param string $value
	 * @param array  $params
	 *
	 * @return int
	 */
	protected function findByRelationship(string $value, array $params): int
	{
		if ($id = $this->findInMapTable($value, $params['tableName'])) {
		if ($id = $this->findInMapTable(/** @scrutinizer ignore-type */ $value, $params['tableName'])) {
			return $id;
		}
		if (!empty($params['skipMode'])) {
			$this->skip = true;
		}
		return 0;
	}

	/**
	 * Get information about base currency.
	 *
	 * @return array
	 */
	protected function getBaseCurrency(): array
	{
		if (isset(self::$currency)) {
			return self::$currency;

		}
		$wapro = (new \App\Db\Query())->from('dbo.WALUTA_BAZOWA_V')->one($this->controller->getDb());
		return self::$currency = [

			'wapro' => $wapro,
			'currencyId' => $this->convertCurrency($wapro['SYM_WALUTY'], []),
			'default' => \App\Fields\Currency::getDefault(),
		];
	}

	/**
	 * Convert unit name to system format.
	 *
	 * @param string $value
	 * @param array  $params
	 *
	 * @return string
	 */
	protected function convertUnitName(string $value, array $params): string
	{
		$value = trim($value, '.');
		$picklistValues = \App\Fields\Picklist::getValuesName($params['fieldName']);
		$return = \in_array($value, $picklistValues);
		if (!$return) {
			foreach ($picklistValues as $picklistValue) {
				if (\App\Language::translate($picklistValue, $params['moduleName']) === $value) {
					$return = true;
					$value = $picklistValue;
					break;
				}
			}
		}
		return $return ? $value : '';
	}

	/**
	 * Get global tax from value.
	 *
	 * @param string $value
	 * @param bool   $addIfNotExist
	 *
	 * @return string
	 */
	protected function getGlobalTax(string $value, bool $addIfNotExist = false): string
	{
		$value = (float) $value;
		$taxes = '';
		foreach (\Vtiger_Inventory_Model::getGlobalTaxes() as $key => $tax) {
			if (\App\Validator::floatIsEqual($tax['value'], $value)) {
				$taxes = $key;
				break;
			}
		}
		if ($addIfNotExist && empty($taxes)) {
			$taxModel = new \Settings_Inventory_Record_Model();
			$taxModel->setData([
				'name' => $value,
				'value' => $value,
				'status' => 0,
				'default' => 0,
			])
				->setType('Taxes');
			$taxes = $taxModel->save();
		}
		return $taxes;
	}

	/**
	 * Convert unit name to system format.
	 *
	 * @param string $value
	 * @param array  $params
	 *
	 * @return string
	 */
	protected function decode(string $value, array $params): string
	{
		return trim(preg_replace('/[\x{0081}\n]/u', ' ', \App\Purifier::decodeHtml($value)));
	}

	/**
	 * Search for user in activity.
	 *
	 * @param int    $id
	 * @param string $table
	 *
	 * @return int|null
	 */
	public function searchUserInActivity(int $id, string $table): ?int
	{
		$cacheKey = "$id|$table";
		if (\App\Cache::has('WaproUser', $cacheKey)) {
			return \App\Cache::get('WaproUser', $cacheKey);
		}
		$userId = null;
		$erpId = (new \App\Db\Query())->select(['ID_UZYTKOWNIKA'])->from('dbo.AKTYWNOSC_UZYTKOWNIKA')
			->where(['ID_ZAPISU' => $id, 'TYP_ZAPISU' => $table])->scalar($this->controller->getDb());
		if ($erpId) {
			$userId = $this->getUser($erpId);
			$userId = $this->getUser(/** @scrutinizer ignore-type */ $erpId);
		}
		\App\Cache::save('WaproUser', $cacheKey, $userId);
		return $userId;
	}

	/**
	 * Find CRM User ID by ID from ERP.
	 *
	 * @param int $erpId
	 *
	 * @return int|null
	 */
	protected function getUser(int $erpId): ?int
	{
		if (\App\Cache::has('WaproUserMap', '')) {
			$users = \App\Cache::get('WaproUserMap', '');
		} else {
			$erpUsers = (new \App\Db\Query())->select(['ID_UZYTKOWNIKA', 'IDENTYFIKATOR'])
				->from('dbo.UZYTKOWNIK')->createCommand($this->controller->getDb())->queryAllByGroup();
			$dataReader = (new \App\Db\Query())->select(['wapro_user', 'id'])->from('vtiger_users')
				->where(['and', ['not', ['wapro_user' => null]], ['<>', 'wapro_user', '']])
				->createCommand()->query();
			$crmUsers = [];
			while ($row = $dataReader->read()) {
				$erpIds = explode(',', $row['wapro_user']);
				foreach ($erpIds as $erpId) {
					$crmUsers[$erpId] = $row['id'];
				}
			}
			$users = [];
			foreach ($erpUsers as $id => $ident) {
				if (isset($crmUsers[$ident])) {
					$users[$id] = $crmUsers[$ident];
				}
			}
			\App\Cache::save('WaproUserMap', '', $users);
		}
		return $users[$erpId] ?? null;
	}
}

YetiForceCompany / YetiForceCRM

Push — developer ( b6ebe7...0bf5e9 )

Synchronizer::findRelationship() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
