pamil / Sylius

Model/AdjustableInterface.php

Doc Comments +11 added lines

@@ -18,20 +18,31 @@
 interface AdjustableInterface
 {
     /**
+     * @param string $type
      * @return Collection|AdjustmentInterface[]
      */
     public function getAdjustments(?string $type = null): Collection;
 
+    /**
+     * @return void
+     */
     public function addAdjustment(AdjustmentInterface $adjustment): void;
 
+    /**
+     * @return void
+     */
     public function removeAdjustment(AdjustmentInterface $adjustment): void;
 
     public function getAdjustmentsTotal(?string $type = null): int;
 
+    /**
+     * @return void
+     */
     public function removeAdjustments(?string $type = null): void;
 
     /**
      * Recalculates adjustments total. Should be used after adjustment change.
+     * @return void
      */
     public function recalculateAdjustmentsTotal(): void;
 }

Model/AdjustmentInterface.php

Doc Comments +37 added lines

@@ -20,28 +20,59 @@ 
 {
     public function getAdjustable(): ?AdjustableInterface;
 
+    /**
+     * @return void
+     */
     public function setAdjustable(?AdjustableInterface $adjustable): void;
 
+    /**
+     * @return string|null
+     */
     public function getType(): ?string;
 
+    /**
+     * @param string $type
+     *
+     * @return void
+     */
     public function setType(?string $type): void;
 
+    /**
+     * @return string|null
+     */
     public function getLabel(): ?string;
 
+    /**
+     * @param string $label
+     *
+     * @return void
+     */
     public function setLabel(?string $label): void;
 
     public function getAmount(): int;
 
+    /**
+     * @return void
+     */
     public function setAmount(int $amount): void;
 
     public function isNeutral(): bool;
 
+    /**
+     * @return void
+     */
     public function setNeutral(bool $neutral): void;
 
     public function isLocked(): bool;
 
+    /**
+     * @return void
+     */
     public function lock(): void;
 
+    /**
+     * @return void
+     */
     public function unlock(): void;
 
     /**
@@ -54,7 +85,13 @@ 
      */
     public function isCredit(): bool;
 
+    /**
+     * @return string|null
+     */
     public function getOriginCode(): ?string;
 
+    /**
+     * @return void
+     */
     public function setOriginCode(?string $originCode): void;
 }

Model/OrderAwareInterface.php

Doc Comments +6 added lines

@@ -15,7 +15,13 @@
 
 interface OrderAwareInterface
 {
+    /**
+     * @return OrderInterface|null
+     */
     public function getOrder(): ?OrderInterface;
 
+    /**
+     * @return void
+     */
     public function setOrder(?OrderInterface $order): void;
 }

Model/OrderInterface.php

Doc Comments +39 added lines

@@ -24,20 +24,41 @@ 
     public const STATE_CANCELLED = 'cancelled';
     public const STATE_FULFILLED = 'fulfilled';
 
+    /**
+     * @return \DateTimeInterface|null
+     */
     public function getCheckoutCompletedAt(): ?\DateTimeInterface;
 
+    /**
+     * @return void
+     */
     public function setCheckoutCompletedAt(?\DateTimeInterface $checkoutCompletedAt): void;
 
     public function isCheckoutCompleted(): bool;
 
+    /**
+     * @return void
+     */
     public function completeCheckout(): void;
 
+    /**
+     * @return string|null
+     */
     public function getNumber(): ?string;
 
+    /**
+     * @return void
+     */
     public function setNumber(?string $number): void;
 
+    /**
+     * @return string|null
+     */
     public function getNotes(): ?string;
 
+    /**
+     * @return void
+     */
     public function setNotes(?string $notes): void;
 
     /**
@@ -45,18 +66,30 @@ 
      */
     public function getItems(): Collection;
 
+    /**
+     * @return void
+     */
     public function clearItems(): void;
 
     public function countItems(): int;
 
+    /**
+     * @return void
+     */
     public function addItem(OrderItemInterface $item): void;
 
+    /**
+     * @return void
+     */
     public function removeItem(OrderItemInterface $item): void;
 
     public function hasItem(OrderItemInterface $item): bool;
 
     public function getItemsTotal(): int;
 
+    /**
+     * @return void
+     */
     public function recalculateItemsTotal(): void;
 
     public function getTotal(): int;
@@ -65,6 +98,9 @@ 
 
     public function getState(): string;
 
+    /**
+     * @return void
+     */
     public function setState(string $state): void;
 
     public function isEmpty(): bool;
@@ -76,5 +112,8 @@ 
 
     public function getAdjustmentsTotalRecursively(?string $type = null): int;
 
+    /**
+     * @return void
+     */
     public function removeAdjustmentsRecursively(?string $type = null): void;
 }

Model/OrderItemInterface.php

Doc Comments +18 added lines

@@ -22,12 +22,16 @@ 
 
     public function getUnitPrice(): int;
 
+    /**
+     * @return void
+     */
     public function setUnitPrice(int $unitPrice): void;
 
     public function getTotal(): int;
 
     /**
      * Recalculate totals. Should be used after every unit change.
+     * @return void
      */
     public function recalculateUnitsTotal(): void;
 
@@ -39,6 +43,9 @@ 
 
     public function isImmutable(): bool;
 
+    /**
+     * @return void
+     */
     public function setImmutable(bool $immutable): void;
 
     /**
@@ -48,8 +55,14 @@ 
 
     public function hasUnit(OrderItemUnitInterface $itemUnit): bool;
 
+    /**
+     * @return void
+     */
     public function addUnit(OrderItemUnitInterface $itemUnit): void;
 
+    /**
+     * @return void
+     */
     public function removeUnit(OrderItemUnitInterface $itemUnit): void;
 
     /**
@@ -57,6 +70,11 @@ 
      */
     public function getAdjustmentsRecursively(?string $type = null): Collection;
 
+    /**
+     * @param string $type
+     *
+     * @return void
+     */
     public function removeAdjustmentsRecursively(?string $type = null): void;
 
     public function getAdjustmentsTotalRecursively(?string $type = null): int;

Model/OrderSequenceInterface.php

Doc Comments +3 added lines

@@ -19,5 +19,8 @@
 {
     public function getIndex(): int;
 
+    /**
+     * @return void
+     */
     public function incrementIndex(): void;
 }

Modifier/OrderItemQuantityModifierInterface.php

Doc Comments +3 added lines

@@ -17,5 +17,8 @@
 
 interface OrderItemQuantityModifierInterface
 {
+    /**
+     * @return void
+     */
     public function modify(OrderItemInterface $orderItem, int $targetQuantity): void;
 }

Modifier/OrderModifierInterface.php

Doc Comments +6 added lines

@@ -18,7 +18,13 @@
 
 interface OrderModifierInterface
 {
+    /**
+     * @return void
+     */
     public function addToOrder(OrderInterface $cart, OrderItemInterface $cartItem): void;
 
+    /**
+     * @return void
+     */
     public function removeFromOrder(OrderInterface $cart, OrderItemInterface $item): void;
 }

Processor/OrderProcessorInterface.php

Doc Comments +3 added lines

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