pamil / Sylius

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

Doc Comments +48 added lines

@@ -19,42 +19,90 @@
 
 interface CreateSimpleProductPageInterface extends BaseCreatePageInterface
 {
+    /**
+     * @return void
+     */
     public function specifyPrice(string $channelName, string $price): void;
 
+    /**
+     * @return void
+     */
     public function specifyOriginalPrice(string $channelName, 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;
 }

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

Doc Comments +51 added lines

@@ -25,43 +25,94 @@
     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;
 }

src/Sylius/Behat/Page/External/PaypalExpressCheckoutPageInterface.php

Doc Comments +3 added lines

@@ -22,18 +22,21 @@
     /**
      * @throws UnsupportedDriverActionException
      * @throws DriverException
+     * @return void
      */
     public function authorize();
     
     /**
      * @throws UnsupportedDriverActionException
      * @throws DriverException
+     * @return void
      */
     public function pay();
 
     /**
      * @throws UnsupportedDriverActionException
      * @throws DriverException
+     * @return void
      */
     public function cancel();
 }

src/Sylius/Behat/Context/Setup/ProductContext.php

Doc Comments +3 added lines

@@ -947,6 +947,9 @@
         $this->objectManager->flush();
     }
 
+    /**
+     * @param ProductVariantInterface $variant
+     */
     private function createProductImage(
         ProductInterface $product,
         string $imagePath,

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

Doc Comments +11 added lines

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

src/Sylius/Behat/Context/Transform/TaxonContext.php

Doc Comments +1 added lines

@@ -37,6 +37,7 @@
      * @Transform /^taxon with "([^"]+)" name/
      * @Transform /^taxon "([^"]+)"$/
      * @Transform :taxon
+     * @param string $name
      */
     public function getTaxonByName($name)
     {

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

Doc Comments +27 added lines

@@ -17,26 +17,50 @@ 
 
 interface UpdatePageInterface extends BaseUpdatePageInterface
 {
+    /**
+     * @return void
+     */
     public function setPriority(?int $priority): void;
 
     public function getPriority(): int;
 
+    /**
+     * @return void
+     */
     public function nameIt(string $name): void;
 
     public function checkChannelsState(string $channelName): bool;
 
     public function isCodeDisabled(): bool;
 
+    /**
+     * @return void
+     */
     public function fillUsageLimit(string $limit): void;
 
+    /**
+     * @return void
+     */
     public function makeExclusive(): void;
 
+    /**
+     * @return void
+     */
     public function checkCouponBased(): void;
 
+    /**
+     * @return void
+     */
     public function checkChannel(string $name): void;
 
+    /**
+     * @return void
+     */
     public function setStartsAt(\DateTimeInterface $dateTime): void;
 
+    /**
+     * @return void
+     */
     public function setEndsAt(\DateTimeInterface $dateTime): void;
 
     public function hasStartsAt(\DateTimeInterface $dateTime): bool;
@@ -45,6 +69,9 @@ 
 
     public function isCouponManagementAvailable(): bool;
 
+    /**
+     * @return void
+     */
     public function manageCoupons(): void;
 
     public function hasAnyRule(): bool;

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

Doc Comments +6 added lines

@@ -17,9 +17,15 @@
 
 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;
 }

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

Doc Comments +51 added lines

@@ -30,24 +30,66 @@ 
     VersionedInterface,
     ProductImagesAwareInterface
 {
+    /**
+     * @return double
+     */
     public function getWeight(): ?float;
 
+    /**
+     * @param double $weight
+     *
+     * @return void
+     */
     public function setWeight(?float $weight): void;
 
+    /**
+     * @return double
+     */
     public function getWidth(): ?float;
 
+    /**
+     * @param double $width
+     *
+     * @return void
+     */
     public function setWidth(?float $width): void;
 
+    /**
+     * @return double
+     */
     public function getHeight(): ?float;
 
+    /**
+     * @param double $height
+     *
+     * @return void
+     */
     public function setHeight(?float $height): void;
 
+    /**
+     * @return double
+     */
     public function getDepth(): ?float;
 
+    /**
+     * @param double $depth
+     *
+     * @return void
+     */
     public function setDepth(?float $depth): void;
 
+    /**
+     * @param TaxCategoryInterface $category
+     *
+     * @return void
+     */
     public function setTaxCategory(?TaxCategoryInterface $category): void;
 
+    /**
+     * @param ShippingCategoryInterface $shippingCategory
+     *
+     * @return void
+     */
     public function setShippingCategory(?ShippingCategoryInterface $shippingCategory): void;
 
     /**
@@ -61,11 +103,20 @@ 
 
     public function hasChannelPricing(ChannelPricingInterface $channelPricing): bool;
 
+    /**
+     * @return void
+     */
     public function addChannelPricing(ChannelPricingInterface $channelPricing): void;
 
+    /**
+     * @return void
+     */
     public function removeChannelPricing(ChannelPricingInterface $channelPricing): void;
 
     public function isShippingRequired(): bool;
 
+    /**
+     * @return void
+     */
     public function setShippingRequired(bool $shippingRequired): void;
 }