pamil / Sylius

src/Sylius/Component/Promotion/Action/PromotionApplicatorInterface.php

Doc Comments +6 added lines

@@ -18,7 +18,13 @@
 
 interface PromotionApplicatorInterface
 {
+    /**
+     * @return void
+     */
     public function apply(PromotionSubjectInterface $subject, PromotionInterface $promotion): void;
 
+    /**
+     * @return void
+     */
     public function revert(PromotionSubjectInterface $subject, PromotionInterface $promotion): void;
 }

src/Sylius/Component/Promotion/Generator/PromotionCouponGeneratorInstructionInterface.php

Doc Comments +22 added lines

@@ -15,22 +15,44 @@
 
 interface PromotionCouponGeneratorInstructionInterface
 {
+    /**
+     * @return integer
+     */
     public function getAmount(): ?int;
 
+    /**
+     * @return void
+     */
     public function setAmount(?int $amount): void;
 
+    /**
+     * @return integer
+     */
     public function getCodeLength(): ?int;
 
+    /**
+     * @return void
+     */
     public function setCodeLength(?int $codeLength): void;
 
+    /**
+     * @return \DateTimeInterface
+     */
     public function getExpiresAt(): ?\DateTimeInterface;
 
     /**
      * @param \DateTimeInterface $expiresAt
+     * @return void
      */
     public function setExpiresAt(?\DateTimeInterface $expiresAt): void;
 
+    /**
+     * @return integer
+     */
     public function getUsageLimit(): ?int;
 
+    /**
+     * @return void
+     */
     public function setUsageLimit(int $usageLimit): void;
 }

src/Sylius/Component/Promotion/Model/ConfigurablePromotionElementInterface.php

Doc Comments +6 added lines

@@ -17,9 +17,15 @@
 
 interface ConfigurablePromotionElementInterface extends ResourceInterface
 {
+    /**
+     * @return string
+     */
     public function getType(): ?string;
 
     public function getConfiguration(): array;
 
+    /**
+     * @return PromotionInterface
+     */
     public function getPromotion(): ?PromotionInterface;
 }

src/Sylius/Component/Promotion/Model/PromotionActionInterface.php

Doc Comments +9 added lines

@@ -17,9 +17,18 @@
 
 interface PromotionActionInterface extends ResourceInterface, ConfigurablePromotionElementInterface
 {
+    /**
+     * @return void
+     */
     public function setType(?string $type): void;
 
+    /**
+     * @return void
+     */
     public function setConfiguration(array $configuration): void;
 
+    /**
+     * @return void
+     */
     public function setPromotion(?PromotionInterface $promotion): void;
 }

src/Sylius/Component/Promotion/Model/PromotionCouponAwarePromotionSubjectInterface.php

Doc Comments +3 added lines

@@ -15,5 +15,8 @@
 
 interface PromotionCouponAwarePromotionSubjectInterface extends PromotionSubjectInterface
 {
+    /**
+     * @return PromotionCouponInterface
+     */
     public function getPromotionCoupon(): ?PromotionCouponInterface;
 }

src/Sylius/Component/Promotion/Model/PromotionCouponInterface.php

Doc Comments +22 added lines

@@ -19,16 +19,31 @@ 
 
 interface PromotionCouponInterface extends CodeAwareInterface, TimestampableInterface, ResourceInterface
 {
+    /**
+     * @return integer|null
+     */
     public function getUsageLimit(): ?int;
 
+    /**
+     * @return void
+     */
     public function setUsageLimit(?int $usageLimit): void;
 
     public function getUsed(): int;
 
+    /**
+     * @return void
+     */
     public function setUsed(int $used): void;
 
+    /**
+     * @return void
+     */
     public function incrementUsed(): void;
 
+    /**
+     * @return void
+     */
     public function decrementUsed(): void;
 
     /**
@@ -36,12 +51,19 @@ 
      */
     public function getPromotion(): ?PromotionInterface;
 
+    /**
+     * @return void
+     */
     public function setPromotion(?PromotionInterface $promotion): void;
 
+    /**
+     * @return \DateTimeInterface
+     */
     public function getExpiresAt(): ?\DateTimeInterface;
 
     /**
      * @param \DateTimeInterface $expiresAt
+     * @return void
      */
     public function setExpiresAt(?\DateTimeInterface $expiresAt): void;
 

src/Sylius/Component/Promotion/Model/PromotionInterface.php

Doc Comments +68 added lines

@@ -20,44 +20,94 @@ 
 
 interface PromotionInterface extends CodeAwareInterface, TimestampableInterface, ResourceInterface
 {
+    /**
+     * @return string
+     */
     public function getName(): ?string;
 
+    /**
+     * @return void
+     */
     public function setName(?string $name): void;
 
+    /**
+     * @return string
+     */
     public function getDescription(): ?string;
 
+    /**
+     * @return void
+     */
     public function setDescription(?string $description): void;
 
     public function getPriority(): int;
 
+    /**
+     * @param integer $priority
+     *
+     * @return void
+     */
     public function setPriority(?int $priority): void;
 
     public function isExclusive(): bool;
 
+    /**
+     * @return void
+     */
     public function setExclusive(?bool $exclusive): void;
 
+    /**
+     * @return integer
+     */
     public function getUsageLimit(): ?int;
 
+    /**
+     * @return void
+     */
     public function setUsageLimit(?int $usageLimit): void;
 
     public function getUsed(): int;
 
+    /**
+     * @return void
+     */
     public function setUsed(int $used): void;
 
+    /**
+     * @return void
+     */
     public function incrementUsed(): void;
 
+    /**
+     * @return void
+     */
     public function decrementUsed(): void;
 
+    /**
+     * @return \DateTimeInterface
+     */
     public function getStartsAt(): ?\DateTimeInterface;
 
+    /**
+     * @return void
+     */
     public function setStartsAt(?\DateTimeInterface $startsAt): void;
 
+    /**
+     * @return \DateTimeInterface
+     */
     public function getEndsAt(): ?\DateTimeInterface;
 
+    /**
+     * @return void
+     */
     public function setEndsAt(?\DateTimeInterface $endsAt): void;
 
     public function isCouponBased(): bool;
 
+    /**
+     * @return void
+     */
     public function setCouponBased(?bool $couponBased): void;
 
     /**
@@ -69,8 +119,14 @@ 
 
     public function hasCoupons(): bool;
 
+    /**
+     * @return void
+     */
     public function addCoupon(PromotionCouponInterface $coupon): void;
 
+    /**
+     * @return void
+     */
     public function removeCoupon(PromotionCouponInterface $coupon): void;
 
     /**
@@ -82,8 +138,14 @@ 
 
     public function hasRule(PromotionRuleInterface $rule): bool;
 
+    /**
+     * @return void
+     */
     public function addRule(PromotionRuleInterface $rule): void;
 
+    /**
+     * @return void
+     */
     public function removeRule(PromotionRuleInterface $rule): void;
 
     /**
@@ -95,7 +157,13 @@ 
 
     public function hasAction(PromotionActionInterface $action): bool;
 
+    /**
+     * @return void
+     */
     public function addAction(PromotionActionInterface $action): void;
 
+    /**
+     * @return void
+     */
     public function removeAction(PromotionActionInterface $action): void;
 }

src/Sylius/Component/Promotion/Model/PromotionRuleInterface.php

Doc Comments +9 added lines

@@ -17,9 +17,18 @@
 
 interface PromotionRuleInterface extends ResourceInterface, ConfigurablePromotionElementInterface
 {
+    /**
+     * @return void
+     */
     public function setType(?string $type): void;
 
+    /**
+     * @return void
+     */
     public function setConfiguration(array $configuration): void;
 
+    /**
+     * @return void
+     */
     public function setPromotion(?PromotionInterface $promotion): void;
 }

src/Sylius/Component/Promotion/Model/PromotionSubjectInterface.php

Doc Comments +6 added lines

@@ -26,7 +26,13 @@
 
     public function hasPromotion(PromotionInterface $promotion): bool;
 
+    /**
+     * @return void
+     */
     public function addPromotion(PromotionInterface $promotion): void;
 
+    /**
+     * @return void
+     */
     public function removePromotion(PromotionInterface $promotion): void;
 }