Gus::search() - Code Metrics - Inspection of "Added improvements in record collector" - YetiForceCompany/YetiForceCRM - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — developer ( b17be7...a57010 )

by Mariusz
created 2023-04-27 14:13 UTC
Gus::search() D

↳ Parent: Gus
Complexity

Conditions	20
Paths	75
Size

Total Lines	76
Code Lines	58
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
eloc	58
dl	0
loc	76
rs	4.1666
c	0
b	0
f	0
cc	20
nc	75
nop	0
How to fix Long Method Complexity

<?php
/**
 * Gus class for downloading REGON registry open public data. For BIR 1.1 version.
 *
 * The file is part of the paid functionality. Using the file is allowed only after purchasing a subscription. File modification allowed only with the consent of the system producer.
 *
 * @see https://api.stat.gov.pl/Home/RegonApi
 *
 * @package App
 *
 * @copyright YetiForce S.A.
 * @license   YetiForce Public License 5.0 (licenses/LicenseEN.txt or yetiforce.com)
 * @author    Adrian Kon <[email protected]>
 * @author    Mariusz Krzaczkowski <[email protected]>
 */

namespace App\RecordCollectors;

/**
 * Gus record collector class.
 */
class Gus extends Base
{
	/** {@inheritdoc} */
	public $allowedModules = ['Accounts', 'Leads', 'Vendors', 'Competition', 'Partners'];

	/** {@inheritdoc} */
	public $icon = 'yfi-gus-regon-pl';

	/** {@inheritdoc} */
	public $label = 'LBL_PL_GUS';

	/** {@inheritdoc} */
	public $description = 'LBL_PL_GUS_DESC';

	/** {@inheritdoc} */
	public $displayType = 'FillFields';

	/** {@inheritdoc} */
	public $docUrl = 'https://api.stat.gov.pl/Home/RegonApi';

	/** {@inheritdoc} */
	protected $fields = [
		'vatId' => [
			'labelModule' => '_Base',
			'label' => 'Vat ID',
		],
		'ncr' => [
			'labelModule' => '_Base',
			'label' => 'Registration number 1',
		],
		'taxNumber' => [
			'labelModule' => '_Base',
			'label' => 'Registration number 2',
		],
	];

	/** {@inheritdoc} */
	protected $modulesFieldsMap = [
		'Accounts' => [
			'vatId' => 'vat_id',
			'taxNumber' => 'registration_number_2',
			'ncr' => 'registration_number_1',
		],
		'Leads' => [
			'vatId' => 'vat_id',
			'taxNumber' => 'registration_number_2',
			'ncr' => 'registration_number_1',
		],
		'Vendors' => [
			'vatId' => 'vat_id',
			'taxNumber' => 'registration_number_2',
			'ncr' => 'registration_number_1',
		],
		'Competition' => [
			'vatId' => 'vat_id',
			'taxNumber' => 'registration_number_2',
			'ncr' => 'registration_number_1',
		],
		'Partners' => [
			'vatId' => 'vat_id',
		],
	];

	/** {@inheritdoc} */
	public $formFieldsToRecordMap = [
		'Accounts' => [
			'Nazwa' => 'accountname',
			'Regon' => 'registration_number_2',
			'Krs' => 'registration_number_1',
			'Nip' => 'vat_id',
			'NumerBudynku' => 'buildingnumbera',
			'NumerLokalu' => 'localnumbera',
			'Ulica' => 'addresslevel8a',
			'KodPocztowy' => 'addresslevel7a',
			'Miejscowosc' => 'addresslevel5a',
			'Gmina' => 'addresslevel4a',
			'Powiat' => 'addresslevel3a',
			'Wojewodztwo' => 'addresslevel2a',
			'Kraj' => 'addresslevel1a',
			'NumerTelefonu' => 'phone',
			'NumerFaksu' => 'fax',
			'AdresEmail' => 'email1',
			'AdresStronyInternetowej' => 'website',
		],
		'Leads' => [
			'Nazwa' => 'company',
			'Nip' => 'vat_id',
			'Regon' => 'registration_number_2',
			'NumerBudynku' => 'buildingnumbera',
			'NumerLokalu' => 'localnumbera',
			'Ulica' => 'addresslevel8a',
			'KodPocztowy' => 'addresslevel7a',
			'Miejscowosc' => 'addresslevel5a',
			'Gmina' => 'addresslevel4a',
			'Powiat' => 'addresslevel3a',
			'Wojewodztwo' => 'addresslevel2a',
			'Kraj' => 'addresslevel1a',
			'NumerBudynku' => 'buildingnumbera',
			'NumerTelefonu' => 'phone',
			'NumerFaksu' => 'fax',
			'AdresEmail' => 'email',
			'AdresStronyInternetowej' => 'website',
		],
		'Partners' => [
			'Nazwa' => 'subject',
			'Nip' => 'vat_id',
			'NumerBudynku' => 'buildingnumbera',
			'NumerLokalu' => 'localnumbera',
			'Ulica' => 'addresslevel8a',
			'KodPocztowy' => 'addresslevel7a',
			'Miejscowosc' => 'addresslevel5a',
			'Gmina' => 'addresslevel4a',
			'Powiat' => 'addresslevel3a',
			'Wojewodztwo' => 'addresslevel2a',
			'Kraj' => 'addresslevel1a',
		],
		'Vendors' => [
			'Nazwa' => 'vendorname',
			'Nip' => 'vat_id',
			'Regon' => 'registration_number_2',
			'NumerBudynku' => 'buildingnumbera',
			'NumerLokalu' => 'localnumbera',
			'Ulica' => 'addresslevel8a',
			'KodPocztowy' => 'addresslevel7a',
			'Miejscowosc' => 'addresslevel5a',
			'Gmina' => 'addresslevel4a',
			'Powiat' => 'addresslevel3a',
			'Wojewodztwo' => 'addresslevel2a',
			'Kraj' => 'addresslevel1a',
		],
		'Competition' => [
			'Nazwa' => 'subject',
			'Nip' => 'vat_id',
			'NumerBudynku' => 'buildingnumbera',
			'NumerLokalu' => 'localnumbera',
			'Ulica' => 'addresslevel8a',
			'KodPocztowy' => 'addresslevel7a',
			'Miejscowosc' => 'addresslevel5a',
			'Gmina' => 'addresslevel4a',
			'Powiat' => 'addresslevel3a',
			'Wojewodztwo' => 'addresslevel2a',
			'Kraj' => 'addresslevel1a',
		],
	];

	/** {@inheritdoc} */
	public function search(): array
	{
		if (!$this->isActive()) {
			return [];
		}
		$vatId = preg_replace('/[^0-9]/', '', $this->request->getByType('vatId', 'Text'));
		$taxNumber = str_replace([' ', ',', '.', '-'], '', $this->request->getByType('taxNumber', 'Text'));
		$ncr = str_replace([' ', ',', '.', '-'], '', $this->request->getByType('ncr', 'Text'));
		$response = [];
		$moduleName = $this->request->getModule();
		$client = \App\RecordCollectors\Helper\GusClient::getInstance($this->getClientParams($moduleName));
		try {
			$infoFromGus = $client->search($vatId, $ncr, $taxNumber);
			$response['recordModel'] = $this->getRecordModel();
			$fieldsModel = $response['recordModel']->getModule()->getFields();
			if ($infoFromGus && isset($this->formFieldsToRecordMap[$moduleName])) {
				$additional = $fieldsData = $skip = $dataCounter = [];
				foreach ($infoFromGus as $key => &$row) {
					$dataCounter[$key] = 0;
					if (empty($row)) {
						continue;
					}
					foreach ($this->formFieldsToRecordMap[$moduleName] as $apiKey => $fieldName) {
						if (empty($fieldsModel[$fieldName]) || !$fieldsModel[$fieldName]->isActiveField()) {
							if (isset($row[$apiKey]) && '' !== $row[$apiKey]) {
								$skip[$fieldName]['data'][$key] = $row[$apiKey];
								if (isset($fieldsModel[$fieldName]) && empty($skip[$fieldName]['label'])) {
									$skip[$fieldName]['label'] = \App\Language::translate($fieldsModel[$fieldName]->getFieldLabel(), $moduleName);
								} else {
									$skip[$fieldName]['label'] = $fieldName;
								}
							}
							unset($row[$apiKey]);
							continue;
						}
						$value = '';
						if (isset($row[$apiKey])) {
							$value = trim($row[$apiKey]);
							unset($row[$apiKey]);
						}
						$fieldModel = $fieldsModel[$fieldName];
						if ($value) {
							++$dataCounter[$key];
							if ('phone' === $fieldModel->getFieldDataType()) {
								$details = $fieldModel->getUITypeModel()->getPhoneDetails($value, 'PL');
								$details = $fieldModel->getUITypeModel()->/** @scrutinizer ignore-call */ getPhoneDetails($value, 'PL');
								$value = $details['number'];
								if ($fieldName !== $details['fieldName']) {
									$fieldName = $details['fieldName'];
									$fieldModel = $fieldsModel[$fieldName];
								}
							}
						}
						$fieldsData[$fieldName]['label'] = \App\Language::translate($fieldModel->getFieldLabel(), $moduleName);
						$fieldsData[$fieldName]['label'] = \App\Language::translate(/** @scrutinizer ignore-deprecated */ $fieldModel->getFieldLabel(), $moduleName);
						$fieldsData[$fieldName]['data'][$key] = [
							'raw' => $value,
							'edit' => $fieldModel->getEditViewDisplayValue($value),
							'display' => $fieldModel->getDisplayValue($value),
						];
					}
					foreach ($row as $name => $value) {
						if ('' !== $value) {
							$additional[$name][$key] = $value;
						}
					}
				}
				$response['fields'] = $fieldsData;
				$response['additional'] = $additional;
				$response['keys'] = array_keys($infoFromGus);
				$response['skip'] = $skip;
				$response['dataCounter'] = $dataCounter;
			}
		} catch (\SoapFault $e) {
			\App\Log::warning($e->faultstring, 'RecordCollectors');
			$response['error'] = $e->faultstring;
		}
		return $response;
	}

	/**
	 * Get params.
	 *
	 * @param string $moduleName
	 *
	 * @return string[]
	 */
	public function getClientParams(string $moduleName): array
	{
		$params = [];
		if (isset($this->formFieldsToRecordMap[$moduleName]['PKDPodstawowyKod']) || isset($this->formFieldsToRecordMap[$moduleName]['PKDPozostaleNazwy']) || isset($this->formFieldsToRecordMap[$moduleName]['PKDPozostaleKodyNazwy'])) {
			$params[] = 'pkd';
		}
		return $params;
	}
}

YetiForceCompany / YetiForceCRM

Push — developer ( b17be7...a57010 )

Gus::search() D

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like
