PossibleCsvHeaderExpander::replacePlaceholders() - Code Metrics - Inspection of "FRW-10614: Adjusted publish logic for merchant ent..." - spryker/spryker-core - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Push — master ( 36cd34...e25ade )

unknown

created 2025-09-10 10:30 UTC

PossibleCsvHeaderExpander::replacePlaceholders() A

↳ Parent: PossibleCsvHeaderExpander

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	2
eloc	4
c	1
b	0
f	0
nc	2
nop	2
dl	0
loc	8
rs	10

<?php

/**
 * MIT License
 * For full license information, please view the LICENSE file that was distributed with this source code.
 */

namespace Spryker\Zed\MerchantProductDataImport\Business\Expander;

use Generated\Shared\Transfer\MerchantCriteriaTransfer;
use Generated\Shared\Transfer\MerchantStockCriteriaTransfer;
use Generated\Shared\Transfer\MerchantTransfer;
use Generated\Shared\Transfer\StoreTransfer;
use Spryker\Zed\MerchantProductDataImport\Dependency\Facade\MerchantProductDataImportToCurrencyFacadeInterface;
use Spryker\Zed\MerchantProductDataImport\Dependency\Facade\MerchantProductDataImportToLocaleFacadeInterface;
use Spryker\Zed\MerchantProductDataImport\Dependency\Facade\MerchantProductDataImportToMerchantFacadeInterface;
use Spryker\Zed\MerchantProductDataImport\Dependency\Facade\MerchantProductDataImportToMerchantStockFacadeInterface;
use Spryker\Zed\MerchantProductDataImport\Dependency\Facade\MerchantProductDataImportToProductAttributeFacadeInterface;
use Spryker\Zed\MerchantProductDataImport\Dependency\Facade\MerchantProductDataImportToStoreFacadeInterface;
use Spryker\Zed\MerchantProductDataImport\MerchantProductDataImportConfig;

class PossibleCsvHeaderExpander implements PossibleCsvHeaderExpanderInterface
{
    /**
     * @param \Spryker\Zed\MerchantProductDataImport\MerchantProductDataImportConfig $merchantProductDataImportConfig
     * @param \Spryker\Zed\MerchantProductDataImport\Dependency\Facade\MerchantProductDataImportToLocaleFacadeInterface $localeFacade
     * @param \Spryker\Zed\MerchantProductDataImport\Dependency\Facade\MerchantProductDataImportToMerchantFacadeInterface $merchantFacade
     * @param \Spryker\Zed\MerchantProductDataImport\Dependency\Facade\MerchantProductDataImportToMerchantStockFacadeInterface $merchantStockFacade
     * @param \Spryker\Zed\MerchantProductDataImport\Dependency\Facade\MerchantProductDataImportToStoreFacadeInterface $storeFacade
     * @param \Spryker\Zed\MerchantProductDataImport\Dependency\Facade\MerchantProductDataImportToCurrencyFacadeInterface $currencyFacade
     * @param \Spryker\Zed\MerchantProductDataImport\Dependency\Facade\MerchantProductDataImportToProductAttributeFacadeInterface $productAttributeFacade
     */
    public function __construct(
        protected MerchantProductDataImportConfig $merchantProductDataImportConfig,
        protected MerchantProductDataImportToLocaleFacadeInterface $localeFacade,
        protected MerchantProductDataImportToMerchantFacadeInterface $merchantFacade,
        protected MerchantProductDataImportToMerchantStockFacadeInterface $merchantStockFacade,
        protected MerchantProductDataImportToStoreFacadeInterface $storeFacade,
        protected MerchantProductDataImportToCurrencyFacadeInterface $currencyFacade,
        protected MerchantProductDataImportToProductAttributeFacadeInterface $productAttributeFacade
    ) {
    }

    /**
     * @param array<string, list<string>> $possibleCsvHeaders

     * @param \Generated\Shared\Transfer\MerchantTransfer $merchantTransfer
     *
     * @return array<string, list<string>>

     */
    public function expand(array $possibleCsvHeaders, MerchantTransfer $merchantTransfer): array
    {
        if (!isset($possibleCsvHeaders[MerchantProductDataImportConfig::IMPORT_TYPE_MERCHANT_COMBINED_PRODUCT])) {
            return $possibleCsvHeaders;
        }

        $merchantCriteriaTransfer = (new MerchantCriteriaTransfer())
            ->setWithExpanders(false)
            ->setMerchantReference($merchantTransfer->getMerchantReferenceOrFail());

        $merchantTransfer = $this->merchantFacade->get($merchantCriteriaTransfer)->getMerchants()->getIterator()->current();
        if (!$merchantTransfer) {
            return $possibleCsvHeaders;
        }

        $headers = array_merge(
            $this->merchantProductDataImportConfig->getPossibleCsvHeaders(),
            $this->merchantProductDataImportConfig->getPossibleCsvLocaleHeaders(),
            $this->merchantProductDataImportConfig->getPossibleCsvAttributeHeaders(),
            $this->merchantProductDataImportConfig->getPossibleCsvStockHeaders(),
            $this->merchantProductDataImportConfig->getPossibleCsvPriceHeaders(),
            $this->merchantProductDataImportConfig->getPossibleCsvImageHeaders(),
        );

        $locales = array_values($this->localeFacade->getAvailableLocales());
        $stocks = $this->getMerchantStockNames($merchantTransfer);
        $stores = $this->getStoreNames();
        $currencies = $this->getCurrencyCodes(array_keys($stores));
        $attributes = $this->getAttributeKeys();

        $headers = $this->replacePlaceholders($headers, [
            '{locale}' => $locales,
            '{stock}' => $stocks,
            '{store}' => $stores,
            '{currency}' => $currencies,
            '{attribute}' => $attributes,
        ]);

        $possibleCsvHeaders[MerchantProductDataImportConfig::IMPORT_TYPE_MERCHANT_COMBINED_PRODUCT] = array_merge(
            $possibleCsvHeaders[MerchantProductDataImportConfig::IMPORT_TYPE_MERCHANT_COMBINED_PRODUCT],
            $headers,
        );

        return $possibleCsvHeaders;
    }

    /**
     * @param list<string> $headers
     * @param array<string, string|list<string>> $replacements

     *
     * @return list<string>
     */
    protected function replacePlaceholders(array $headers, array $replacements): array
    {
        $result = [];
        foreach ($headers as $header) {
            $result = array_merge($result, $this->expandHeaderPlaceholders($header, $replacements));
        }

        return $result;
    }

    /**
     * @param string $header
     * @param array<string, string|list<string>> $replacements

     *
     * @return list<string>
     */
    protected function expandHeaderPlaceholders(string $header, array $replacements): array
    {
        foreach ($replacements as $placeholder => $values) {
            if (strpos($header, $placeholder) !== false) {
                if (is_array($values)) {
                    $expanded = [];
                    foreach ($values as $value) {
                        $expanded = array_merge(
                            $expanded,
                            $this->expandHeaderPlaceholders(str_replace($placeholder, $value, $header), $replacements),
                        );
                    }

                    return $expanded;
                }
                $header = str_replace($placeholder, $values, $header);
            }
        }

        return [$header];
    }

    /**
     * @param \Generated\Shared\Transfer\MerchantTransfer $merchantTransfer
     *
     * @return list<string>
     */
    protected function getMerchantStockNames(MerchantTransfer $merchantTransfer): array
    {
        $stockNames = [];
        $stockTransfers = $this->merchantStockFacade->get(
            (new MerchantStockCriteriaTransfer())->setIdMerchant($merchantTransfer->getIdMerchantOrFail()),
        )->getStocks();

        foreach ($stockTransfers as $stockTransfer) {
            $stockNames[] = $stockTransfer->getNameOrFail();
        }

        return $stockNames;
    }

    /**
     * @return array<int, string>
     */
    protected function getStoreNames(): array
    {
        $storeNames = [];
        foreach ($this->storeFacade->getAllStores() as $stockTransfer) {
            $storeNames[$stockTransfer->getIdStoreOrFail()] = $stockTransfer->getNameOrFail();
        }

        return $storeNames;
    }

    /**
     * @param list<int> $storeIds
     *
     * @return list<string>
     */
    protected function getCurrencyCodes(array $storeIds): array
    {
        $currencyCodes = [];
        $storeTransfers = array_map(
            static fn (int $idStore): StoreTransfer => (new StoreTransfer())->setIdStore($idStore),
            $storeIds,
        );

        foreach ($this->currencyFacade->expandStoreTransfersWithCurrencies($storeTransfers) as $storeTransfer) {
            foreach ($storeTransfer->getAvailableCurrencyIsoCodes() as $code) {
                $currencyCodes[] = $code;
            }
        }

        return array_unique($currencyCodes);
    }

    /**
     * @return list<string>
     */
    protected function getAttributeKeys(): array
    {
        $attributeKeys = [];
        foreach ($this->productAttributeFacade->getProductAttributeCollection() as $productManagementAttributeTransfer) {
            $attributeKeys[] = $productManagementAttributeTransfer->getKeyOrFail();
        }

        return $attributeKeys;
    }
}


1			<?php
2
3			/**
4			* MIT License
5			* For full license information, please view the LICENSE file that was distributed with this source code.
6			*/
7
8			namespace Spryker\Zed\MerchantProductDataImport\Business\Expander;
9
10			use Generated\Shared\Transfer\MerchantCriteriaTransfer;
11			use Generated\Shared\Transfer\MerchantStockCriteriaTransfer;
12			use Generated\Shared\Transfer\MerchantTransfer;
13			use Generated\Shared\Transfer\StoreTransfer;
14			use Spryker\Zed\MerchantProductDataImport\Dependency\Facade\MerchantProductDataImportToCurrencyFacadeInterface;
15			use Spryker\Zed\MerchantProductDataImport\Dependency\Facade\MerchantProductDataImportToLocaleFacadeInterface;
16			use Spryker\Zed\MerchantProductDataImport\Dependency\Facade\MerchantProductDataImportToMerchantFacadeInterface;
17			use Spryker\Zed\MerchantProductDataImport\Dependency\Facade\MerchantProductDataImportToMerchantStockFacadeInterface;
18			use Spryker\Zed\MerchantProductDataImport\Dependency\Facade\MerchantProductDataImportToProductAttributeFacadeInterface;
19			use Spryker\Zed\MerchantProductDataImport\Dependency\Facade\MerchantProductDataImportToStoreFacadeInterface;
20			use Spryker\Zed\MerchantProductDataImport\MerchantProductDataImportConfig;
21
22			class PossibleCsvHeaderExpander implements PossibleCsvHeaderExpanderInterface
23			{
24			/**
25			* @param \Spryker\Zed\MerchantProductDataImport\MerchantProductDataImportConfig $merchantProductDataImportConfig
26			* @param \Spryker\Zed\MerchantProductDataImport\Dependency\Facade\MerchantProductDataImportToLocaleFacadeInterface $localeFacade
27			* @param \Spryker\Zed\MerchantProductDataImport\Dependency\Facade\MerchantProductDataImportToMerchantFacadeInterface $merchantFacade
28			* @param \Spryker\Zed\MerchantProductDataImport\Dependency\Facade\MerchantProductDataImportToMerchantStockFacadeInterface $merchantStockFacade
29			* @param \Spryker\Zed\MerchantProductDataImport\Dependency\Facade\MerchantProductDataImportToStoreFacadeInterface $storeFacade
30			* @param \Spryker\Zed\MerchantProductDataImport\Dependency\Facade\MerchantProductDataImportToCurrencyFacadeInterface $currencyFacade
31			* @param \Spryker\Zed\MerchantProductDataImport\Dependency\Facade\MerchantProductDataImportToProductAttributeFacadeInterface $productAttributeFacade
32			*/
33			public function __construct(
34			protected MerchantProductDataImportConfig $merchantProductDataImportConfig,
35			protected MerchantProductDataImportToLocaleFacadeInterface $localeFacade,
36			protected MerchantProductDataImportToMerchantFacadeInterface $merchantFacade,
37			protected MerchantProductDataImportToMerchantStockFacadeInterface $merchantStockFacade,
38			protected MerchantProductDataImportToStoreFacadeInterface $storeFacade,
39			protected MerchantProductDataImportToCurrencyFacadeInterface $currencyFacade,
40			protected MerchantProductDataImportToProductAttributeFacadeInterface $productAttributeFacade
41			) {
42			}
43
44			/**
45			* @param array<string, list<string>> $possibleCsvHeaders
			0 ignored issues – show Documentation Bug introduced 2025-09-10 11:15 UTC by Report Bug Copy Issue Report The doc comment `array<string, list<string>>` at position `4` could not be parsed: Expected '>' at position 4, but found 'list'. Loading history...
46			* @param \Generated\Shared\Transfer\MerchantTransfer $merchantTransfer
47			*
48			* @return array<string, list<string>>
			0 ignored issues – show Documentation Bug introduced 2025-09-10 11:15 UTC by Report Bug Copy Issue Report The doc comment `array<string, list<string>>` at position `4` could not be parsed: Expected '>' at position 4, but found 'list'. Loading history...
49			*/
50			public function expand(array $possibleCsvHeaders, MerchantTransfer $merchantTransfer): array
51			{
52			if (!isset($possibleCsvHeaders[MerchantProductDataImportConfig::IMPORT_TYPE_MERCHANT_COMBINED_PRODUCT])) {
53			return $possibleCsvHeaders;
54			}
55
56			$merchantCriteriaTransfer = (new MerchantCriteriaTransfer())
57			->setWithExpanders(false)
58			->setMerchantReference($merchantTransfer->getMerchantReferenceOrFail());
59
60			$merchantTransfer = $this->merchantFacade->get($merchantCriteriaTransfer)->getMerchants()->getIterator()->current();
61			if (!$merchantTransfer) {
62			return $possibleCsvHeaders;
63			}
64
65			$headers = array_merge(
66			$this->merchantProductDataImportConfig->getPossibleCsvHeaders(),
67			$this->merchantProductDataImportConfig->getPossibleCsvLocaleHeaders(),
68			$this->merchantProductDataImportConfig->getPossibleCsvAttributeHeaders(),
69			$this->merchantProductDataImportConfig->getPossibleCsvStockHeaders(),
70			$this->merchantProductDataImportConfig->getPossibleCsvPriceHeaders(),
71			$this->merchantProductDataImportConfig->getPossibleCsvImageHeaders(),
72			);
73
74			$locales = array_values($this->localeFacade->getAvailableLocales());
75			$stocks = $this->getMerchantStockNames($merchantTransfer);
76			$stores = $this->getStoreNames();
77			$currencies = $this->getCurrencyCodes(array_keys($stores));
78			$attributes = $this->getAttributeKeys();
79
80			$headers = $this->replacePlaceholders($headers, [
81			'{locale}' => $locales,
82			'{stock}' => $stocks,
83			'{store}' => $stores,
84			'{currency}' => $currencies,
85			'{attribute}' => $attributes,
86			]);
87
88			$possibleCsvHeaders[MerchantProductDataImportConfig::IMPORT_TYPE_MERCHANT_COMBINED_PRODUCT] = array_merge(
89			$possibleCsvHeaders[MerchantProductDataImportConfig::IMPORT_TYPE_MERCHANT_COMBINED_PRODUCT],
90			$headers,
91			);
92
93			return $possibleCsvHeaders;
94			}
95
96			/**
97			* @param list<string> $headers
98			* @param array<string, string\|list<string>> $replacements
			0 ignored issues – show Documentation Bug introduced 2025-09-10 11:15 UTC by Report Bug Copy Issue Report The doc comment `array<string, string\|list<string>>` at position `6` could not be parsed: Expected '>' at position 6, but found 'list'. Loading history...
99			*
100			* @return list<string>
101			*/
102			protected function replacePlaceholders(array $headers, array $replacements): array
103			{
104			$result = [];
105			foreach ($headers as $header) {
106			$result = array_merge($result, $this->expandHeaderPlaceholders($header, $replacements));
107			}
108
109			return $result;
110			}
111
112			/**
113			* @param string $header
114			* @param array<string, string\|list<string>> $replacements
			0 ignored issues – show Documentation Bug introduced 2025-09-10 11:15 UTC by Report Bug Copy Issue Report The doc comment `array<string, string\|list<string>>` at position `6` could not be parsed: Expected '>' at position 6, but found 'list'. Loading history...
115			*
116			* @return list<string>
117			*/
118			protected function expandHeaderPlaceholders(string $header, array $replacements): array
119			{
120			foreach ($replacements as $placeholder => $values) {
121			if (strpos($header, $placeholder) !== false) {
122			if (is_array($values)) {
123			$expanded = [];
124			foreach ($values as $value) {
125			$expanded = array_merge(
126			$expanded,
127			$this->expandHeaderPlaceholders(str_replace($placeholder, $value, $header), $replacements),
128			);
129			}
130
131			return $expanded;
132			}
133			$header = str_replace($placeholder, $values, $header);
134			}
135			}
136
137			return [$header];
138			}
139
140			/**
141			* @param \Generated\Shared\Transfer\MerchantTransfer $merchantTransfer
142			*
143			* @return list<string>
144			*/
145			protected function getMerchantStockNames(MerchantTransfer $merchantTransfer): array
146			{
147			$stockNames = [];
148			$stockTransfers = $this->merchantStockFacade->get(
149			(new MerchantStockCriteriaTransfer())->setIdMerchant($merchantTransfer->getIdMerchantOrFail()),
150			)->getStocks();
151
152			foreach ($stockTransfers as $stockTransfer) {
153			$stockNames[] = $stockTransfer->getNameOrFail();
154			}
155
156			return $stockNames;
157			}
158
159			/**
160			* @return array<int, string>
161			*/
162			protected function getStoreNames(): array
163			{
164			$storeNames = [];
165			foreach ($this->storeFacade->getAllStores() as $stockTransfer) {
166			$storeNames[$stockTransfer->getIdStoreOrFail()] = $stockTransfer->getNameOrFail();
167			}
168
169			return $storeNames;
170			}
171
172			/**
173			* @param list<int> $storeIds
174			*
175			* @return list<string>
176			*/
177			protected function getCurrencyCodes(array $storeIds): array
178			{
179			$currencyCodes = [];
180			$storeTransfers = array_map(
181			static fn (int $idStore): StoreTransfer => (new StoreTransfer())->setIdStore($idStore),
182			$storeIds,
183			);
184
185			foreach ($this->currencyFacade->expandStoreTransfersWithCurrencies($storeTransfers) as $storeTransfer) {
186			foreach ($storeTransfer->getAvailableCurrencyIsoCodes() as $code) {
187			$currencyCodes[] = $code;
188			}
189			}
190
191			return array_unique($currencyCodes);
192			}
193
194			/**
195			* @return list<string>
196			*/
197			protected function getAttributeKeys(): array
198			{
199			$attributeKeys = [];
200			foreach ($this->productAttributeFacade->getProductAttributeCollection() as $productManagementAttributeTransfer) {
201			$attributeKeys[] = $productManagementAttributeTransfer->getKeyOrFail();
202			}
203
204			return $attributeKeys;
205			}
206			}
207

spryker / spryker-core

Push — master ( 36cd34...e25ade )

PossibleCsvHeaderExpander::replacePlaceholders() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like