pamil / Sylius

src/Sylius/Component/Core/Model/ImageInterface.php

Doc Comments +20 added lines

@@ -22,16 +22,35 @@ 
      */
     public function getType(): ?string;
 
+    /**
+     * @return void
+     */
     public function setType(?string $type): void;
 
+    /**
+     * @return \SplFileInfo|null
+     */
     public function getFile(): ?\SplFileInfo;
 
+    /**
+     * @param \Symfony\Component\HttpFoundation\File\UploadedFile $file
+     *
+     * @return void
+     */
     public function setFile(?\SplFileInfo $file): void;
 
     public function hasFile(): bool;
 
+    /**
+     * @return string|null
+     */
     public function getPath(): ?string;
 
+    /**
+     * @param string $path
+     *
+     * @return void
+     */
     public function setPath(?string $path): void;
 
     /**
@@ -41,6 +60,7 @@ 
 
     /**
      * @param object|null $owner
+     * @return void
      */
     public function setOwner($owner): void;
 }

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

Doc Comments +75 added lines

@@ -32,22 +32,51 @@ 
     CustomerAwareInterface,
     ChannelAwareInterface
 {
+    /**
+     * @return null|UserInterface
+     */
     public function getUser(): ?UserInterface;
 
+    /**
+     * @return AddressInterface|null
+     */
     public function getShippingAddress(): ?AddressInterface;
 
+    /**
+     * @return void
+     */
     public function setShippingAddress(?AddressInterface $address): void;
 
+    /**
+     * @return AddressInterface|null
+     */
     public function getBillingAddress(): ?AddressInterface;
 
+    /**
+     * @param AddressInterface $address
+     *
+     * @return void
+     */
     public function setBillingAddress(?AddressInterface $address): void;
 
+    /**
+     * @return string
+     */
     public function getCheckoutState(): ?string;
 
+    /**
+     * @return void
+     */
     public function setCheckoutState(?string $checkoutState): void;
 
+    /**
+     * @return string
+     */
     public function getPaymentState(): ?string;
 
+    /**
+     * @return void
+     */
     public function setPaymentState(?string $paymentState): void;
 
     /**
@@ -75,26 +104,58 @@ 
 
     public function hasShipments(): bool;
 
+    /**
+     * @return void
+     */
     public function addShipment(ShipmentInterface $shipment): void;
 
+    /**
+     * @return void
+     */
     public function removeShipment(ShipmentInterface $shipment): void;
 
+    /**
+     * @return void
+     */
     public function removeShipments(): void;
 
     public function hasShipment(ShipmentInterface $shipment): bool;
 
+    /**
+     * @return string|null
+     */
     public function getCurrencyCode(): ?string;
 
+    /**
+     * @return void
+     */
     public function setCurrencyCode(?string $currencyCode): void;
 
+    /**
+     * @return string|null
+     */
     public function getLocaleCode(): ?string;
 
+    /**
+     * @return void
+     */
     public function setLocaleCode(?string $localeCode): void;
 
+    /**
+     * @param PromotionCouponInterface $coupon
+     *
+     * @return void
+     */
     public function setPromotionCoupon(?BaseCouponInterface $coupon): void;
 
+    /**
+     * @return string
+     */
     public function getShippingState(): ?string;
 
+    /**
+     * @return void
+     */
     public function setShippingState(?string $state): void;
 
     public function getLastPayment(?string $state = null): ?PaymentInterface;
@@ -105,12 +166,26 @@ 
 
     public function getOrderPromotionTotal(): int;
 
+    /**
+     * @return string|null
+     */
     public function getTokenValue(): ?string;
 
+    /**
+     * @return void
+     */
     public function setTokenValue(?string $tokenValue): void;
 
+    /**
+     * @return string|null
+     */
     public function getCustomerIp(): ?string;
 
+    /**
+     * @param string|null $customerIp
+     *
+     * @return void
+     */
     public function setCustomerIp(?string $customerIp): void;
 
     /**

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

Doc Comments +11 added lines, -1 removed lines

@@ -18,22 +18,32 @@
 interface AdjustableInterface
 {
     /**
-     * @return AdjustmentInterface[]
+     * @return Collection
      *
      * @psalm-return Collection<array-key, 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;
 }

src/Sylius/Component/Product/Model/ProductOptionValueInterface.php

Doc Comments +14 added lines

@@ -20,16 +20,30 @@
 
 interface ProductOptionValueInterface extends ResourceInterface, CodeAwareInterface, TranslatableInterface
 {
+    /**
+     * @return ProductOptionInterface|null
+     */
     public function getOption(): ?ProductOptionInterface;
 
+    /**
+     * @param ProductOptionInterface|null $option
+     *
+     * @return void
+     */
     public function setOption(?ProductOptionInterface $option): void;
 
     public function getValue(): ?string;
 
+    /**
+     * @return void
+     */
     public function setValue(?string $value): void;
 
     public function getOptionCode(): ?string;
 
+    /**
+     * @return string
+     */
     public function getName(): ?string;
 
     /**

src/Sylius/Component/User/Model/UserAwareInterface.php

Doc Comments +8 added lines

@@ -15,7 +15,15 @@
 
 interface UserAwareInterface
 {
+    /**
+     * @return null|UserInterface
+     */
     public function getUser(): ?UserInterface;
 
+    /**
+     * @param null|User $user
+     *
+     * @return void
+     */
     public function setUser(?UserInterface $user);
 }

src/Sylius/Behat/Page/Shop/Checkout/CompletePageInterface.php

Doc Comments +15 added lines

@@ -38,6 +38,9 @@ 
 
     public function hasShippingMethod(ShippingMethodInterface $shippingMethod): bool;
 
+    /**
+     * @return void
+     */
     public function addNotes(string $notes): void;
 
     public function hasPromotionTotal(string $promotionTotal): bool;
@@ -62,12 +65,24 @@ 
 
     public function hasCurrency(string $currencyCode): bool;
 
+    /**
+     * @return void
+     */
     public function confirmOrder(): void;
 
+    /**
+     * @return void
+     */
     public function changeAddress(): void;
 
+    /**
+     * @return void
+     */
     public function changeShippingMethod(): void;
 
+    /**
+     * @return void
+     */
     public function changePaymentMethod(): void;
 
     public function hasShippingProvinceName(string $provinceName): bool;

src/Sylius/Behat/Page/Shop/Checkout/SelectPaymentPageInterface.php

Doc Comments +15 added lines

@@ -17,18 +17,33 @@
 
 interface SelectPaymentPageInterface extends SymfonyPageInterface
 {
+    /**
+     * @return void
+     */
     public function selectPaymentMethod(string $paymentMethod): void;
 
     public function hasPaymentMethod(string $paymentMethodName): bool;
 
     public function getItemSubtotal(string $itemName): string;
 
+    /**
+     * @return void
+     */
     public function nextStep(): void;
 
+    /**
+     * @return void
+     */
     public function changeShippingMethod(): void;
 
+    /**
+     * @return void
+     */
     public function changeShippingMethodByStepLabel(): void;
 
+    /**
+     * @return void
+     */
     public function changeAddressByStepLabel(): void;
 
     public function hasNoAvailablePaymentMethodsWarning(): bool;

src/Sylius/Behat/Page/Shop/Checkout/SelectShippingPageInterface.php

Doc Comments +12 added lines

@@ -17,6 +17,9 @@ 
 
 interface SelectShippingPageInterface extends SymfonyPageInterface
 {
+    /**
+     * @return void
+     */
     public function selectShippingMethod(string $shippingMethod): void;
 
     public function getShippingMethods(): array;
@@ -29,10 +32,19 @@ 
 
     public function getItemSubtotal(string $itemName): string;
 
+    /**
+     * @return void
+     */
     public function nextStep(): void;
 
+    /**
+     * @return void
+     */
     public function changeAddress(): void;
 
+    /**
+     * @return void
+     */
     public function changeAddressByStepLabel(): void;
 
     public function getPurchaserEmail(): string;

src/Sylius/Behat/Page/Shop/Checkout/AddressPageInterface.php

Doc Comments +45 added lines

@@ -18,48 +18,93 @@
 
 interface AddressPageInterface extends SymfonyPageInterface
 {
+    /**
+     * @return void
+     */
     public function chooseDifferentBillingAddress(): void;
 
     public function checkInvalidCredentialsValidation(): bool;
 
     public function checkValidationMessageFor(string $element, string $message): bool;
 
+    /**
+     * @return void
+     */
     public function specifyShippingAddress(AddressInterface $shippingAddress): void;
 
+    /**
+     * @return void
+     */
     public function selectShippingAddressProvince(string $province): void;
 
+    /**
+     * @return void
+     */
     public function specifyBillingAddress(AddressInterface $billingAddress): void;
 
+    /**
+     * @return void
+     */
     public function selectBillingAddressProvince(string $province): void;
 
+    /**
+     * @return void
+     */
     public function specifyEmail(?string $email): void;
 
+    /**
+     * @return void
+     */
     public function specifyShippingAddressFullName(string $fullName): void;
 
     public function canSignIn(): bool;
 
+    /**
+     * @return void
+     */
     public function signIn(): void;
 
+    /**
+     * @return void
+     */
     public function specifyPassword(string $password): void;
 
     public function getItemSubtotal(string $itemName): string;
 
     public function getShippingAddressCountry(): string;
 
+    /**
+     * @return void
+     */
     public function nextStep(): void;
 
+    /**
+     * @return void
+     */
     public function backToStore(): void;
 
+    /**
+     * @return void
+     */
     public function specifyBillingAddressProvince(string $provinceName): void;
 
+    /**
+     * @return void
+     */
     public function specifyShippingAddressProvince(string $provinceName): void;
 
     public function hasShippingAddressInput(): bool;
 
     public function hasBillingAddressInput(): bool;
 
+    /**
+     * @return void
+     */
     public function selectShippingAddressFromAddressBook(AddressInterface $address): void;
 
+    /**
+     * @return void
+     */
     public function selectBillingAddressFromAddressBook(AddressInterface $address): void;
 
     public function getPreFilledShippingAddress(): AddressInterface;