spryker / spryker-core

Bundles/ProductImageSetsRestApi/src/Spryker/Glue/ProductImageSetsRestApi/Processor/Reader/ConcreteProductImageSetsReader.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\Glue\ProductImageSetsRestApi\Processor\Reader;

use Generated\Shared\Transfer\ProductConcreteStorageTransfer;
use Generated\Shared\Transfer\RestErrorMessageTransfer;
use Spryker\Glue\GlueApplication\Rest\JsonApi\RestLinkInterface;
use Spryker\Glue\GlueApplication\Rest\JsonApi\RestResourceBuilderInterface;
use Spryker\Glue\GlueApplication\Rest\JsonApi\RestResourceInterface;
use Spryker\Glue\GlueApplication\Rest\JsonApi\RestResponseInterface;
use Spryker\Glue\GlueApplication\Rest\Request\Data\RestRequestInterface;
use Spryker\Glue\ProductImageSetsRestApi\Dependency\Client\ProductImageSetsRestApiToProductImageStorageClientInterface;
use Spryker\Glue\ProductImageSetsRestApi\Dependency\Client\ProductImageSetsRestApiToProductStorageClientInterface;
use Spryker\Glue\ProductImageSetsRestApi\Processor\Mapper\ConcreteProductImageSetsMapperInterface;
use Spryker\Glue\ProductImageSetsRestApi\ProductImageSetsRestApiConfig;
use Spryker\Glue\ProductsRestApi\ProductsRestApiConfig;
use Symfony\Component\HttpFoundation\Response;

class ConcreteProductImageSetsReader implements ConcreteProductImageSetsReaderInterface
{
    /**
     * @var string
     */
    protected const PRODUCT_CONCRETE_MAPPING_TYPE = 'sku';

    /**
     * @var string
     */
    protected const SELF_LINK_FORMAT = '%s/%s/%s';

    /**
     * @var \Spryker\Glue\ProductImageSetsRestApi\Dependency\Client\ProductImageSetsRestApiToProductStorageClientInterface
     */
    protected $productStorageClient;

    /**
     * @var \Spryker\Glue\ProductImageSetsRestApi\Dependency\Client\ProductImageSetsRestApiToProductImageStorageClientInterface
     */
    protected $productImageStorageClient;

    /**
     * @var \Spryker\Glue\GlueApplication\Rest\JsonApi\RestResourceBuilderInterface
     */
    protected $restResourceBuilder;

    /**
     * @var \Spryker\Glue\ProductImageSetsRestApi\Processor\Mapper\ConcreteProductImageSetsMapperInterface
     */
    protected $concreteProductImageSetsMapper;

    /**
     * @param \Spryker\Glue\ProductImageSetsRestApi\Dependency\Client\ProductImageSetsRestApiToProductStorageClientInterface $productStorageClient
     * @param \Spryker\Glue\ProductImageSetsRestApi\Dependency\Client\ProductImageSetsRestApiToProductImageStorageClientInterface $productImageStorageClient
     * @param \Spryker\Glue\GlueApplication\Rest\JsonApi\RestResourceBuilderInterface $restResponseBuilder
     * @param \Spryker\Glue\ProductImageSetsRestApi\Processor\Mapper\ConcreteProductImageSetsMapperInterface $concreteProductImageSetsMapper
     */
    public function __construct(
        ProductImageSetsRestApiToProductStorageClientInterface $productStorageClient,
        ProductImageSetsRestApiToProductImageStorageClientInterface $productImageStorageClient,
        RestResourceBuilderInterface $restResponseBuilder,
        ConcreteProductImageSetsMapperInterface $concreteProductImageSetsMapper
    ) {
        $this->productStorageClient = $productStorageClient;
        $this->productImageStorageClient = $productImageStorageClient;
        $this->restResourceBuilder = $restResponseBuilder;
        $this->concreteProductImageSetsMapper = $concreteProductImageSetsMapper;
    }

    /**
     * @param \Spryker\Glue\GlueApplication\Rest\Request\Data\RestRequestInterface $restRequest
     *
     * @return \Spryker\Glue\GlueApplication\Rest\JsonApi\RestResponseInterface
     */
    public function getConcreteProductImageSets(RestRequestInterface $restRequest): RestResponseInterface
    {
        $restResponse = $this->restResourceBuilder->createRestResponse();

        $parentResource = $restRequest->findParentResourceByType(ProductsRestApiConfig::RESOURCE_CONCRETE_PRODUCTS);
        if (!$parentResource) {
            return $restResponse->addError(
                $this->createConcreteProductNotFoundError(),
            );
        }

        $concreteSku = $parentResource->getId();
        $restResource = $this->findConcreteProductImageSetsBySku($concreteSku, $restRequest);

It seems like $concreteSku can also be of type null; however, parameter $sku of Spryker\Glue\ProductImageSetsRestApi\Processor\Reader\ConcreteProductImageSetsReader::findConcreteProductImageSetsBySku() does only seem to accept string, maybe add an additional type check?

        if ($restResource === null) {
            return $restResponse->addError(
                $this->createConcreteProductImageSetsNotFoundError(),
            );
        }

        return $restResponse->addResource($restResource);
    }

    /**
     * @param string $sku
     * @param \Spryker\Glue\GlueApplication\Rest\Request\Data\RestRequestInterface $restRequest
     *
     * @return \Spryker\Glue\GlueApplication\Rest\JsonApi\RestResourceInterface|null
     */
    public function findConcreteProductImageSetsBySku(string $sku, RestRequestInterface $restRequest): ?RestResourceInterface
    {
        $concreteProductStorageData = $this->productStorageClient
            ->findProductConcreteStorageDataByMapping(
                static::PRODUCT_CONCRETE_MAPPING_TYPE,
                $sku,
                $restRequest->getMetadata()->getLocale(),
            );

        if (!$concreteProductStorageData) {
            return null;
        }

        $concreteProductStorageTransfer = (new ProductConcreteStorageTransfer())->fromArray(
            $concreteProductStorageData,
            true,
        );

        $productImageConcreteStorageTransfers = $this->productImageStorageClient
            ->resolveProductImageSetStorageTransfers(
                $concreteProductStorageTransfer->getIdProductConcrete(),
                $concreteProductStorageTransfer->getIdProductAbstract(),
                $restRequest->getMetadata()->getLocale(),
            );

        if (!$productImageConcreteStorageTransfers) {
            $productImageConcreteStorageTransfers = [];
        }

        return $this->buildProductImageSetsResource($sku, $productImageConcreteStorageTransfers);
    }

    /**
     * @param string $sku
     * @param array<\Generated\Shared\Transfer\ProductImageSetStorageTransfer> $productImageConcreteStorageTransfers
     *
     * @return \Spryker\Glue\GlueApplication\Rest\JsonApi\RestResourceInterface
     */
    protected function buildProductImageSetsResource(string $sku, array $productImageConcreteStorageTransfers): RestResourceInterface
    {
        $restProductImageSetsAttributesTransfer = $this->concreteProductImageSetsMapper
            ->mapProductImageSetStorageTransfersToRestProductImageSetsAttributesTransfer($productImageConcreteStorageTransfers);

        $restResource = $this->restResourceBuilder->createRestResource(
            ProductImageSetsRestApiConfig::RESOURCE_CONCRETE_PRODUCT_IMAGE_SETS,
            $sku,
            $restProductImageSetsAttributesTransfer,
        );

        $restResourceSelfLink = sprintf(
            static::SELF_LINK_FORMAT,
            ProductsRestApiConfig::RESOURCE_CONCRETE_PRODUCTS,
            $sku,
            ProductImageSetsRestApiConfig::RESOURCE_CONCRETE_PRODUCT_IMAGE_SETS,
        );
        $restResource->addLink(RestLinkInterface::LINK_SELF, $restResourceSelfLink);

        return $restResource;
    }

    /**
     * @return \Generated\Shared\Transfer\RestErrorMessageTransfer
     */
    protected function createConcreteProductNotFoundError(): RestErrorMessageTransfer
    {
        return (new RestErrorMessageTransfer())
            ->setCode(ProductsRestApiConfig::RESPONSE_CODE_CANT_FIND_CONCRETE_PRODUCT)
            ->setStatus(Response::HTTP_NOT_FOUND)
            ->setDetail(ProductsRestApiConfig::RESPONSE_DETAIL_CANT_FIND_CONCRETE_PRODUCT);
    }

    /**
     * @return \Generated\Shared\Transfer\RestErrorMessageTransfer
     */
    protected function createConcreteProductImageSetsNotFoundError(): RestErrorMessageTransfer
    {
        $restErrorTransfer = (new RestErrorMessageTransfer())
            ->setCode(ProductImageSetsRestApiConfig::RESPONSE_CODE_CONCRETE_PRODUCT_IMAGE_SETS_NOT_FOUND)
            ->setStatus(Response::HTTP_NOT_FOUND)
            ->setDetail(ProductImageSetsRestApiConfig::RESPONSE_DETAIL_CONCRETE_PRODUCT_IMAGE_SETS_NOT_FOUND);

        return $restErrorTransfer;
    }
}