pamil / Sylius

src/Sylius/Component/Resource/Repository/RepositoryInterface.php

Doc Comments +9 added lines

@@ -21,9 +21,18 @@
     public const ORDER_ASCENDING = 'ASC';
     public const ORDER_DESCENDING = 'DESC';
 
+    /**
+     * @return \Pagerfanta\Pagerfanta
+     */
     public function createPaginator(array $criteria = [], array $sorting = []): iterable;
 
+    /**
+     * @return void
+     */
     public function add(ResourceInterface $resource): void;
 
+    /**
+     * @return void
+     */
     public function remove(ResourceInterface $resource): void;
 }

src/Sylius/Component/Resource/StateMachine/StateMachineInterface.php

Doc Comments +1 added lines

@@ -26,6 +26,7 @@
     /**
      * Returns the possible transition to the given state
      * Returns null if no transition is possible
+     * @return string
      */
     public function getTransitionToState(string $toState): ?string;
 }

src/Sylius/Component/Resource/Storage/StorageInterface.php

Doc Comments +8 added lines

@@ -19,8 +19,16 @@
 
     public function get(string $name, $default = null);
 
+    /**
+     * @param string $value
+     *
+     * @return void
+     */
     public function set(string $name, $value): void;
 
+    /**
+     * @return void
+     */
     public function remove(string $name): void;
 
     public function all(): array;

src/Sylius/Component/Resource/Translation/TranslatableEntityLocaleAssignerInterface.php

Doc Comments +3 added lines

@@ -17,5 +17,8 @@
 
 interface TranslatableEntityLocaleAssignerInterface
 {
+    /**
+     * @return void
+     */
     public function assignLocale(TranslatableInterface $translatableEntity): 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/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;