pamil / Sylius

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/Review/Model/ReviewInterface.php

Doc Comments +38 added lines

@@ -22,27 +22,65 @@
     public const STATUS_ACCEPTED = 'accepted';
     public const STATUS_REJECTED = 'rejected';
 
+    /**
+     * @return string
+     */
     public function getTitle(): ?string;
 
+    /**
+     * @return void
+     */
     public function setTitle(?string $title): void;
 
+    /**
+     * @return integer
+     */
     public function getRating(): ?int;
 
+    /**
+     * @return void
+     */
     public function setRating(?int $rating): void;
 
+    /**
+     * @return string
+     */
     public function getComment(): ?string;
 
+    /**
+     * @return void
+     */
     public function setComment(?string $comment): void;
 
+    /**
+     * @return ReviewerInterface
+     */
     public function getAuthor(): ?ReviewerInterface;
 
+    /**
+     * @return void
+     */
     public function setAuthor(?ReviewerInterface $author): void;
 
+    /**
+     * @return string
+     */
     public function getStatus(): ?string;
 
+    /**
+     * @return void
+     */
     public function setStatus(?string $status): void;
 
+    /**
+     * @return ReviewableInterface
+     */
     public function getReviewSubject(): ?ReviewableInterface;
 
+    /**
+     * @param ReviewableInterface $reviewSubject
+     *
+     * @return void
+     */
     public function setReviewSubject(?ReviewableInterface $reviewSubject): void;
 }

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

Doc Comments +24 added lines

@@ -24,12 +24,24 @@ 
     public const STATE_SHIPPED = 'shipped';
     public const STATE_CANCELLED = 'cancelled';
 
+    /**
+     * @return string
+     */
     public function getState(): ?string;
 
+    /**
+     * @return void
+     */
     public function setState(?string $state): void;
 
+    /**
+     * @return ShippingMethodInterface
+     */
     public function getMethod(): ?ShippingMethodInterface;
 
+    /**
+     * @return void
+     */
     public function setMethod(?ShippingMethodInterface $method): void;
 
     /**
@@ -37,14 +49,26 @@ 
      */
     public function getUnits(): Collection;
 
+    /**
+     * @return void
+     */
     public function addUnit(ShipmentUnitInterface $unit): void;
 
+    /**
+     * @return void
+     */
     public function removeUnit(ShipmentUnitInterface $unit): void;
 
     public function hasUnit(ShipmentUnitInterface $unit): bool;
 
+    /**
+     * @return string
+     */
     public function getTracking(): ?string;
 
+    /**
+     * @return void
+     */
     public function setTracking(?string $tracking): void;
 
     public function isTracked(): bool;

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

Doc Comments +6 added lines

@@ -18,8 +18,14 @@
 
 interface ShipmentUnitInterface extends TimestampableInterface, ResourceInterface
 {
+    /**
+     * @return null|ShipmentInterface
+     */
     public function getShipment(): ?ShipmentInterface;
 
+    /**
+     * @return void
+     */
     public function setShipment(?ShipmentInterface $shipment): void;
 
     public function getShippable(): ?ShippableInterface;

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;

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

Doc Comments +12 added lines

@@ -18,11 +18,23 @@
 
 interface ShippingMethodTranslationInterface extends ResourceInterface, TranslationInterface
 {
+    /**
+     * @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;
 }