pamil / Sylius

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/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/Behat/Page/Admin/Crud/IndexPageInterface.php

Doc Comments +18 added lines

@@ -24,19 +24,37 @@
 
     public function getColumnFields(string $columnName): array;
 
+    /**
+     * @return void
+     */
     public function sortBy(string $fieldName): void;
 
+    /**
+     * @return void
+     */
     public function deleteResourceOnPage(array $parameters): void;
 
     public function getActionsForResource(array $parameters): NodeElement;
 
+    /**
+     * @return void
+     */
     public function checkResourceOnPage(array $parameters): void;
 
     public function countItems(): int;
 
+    /**
+     * @return void
+     */
     public function filter(): void;
 
+    /**
+     * @return void
+     */
     public function bulkDelete(): void;
 
+    /**
+     * @return void
+     */
     public function sort(string $order): void;
 }

src/Sylius/Component/Customer/Model/CustomerInterface.php

Doc Comments +44 added lines

@@ -24,35 +24,64 @@ 
 
     public const FEMALE_GENDER = 'f';
 
+    /**
+     * @return string|null
+     */
     public function getEmail(): ?string;
 
+    /**
+     * @return void
+     */
     public function setEmail(?string $email): void;
 
     /**
      * Gets normalized email (should be used in search and sort queries).
+     * @return string|null
      */
     public function getEmailCanonical(): ?string;
 
+    /**
+     * @return void
+     */
     public function setEmailCanonical(?string $emailCanonical): void;
 
     public function getFullName(): string;
 
+    /**
+     * @return string|null
+     */
     public function getFirstName(): ?string;
 
+    /**
+     * @return void
+     */
     public function setFirstName(?string $firstName): void;
 
+    /**
+     * @return string|null
+     */
     public function getLastName(): ?string;
 
+    /**
+     * @return void
+     */
     public function setLastName(?string $lastName): void;
 
+    /**
+     * @return \DateTimeInterface|null
+     */
     public function getBirthday(): ?\DateTimeInterface;
 
+    /**
+     * @return void
+     */
     public function setBirthday(?\DateTimeInterface $birthday): void;
 
     public function getGender(): string;
 
     /**
      * You should use interface constants for that.
+     * @return void
      */
     public function setGender(string $gender): void;
 
@@ -60,15 +89,30 @@ 
 
     public function isFemale(): bool;
 
+    /**
+     * @return CustomerGroupInterface|null
+     */
     public function getGroup(): ?CustomerGroupInterface;
 
+    /**
+     * @return void
+     */
     public function setGroup(?CustomerGroupInterface $group): void;
 
+    /**
+     * @return string|null
+     */
     public function getPhoneNumber(): ?string;
 
+    /**
+     * @return void
+     */
     public function setPhoneNumber(?string $phoneNumber): void;
 
     public function isSubscribedToNewsletter(): bool;
 
+    /**
+     * @return void
+     */
     public function setSubscribedToNewsletter(bool $subscribedToNewsletter): void;
 }

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

Doc Comments +12 added lines

@@ -17,15 +17,27 @@
 
 interface IndexPageInterface extends BaseIndexPageInterface
 {
+    /**
+     * @return void
+     */
     public function chooseStateToFilter(string $paymentState): void;
 
+    /**
+     * @return void
+     */
     public function completePaymentOfOrderWithNumber(string $orderNumber): void;
 
     public function getPaymentStateByOrderNumber(string $orderNumber): string;
 
     public function isPaymentWithOrderNumberInPosition(string $orderNumber, int $position): bool;
 
+    /**
+     * @return void
+     */
     public function showOrderPageForNthPayment(int $position): void;
 
+    /**
+     * @return void
+     */
     public function chooseChannelFilter(string $channelName): void;
 }

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

Doc Comments +12 added lines

@@ -24,11 +24,23 @@
 
     public function isShowInShopButtonDisabled(): bool;
 
+    /**
+     * @return void
+     */
     public function showProductInChannel(string $channel): void;
 
+    /**
+     * @return void
+     */
     public function showProductInSingleChannel(): void;
 
+    /**
+     * @return void
+     */
     public function showProductEditPage(): void;
 
+    /**
+     * @return void
+     */
     public function showVariantEditPage(ProductVariantInterface $variant): void;
 }