pamil / Sylius

src/Sylius/Component/Attribute/Model/AttributeValueInterface.php

Doc Comments +29 added lines

@@ -31,28 +31,57 @@
 
     public const STORAGE_TEXT = 'text';
 
+    /**
+     * @return AttributeSubjectInterface
+     */
     public function getSubject(): ?AttributeSubjectInterface;
 
+    /**
+     * @return void
+     */
     public function setSubject(?AttributeSubjectInterface $subject): void;
 
+    /**
+     * @return AttributeInterface
+     */
     public function getAttribute(): ?AttributeInterface;
 
+    /**
+     * @param \Sylius\Component\Product\Model\ProductAttributeInterface $attribute
+     *
+     * @return void
+     */
     public function setAttribute(?AttributeInterface $attribute): void;
 
     public function getValue();
 
+    /**
+     * @return void
+     */
     public function setValue($value): void;
 
+    /**
+     * @return string
+     */
     public function getCode(): ?string;
 
     public function getName(): ?string;
 
+    /**
+     * @return string
+     */
     public function getType(): ?string;
 
     /**
      * @throws \InvalidArgumentException
+     * @return string
      */
     public function getLocaleCode(): ?string;
 
+    /**
+     * @param string $localeCode
+     *
+     * @return void
+     */
     public function setLocaleCode(?string $localeCode): void;
 }

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

Doc Comments +44 added lines

@@ -24,35 +24,64 @@ 
 
     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;
 
@@ -60,15 +89,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/Order/Model/OrderInterface.php

Doc Comments +43 added lines

@@ -27,20 +27,45 @@ 
 
     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;
 
     /**
@@ -48,18 +73,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;
@@ -68,6 +105,9 @@ 
 
     public function getState(): string;
 
+    /**
+     * @return void
+     */
     public function setState(string $state): void;
 
     public function isEmpty(): bool;
@@ -79,5 +119,8 @@ 
 
     public function getAdjustmentsTotalRecursively(?string $type = null): int;
 
+    /**
+     * @return void
+     */
     public function removeAdjustmentsRecursively(?string $type = null): void;
 }

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

Doc Comments +38 added lines

@@ -24,27 +24,65 @@
 
     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

@@ -27,12 +27,24 @@ 
 
     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;
 
     /**
@@ -40,14 +52,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;