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/Behat/Page/Admin/Channel/UpdatePageInterface.php

Doc Comments +22 added lines

@@ -18,23 +18,45 @@
 
 interface UpdatePageInterface extends BaseUpdatePageInterface
 {
+    /**
+     * @return void
+     */
     public function enable(): void;
 
+    /**
+     * @return void
+     */
     public function disable(): void;
 
+    /**
+     * @return void
+     */
     public function setTheme(string $themeName): void;
 
     /**
      * @throws ElementNotFoundException
+     * @return void
      */
     public function unsetTheme(): void;
 
+    /**
+     * @return void
+     */
     public function chooseLocale(string $language): void;
 
+    /**
+     * @return void
+     */
     public function chooseCurrency(string $currencyCode): void;
 
+    /**
+     * @return void
+     */
     public function chooseDefaultTaxZone(string $taxZone): void;
 
+    /**
+     * @return void
+     */
     public function chooseTaxCalculationStrategy(string $taxCalculationStrategy): void;
 
     public function isCodeDisabled(): 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/Component/Core/Model/CustomerInterface.php

Doc Comments +13 added lines

@@ -25,12 +25,24 @@ 
      */
     public function getOrders(): Collection;
 
+    /**
+     * @return AddressInterface
+     */
     public function getDefaultAddress(): ?AddressInterface;
 
+    /**
+     * @return void
+     */
     public function setDefaultAddress(?AddressInterface $defaultAddress): void;
 
+    /**
+     * @return void
+     */
     public function addAddress(AddressInterface $address): void;
 
+    /**
+     * @return void
+     */
     public function removeAddress(AddressInterface $address): void;
 
     public function hasAddress(AddressInterface $address): bool;
@@ -49,6 +61,7 @@ 
 
     /**
      * @param ShopUserInterface|UserInterface|null $user
+     * @return void
      */
     public function setUser(?UserInterface $user);
 }

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

Doc Comments +36 added lines

@@ -15,27 +15,63 @@
 
 interface ShopBillingDataInterface
 {
+    /**
+     * @return string|null
+     */
     public function getTaxId(): ?string;
 
+    /**
+     * @return void
+     */
     public function setTaxId(?string $taxId): void;
 
+    /**
+     * @return string|null
+     */
     public function getCompany(): ?string;
 
+    /**
+     * @return void
+     */
     public function setCompany(?string $company): void;
 
+    /**
+     * @return string|null
+     */
     public function getCountryCode(): ?string;
 
+    /**
+     * @return void
+     */
     public function setCountryCode(?string $countryCode): void;
 
+    /**
+     * @return string|null
+     */
     public function getStreet(): ?string;
 
+    /**
+     * @return void
+     */
     public function setStreet(?string $street): void;
 
+    /**
+     * @return string|null
+     */
     public function getCity(): ?string;
 
+    /**
+     * @return void
+     */
     public function setCity(?string $city): void;
 
+    /**
+     * @return string|null
+     */
     public function getPostcode(): ?string;
 
+    /**
+     * @return void
+     */
     public function setPostcode(?string $postcode): 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/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;
 }