pamil / Sylius

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

Doc Comments +56 added lines

@@ -17,42 +17,98 @@
 
 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 setContactPhoneNumber(string $contactPhoneNumber): 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;
 
+    /**
+     * @param null|string $locale
+     *
+     * @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/Customer/UpdatePageInterface.php

Doc Comments +24 added lines

@@ -17,31 +17,55 @@
 
 interface UpdatePageInterface extends BaseUpdatePageInterface
 {
+    /**
+     * @return void
+     */
     public function enable(): void;
 
+    /**
+     * @return void
+     */
     public function disable(): void;
 
     public function getFullName(): string;
 
+    /**
+     * @return void
+     */
     public function changeFirstName(string $firstName): void;
 
     public function getFirstName(): string;
 
+    /**
+     * @return void
+     */
     public function changeLastName(string $lastName): void;
 
     public function getLastName(): string;
 
+    /**
+     * @return void
+     */
     public function changeEmail(string $email): void;
 
+    /**
+     * @return void
+     */
     public function changePassword(string $password): void;
 
     public function getPassword(): string;
 
+    /**
+     * @return void
+     */
     public function subscribeToTheNewsletter(): void;
 
     public function isSubscribedToTheNewsletter(): bool;
 
     public function getGroupName(): string;
 
+    /**
+     * @return void
+     */
     public function verifyUser(): void;
 }

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

Doc Comments +21 added lines

@@ -17,17 +17,38 @@
 
 interface IndexPageInterface extends BaseIndexPageInterface
 {
+    /**
+     * @return void
+     */
     public function specifyFilterDateFrom(string $dateTime): void;
 
+    /**
+     * @return void
+     */
     public function specifyFilterDateTo(string $dateTime): void;
 
+    /**
+     * @return void
+     */
     public function chooseChannelFilter(string $channelName): void;
 
+    /**
+     * @return void
+     */
     public function chooseShippingMethodFilter(string $methodName): void;
 
+    /**
+     * @return void
+     */
     public function chooseCurrencyFilter(string $currencyName): void;
 
+    /**
+     * @return void
+     */
     public function specifyFilterTotalGreaterThan(string $total): void;
 
+    /**
+     * @return void
+     */
     public function specifyFilterTotalLessThan(string $total): void;
 }

src/Sylius/Behat/Page/Admin/Product/CreateSimpleProductPageInterface.php

Doc Comments +48 added lines

@@ -20,43 +20,91 @@
 
 interface CreateSimpleProductPageInterface extends BaseCreatePageInterface
 {
+    /**
+     * @return void
+     */
     public function specifyPrice(ChannelInterface $channel, string $price): void;
 
+    /**
+     * @return void
+     */
     public function specifyOriginalPrice(ChannelInterface $channel, int $originalPrice): void;
 
+    /**
+     * @return void
+     */
     public function choosePricingCalculator(string $name): void;
 
+    /**
+     * @return void
+     */
     public function checkChannel(string $channelName): void;
 
+    /**
+     * @return void
+     */
     public function specifyCode(string $code): void;
 
+    /**
+     * @return void
+     */
     public function nameItIn(string $name, string $localeCode): void;
 
+    /**
+     * @return void
+     */
     public function specifySlugIn(?string $slug, string $locale): void;
 
+    /**
+     * @return void
+     */
     public function addAttribute(string $attributeName, string $value, string $localeCode): void;
 
     public function getAttributeValidationErrors(string $attributeName, string $localeCode): string;
 
+    /**
+     * @return void
+     */
     public function removeAttribute(string $attributeName, string $localeCode): void;
 
     public function isMainTaxonChosen(string $taxonName): bool;
 
+    /**
+     * @return void
+     */
     public function selectMainTaxon(TaxonInterface $taxon): void;
 
+    /**
+     * @param string $type
+     *
+     * @return void
+     */
     public function attachImage(string $path, ?string $type = null): void;
 
     /**
      * @param string[] $productsNames
+     * @return void
      */
     public function associateProducts(ProductAssociationTypeInterface $productAssociationType, array $productsNames): void;
 
+    /**
+     * @return void
+     */
     public function removeAssociatedProduct(string $productName, ProductAssociationTypeInterface $productAssociationType): void;
 
+    /**
+     * @return void
+     */
     public function activateLanguageTab(string $locale): void;
 
+    /**
+     * @return void
+     */
     public function selectShippingCategory(string $shippingCategoryName): void;
 
+    /**
+     * @return void
+     */
     public function setShippingRequired(bool $isShippingRequired): void;
 
     public function getChannelPricingValidationMessage(): string;

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

Doc Comments +12 added lines

@@ -17,13 +17,25 @@
 
 interface IndexPageInterface extends CrudIndexPageInterface
 {
+    /**
+     * @return void
+     */
     public function filterByTaxon(string $taxonName): void;
 
     public function hasProductAccessibleImage(string $productCode): bool;
 
+    /**
+     * @return void
+     */
     public function showProductPage(string $productName): void;
 
+    /**
+     * @return void
+     */
     public function chooseChannelFilter(string $channelName): void;
 
+    /**
+     * @return void
+     */
     public function filter(): void;
 }

src/Sylius/Behat/Page/Admin/Product/UpdateSimpleProductPageInterface.php

Doc Comments +71 added lines

@@ -25,14 +25,29 @@ 
 
     public function isSlugReadonlyIn(string $locale): bool;
 
+    /**
+     * @return void
+     */
     public function specifyPrice(ChannelInterface $channel, string $price): void;
 
+    /**
+     * @return void
+     */
     public function specifyOriginalPrice(ChannelInterface $channel, string $originalPrice): void;
 
+    /**
+     * @return void
+     */
     public function nameItIn(string $name, string $localeCode): void;
 
+    /**
+     * @return void
+     */
     public function addSelectedAttributes(): void;
 
+    /**
+     * @return void
+     */
     public function removeAttribute(string $attributeName, string $localeCode): void;
 
     public function getAttributeValue(string $attributeName, string $localeCode): string;
@@ -45,48 +60,83 @@ 
 
     public function isMainTaxonChosen(string $taxonName): bool;
 
+    /**
+     * @return void
+     */
     public function selectMainTaxon(TaxonInterface $taxon): void;
 
+    /**
+     * @return void
+     */
     public function disableTracking(): void;
 
+    /**
+     * @return void
+     */
     public function enableTracking(): void;
 
     public function isTracked(): bool;
 
+    /**
+     * @return void
+     */
     public function enableSlugModification(string $locale): void;
 
     public function isImageWithTypeDisplayed(string $type): bool;
 
     /**
      * @param string $type
+     * @return void
      */
     public function attachImage(string $path, string $type = null): void;
 
+    /**
+     * @return void
+     */
     public function changeImageWithType(string $type, string $path): void;
 
+    /**
+     * @return void
+     */
     public function removeImageWithType(string $type): void;
 
+    /**
+     * @return void
+     */
     public function removeFirstImage(): void;
 
+    /**
+     * @return void
+     */
     public function modifyFirstImageType(string $type): void;
 
     public function countImages(): int;
 
     /**
      * @param string[] $productsNames
+     * @return void
      */
     public function associateProducts(ProductAssociationTypeInterface $productAssociationType, array $productsNames): void;
 
     public function hasAssociatedProduct(string $productName, ProductAssociationTypeInterface $productAssociationType): bool;
 
+    /**
+     * @return void
+     */
     public function removeAssociatedProduct(string $productName, ProductAssociationTypeInterface $productAssociationType): void;
 
     public function getPricingConfigurationForChannelAndCurrencyCalculator(ChannelInterface $channel, CurrencyInterface $currency): string;
 
+    /**
+     * @return void
+     */
     public function activateLanguageTab(string $locale): void;
 
     public function getSlug(string $locale): string;
 
+    /**
+     * @return void
+     */
     public function specifySlugIn(string $slug, string $locale): void;
 
     public function getPriceForChannel(ChannelInterface $channel): string;
@@ -95,24 +145,45 @@ 
 
     public function isShippingRequired(): bool;
 
+    /**
+     * @return void
+     */
     public function goToVariantsList(): void;
 
+    /**
+     * @return void
+     */
     public function goToVariantCreation(): void;
 
+    /**
+     * @return void
+     */
     public function goToVariantGeneration(): void;
 
     public function hasInventoryTab(): bool;
 
     public function isShowInShopButtonDisabled(): bool;
 
+    /**
+     * @return void
+     */
     public function showProductInChannel(string $channel): void;
 
+    /**
+     * @return void
+     */
     public function showProductInSingleChannel(): void;
 
+    /**
+     * @return void
+     */
     public function disable(): void;
 
     public function isEnabled(): bool;
 
+    /**
+     * @return void
+     */
     public function enable(): void;
 
     public function hasNoPriceForChannel(string $channelName): bool;

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

Doc Comments +30 added lines

@@ -18,27 +18,57 @@
 
 interface CreatePageInterface extends BaseCreatePageInterface
 {
+    /**
+     * @return void
+     */
     public function specifyPrice(string $price, ChannelInterface $channelName): void;
 
+    /**
+     * @return void
+     */
     public function specifyOriginalPrice(string $originalPrice, ChannelInterface $channelName): void;
 
+    /**
+     * @return void
+     */
     public function specifyHeightWidthDepthAndWeight(string $height, string $width, string $depth, string $weight): void;
 
+    /**
+     * @return void
+     */
     public function specifyCode(string $code): void;
 
+    /**
+     * @return void
+     */
     public function specifyCurrentStock(string $currentStock): void;
 
+    /**
+     * @return void
+     */
     public function nameItIn(string $name, string $language): void;
 
+    /**
+     * @return void
+     */
     public function selectOption(string $optionName, string $optionValue): void;
 
+    /**
+     * @return void
+     */
     public function choosePricingCalculator(string $name): void;
 
     public function getValidationMessageForForm(): string;
 
+    /**
+     * @return void
+     */
     public function selectShippingCategory(string $shippingCategoryName): void;
 
     public function getPricesValidationMessage(): string;
 
+    /**
+     * @return void
+     */
     public function setShippingRequired(bool $isShippingRequired): void;
 }

src/Sylius/Behat/Page/Admin/ProductVariant/GeneratePageInterface.php

Doc Comments +12 added lines

@@ -18,12 +18,24 @@
 
 interface GeneratePageInterface extends SymfonyPageInterface
 {
+    /**
+     * @return void
+     */
     public function generate(): void;
 
+    /**
+     * @return void
+     */
     public function specifyPrice(int $nth, int $price, ChannelInterface $channel): void;
 
+    /**
+     * @return void
+     */
     public function specifyCode(int $nth, string $code): void;
 
+    /**
+     * @return void
+     */
     public function removeVariant(int $nth): void;
 
     public function getValidationMessage(string $element, int $position): string;

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

Doc Comments +18 added lines

@@ -17,20 +17,38 @@
 
 interface IndexPageInterface extends BaseIndexPageInterface
 {
+    /**
+     * @return void
+     */
     public function chooseStateToFilter(string $shipmentState): void;
 
+    /**
+     * @return void
+     */
     public function chooseChannelFilter(string $channelName): void;
 
+    /**
+     * @return void
+     */
     public function chooseShippingMethodFilter(string $shippingMethodName): 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;