pamil / Sylius

src/Sylius/Component/User/Model/UserInterface.php

Doc Comments +78 added lines

@@ -33,6 +33,9 @@ 
 
     public function getEmail(): ?string;
 
+    /**
+     * @return void
+     */
     public function setEmail(?string $email): void;
 
     /**
@@ -40,49 +43,110 @@ 
      */
     public function getEmailCanonical(): ?string;
 
+    /**
+     * @return void
+     */
     public function setEmailCanonical(?string $emailCanonical): void;
 
+    /**
+     * @return void
+     */
     public function setUsername(?string $username): void;
 
     /**
      * Gets normalized username (should be used in search and sort queries).
+     * @return string|null
      */
     public function getUsernameCanonical(): ?string;
 
+    /**
+     * @return void
+     */
     public function setUsernameCanonical(?string $usernameCanonical): void;
 
+    /**
+     * @return void
+     */
     public function setLocked(bool $locked): void;
 
+    /**
+     * @return string|null
+     */
     public function getEmailVerificationToken(): ?string;
 
+    /**
+     * @return void
+     */
     public function setEmailVerificationToken(?string $verificationToken): void;
 
+    /**
+     * @return string|null
+     */
     public function getPasswordResetToken(): ?string;
 
+    /**
+     * @param string|null $passwordResetToken
+     *
+     * @return void
+     */
     public function setPasswordResetToken(?string $passwordResetToken): void;
 
+    /**
+     * @return \DateTimeInterface|null
+     */
     public function getPasswordRequestedAt(): ?\DateTimeInterface;
 
+    /**
+     * @param \DateTime|null $date
+     *
+     * @return void
+     */
     public function setPasswordRequestedAt(?\DateTimeInterface $date): void;
 
     public function isPasswordRequestNonExpired(\DateInterval $ttl): bool;
 
     public function isVerified(): bool;
 
+    /**
+     * @return \DateTimeInterface|null
+     */
     public function getVerifiedAt(): ?\DateTimeInterface;
 
+    /**
+     * @param \DateTime|null $verifiedAt
+     *
+     * @return void
+     */
     public function setVerifiedAt(?\DateTimeInterface $verifiedAt): void;
 
+    /**
+     * @return \DateTimeInterface|null
+     */
     public function getExpiresAt(): ?\DateTimeInterface;
 
+    /**
+     * @return void
+     */
     public function setExpiresAt(?\DateTimeInterface $date): void;
 
+    /**
+     * @return \DateTimeInterface|null
+     */
     public function getCredentialsExpireAt(): ?\DateTimeInterface;
 
+    /**
+     * @return void
+     */
     public function setCredentialsExpireAt(?\DateTimeInterface $date): void;
 
+    /**
+     * @return \DateTimeInterface|null
+     */
     public function getLastLogin(): ?\DateTimeInterface;
 
+    /**
+     * @return void
+     */
     public function setLastLogin(?\DateTimeInterface $time): void;
 
     /**
@@ -95,8 +159,14 @@ 
      */
     public function hasRole(string $role): bool;
 
+    /**
+     * @return void
+     */
     public function addRole(string $role): void;
 
+    /**
+     * @return void
+     */
     public function removeRole(string $role): void;
 
     /**
@@ -106,7 +176,15 @@ 
 
     public function getOAuthAccount(string $provider): ?UserOAuthInterface;
 
+    /**
+     * @return void
+     */
     public function addOAuthAccount(UserOAuthInterface $oauth): void;
 
+    /**
+     * @param string $encoderName
+     *
+     * @return void
+     */
     public function setEncoderName(?string $encoderName): void;
 }

src/Sylius/Behat/Element/Admin/Channel/ShopBillingDataElementInterface.php

Doc Comments +9 added lines

@@ -6,10 +6,19 @@
 
 interface ShopBillingDataElementInterface
 {
+    /**
+     * @return void
+     */
     public function specifyCompany(string $company): void;
 
+    /**
+     * @return void
+     */
     public function specifyTaxId(string $taxId): void;
 
+    /**
+     * @return void
+     */
     public function specifyBillingAddress(string $street, string $postcode, string $city, string $countryCode): void;
 
     public function hasCompany(string $company): bool;

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

Doc Comments +1 added lines

@@ -59,6 +59,7 @@
 
     /**
      * {@inheritdoc}
+     * @param AddressInterface $defaultAddress
      */
     public function setDefaultAddress(?AddressInterface $defaultAddress): void
     {

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

Doc Comments +15 added lines

@@ -18,15 +18,30 @@
 
 interface CreateConfigurableProductPageInterface extends BaseCreatePageInterface
 {
+    /**
+     * @return void
+     */
     public function selectOption(string $optionName): void;
 
+    /**
+     * @return void
+     */
     public function specifyCode(string $code): void;
 
+    /**
+     * @return void
+     */
     public function nameItIn(string $name, string $localeCode): void;
 
     public function isMainTaxonChosen(string $taxonName): bool;
 
+    /**
+     * @return void
+     */
     public function selectMainTaxon(TaxonInterface $taxon): void;
 
+    /**
+     * @return void
+     */
     public function attachImage(string $path, ?string $type = null): void;
 }

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/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/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;