pamil / Sylius

src/Sylius/Component/Customer/Model/CustomerInterface.php

Doc Comments +44 added lines

@@ -22,35 +22,64 @@ 
     public const MALE_GENDER = 'm';
     public const FEMALE_GENDER = 'f';
 
+    /**
+     * @return string|null
+     */
     public function getEmail(): ?string;
 
+    /**
+     * @return void
+     */
     public function setEmail(?string $email): void;
 
     /**
      * Gets normalized email (should be used in search and sort queries).
+     * @return string|null
      */
     public function getEmailCanonical(): ?string;
 
+    /**
+     * @return void
+     */
     public function setEmailCanonical(?string $emailCanonical): void;
 
     public function getFullName(): string;
 
+    /**
+     * @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;
 
+    /**
+     * @return \DateTimeInterface|null
+     */
     public function getBirthday(): ?\DateTimeInterface;
 
+    /**
+     * @return void
+     */
     public function setBirthday(?\DateTimeInterface $birthday): void;
 
     public function getGender(): string;
 
     /**
      * You should use interface constants for that.
+     * @return void
      */
     public function setGender(string $gender): void;
 
@@ -58,15 +87,30 @@ 
 
     public function isFemale(): bool;
 
+    /**
+     * @return CustomerGroupInterface|null
+     */
     public function getGroup(): ?CustomerGroupInterface;
 
+    /**
+     * @return void
+     */
     public function setGroup(?CustomerGroupInterface $group): void;
 
+    /**
+     * @return string|null
+     */
     public function getPhoneNumber(): ?string;
 
+    /**
+     * @return void
+     */
     public function setPhoneNumber(?string $phoneNumber): void;
 
     public function isSubscribedToNewsletter(): bool;
 
+    /**
+     * @return void
+     */
     public function setSubscribedToNewsletter(bool $subscribedToNewsletter): void;
 }

src/Sylius/Component/Inventory/Model/StockableInterface.php

Doc Comments +15 added lines

@@ -19,15 +19,30 @@
 
     public function isInStock(): bool;
 
+    /**
+     * @return integer
+     */
     public function getOnHold(): ?int;
 
+    /**
+     * @return void
+     */
     public function setOnHold(?int $onHold): void;
 
+    /**
+     * @return integer
+     */
     public function getOnHand(): ?int;
 
+    /**
+     * @return void
+     */
     public function setOnHand(?int $onHand): void;
 
     public function isTracked(): bool;
 
+    /**
+     * @return void
+     */
     public function setTracked(bool $tracked): void;
 }

src/Sylius/Component/Locale/Model/LocaleInterface.php

Doc Comments +3 added lines

@@ -19,5 +19,8 @@
 
 interface LocaleInterface extends ResourceInterface, CodeAwareInterface, TimestampableInterface
 {
+    /**
+     * @return string|null
+     */
     public function getName(?string $locale = null): ?string;
 }

src/Sylius/Component/Locale/Model/LocalesAwareInterface.php

Doc Comments +6 added lines

@@ -24,7 +24,13 @@
 
     public function hasLocale(LocaleInterface $locale): bool;
 
+    /**
+     * @return void
+     */
     public function addLocale(LocaleInterface $locale): void;
 
+    /**
+     * @return void
+     */
     public function removeLocale(LocaleInterface $locale): void;
 }

src/Sylius/Component/Order/Model/AdjustableInterface.php

Doc Comments +10 added lines

@@ -22,16 +22,26 @@
      */
     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;
 }

src/Sylius/Component/Order/Model/AdjustmentInterface.php

Doc Comments +33 added lines

@@ -20,28 +20,55 @@ 
 {
     public function getAdjustable(): ?AdjustableInterface;
 
+    /**
+     * @return void
+     */
     public function setAdjustable(?AdjustableInterface $adjustable): void;
 
+    /**
+     * @return string|null
+     */
     public function getType(): ?string;
 
+    /**
+     * @return void
+     */
     public function setType(?string $type): void;
 
+    /**
+     * @return string|null
+     */
     public function getLabel(): ?string;
 
+    /**
+     * @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 +81,13 @@ 
      */
     public function isCredit(): bool;
 
+    /**
+     * @return string|null
+     */
     public function getOriginCode(): ?string;
 
+    /**
+     * @return void
+     */
     public function setOriginCode(?string $originCode): void;
 }

src/Sylius/Component/Order/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;
 }

src/Sylius/Component/Order/Model/OrderInterface.php

Doc Comments +43 added lines

@@ -24,20 +24,45 @@ 
     public const STATE_CANCELLED = 'cancelled';
     public const STATE_FULFILLED = 'fulfilled';
 
+    /**
+     * @return \DateTimeInterface|null
+     */
     public function getCheckoutCompletedAt(): ?\DateTimeInterface;
 
+    /**
+     * @param \DateTime $checkoutCompletedAt
+     *
+     * @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;
 
+    /**
+     * @param string $notes
+     *
+     * @return void
+     */
     public function setNotes(?string $notes): void;
 
     /**
@@ -45,18 +70,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 +102,9 @@ 
 
     public function getState(): string;
 
+    /**
+     * @return void
+     */
     public function setState(string $state): void;
 
     public function isEmpty(): bool;
@@ -76,5 +116,8 @@ 
 
     public function getAdjustmentsTotalRecursively(?string $type = null): int;
 
+    /**
+     * @return void
+     */
     public function removeAdjustmentsRecursively(?string $type = null): void;
 }

src/Sylius/Component/Order/Model/OrderItemInterface.php

Doc Comments +16 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,9 @@ 
      */
     public function getAdjustmentsRecursively(?string $type = null): Collection;
 
+    /**
+     * @return void
+     */
     public function removeAdjustmentsRecursively(?string $type = null): void;
 
     public function getAdjustmentsTotalRecursively(?string $type = null): int;