pamil / Sylius

src/Sylius/Bundle/AdminBundle/EmailManager/OrderEmailManagerInterface.php

Doc Comments +3 added lines

@@ -17,5 +17,8 @@
 
 interface OrderEmailManagerInterface
 {
+    /**
+     * @return void
+     */
     public function sendConfirmationEmail(OrderInterface $order): void;
 }

src/Sylius/Bundle/ShopBundle/EmailManager/ContactEmailManagerInterface.php

Doc Comments +6 added lines

@@ -17,6 +17,12 @@
 
 interface ContactEmailManagerInterface
 {
+    /**
+     * @param ChannelInterface $channel
+     * @param string $localeCode
+     *
+     * @return void
+     */
     public function sendContactRequest(
         array $data,
         array $recipients,

src/Sylius/Bundle/CoreBundle/Fixture/OptionsResolver/LazyOption.php

Doc Comments +1 added lines, -1 removed lines

@@ -123,7 +123,7 @@
     public static function findOneBy(RepositoryInterface $repository, string $field, array $criteria = []): \Closure
     {
         return
-            /** @param mixed $previousValue */
+            /** @param string $previousValue */
             function (Options $options, $previousValue) use ($repository, $field, $criteria): ?object {
                 if (null === $previousValue || [] === $previousValue) {
                     return $previousValue;

Spacing +1 added lines, -1 removed lines

@@ -102,7 +102,7 @@
 
     public static function findBy(RepositoryInterface $repository, string $field, array $criteria = []): \Closure
     {
-        return function (Options $options, ?array $previousValues) use ($repository, $field, $criteria): ?iterable {
+        return function (Options $options, ?array $previousValues) use ($repository, $field, $criteria) : ?iterable {
             if (null === $previousValues || [] === $previousValues) {
                 return $previousValues;
             }

src/Sylius/Bundle/UserBundle/DependencyInjection/Configuration.php

Doc Comments +3 added lines, -3 removed lines

@@ -75,7 +75,7 @@ 
                                                         ->defaultValue('passwordResetToken')
                                                         ->validate()
                                                         ->ifTrue(
-                                                            /** @param mixed $tokenFieldName */
+                                                            /** @param ArrayNodeDefinition $tokenFieldName */
                                                             function ($tokenFieldName) {
                                                                 return !is_string($tokenFieldName);
                                                             }
@@ -96,7 +96,7 @@ 
                                                         ->defaultValue('passwordResetToken')
                                                         ->validate()
                                                         ->ifTrue(
-                                                            /** @param mixed $passwordResetToken */
+                                                            /** @param ArrayNodeDefinition $passwordResetToken */
                                                             function ($passwordResetToken) {
                                                                 return !is_string($passwordResetToken);
                                                             }
@@ -122,7 +122,7 @@ 
                                                         ->defaultValue('emailVerificationToken')
                                                         ->validate()
                                                         ->ifTrue(
-                                                            /** @param mixed $emailVerificationToken */
+                                                            /** @param ArrayNodeDefinition $emailVerificationToken */
                                                             function ($emailVerificationToken) {
                                                                 return !is_string($emailVerificationToken);
                                                             }

src/Sylius/Component/Addressing/Model/CountryInterface.php

Doc Comments +10 added lines, -1 removed lines

@@ -20,10 +20,13 @@ 
 
 interface CountryInterface extends ToggleableInterface, ResourceInterface, CodeAwareInterface
 {
+    /**
+     * @return string|null
+     */
     public function getName(?string $locale = null): ?string;
 
     /**
-     * @return Collection|ProvinceInterface[]
+     * @return Collection
      *
      * @psalm-return Collection<array-key, ProvinceInterface>
      */
@@ -31,8 +34,14 @@ 
 
     public function hasProvinces(): bool;
 
+    /**
+     * @return void
+     */
     public function addProvince(ProvinceInterface $province): void;
 
+    /**
+     * @return void
+     */
     public function removeProvince(ProvinceInterface $province): void;
 
     public function hasProvince(ProvinceInterface $province): bool;

src/Sylius/Component/Attribute/Model/AttributeValueInterface.php

Doc Comments +29 added lines

@@ -31,28 +31,57 @@
 
     public const STORAGE_TEXT = 'text';
 
+    /**
+     * @return AttributeSubjectInterface|null
+     */
     public function getSubject(): ?AttributeSubjectInterface;
 
+    /**
+     * @return void
+     */
     public function setSubject(?AttributeSubjectInterface $subject): void;
 
+    /**
+     * @return AttributeInterface|null
+     */
     public function getAttribute(): ?AttributeInterface;
 
+    /**
+     * @param \Sylius\Component\Product\Model\ProductAttributeInterface|null $attribute
+     *
+     * @return void
+     */
     public function setAttribute(?AttributeInterface $attribute): void;
 
     public function getValue();
 
+    /**
+     * @return void
+     */
     public function setValue($value): void;
 
+    /**
+     * @return string
+     */
     public function getCode(): ?string;
 
     public function getName(): ?string;
 
+    /**
+     * @return string
+     */
     public function getType(): ?string;
 
     /**
      * @throws \InvalidArgumentException
+     * @return string|null
      */
     public function getLocaleCode(): ?string;
 
+    /**
+     * @param string $localeCode
+     *
+     * @return void
+     */
     public function setLocaleCode(?string $localeCode): void;
 }

src/Sylius/Component/Core/Model/ChannelPricingInterface.php

Doc Comments +25 added lines

@@ -17,12 +17,26 @@ 
 
 interface ChannelPricingInterface extends ResourceInterface
 {
+    /**
+     * @return ProductVariantInterface|null
+     */
     public function getProductVariant(): ?ProductVariantInterface;
 
+    /**
+     * @return void
+     */
     public function setProductVariant(?ProductVariantInterface $productVariant): void;
 
+    /**
+     * @return integer|null
+     */
     public function getPrice(): ?int;
 
+    /**
+     * @param integer $price
+     *
+     * @return void
+     */
     public function setPrice(?int $price): void;
 
     /**
@@ -30,10 +44,21 @@ 
      */
     public function getChannelCode(): ?string;
 
+    /**
+     * @return void
+     */
     public function setChannelCode(?string $channelCode): void;
 
+    /**
+     * @return integer|null
+     */
     public function getOriginalPrice(): ?int;
 
+    /**
+     * @param integer $originalPrice
+     *
+     * @return void
+     */
     public function setOriginalPrice(?int $originalPrice): void;
 
     public function isPriceReduced(): bool;

src/Sylius/Component/Core/Model/CustomerInterface.php

Doc Comments +13 added lines

@@ -27,12 +27,24 @@ 
      */
     public function getOrders(): Collection;
 
+    /**
+     * @return AddressInterface|null
+     */
     public function getDefaultAddress(): ?AddressInterface;
 
+    /**
+     * @return void
+     */
     public function setDefaultAddress(?AddressInterface $defaultAddress): void;
 
+    /**
+     * @return void
+     */
     public function addAddress(AddressInterface $address): void;
 
+    /**
+     * @return void
+     */
     public function removeAddress(AddressInterface $address): void;
 
     public function hasAddress(AddressInterface $address): bool;
@@ -53,6 +65,7 @@ 
 
     /**
      * @param ShopUserInterface|UserInterface|null $user
+     * @return void
      */
     public function setUser(?UserInterface $user);
 }

src/Sylius/Component/Core/Model/ImageInterface.php

Doc Comments +20 added lines

@@ -22,16 +22,35 @@ 
      */
     public function getType(): ?string;
 
+    /**
+     * @return void
+     */
     public function setType(?string $type): void;
 
+    /**
+     * @return \SplFileInfo|null
+     */
     public function getFile(): ?\SplFileInfo;
 
+    /**
+     * @param \Symfony\Component\HttpFoundation\File\UploadedFile $file
+     *
+     * @return void
+     */
     public function setFile(?\SplFileInfo $file): void;
 
     public function hasFile(): bool;
 
+    /**
+     * @return string|null
+     */
     public function getPath(): ?string;
 
+    /**
+     * @param string $path
+     *
+     * @return void
+     */
     public function setPath(?string $path): void;
 
     /**
@@ -41,6 +60,7 @@ 
 
     /**
      * @param object|null $owner
+     * @return void
      */
     public function setOwner($owner): void;
 }