pamil / Sylius

src/Sylius/Behat/Page/Shop/Contact/ContactPageInterface.php

Doc Comments +9 added lines

@@ -17,10 +17,19 @@
 
 interface ContactPageInterface extends PageInterface
 {
+    /**
+     * @return void
+     */
     public function specifyEmail(?string $email): void;
 
+    /**
+     * @return void
+     */
     public function specifyMessage(?string $message): void;
 
+    /**
+     * @return void
+     */
     public function send(): void;
 
     public function getValidationMessageFor(string $element): string;

src/Sylius/Behat/Page/Shop/HomePageInterface.php

Doc Comments +9 added lines

@@ -21,6 +21,9 @@ 
 
     public function hasLogoutButton(): bool;
 
+    /**
+     * @return void
+     */
     public function logOut();
 
     public function getFullName(): string;
@@ -29,12 +32,18 @@ 
 
     public function getAvailableCurrencies(): array;
 
+    /**
+     * @return void
+     */
     public function switchCurrency(string $currencyCode): void;
 
     public function getActiveLocale(): string;
 
     public function getAvailableLocales(): array;
 
+    /**
+     * @return void
+     */
     public function switchLocale(string $localeCode): void;
 
     public function getLatestProductsNames(): array;

src/Sylius/Behat/Page/Shop/Order/ShowPageInterface.php

Doc Comments +6 added lines

@@ -19,8 +19,14 @@
 {
     public function hasPayAction(): bool;
 
+    /**
+     * @return void
+     */
     public function pay(): void;
 
+    /**
+     * @return void
+     */
     public function choosePaymentMethod(string $paymentMethodName): void;
 
     public function getNotifications(): array;

src/Sylius/Behat/Page/Shop/Order/ThankYouPageInterface.php

Doc Comments +9 added lines

@@ -17,8 +17,14 @@ 
 
 interface ThankYouPageInterface extends SymfonyPageInterface
 {
+    /**
+     * @return void
+     */
     public function goToTheChangePaymentMethodPage(): void;
 
+    /**
+     * @return void
+     */
     public function goToOrderDetailsInAccount(): void;
 
     public function hasThankYouMessage(): bool;
@@ -31,5 +37,8 @@ 
 
     public function hasRegistrationButton(): bool;
 
+    /**
+     * @return void
+     */
     public function createAccount(): void;
 }

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 chooseDifferentShippingAddress(): 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 specifyBillingAddressFullName(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;

tests/Controller/CheckoutApiTestCase.php

Upper-Lower-Casing +5 added lines, -5 removed lines

@@ -39,7 +39,7 @@ 
             "channel": "CHANNEL",
             "localeCode": "en_US"
         }
-EOT;
+eot;
 
         $this->client->request('POST', '/api/v1/carts/', [], [], static::$authorizedHeaderWithContentType, $data);
 
@@ -60,7 +60,7 @@ 
             "variant": "MUG_SW",
             "quantity": 1
         }
-EOT;
+eot;
 
         $this->client->request('POST', $url, [], [], static::$authorizedHeaderWithContentType, $data);
         $this->assertResponseCode($this->client->getResponse(), Response::HTTP_CREATED);
@@ -91,7 +91,7 @@ 
             },
             "differentShippingAddress": true
         }
-EOT;
+eot;
 
         $url = sprintf('/api/v1/checkouts/addressing/%d', $cartId);
         $this->client->request('PUT', $url, [], [], static::$authorizedHeaderWithContentType, $data);
@@ -116,7 +116,7 @@ 
                 }
             ]
         }
-EOT;
+eot;
 
         $this->client->request('PUT', $url, [], [], static::$authorizedHeaderWithContentType, $data);
         $this->assertResponseCode($this->client->getResponse(), Response::HTTP_NO_CONTENT);
@@ -140,7 +140,7 @@ 
                 }
             ]
         }
-EOT;
+eot;
 
         $this->client->request('PUT', $url, [], [], static::$authorizedHeaderWithContentType, $data);
         $this->assertResponseCode($this->client->getResponse(), Response::HTTP_NO_CONTENT);

tests/Controller/CheckoutAddressingApiTest.php

Upper-Lower-Casing +12 added lines, -12 removed lines

@@ -57,7 +57,7 @@ 
         {
             "differentShippingAddress": false
         }
-EOT;
+eot;
 
         $this->client->request('PUT', $this->getAddressingUrl($cartId), [], [], static::$authorizedHeaderWithContentType, $data);
 
@@ -90,7 +90,7 @@ 
             },
             "differentShippingAddress": false
         }
-EOT;
+eot;
 
         $this->client->request('PUT', $this->getAddressingUrl($cartId), [], [], static::$authorizedHeaderWithContentType, $data);
 
@@ -125,7 +125,7 @@ 
             },
             "differentBillingAddress": false
         }
-EOT;
+eot;
 
         $this->client->request('PUT', $this->getAddressingUrl($cartId), [], [], static::$authorizedHeaderWithContentType, $data);
 
@@ -159,7 +159,7 @@ 
             },
             "differentShippingAddress": true
         }
-EOT;
+eot;
 
         $this->client->request('PUT', $this->getAddressingUrl($cartId), [], [], static::$authorizedHeaderWithContentType, $data);
 
@@ -200,7 +200,7 @@ 
             },
             "differentShippingAddress": true
         }
-EOT;
+eot;
 
         $this->client->request('PUT', $this->getAddressingUrl($cartId), [], [], static::$authorizedHeaderWithContentType, $data);
 
@@ -248,7 +248,7 @@ 
             },
             "differentBillingAddress": true
         }
-EOT;
+eot;
 
         $this->client->request('PUT', $this->getAddressingUrl($cartId), [], [], static::$authorizedHeaderWithContentType, $data);
 
@@ -286,7 +286,7 @@ 
             },
             "differentShippingAddress": false
         }
-EOT;
+eot;
 
         $this->client->request('PUT', $this->getAddressingUrl($cartId), [], [], static::$authorizedHeaderWithContentType, $data);
 
@@ -303,7 +303,7 @@ 
             },
             "differentShippingAddress": false
         }
-EOT;
+eot;
 
         $this->client->request('PUT', $this->getAddressingUrl($cartId), [], [], static::$authorizedHeaderWithContentType, $newData);
 
@@ -336,7 +336,7 @@ 
             },
             "differentShippingAddress": false
         }
-EOT;
+eot;
 
         $this->client->request('PUT', $this->getAddressingUrl($cartId), [], [], static::$authorizedHeaderWithContentType, $addressData);
 
@@ -355,7 +355,7 @@ 
             },
             "differentShippingAddress": false
         }
-EOT;
+eot;
 
         $this->client->request('PUT', $this->getAddressingUrl($cartId), [], [], static::$authorizedHeaderWithContentType, $newAddressData);
 
@@ -388,7 +388,7 @@ 
             },
             "differentShippingAddress": false
         }
-EOT;
+eot;
 
         $this->client->request('PUT', $this->getAddressingUrl($cartId), [], [], static::$authorizedHeaderWithContentType, $addressData);
 
@@ -408,7 +408,7 @@ 
             },
             "differentShippingAddress": false
         }
-EOT;
+eot;
 
         $this->client->request('PUT', $this->getAddressingUrl($cartId), [], [], static::$authorizedHeaderWithContentType, $newAddressData);
 

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

Doc Comments +73 added lines

@@ -34,20 +34,46 @@ 
 {
     public function getUser(): ?UserInterface;
 
+    /**
+     * @return AddressInterface|null
+     */
     public function getShippingAddress(): ?AddressInterface;
 
+    /**
+     * @param AddressInterface $address
+     *
+     * @return void
+     */
     public function setShippingAddress(?AddressInterface $address): void;
 
+    /**
+     * @return AddressInterface|null
+     */
     public function getBillingAddress(): ?AddressInterface;
 
+    /**
+     * @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,28 +101,63 @@ 
 
     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;
 
+    /**
+     * @return PaymentInterface
+     */
     public function getLastPayment(?string $state = null): ?PaymentInterface;
 
     public function getTaxTotal(): int;
@@ -105,12 +166,24 @@ 
 
     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;
 
+    /**
+     * @return void
+     */
     public function setCustomerIp(?string $customerIp): void;
 
     /**

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

Doc Comments +65 added lines

@@ -27,48 +27,107 @@ 
     CurrenciesAwareInterface,
     LocalesAwareInterface
 {
+    /**
+     * @return CurrencyInterface
+     */
     public function getBaseCurrency(): ?CurrencyInterface;
 
+    /**
+     * @return void
+     */
     public function setBaseCurrency(?CurrencyInterface $currency): void;
 
+    /**
+     * @return LocaleInterface
+     */
     public function getDefaultLocale(): ?LocaleInterface;
 
+    /**
+     * @return void
+     */
     public function setDefaultLocale(?LocaleInterface $locale): void;
 
+    /**
+     * @return ZoneInterface
+     */
     public function getDefaultTaxZone(): ?ZoneInterface;
 
+    /**
+     * @return void
+     */
     public function setDefaultTaxZone(?ZoneInterface $defaultTaxZone): void;
 
+    /**
+     * @return string
+     */
     public function getTaxCalculationStrategy(): ?string;
 
+    /**
+     * @return void
+     */
     public function setTaxCalculationStrategy(?string $taxCalculationStrategy): void;
 
+    /**
+     * @return string
+     */
     public function getThemeName(): ?string;
 
+    /**
+     * @return void
+     */
     public function setThemeName(?string $themeName): void;
 
+    /**
+     * @return string
+     */
     public function getContactEmail(): ?string;
 
+    /**
+     * @return void
+     */
     public function setContactEmail(?string $contactEmail): void;
 
     public function isSkippingShippingStepAllowed(): bool;
 
+    /**
+     * @return void
+     */
     public function setSkippingShippingStepAllowed(bool $skippingShippingStepAllowed): void;
 
     public function isSkippingPaymentStepAllowed(): bool;
 
+    /**
+     * @return void
+     */
     public function setSkippingPaymentStepAllowed(bool $skippingPaymentStepAllowed): void;
 
     public function isAccountVerificationRequired(): bool;
 
+    /**
+     * @return void
+     */
     public function setAccountVerificationRequired(bool $accountVerificationRequired): void;
 
+    /**
+     * @return ShopBillingDataInterface|null
+     */
     public function getShopBillingData(): ?ShopBillingDataInterface;
 
+    /**
+     * @return void
+     */
     public function setShopBillingData(ShopBillingDataInterface $shopBillingData): void;
 
+    /**
+     * @return TaxonInterface|null
+     */
     public function getMenuTaxon(): ?TaxonInterface;
 
+    /**
+     * @param TaxonInterface $menuTaxon
+     *
+     * @return void
+     */
     public function setMenuTaxon(?TaxonInterface $menuTaxon): void;
 
     /**
@@ -78,8 +137,14 @@ 
      */
     public function getCountries(): Collection;
 
+    /**
+     * @return void
+     */
     public function addCountry(CountryInterface $country): void;
 
+    /**
+     * @return void
+     */
     public function removeCountry(CountryInterface $country): void;
 
     public function hasCountry(CountryInterface $country): bool;