pamil / Sylius

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;
 }

src/Sylius/Component/Promotion/Processor/PromotionProcessorInterface.php

Doc Comments +3 added lines

@@ -17,5 +17,8 @@
 
 interface PromotionProcessorInterface
 {
+    /**
+     * @return void
+     */
     public function process(PromotionSubjectInterface $subject): void;
 }

src/Sylius/Component/Review/Model/ReviewableInterface.php

Doc Comments +12 added lines

@@ -27,11 +27,23 @@
      */
     public function getReviews(): Collection;
 
+    /**
+     * @return void
+     */
     public function addReview(ReviewInterface $review): void;
 
+    /**
+     * @return void
+     */
     public function removeReview(ReviewInterface $review): void;
 
+    /**
+     * @return double
+     */
     public function getAverageRating(): ?float;
 
+    /**
+     * @return void
+     */
     public function setAverageRating(float $averageRating): void;
 }

src/Sylius/Component/Review/Model/ReviewerInterface.php

Doc Comments +18 added lines

@@ -17,15 +17,33 @@
 
 interface ReviewerInterface extends ResourceInterface
 {
+    /**
+     * @return string|null
+     */
     public function getEmail(): ?string;
 
+    /**
+     * @return void
+     */
     public function setEmail(?string $email): void;
 
+    /**
+     * @return string|null
+     */
     public function getFirstName(): ?string;
 
+    /**
+     * @return void
+     */
     public function setFirstName(?string $firstName): void;
 
+    /**
+     * @return string|null
+     */
     public function getLastName(): ?string;
 
+    /**
+     * @return void
+     */
     public function setLastName(?string $lastName): void;
 }

src/Sylius/Component/Shipping/Model/ShippableInterface.php

Doc Comments +18 added lines

@@ -15,15 +15,33 @@
 
 interface ShippableInterface
 {
+    /**
+     * @return double
+     */
     public function getShippingWeight(): ?float;
 
+    /**
+     * @return double
+     */
     public function getShippingVolume(): ?float;
 
+    /**
+     * @return double
+     */
     public function getShippingWidth(): ?float;
 
+    /**
+     * @return double
+     */
     public function getShippingHeight(): ?float;
 
+    /**
+     * @return double
+     */
     public function getShippingDepth(): ?float;
 
+    /**
+     * @return ShippingCategoryInterface
+     */
     public function getShippingCategory(): ?ShippingCategoryInterface;
 }

src/Sylius/Component/Shipping/Model/ShippingCategoryInterface.php

Doc Comments +12 added lines

@@ -19,11 +19,23 @@
 
 interface ShippingCategoryInterface 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;
 }

src/Sylius/Component/Shipping/Model/ShippingMethodInterface.php

Doc Comments +29 added lines

@@ -35,18 +35,38 @@ 
 
     public function getName(): ?string;
 
+    /**
+     * @return void
+     */
     public function setName(?string $name): void;
 
     public function getDescription(): ?string;
 
+    /**
+     * @return void
+     */
     public function setDescription(?string $description): void;
 
+    /**
+     * @return integer
+     */
     public function getPosition(): ?int;
 
+    /**
+     * @param integer $position
+     *
+     * @return void
+     */
     public function setPosition(?int $position): void;
 
+    /**
+     * @return ShippingCategoryInterface
+     */
     public function getCategory(): ?ShippingCategoryInterface;
 
+    /**
+     * @return void
+     */
     public function setCategory(?ShippingCategoryInterface $category);
 
     /**
@@ -56,9 +76,13 @@ 
      * 1) None of shippables matches the category.
      * 2) At least one of shippables matches the category.
      * 3) All shippables have to match the method category.
+     * @return integer
      */
     public function getCategoryRequirement(): ?int;
 
+    /**
+     * @return void
+     */
     public function setCategoryRequirement(?int $categoryRequirement): void;
 
     /**
@@ -68,14 +92,19 @@ 
 
     /**
      * @param string $calculator
+     * @return void
      */
     public function setCalculator(?string $calculator): void;
 
     public function getConfiguration(): array;
 
+    /**
+     * @return void
+     */
     public function setConfiguration(array $configuration): void;
 
     /**
+     * @param string $locale
      * @return ShippingMethodTranslationInterface
      */
     public function getTranslation(?string $locale = null): TranslationInterface;