pamil / Sylius

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;

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

Doc Comments +38 added lines

@@ -18,20 +18,46 @@ 
 
 interface CreatePageInterface extends BaseCreatePageInterface
 {
+    /**
+     * @return void
+     */
     public function specifyCode(string $code): void;
 
+    /**
+     * @param null|integer $position
+     *
+     * @return void
+     */
     public function specifyPosition(?int $position): void;
 
+    /**
+     * @return void
+     */
     public function nameIt(string $name, string $language): void;
 
+    /**
+     * @return void
+     */
     public function describeIt(string $description, string $languageCode): void;
 
+    /**
+     * @return void
+     */
     public function specifyAmountForChannel(string $channelCode, string $amount): void;
 
+    /**
+     * @return void
+     */
     public function chooseZone(string $name): void;
 
+    /**
+     * @return void
+     */
     public function chooseCalculator(string $name): void;
 
+    /**
+     * @return void
+     */
     public function checkChannel($channelName): void;
 
     /**
@@ -39,11 +65,23 @@ 
      */
     public function getValidationMessageForAmount(string $channelCode): string;
 
+    /**
+     * @return void
+     */
     public function addRule(string $ruleName): void;
 
+    /**
+     * @return void
+     */
     public function selectRuleOption(string $option, string $value, bool $multiple = false): void;
 
+    /**
+     * @return void
+     */
     public function fillRuleOption(string $option, string $value): void;
 
+    /**
+     * @return void
+     */
     public function fillRuleOptionForChannel(string $channelName, string $option, string $value): void;
 }

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

Doc Comments +37 added lines

@@ -19,18 +19,31 @@ 
 
 interface UpdatePageInterface extends BaseUpdatePageInterface
 {
+    /**
+     * @return void
+     */
     public function describeItAs(string $description, string $languageCode): void;
 
+    /**
+     * @return void
+     */
     public function chooseParent(TaxonInterface $taxon): void;
 
     public function isCodeDisabled(): bool;
 
+    /**
+     * @return void
+     */
     public function nameIt(string $name, string $languageCode): void;
 
+    /**
+     * @return void
+     */
     public function specifySlug(string $slug, string $languageCode): void;
 
     /**
      * @param string $type
+     * @return void
      */
     public function attachImage(string $path, string $type = null): void;
 
@@ -38,16 +51,31 @@ 
 
     public function isSlugReadonly(string $languageCode = 'en_US'): bool;
 
+    /**
+     * @return void
+     */
     public function removeImageWithType(string $type): void;
 
+    /**
+     * @return void
+     */
     public function removeFirstImage(): void;
 
+    /**
+     * @return void
+     */
     public function enableSlugModification(string $languageCode = 'en_US'): void;
 
     public function countImages(): int;
 
+    /**
+     * @return void
+     */
     public function changeImageWithType(string $type, string $path): void;
 
+    /**
+     * @return void
+     */
     public function modifyFirstImageType(string $type): void;
 
     public function getParent(): string;
@@ -64,10 +92,19 @@ 
      */
     public function getValidationMessageForImageAtPlace(int $place): string;
 
+    /**
+     * @return void
+     */
     public function activateLanguageTab(string $locale): void;
 
+    /**
+     * @return void
+     */
     public function enable(): void;
 
+    /**
+     * @return void
+     */
     public function disable(): void;
 
     public function isEnabled(): bool;

src/Sylius/Bundle/AdminBundle/Controller/DashboardController.php

Doc Comments +3 added lines

@@ -88,6 +88,9 @@
         );
     }
 
+    /**
+     * @return ChannelInterface
+     */
     private function findChannelByCodeOrFindFirst(?string $channelCode): ?ChannelInterface
     {
         if (null !== $channelCode) {

src/Sylius/Bundle/ApiBundle/Command/OrderTokenValueAwareInterface.php

Doc Comments +6 added lines

@@ -16,7 +16,13 @@
 /** @experimental */
 interface OrderTokenValueAwareInterface extends CommandAwareDataTransformerInterface
 {
+    /**
+     * @return string|null
+     */
     public function getOrderTokenValue(): ?string;
 
+    /**
+     * @return void
+     */
     public function setOrderTokenValue(?string $orderTokenValue): void;
 }

src/Sylius/Bundle/ApiBundle/Command/ShopUserIdAwareInterface.php

Doc Comments +3 added lines

@@ -9,5 +9,8 @@
 {
     public function getShopUserId();
 
+    /**
+     * @return void
+     */
     public function setShopUserId($shopUserId): void;
 }