pamil / Sylius

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;

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;

src/Sylius/Behat/Page/Admin/Channel/CreatePageInterface.php

Doc Comments +51 added lines

@@ -17,40 +17,91 @@
 
 interface CreatePageInterface extends BaseCreatePageInterface
 {
+    /**
+     * @return void
+     */
     public function enable(): void;
 
+    /**
+     * @return void
+     */
     public function disable(): void;
 
+    /**
+     * @return void
+     */
     public function nameIt(string $name): void;
 
+    /**
+     * @return void
+     */
     public function specifyCode(string $code): void;
 
+    /**
+     * @return void
+     */
     public function describeItAs(string $description): void;
 
+    /**
+     * @return void
+     */
     public function setHostname(string $hostname): void;
 
+    /**
+     * @return void
+     */
     public function setContactEmail(string $contactEmail): void;
 
+    /**
+     * @return void
+     */
     public function defineColor(string $color): void;
 
+    /**
+     * @return void
+     */
     public function chooseLocale(string $language): void;
 
+    /**
+     * @return void
+     */
     public function chooseCurrency(string $currencyCode): void;
 
+    /**
+     * @return void
+     */
     public function chooseDefaultTaxZone(string $taxZone): void;
 
+    /**
+     * @return void
+     */
     public function chooseDefaultLocale(?string $locale): void;
 
     /** @param string[] $countries */
     public function chooseOperatingCountries(array $countries): void;
 
+    /**
+     * @return void
+     */
     public function chooseBaseCurrency(?string $currency): void;
 
+    /**
+     * @return void
+     */
     public function chooseTaxCalculationStrategy(string $taxCalculationStrategy): void;
 
+    /**
+     * @return void
+     */
     public function allowToSkipShippingStep(): void;
 
+    /**
+     * @return void
+     */
     public function allowToSkipPaymentStep(): void;
 
+    /**
+     * @return void
+     */
     public function specifyMenuTaxon(string $menuTaxon): void;
 }

src/Sylius/Behat/Page/Admin/Channel/UpdatePageInterface.php

Doc Comments +25 added lines

@@ -18,23 +18,45 @@ 
 
 interface UpdatePageInterface extends BaseUpdatePageInterface
 {
+    /**
+     * @return void
+     */
     public function enable(): void;
 
+    /**
+     * @return void
+     */
     public function disable(): void;
 
+    /**
+     * @return void
+     */
     public function setTheme(string $themeName): void;
 
     /**
      * @throws ElementNotFoundException
+     * @return void
      */
     public function unsetTheme(): void;
 
+    /**
+     * @return void
+     */
     public function chooseLocale(string $language): void;
 
+    /**
+     * @return void
+     */
     public function chooseCurrency(string $currencyCode): void;
 
+    /**
+     * @return void
+     */
     public function chooseDefaultTaxZone(string $taxZone): void;
 
+    /**
+     * @return void
+     */
     public function chooseTaxCalculationStrategy(string $taxCalculationStrategy): void;
 
     public function isCodeDisabled(): bool;
@@ -51,6 +73,9 @@ 
 
     public function isBaseCurrencyDisabled(): bool;
 
+    /**
+     * @return void
+     */
     public function changeMenuTaxon(string $menuTaxon): void;
 
     public function getMenuTaxon(): string;

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

Doc Comments +24 added lines

@@ -28,18 +28,30 @@ 
 
     public function hasShipment(string $shippingMethodName): bool;
 
+    /**
+     * @return void
+     */
     public function specifyTrackingCode(string $code): void;
 
     public function canShipOrder(OrderInterface $order): bool;
 
+    /**
+     * @return void
+     */
     public function shipOrder(OrderInterface $order): void;
 
     public function hasPayment(string $paymentMethodName): bool;
 
     public function canCompleteOrderLastPayment(OrderInterface $order): bool;
 
+    /**
+     * @return void
+     */
     public function completeOrderLastPayment(OrderInterface $order): void;
 
+    /**
+     * @return void
+     */
     public function refundOrderLastPayment(OrderInterface $order): void;
 
     public function countItems(): int;
@@ -94,8 +106,14 @@ 
 
     public function getShippingState(): string;
 
+    /**
+     * @return void
+     */
     public function cancelOrder(): void;
 
+    /**
+     * @return void
+     */
     public function deleteOrder(): void;
 
     public function hasNote(string $note): bool;
@@ -116,8 +134,14 @@ 
 
     public function hasInformationAboutNoPayment(): bool;
 
+    /**
+     * @return void
+     */
     public function resendOrderConfirmationEmail(): void;
 
+    /**
+     * @return void
+     */
     public function resendShipmentConfirmationEmail(): void;
 
     public function getShippedAtDate(): string;

src/Sylius/Behat/Page/Admin/Shipment/IndexPageInterface.php

Doc Comments +15 added lines

@@ -17,18 +17,33 @@
 
 interface IndexPageInterface extends BaseIndexPageInterface
 {
+    /**
+     * @return void
+     */
     public function chooseStateToFilter(string $shipmentState): void;
 
+    /**
+     * @return void
+     */
     public function chooseChannelFilter(string $channelName): void;
 
     public function isShipmentWithOrderNumberInPosition(string $orderNumber, int $position): bool;
 
+    /**
+     * @return void
+     */
     public function shipShipmentOfOrderWithNumber(string $orderNumber): void;
 
     public function getShipmentStatusByOrderNumber(string $orderNumber): string;
 
+    /**
+     * @return void
+     */
     public function showOrderPageForNthShipment(int $position): void;
 
+    /**
+     * @return void
+     */
     public function shipShipmentOfOrderWithTrackingCode(string $orderNumber, string $trackingCode): void;
 
     public function getShippedAtDate(string $orderNumber): string;

src/Sylius/Behat/Page/Shop/Account/AddressBook/CreatePageInterface.php

Doc Comments +9 added lines

@@ -18,10 +18,19 @@
 
 interface CreatePageInterface extends SymfonyPageInterface
 {
+    /**
+     * @return void
+     */
     public function fillAddressData(AddressInterface $address): void;
 
+    /**
+     * @return void
+     */
     public function selectCountry(string $name): void;
 
+    /**
+     * @return void
+     */
     public function addAddress(): void;
 
     public function hasProvinceValidationMessage(): bool;