pamil / Sylius

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

Doc Comments +9 added lines

@@ -17,11 +17,20 @@
 
 interface PromotionCouponInterface extends BasePromotionCouponInterface
 {
+    /**
+     * @return integer|null
+     */
     public function getPerCustomerUsageLimit(): ?int;
 
+    /**
+     * @return void
+     */
     public function setPerCustomerUsageLimit(?int $perCustomerUsageLimit): void;
 
     public function isReusableFromCancelledOrders(): bool;
 
+    /**
+     * @return void
+     */
     public function setReusableFromCancelledOrders(bool $reusableFromCancelledOrders): void;
 }

src/Sylius/Behat/Client/ApiClientInterface.php

Doc Comments +22 added lines, -1 removed lines

@@ -44,27 +44,48 @@
 
     public function upload(): Response;
 
+    /**
+     * @return void
+     */
     public function buildCreateRequest(): void;
 
+    /**
+     * @return void
+     */
     public function buildUpdateRequest(string $id): void;
 
+    /**
+     * @return void
+     */
     public function buildUploadRequest(): void;
 
-    /** @param string|int $value */
+    /** @param string $value */
     public function addParameter(string $key, $value): void;
 
     /** @param string|int $value */
     public function addFilter(string $key, $value): void;
 
+    /**
+     * @return void
+     */
     public function addFile(string $key, UploadedFile $file): void;
 
     /** @param string|int|array $value */
     public function addRequestData(string $key, $value): void;
 
+    /**
+     * @return void
+     */
     public function addSubResourceData(string $key, array $data): void;
 
+    /**
+     * @return void
+     */
     public function removeSubResource(string $subResource, string $id): void;
 
+    /**
+     * @return void
+     */
     public function updateRequestData(array $data): void;
 
     public function getLastResponse(): Response;

src/Sylius/Bundle/ApiBundle/Context/UserContextInterface.php

Doc Comments +3 added lines

@@ -17,5 +17,8 @@
 
 interface UserContextInterface
 {
+    /**
+     * @return null|UserInterface
+     */
     public function getUser(): ?UserInterface;
 }

src/Sylius/Bundle/CoreBundle/Fixture/Factory/PromotionExampleFactory.php

Doc Comments +3 added lines

@@ -164,6 +164,9 @@
         ;
     }
 
+    /**
+     * @param FactoryInterface|null $couponFactory
+     */
     private static function getCouponNormalizer(?FactoryInterface $couponFactory): \Closure
     {
         return function (Options $options, array $couponDefinitions) use ($couponFactory): array {

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

Doc Comments +12 added lines

@@ -18,13 +18,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(string $channelName, string $price): void;
 
+    /**
+     * @return void
+     */
     public function specifyOriginalPrice(string $channelName, 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(string $channelName): string;
@@ -95,23 +145,44 @@ 
 
     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;
 }

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

Doc Comments +27 added lines

@@ -19,8 +19,14 @@ 
 
 interface UpdatePageInterface extends BaseUpdatePageInterface
 {
+    /**
+     * @return void
+     */
     public function disableTracking(): void;
 
+    /**
+     * @return void
+     */
     public function enableTracking(): void;
 
     public function isCodeDisabled(): bool;
@@ -39,21 +45,42 @@ 
 
     public function getNameInLanguage(string $language): string;
 
+    /**
+     * @return void
+     */
     public function selectOption(string $optionName, string $optionValue): void;
 
     public function isShowInShopButtonDisabled(): bool;
 
+    /**
+     * @return void
+     */
     public function showProductInChannel(string $channel): void;
 
+    /**
+     * @return void
+     */
     public function showProductInSingleChannel(): void;
 
+    /**
+     * @return void
+     */
     public function specifyCurrentStock(int $amount): void;
 
+    /**
+     * @return void
+     */
     public function specifyPrice(int $price): void;
 
+    /**
+     * @return void
+     */
     public function disable(): void;
 
     public function isEnabled(): bool;
 
+    /**
+     * @return void
+     */
     public function enable(): void;
 }

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

Doc Comments +16 added lines

@@ -22,24 +22,31 @@ 
 {
     /**
      * @throws ElementNotFoundException
+     * @return void
      */
     public function addToCart(): void;
 
     /**
      * @throws ElementNotFoundException
+     * @return void
      */
     public function addToCartWithQuantity(string $quantity): void;
 
     /**
      * @throws ElementNotFoundException
+     * @return void
      */
     public function addToCartWithVariant(string $variant): void;
 
     /**
      * @throws ElementNotFoundException
+     * @return void
      */
     public function addToCartWithOption(ProductOptionInterface $option, string $optionValue): void;
 
+    /**
+     * @return null|string
+     */
     public function getAttributeByName(string $name): ?string;
 
     public function getAttributes(): array;
@@ -72,10 +79,19 @@ 
 
     public function countReviews(): int;
 
+    /**
+     * @return void
+     */
     public function selectOption(string $optionCode, string $optionValue): void;
 
+    /**
+     * @return void
+     */
     public function selectVariant(string $variantName): void;
 
+    /**
+     * @return void
+     */
     public function visit(string $url): void;
 
     public function getVariantsNames(): array;

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

Doc Comments +27 added lines

@@ -28,8 +28,14 @@ 
     ToggleableInterface,
     TranslatableInterface
 {
+    /**
+     * @return string
+     */
     public function getName(): ?string;
 
+    /**
+     * @return void
+     */
     public function setName(?string $name): void;
 
     public function getDescriptor(): string;
@@ -41,21 +47,42 @@ 
      */
     public function getOptionValues(): Collection;
 
+    /**
+     * @return void
+     */
     public function addOptionValue(ProductOptionValueInterface $optionValue): void;
 
+    /**
+     * @return void
+     */
     public function removeOptionValue(ProductOptionValueInterface $optionValue): void;
 
     public function hasOptionValue(ProductOptionValueInterface $optionValue): bool;
 
+    /**
+     * @return ProductInterface
+     */
     public function getProduct(): ?ProductInterface;
 
+    /**
+     * @return void
+     */
     public function setProduct(?ProductInterface $product): void;
 
+    /**
+     * @return integer
+     */
     public function getPosition(): ?int;
 
+    /**
+     * @param integer $position
+     *
+     * @return void
+     */
     public function setPosition(?int $position): void;
 
     /**
+     * @param string $locale
      * @return ProductVariantTranslationInterface
      */
     public function getTranslation(?string $locale = null): TranslationInterface;