spryker / spryker-core

Bundles/ShipmentTypeStorage/src/Spryker/Client/ShipmentTypeStorage/Reader/ShipmentTypeStorageReader.php

<?php

/**
 * Copyright © 2016-present Spryker Systems GmbH. All rights reserved.
 * Use of this software requires acceptance of the Evaluation License Agreement. See LICENSE file.
 */

namespace Spryker\Client\ShipmentTypeStorage\Reader;

use Generated\Shared\Transfer\ShipmentTypeStorageCollectionTransfer;
use Generated\Shared\Transfer\ShipmentTypeStorageConditionsTransfer;
use Generated\Shared\Transfer\ShipmentTypeStorageCriteriaTransfer;
use Generated\Shared\Transfer\ShipmentTypeStorageTransfer;
use Spryker\Client\ShipmentTypeStorage\Dependency\Client\ShipmentTypeStorageToStorageClientInterface;
use Spryker\Client\ShipmentTypeStorage\Dependency\Service\ShipmentTypeStorageToUtilEncodingServiceInterface;
use Spryker\Client\ShipmentTypeStorage\Generator\ShipmentTypeStorageKeyGeneratorInterface;
use Spryker\Client\ShipmentTypeStorage\Scanner\ShipmentTypeStorageKeyScannerInterface;

class ShipmentTypeStorageReader implements ShipmentTypeStorageReaderInterface
{
    /**
     * @var string
     */
    protected const KEY_ID = 'id';

    /**
     * @var \Spryker\Client\ShipmentTypeStorage\Generator\ShipmentTypeStorageKeyGeneratorInterface
     */
    protected ShipmentTypeStorageKeyGeneratorInterface $shipmentTypeStorageKeyGenerator;

    /**
     * @var \Spryker\Client\ShipmentTypeStorage\Dependency\Client\ShipmentTypeStorageToStorageClientInterface
     */
    protected ShipmentTypeStorageToStorageClientInterface $storageClient;

    /**
     * @var \Spryker\Client\ShipmentTypeStorage\Dependency\Service\ShipmentTypeStorageToUtilEncodingServiceInterface
     */
    protected ShipmentTypeStorageToUtilEncodingServiceInterface $utilEncodingService;

    /**
     * @var \Spryker\Client\ShipmentTypeStorage\Scanner\ShipmentTypeStorageKeyScannerInterface
     */
    protected ShipmentTypeStorageKeyScannerInterface $shipmentTypeStorageKeyScanner;

    /**
     * @var list<\Spryker\Client\ShipmentTypeStorageExtension\Dependency\Plugin\ShipmentTypeStorageExpanderPluginInterface>
     */
    protected array $shipmentTypeStorageExpanderPlugins;

    /**
     * @param \Spryker\Client\ShipmentTypeStorage\Generator\ShipmentTypeStorageKeyGeneratorInterface $shipmentTypeStorageKeyGenerator
     * @param \Spryker\Client\ShipmentTypeStorage\Dependency\Client\ShipmentTypeStorageToStorageClientInterface $storageClient
     * @param \Spryker\Client\ShipmentTypeStorage\Dependency\Service\ShipmentTypeStorageToUtilEncodingServiceInterface $utilEncodingService
     * @param \Spryker\Client\ShipmentTypeStorage\Scanner\ShipmentTypeStorageKeyScannerInterface $shipmentTypeStorageKeyScanner
     * @param list<\Spryker\Client\ShipmentTypeStorageExtension\Dependency\Plugin\ShipmentTypeStorageExpanderPluginInterface> $shipmentTypeStorageExpanderPlugins
     */
    public function __construct(
        ShipmentTypeStorageKeyGeneratorInterface $shipmentTypeStorageKeyGenerator,
        ShipmentTypeStorageToStorageClientInterface $storageClient,
        ShipmentTypeStorageToUtilEncodingServiceInterface $utilEncodingService,
        ShipmentTypeStorageKeyScannerInterface $shipmentTypeStorageKeyScanner,
        array $shipmentTypeStorageExpanderPlugins
    ) {
        $this->shipmentTypeStorageKeyGenerator = $shipmentTypeStorageKeyGenerator;
        $this->storageClient = $storageClient;
        $this->utilEncodingService = $utilEncodingService;
        $this->shipmentTypeStorageKeyScanner = $shipmentTypeStorageKeyScanner;
        $this->shipmentTypeStorageExpanderPlugins = $shipmentTypeStorageExpanderPlugins;
    }

    /**
     * @param \Generated\Shared\Transfer\ShipmentTypeStorageCriteriaTransfer $shipmentTypeStorageCriteriaTransfer
     *
     * @return \Generated\Shared\Transfer\ShipmentTypeStorageCollectionTransfer
     */
    public function getShipmentTypeStorageCollection(
        ShipmentTypeStorageCriteriaTransfer $shipmentTypeStorageCriteriaTransfer
    ): ShipmentTypeStorageCollectionTransfer {
        $shipmentTypeStorageCollectionTransfer = $this->getShipmentTypeStorageCollectionByCriteria($shipmentTypeStorageCriteriaTransfer);
        if ($shipmentTypeStorageCollectionTransfer->getShipmentTypeStorages()->count() === 0) {
            return $shipmentTypeStorageCollectionTransfer;
        }

        return $this->executeShipmentTypeStorageExpanderPlugins($shipmentTypeStorageCollectionTransfer);
    }

    /**
     * @param \Generated\Shared\Transfer\ShipmentTypeStorageCriteriaTransfer $shipmentTypeStorageCriteriaTransfer
     *
     * @return \Generated\Shared\Transfer\ShipmentTypeStorageCollectionTransfer
     */
    protected function getShipmentTypeStorageCollectionByCriteria(
        ShipmentTypeStorageCriteriaTransfer $shipmentTypeStorageCriteriaTransfer
    ): ShipmentTypeStorageCollectionTransfer {
        $shipmentTypeStorageConditionsTransfer = $shipmentTypeStorageCriteriaTransfer->getShipmentTypeStorageConditionsOrFail();
        if (
            !$shipmentTypeStorageConditionsTransfer->getShipmentTypeIds()
            && !$shipmentTypeStorageConditionsTransfer->getUuids()
        ) {
            return $this->getShipmentTypeStorageByStore($shipmentTypeStorageConditionsTransfer->getStoreNameOrFail());
        }

        if ($shipmentTypeStorageConditionsTransfer->getUuids() !== []) {
            return $this->getShipmentTypeStorageByUuids($shipmentTypeStorageConditionsTransfer);
        }

        if ($shipmentTypeStorageConditionsTransfer->getShipmentTypeIds() !== []) {
            return $this->getShipmentTypeStorageByShipmentTypeIds($shipmentTypeStorageConditionsTransfer);
        }

        return new ShipmentTypeStorageCollectionTransfer();
    }

    /**
     * @param string $storeName
     *
     * @return \Generated\Shared\Transfer\ShipmentTypeStorageCollectionTransfer
     */
    protected function getShipmentTypeStorageByStore(string $storeName): ShipmentTypeStorageCollectionTransfer
    {
        $shipmentTypeStorageConditionsTransfer = (new ShipmentTypeStorageConditionsTransfer())
            ->setUuids($this->shipmentTypeStorageKeyScanner->scanShipmentTypeUuids())
            ->setStoreName($storeName);

        return $this->getShipmentTypeStorageByUuids($shipmentTypeStorageConditionsTransfer);
    }

    /**
     * @param \Generated\Shared\Transfer\ShipmentTypeStorageConditionsTransfer $shipmentTypeStorageConditionsTransfer
     *
     * @return \Generated\Shared\Transfer\ShipmentTypeStorageCollectionTransfer
     */
    protected function getShipmentTypeStorageByUuids(
        ShipmentTypeStorageConditionsTransfer $shipmentTypeStorageConditionsTransfer
    ): ShipmentTypeStorageCollectionTransfer {
        $shipmentTypeStorageCollectionTransfer = new ShipmentTypeStorageCollectionTransfer();

        $storageMappingKeys = $this->shipmentTypeStorageKeyGenerator->generateShipmentTypeStorageUuidMappingKeys(
            $shipmentTypeStorageConditionsTransfer->getUuids(),
            $shipmentTypeStorageConditionsTransfer->getStoreNameOrFail(),
        );
        if ($storageMappingKeys === []) {
            return $shipmentTypeStorageCollectionTransfer;
        }

        $storageMappingData = array_filter($this->storageClient->getMulti($storageMappingKeys));
        if ($storageMappingData === []) {
            return $shipmentTypeStorageCollectionTransfer;
        }

        $shipmentTypeStorageConditionsTransfer->setShipmentTypeIds(
            $this->extractShipmentTypeIdsFromStorageMappingData($storageMappingData),
        );

        return $this->getShipmentTypeStorageByShipmentTypeIds($shipmentTypeStorageConditionsTransfer);
    }

    /**
     * @param \Generated\Shared\Transfer\ShipmentTypeStorageConditionsTransfer $shipmentTypeStorageConditionsTransfer
     *
     * @return \Generated\Shared\Transfer\ShipmentTypeStorageCollectionTransfer
     */
    protected function getShipmentTypeStorageByShipmentTypeIds(
        ShipmentTypeStorageConditionsTransfer $shipmentTypeStorageConditionsTransfer
    ): ShipmentTypeStorageCollectionTransfer {
        $shipmentTypeStorageCollectionTransfer = new ShipmentTypeStorageCollectionTransfer();

        $storageKeys = $this->shipmentTypeStorageKeyGenerator->generateShipmentTypeStorageKeys(
            $shipmentTypeStorageConditionsTransfer->getShipmentTypeIds(),
            $shipmentTypeStorageConditionsTransfer->getStoreNameOrFail(),
        );
        if ($storageKeys === []) {
            return $shipmentTypeStorageCollectionTransfer;
        }

        $shipmentTypeStorageData = array_filter($this->storageClient->getMulti($storageKeys));
        if ($shipmentTypeStorageData === []) {
            return $shipmentTypeStorageCollectionTransfer;
        }

        /** @var array<string, mixed>|string $shipmentTypeStorageDataItem */
        foreach ($shipmentTypeStorageData as $shipmentTypeStorageDataItem) {
            if (!is_array($shipmentTypeStorageDataItem)) {
                $shipmentTypeStorageDataItem = $this->utilEncodingService->decodeJson($shipmentTypeStorageDataItem, true);
            }
            if (!$shipmentTypeStorageDataItem) {
                continue;
            }

            $shipmentTypeStorageCollectionTransfer->addShipmentTypeStorage(
                (new ShipmentTypeStorageTransfer())->fromArray($shipmentTypeStorageDataItem, true),
            );
        }

        return $shipmentTypeStorageCollectionTransfer;
    }

    /**
     * @param array<string, array<string, string>|string> $storageMappingData
     *
     * @return list<int>
     */
    protected function extractShipmentTypeIdsFromStorageMappingData(array $storageMappingData): array
    {
        $shipmentTypeIds = [];
        foreach ($storageMappingData as $storageMappingDataItem) {
            if (!is_array($storageMappingDataItem)) {
                $storageMappingDataItem = $this->utilEncodingService->decodeJson($storageMappingDataItem, true);
            }

            if ($storageMappingDataItem === [] || !isset($storageMappingDataItem[static::KEY_ID])) {
                continue;
            }

            $shipmentTypeIds[] = (int)$storageMappingDataItem[static::KEY_ID];
        }

        return $shipmentTypeIds;

The expression return $shipmentTypeIds returns the type array|integer[] which is incompatible with the documented return type Spryker\Client\ShipmentTypeStorage\Reader\list.

    }

    /**
     * @param \Generated\Shared\Transfer\ShipmentTypeStorageCollectionTransfer $shipmentTypeStorageCollectionTransfer
     *
     * @return \Generated\Shared\Transfer\ShipmentTypeStorageCollectionTransfer
     */
    protected function executeShipmentTypeStorageExpanderPlugins(
        ShipmentTypeStorageCollectionTransfer $shipmentTypeStorageCollectionTransfer
    ): ShipmentTypeStorageCollectionTransfer {
        foreach ($this->shipmentTypeStorageExpanderPlugins as $shipmentTypeStorageExpanderPlugin) {
            $shipmentTypeStorageCollectionTransfer = $shipmentTypeStorageExpanderPlugin->expand($shipmentTypeStorageCollectionTransfer);
        }

        return $shipmentTypeStorageCollectionTransfer;
    }
}