pamil / Sylius

src/Sylius/Component/Order/Model/OrderAwareInterface.php

Doc Comments +3 added lines

@@ -17,5 +17,8 @@
 {
     public function getOrder(): ?OrderInterface;
 
+    /**
+     * @return void
+     */
     public function setOrder(?OrderInterface $order): void;
 }

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

Doc Comments +12 added lines

@@ -20,16 +20,28 @@
 
 interface ProductOptionValueInterface extends ResourceInterface, CodeAwareInterface, TranslatableInterface
 {
+    /**
+     * @return ProductOptionInterface
+     */
     public function getOption(): ?ProductOptionInterface;
 
+    /**
+     * @return void
+     */
     public function setOption(?ProductOptionInterface $option): void;
 
     public function getValue(): ?string;
 
+    /**
+     * @return void
+     */
     public function setValue(?string $value): void;
 
     public function getOptionCode(): ?string;
 
+    /**
+     * @return string
+     */
     public function getName(): ?string;
 
     /**

src/Sylius/Component/Shipping/Model/ShipmentUnitInterface.php

Doc Comments +3 added lines

@@ -20,6 +20,9 @@
 {
     public function getShipment(): ?ShipmentInterface;
 
+    /**
+     * @return void
+     */
     public function setShipment(?ShipmentInterface $shipment): void;
 
     public function getShippable(): ?ShippableInterface;

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

Doc Comments +18 added lines

@@ -17,16 +17,34 @@
 
 interface UpdatePageInterface extends BaseUpdatePageInterface
 {
+    /**
+     * @return void
+     */
     public function attachAvatar(string $path): void;
 
+    /**
+     * @return void
+     */
     public function changeUsername(string $username): void;
 
+    /**
+     * @return void
+     */
     public function changeEmail(string $email): void;
 
+    /**
+     * @return void
+     */
     public function changePassword(string $password): void;
 
+    /**
+     * @return void
+     */
     public function changeLocale(string $localeCode): void;
 
+    /**
+     * @return void
+     */
     public function removeAvatar(): void;
 
     public function hasAvatar(string $avatarPath): bool;

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

Doc Comments +65 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,17 +145,32 @@ 
 
     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;
 }

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

Doc Comments +21 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,15 +45,30 @@ 
 
     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;
 }

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

Doc Comments +23 added lines

@@ -17,12 +17,24 @@ 
 
 interface ChannelPricingInterface extends ResourceInterface
 {
+    /**
+     * @return ProductVariantInterface
+     */
     public function getProductVariant(): ?ProductVariantInterface;
 
+    /**
+     * @return void
+     */
     public function setProductVariant(?ProductVariantInterface $productVariant): void;
 
+    /**
+     * @return integer
+     */
     public function getPrice(): ?int;
 
+    /**
+     * @return void
+     */
     public function setPrice(?int $price): void;
 
     /**
@@ -30,10 +42,21 @@ 
      */
     public function getChannelCode(): ?string;
 
+    /**
+     * @return void
+     */
     public function setChannelCode(?string $channelCode): void;
 
+    /**
+     * @return integer
+     */
     public function getOriginalPrice(): ?int;
 
+    /**
+     * @param integer $originalPrice
+     *
+     * @return void
+     */
     public function setOriginalPrice(?int $originalPrice): void;
 
     public function isPriceReduced(): bool;

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

Doc Comments +1 added lines

@@ -126,6 +126,7 @@
      * @Given a customer :customer placed an order :orderNumber
      * @Given the customer :customer has already placed an order :orderNumber
      * @Given there is a customer :customer that placed an order :orderNumber in channel :channel
+     * @param string $orderNumber
      */
     public function thereIsCustomerThatPlacedOrder(CustomerInterface $customer, $orderNumber = null, $channel = null)
     {

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

Doc Comments +18 added lines

@@ -22,16 +22,33 @@ 
      */
     public function getType(): ?string;
 
+    /**
+     * @return void
+     */
     public function setType(?string $type): void;
 
+    /**
+     * @return \SplFileInfo
+     */
     public function getFile(): ?\SplFileInfo;
 
+    /**
+     * @return void
+     */
     public function setFile(?\SplFileInfo $file): void;
 
     public function hasFile(): bool;
 
+    /**
+     * @return string
+     */
     public function getPath(): ?string;
 
+    /**
+     * @param string $path
+     *
+     * @return void
+     */
     public function setPath(?string $path): void;
 
     /**
@@ -41,6 +58,7 @@ 
 
     /**
      * @param object|null $owner
+     * @return void
      */
     public function setOwner($owner): void;
 }