BitBagCommerce / SyliusElasticsearchPlugin

src/QueryBuilder/HasPriceBetweenQueryBuilder.php

<?php

/*
 * This file was created by developers working at BitBag
 * Do you need more information about us and what we do? Visit our https://bitbag.io website!
 * We are hiring developers from all over the world. Join us and start your new, exciting adventure and become part of us: https://bitbag.io/career
*/

declare(strict_types=1);

namespace BitBag\SyliusElasticsearchPlugin\QueryBuilder;

use BitBag\SyliusElasticsearchPlugin\PropertyNameResolver\ConcatedNameResolverInterface;
use BitBag\SyliusElasticsearchPlugin\PropertyNameResolver\PriceNameResolverInterface;
use Elastica\Query\AbstractQuery;
use Elastica\Query\Range;
use Sylius\Bundle\MoneyBundle\Form\DataTransformer\SyliusMoneyTransformer;
use Sylius\Component\Channel\Context\ChannelContextInterface;
use Sylius\Component\Core\Model\ChannelInterface;
use Sylius\Component\Currency\Context\CurrencyContextInterface;
use Sylius\Component\Currency\Converter\CurrencyConverterInterface;

final class HasPriceBetweenQueryBuilder implements QueryBuilderInterface
{
    /** @var ConcatedNameResolverInterface */
    private $channelPricingNameResolver;

    /** @var PriceNameResolverInterface */
    private $priceNameResolver;

    /** @var ChannelContextInterface */
    private $channelContext;

    /** @var CurrencyContextInterface */
    private $currencyContext;

    /** @var CurrencyConverterInterface */
    private $currencyConverter;

    public function __construct(
        PriceNameResolverInterface $priceNameResolver,
        ConcatedNameResolverInterface $channelPricingNameResolver,
        ChannelContextInterface $channelContext,
        CurrencyContextInterface $currencyContext,
        CurrencyConverterInterface $currencyConverter
    ) {
        $this->channelPricingNameResolver = $channelPricingNameResolver;
        $this->priceNameResolver = $priceNameResolver;
        $this->channelContext = $channelContext;
        $this->currencyContext = $currencyContext;
        $this->currencyConverter = $currencyConverter;
    }

    public function buildQuery(array $data): ?AbstractQuery
    {
        $dataMinPrice = $this->getDataByKey($data, $this->priceNameResolver->resolveMinPriceName());
        $dataMaxPrice = $this->getDataByKey($data, $this->priceNameResolver->resolveMaxPriceName());

        $minPrice = $dataMinPrice ? $this->resolveBasePrice($dataMinPrice) : null;
        $maxPrice = $dataMaxPrice ? $this->resolveBasePrice($dataMaxPrice) : null;

        $channelCode = $this->channelContext->getChannel()->getCode();
        $propertyName = $this->channelPricingNameResolver->resolvePropertyName($channelCode);

It seems like $channelCode can also be of type null; however, parameter $suffix of BitBag\SyliusElasticsearchPlugin\PropertyNameResolver\ConcatedNameResolverInterface::resolvePropertyName() does only seem to accept string, maybe add an additional type check?

        $rangeQuery = new Range();

        $paramValue = $this->getQueryParamValue($minPrice, $maxPrice);

        if (null === $paramValue) {
            return null;
        }

        $rangeQuery->setParam($propertyName, $paramValue);

        return $rangeQuery;
    }

    private function resolveBasePrice(string $price): int
    {
        $price = $this->convertFromString($price);
        /** @var ChannelInterface $channel */
        $channel = $this->channelContext->getChannel();
        $currentCurrencyCode = $this->currencyContext->getCurrencyCode();
        $channelBaseCurrencyCode = $channel->getBaseCurrency()->getCode();

        if ($currentCurrencyCode !== $channelBaseCurrencyCode) {
            $price = $this->currencyConverter->convert($price, $currentCurrencyCode, $channelBaseCurrencyCode);

It seems like $channelBaseCurrencyCode can also be of type null; however, parameter $targetCurrencyCode of Sylius\Component\Currency\Converter\CurrencyConverterInterface::convert() does only seem to accept string, maybe add an additional type check?

        }

        return $price;
    }

    private function convertFromString(string $price): int
    {
        $transformer = new SyliusMoneyTransformer(2, false, SyliusMoneyTransformer::ROUND_HALF_UP, 100);

The constant Symfony\Component\Form\Extension\Core\DataTransformer\NumberToLocalizedStringTransformer::ROUND_HALF_UP has been deprecated: since Symfony 5.1, use \NumberFormatter::ROUND_HALFUP instead.

        return $transformer->reverseTransform($price);

The expression return $transformer->reverseTransform($price) returns the type null which is incompatible with the type-hinted return integer.

Are you sure the usage of $transformer->reverseTransform($price) targeting Sylius\Bundle\MoneyBundle\Form\DataTransformer\SyliusMoneyTransformer::reverseTransform() seems to always return null.

    }

    private function getDataByKey(array $data, ?string $key = null): ?string
    {
        return $data[$key] ?? null;
    }

    private function getQueryParamValue(?int $min, ?int $max): ?array
    {
        foreach (['gte' => $min, 'lte' => $max] as $key => $value) {
            if (null !== $value) {
                $paramValue[$key] = $value;
            }
        }

        return $paramValue ?? null;
    }
}