fix code style and psalm errors

gewebe · Jan 13, 2021 · 4e9f567 · 4e9f567
1 parent ee53cd8
commit 4e9f567
Show file tree

Hide file tree

Showing 15 changed files with 48 additions and 209 deletions.
diff --git a/src/DependencyInjection/Configuration.php b/src/DependencyInjection/Configuration.php
@@ -9,9 +9,6 @@
 
 final class Configuration implements ConfigurationInterface
 {
-    /**
-     * {@inheritdoc}
-     */
     public function getConfigTreeBuilder(): TreeBuilder
     {
         $treeBuilder = new TreeBuilder('gewebe_product_deposit');

diff --git a/src/DependencyInjection/GewebeSyliusProductDepositExtension.php b/src/DependencyInjection/GewebeSyliusProductDepositExtension.php
@@ -12,9 +12,6 @@
 
 final class GewebeSyliusProductDepositExtension extends Extension
 {
-    /**
-     * {@inheritdoc}
-     */
     public function load(array $configs, ContainerBuilder $container): void
     {
         $config = $this->processConfiguration($this->getConfiguration([], $container), $configs);

diff --git a/src/Entity/ChannelDeposit.php b/src/Entity/ChannelDeposit.php
@@ -9,29 +9,18 @@
  */
 class ChannelDeposit implements ChannelDepositInterface
 {
-    /**
-     * @var int
-     */
+    /** @var mixed */
     private $id;
 
-    /**
-     * @var int
-     */
+    /** @var int|null */
     private $price;
 
-    /**
-     * @var string
-     */
+    /** @var string|null */
     private $channelCode;
 
-    /**
-     * @var ProductVariantInterface|null
-     */
+    /** @var ProductVariantInterface|null */
     private $productVariant;
 
-    /**
-     * {@inheritdoc}
-     */
     public function __toString(): string
     {
         return (string) $this->getPrice();
@@ -45,50 +34,32 @@ public function getId()
         return $this->id;
     }
 
-    /**
-     * @return int
-     */
     public function getPrice(): ?int
     {
         return $this->price;
     }
 
-    /**
-     * @param int $price
-     */
-    public function setPrice(int $price): void
+    public function setPrice(?int $price): void
     {
         $this->price = $price;
     }
 
-    /**
-     * @return ProductVariantInterface|null
-     */
     public function getProductVariant(): ?ProductVariantInterface
     {
         return $this->productVariant;
     }
 
-    /**
-     * @param ProductVariantInterface|null $productVariants
-     */
     public function setProductVariant(?ProductVariantInterface $productVariants): void
     {
         $this->productVariant = $productVariants;
     }
 
-    /**
-     * @return string|null
-     */
     public function getChannelCode(): ?string
     {
         return $this->channelCode;
     }
 
-    /**
-     * @param string $channelCode
-     */
-    public function setChannelCode(string $channelCode): void
+    public function setChannelCode(?string $channelCode): void
     {
         $this->channelCode = $channelCode;
     }

diff --git a/src/Entity/ChannelDepositInterface.php b/src/Entity/ChannelDepositInterface.php
@@ -11,33 +11,15 @@
  */
 interface ChannelDepositInterface extends ResourceInterface
 {
-    /**
-     * @return int
-     */
     public function getPrice(): ?int;
 
-    /**
-     * @param int $price
-     */
     public function setPrice(int $price): void;
 
-    /**
-     * @return ProductVariantInterface|null
-     */
     public function getProductVariant(): ?ProductVariantInterface;
 
-    /**
-     * @param ProductVariantInterface $productVariants
-     */
     public function setProductVariant(?ProductVariantInterface $productVariants): void;
 
-    /**
-     * @return string
-     */
     public function getChannelCode(): ?string;
 
-    /**
-     * @param string $channelCode
-     */
     public function setChannelCode(string $channelCode): void;
 }
diff --git a/src/Entity/ProductVariant.php b/src/Entity/ProductVariant.php
@@ -13,6 +13,8 @@
  *
  * @ORM\Entity
  * @ORM\Table(name="sylius_product_variant")
+ *
+ * @psalm-suppress PropertyNotSetInConstructor
  */
 class ProductVariant extends BaseProductVariant implements DepositProductVariantInterface
 {
@@ -24,5 +26,4 @@ public function __construct()
 
         $this->initProductVariantDepositTrait();
     }
-
 }
diff --git a/src/Entity/ProductVariantDepositTrait.php b/src/Entity/ProductVariantDepositTrait.php
@@ -37,7 +37,7 @@ public function initProductVariantDepositTrait(): void
     protected $channelDeposits;
 
     /**
-     * @var TaxCategoryInterface
+     * @var TaxCategoryInterface|null
      *
      * @ORM\ManyToOne(targetEntity="\Sylius\Component\Taxation\Model\TaxCategoryInterface", cascade={"all"}, fetch="EAGER")
      * @ORM\JoinColumn(name="deposit_tax_category_id", referencedColumnName="id", onDelete="SET NULL")
@@ -46,20 +46,13 @@ public function initProductVariantDepositTrait(): void
 
     /**
      * Returns all deposit elements for all channels
-     * @return Collection|ChannelDepositInterface[]
-     *
      * @psalm-return Collection<array-key, ChannelDepositInterface>
      */
     public function getChannelDeposits(): Collection
     {
         return $this->channelDeposits;
     }
 
-    /**
-     * Returns the deposit element for one channel
-     * @param ChannelInterface $channel
-     * @return ChannelDepositInterface|null
-     */
     public function getChannelDepositForChannel(ChannelInterface $channel): ?ChannelDepositInterface
     {
         $channelCode = $channel->getCode();
@@ -71,31 +64,16 @@ public function getChannelDepositForChannel(ChannelInterface $channel): ?Channel
         return null;
     }
 
-    /**
-     * Check if channel has deposit element
-     * @param ChannelInterface $channel
-     * @return bool
-     */
     public function hasChannelDepositForChannel(ChannelInterface $channel): bool
     {
         return null !== $this->getChannelDepositForChannel($channel);
     }
 
-    /**
-     * Check if has deposit element
-     * @param ChannelDepositInterface $channelDeposit
-     * @return bool
-     */
     public function hasChannelDeposit(ChannelDepositInterface $channelDeposit): bool
     {
         return $this->channelDeposits->contains($channelDeposit);
     }
 
-    /**
-     * Adds an deposit element to the list
-     * @param ChannelDepositInterface $channelDeposit
-     * @return void
-     */
     public function addChannelDeposit(ChannelDepositInterface $channelDeposit): void
     {
         $channelCode = $channelDeposit->getChannelCode();
@@ -106,11 +84,6 @@ public function addChannelDeposit(ChannelDepositInterface $channelDeposit): void
         }
     }
 
-    /**
-     * Removes a deposit element from the list
-     * @param ChannelDepositInterface $channelDeposit
-     * @return void
-     */
     public function removeChannelDeposit(ChannelDepositInterface $channelDeposit): void
     {
         $channelCode = $channelDeposit->getChannelCode();
@@ -121,17 +94,11 @@ public function removeChannelDeposit(ChannelDepositInterface $channelDeposit): v
         }
     }
 
-    /**
-     * @return TaxCategoryInterface
-     */
     public function getDepositTaxCategory(): ?TaxCategoryInterface
     {
         return $this->depositTaxCategory;
     }
 
-    /**
-     * @param TaxCategoryInterface $depositTaxCategory
-     */
     public function setDepositTaxCategory(TaxCategoryInterface $depositTaxCategory): void
     {
         $this->depositTaxCategory = $depositTaxCategory;

diff --git a/src/Entity/ProductVariantInterface.php b/src/Entity/ProductVariantInterface.php
@@ -16,54 +16,21 @@ interface ProductVariantInterface extends BaseProductVariantInterface
 {
     /**
      * Returns all deposit elements for all channels
-     * @return Collection|ChannelDepositInterface[]
-     *
      * @psalm-return Collection<array-key, ChannelDepositInterface>
      */
     public function getChannelDeposits(): Collection;
 
-    /**
-     * Returns the deposit element for one channel
-     * @param ChannelInterface $channel
-     * @return ChannelDepositInterface|null
-     */
     public function getChannelDepositForChannel(ChannelInterface $channel): ?ChannelDepositInterface;
 
-    /**
-     * Check if channel has deposit element
-     * @param ChannelInterface $channel
-     * @return bool
-     */
     public function hasChannelDepositForChannel(ChannelInterface $channel): bool;
 
-    /**
-     * Check if has deposit element
-     * @param ChannelDepositInterface $channelDeposit
-     * @return bool
-     */
     public function hasChannelDeposit(ChannelDepositInterface $channelDeposit): bool;
 
-    /**
-     * Adds an deposit element to the list
-     * @param ChannelDepositInterface $channelDeposit
-     * @return void
-     */
     public function addChannelDeposit(ChannelDepositInterface $channelDeposit): void;
 
-    /**
-     * Removes a deposit element from the list
-     * @param ChannelDepositInterface $channelDeposit
-     * @return void
-     */
     public function removeChannelDeposit(ChannelDepositInterface $channelDeposit): void;
 
-    /**
-     * @return TaxCategoryInterface
-     */
     public function getDepositTaxCategory(): ?TaxCategoryInterface;
 
-    /**
-     * @param TaxCategoryInterface $depositTaxCategory
-     */
     public function setDepositTaxCategory(TaxCategoryInterface $depositTaxCategory): void;
 }
diff --git a/src/Form/ChannelDepositType.php b/src/Form/ChannelDepositType.php
@@ -5,10 +5,10 @@
 namespace Gewebe\SyliusProductDepositPlugin\Form;
 
 use Gewebe\SyliusProductDepositPlugin\Entity\ChannelDepositInterface;
+use Gewebe\SyliusProductDepositPlugin\Entity\ProductVariantInterface;
 use Sylius\Bundle\MoneyBundle\Form\Type\MoneyType;
 use Sylius\Bundle\ResourceBundle\Form\Type\AbstractResourceType;
 use Sylius\Component\Core\Model\ChannelInterface;
-use Sylius\Component\Core\Model\ProductVariantInterface;
 use Symfony\Component\Form\FormBuilderInterface;
 use Symfony\Component\Form\FormEvent;
 use Symfony\Component\Form\FormEvents;
@@ -20,18 +20,22 @@
  */
 final class ChannelDepositType extends AbstractResourceType
 {
-    /**
-     * {@inheritdoc}
-     */
     public function buildForm(FormBuilderInterface $builder, array $options): void
     {
+        /** @var ChannelInterface $channel */
+        $channel = $options['channel'];
+        $baseCurrency = $channel->getBaseCurrency();
+        if ($baseCurrency === null) {
+            return;
+        }
+
         $builder->add(
             'price',
             MoneyType::class,
             [
                 'label' => 'gewebe_product_deposit_plugin.admin.product_variant.price',
                 'required' => false,
-                'currency' => $options['channel']->getBaseCurrency()->getCode(),
+                'currency' => $baseCurrency->getCode(),
             ]
         );
 
@@ -47,17 +51,26 @@ function(FormEvent $event) use ($options): void {
                     return;
                 }
 
-                $channelDeposit->setChannelCode($options['channel']->getCode());
-                $channelDeposit->setProductVariant($options['product_variant']);
+                /** @var ChannelInterface $channel */
+                $channel = $options['channel'];
+                $channelCode = $channel->getCode();
+                if ($channelCode === null) {
+                    $event->setData(null);
+
+                    return;
+                }
+
+                /** @var ProductVariantInterface $productVariant */
+                $productVariant = $options['product_variant'];
+
+                $channelDeposit->setChannelCode($channelCode);
+                $channelDeposit->setProductVariant($productVariant);
 
                 $event->setData($channelDeposit);
             }
         );
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function configureOptions(OptionsResolver $resolver): void
     {
         parent::configureOptions($resolver);
@@ -70,15 +83,14 @@ public function configureOptions(OptionsResolver $resolver): void
             ->setDefaults(
                 [
                     'label' => function(Options $options): string {
-                        return $options['channel']->getName();
+                        /** @var ChannelInterface $channel */
+                        $channel = $options['channel'];
+                        return $channel->getName() ?? '';
                     },
                 ]
             );
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getBlockPrefix(): string
     {
         return 'gewebe_channel_deposit';