OP-352 - Fix PHPDoc annotations to resolve build issues

Szymon Kostrubiec · Szymon Kostrubiec · commit 31b076087950 · 2024-07-10T07:11:17.000+02:00
diff --git a/src/QueryBuilder/FormQueryBuilder/SiteWideFacetsQueryBuilder.php b/src/QueryBuilder/FormQueryBuilder/SiteWideFacetsQueryBuilder.php
@@ -12,11 +12,9 @@
 namespace BitBag\SyliusElasticsearchPlugin\QueryBuilder\FormQueryBuilder;
 
 use BitBag\SyliusElasticsearchPlugin\Facet\RegistryInterface;
-use BitBag\SyliusElasticsearchPlugin\Model\Search;
 use BitBag\SyliusElasticsearchPlugin\QueryBuilder\QueryBuilderInterface;
 use Elastica\Query;
 use Symfony\Component\Form\FormEvent;
-use Webmozart\Assert\Assert;
 
 final class SiteWideFacetsQueryBuilder implements SiteWideFacetsQueryBuilderInterface
 {
@@ -28,18 +26,15 @@ public function __construct(
 
     public function getQuery(FormEvent $event): Query
     {
-        /** @var Search $data */
+        /** @var array $data */
         $data = $event->getData();
-        $box = $data->getBox();
-
-        Assert::notNull($box);
 
         /** @var Query\BoolQuery $boolQuery */
         $boolQuery = $this->queryBuilder->buildQuery([
-            'query' => $box->getQuery() ?? '',
+            'query' => $data['box']['query'] ?? '',
         ]);
 
-        foreach ($data->getFacets() as $facetId => $selectedBuckets) {
+        foreach ($data['facets'] ?? [] as $facetId => $selectedBuckets) {
             if (!$selectedBuckets) {
                 continue;
             }
diff --git a/src/Repository/OrderItemRepository.php b/src/Repository/OrderItemRepository.php
@@ -25,7 +25,7 @@ public function __construct(
 
     public function countByVariant(ProductVariantInterface $variant, array $orderStates = []): int
     {
-        if ([] === $orderStates) {
+        if ([] !== $orderStates) {
             $orderStates = [OrderInterface::STATE_CANCELLED, OrderInterface::STATE_CART];
         }
 
diff --git a/src/Repository/ProductAttributeRepository.php b/src/Repository/ProductAttributeRepository.php
@@ -18,18 +18,17 @@
 class ProductAttributeRepository implements ProductAttributeRepositoryInterface
 {
     public function __construct(
-        private RepositoryInterface|EntityRepository $productAttributeRepository
+        private RepositoryInterface $productAttributeRepository
     ) {
     }
 
     public function getAttributeTypeByName(string $attributeName): string
     {
-        /** @var EntityRepository $productAttributeRepository */
-        $productAttributeRepository = $this->productAttributeRepository;
-
-        $queryBuilder = $productAttributeRepository->createQueryBuilder('p');
+        /** @var EntityRepository $queryBuilder */
+        $queryBuilder = $this->productAttributeRepository;
 
         $result = $queryBuilder
+            ->createQueryBuilder('p')
             ->select('p.type')
             ->where('p.code = :code')
             ->setParameter(':code', $attributeName)
@@ -44,12 +43,13 @@ public function findAllWithTranslations(?string $locale): array
         /** @var EntityRepository $productAttributeRepository */
         $productAttributeRepository = $this->productAttributeRepository;
 
-        $queryBuilder = $productAttributeRepository->createQueryBuilder('p');
+        $queryBuilder = $productAttributeRepository->createQueryBuilder('o');
 
         if (null !== $locale) {
             $queryBuilder
                 ->addSelect('translation')
-                ->leftJoin('o.translations', 'ot')
+                /** @phpstan-ignore-next-line phpstan can't read relationship correctly */
+                ->leftJoin('o.translations', 'translation', 'ot')
                 ->andWhere('translation.locale = :locale')
                 ->setParameter('locale', $locale)
             ;
diff --git a/src/Repository/ProductAttributeValueRepository.php b/src/Repository/ProductAttributeValueRepository.php
@@ -20,7 +20,7 @@
 class ProductAttributeValueRepository implements ProductAttributeValueRepositoryInterface
 {
     public function __construct(
-        private BaseAttributeValueRepositoryInterface|EntityRepository $baseAttributeValueRepository,
+        private BaseAttributeValueRepositoryInterface $baseAttributeValueRepository,
         private bool $includeAllDescendants
     ) {
     }
diff --git a/src/Repository/ProductOptionRepository.php b/src/Repository/ProductOptionRepository.php
@@ -18,27 +18,28 @@
 class ProductOptionRepository implements ProductOptionRepositoryInterface
 {
     public function __construct(
-        private RepositoryInterface|EntityRepository $productOptionRepository
+        private RepositoryInterface $productOptionRepository
     ) {
     }
 
     public function findAllWithTranslations(?string $locale): array
     {
-        /** @var EntityRepository $productOptionRepository */
-        $productOptionRepository = $this->productOptionRepository;
-
-        $queryBuilder = $productOptionRepository->createQueryBuilder('o');
+        /** @var EntityRepository $queryBuilder */
+        $queryBuilder = $this->productOptionRepository;
 
         if (null !== $locale) {
             $queryBuilder
+                ->createQueryBuilder('o')
                 ->addSelect('translation')
-                ->leftJoin('o.translations', 'ot')
+                /** @phpstan-ignore-next-line phpstan can't read relationship correctly */
+                ->leftJoin('o.translations', 'translation', 'ot')
                 ->andWhere('translation.locale = :locale')
                 ->setParameter('locale', $locale)
             ;
         }
 
         return $queryBuilder
+            ->createQueryBuilder('o')
             ->getQuery()
             ->getResult()
         ;
diff --git a/src/Repository/ProductVariantRepository.php b/src/Repository/ProductVariantRepository.php
@@ -29,7 +29,8 @@ public function findOneByOptionValue(ProductOptionValueInterface $productOptionV
         /** @var EntityRepository $baseProductVariantRepository */
         $baseProductVariantRepository = $this->baseProductVariantRepository;
 
-        return $baseProductVariantRepository->createQueryBuilder('o')
+        return $baseProductVariantRepository
+            ->createQueryBuilder('o')
             ->where(':optionValue MEMBER OF o.optionValues')
             ->setParameter('optionValue', $productOptionValue)
             ->getQuery()
@@ -43,7 +44,8 @@ public function findByOptionValue(ProductOptionValueInterface $productOptionValu
         /** @var EntityRepository $baseProductVariantRepository */
         $baseProductVariantRepository = $this->baseProductVariantRepository;
 
-        return $baseProductVariantRepository->createQueryBuilder('o')
+        return $baseProductVariantRepository
+            ->createQueryBuilder('o')
             ->where(':optionValue MEMBER OF o.optionValues')
             ->setParameter('optionValue', $productOptionValue)
             ->getQuery()
diff --git a/src/Repository/TaxonRepository.php b/src/Repository/TaxonRepository.php
@@ -43,7 +43,8 @@ public function getTaxonsByAttributeViaProduct(AttributeInterface $attribute): a
             ->leftJoin($this->productTaxonEntityClass, 'pt', Join::WITH, 'pt.taxon = t.id')
             ->where(
                 'pt.product IN(' .
-                    $productRepository->createQueryBuilder('p')
+                $productRepository
+                    ->createQueryBuilder('p')
                     ->leftJoin($this->productAttributeEntityClass, 'pav', Join::WITH, 'pav.subject = p.id')
                     ->where('pav.attribute = :attribute')
                     ->getQuery()

Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ public function __construct(`
`25`	`25`
`26`	`26`	`public function countByVariant(ProductVariantInterface $variant, array $orderStates = []): int`
`27`	`27`	`{`
`28`		`- if ([] === $orderStates) {`
	`28`	`+ if ([] !== $orderStates) {`
`29`	`29`	`$orderStates = [OrderInterface::STATE_CANCELLED, OrderInterface::STATE_CART];`
`30`	`30`	`}`
`31`	`31`
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@`
`20`	`20`	`class ProductAttributeValueRepository implements ProductAttributeValueRepositoryInterface`
`21`	`21`	`{`
`22`	`22`	`public function __construct(`
`23`		`- private BaseAttributeValueRepositoryInterface\|EntityRepository $baseAttributeValueRepository,`
	`23`	`+ private BaseAttributeValueRepositoryInterface $baseAttributeValueRepository,`
`24`	`24`	`private bool $includeAllDescendants`
`25`	`25`	`) {`
`26`	`26`	`}`
Original file line number	Diff line number	Diff line change
`@@ -18,27 +18,28 @@`
`18`	`18`	`class ProductOptionRepository implements ProductOptionRepositoryInterface`
`19`	`19`	`{`
`20`	`20`	`public function __construct(`
`21`		`- private RepositoryInterface\|EntityRepository $productOptionRepository`
	`21`	`+ private RepositoryInterface $productOptionRepository`
`22`	`22`	`) {`
`23`	`23`	`}`
`24`	`24`
`25`	`25`	`public function findAllWithTranslations(?string $locale): array`
`26`	`26`	`{`
`27`		`- /** @var EntityRepository $productOptionRepository */`
`28`		`- $productOptionRepository = $this->productOptionRepository;`
`29`		`-`
`30`		`- $queryBuilder = $productOptionRepository->createQueryBuilder('o');`
	`27`	`+ /** @var EntityRepository $queryBuilder */`
	`28`	`+ $queryBuilder = $this->productOptionRepository;`
`31`	`29`
`32`	`30`	`if (null !== $locale) {`
`33`	`31`	`$queryBuilder`
	`32`	`+ ->createQueryBuilder('o')`
`34`	`33`	`->addSelect('translation')`
`35`		`- ->leftJoin('o.translations', 'ot')`
	`34`	`+ /** @phpstan-ignore-next-line phpstan can't read relationship correctly */`
	`35`	`+ ->leftJoin('o.translations', 'translation', 'ot')`
`36`	`36`	`->andWhere('translation.locale = :locale')`
`37`	`37`	`->setParameter('locale', $locale)`
`38`	`38`	`;`
`39`	`39`	`}`
`40`	`40`
`41`	`41`	`return $queryBuilder`
	`42`	`+ ->createQueryBuilder('o')`
`42`	`43`	`->getQuery()`
`43`	`44`	`->getResult()`
`44`	`45`	`;`