pamil / Sylius

src/Sylius/Component/Taxation/Model/TaxRateInterface.php

Doc Comments +27 added lines

@@ -19,27 +19,54 @@
 
 interface TaxRateInterface extends CodeAwareInterface, TimestampableInterface, ResourceInterface
 {
+    /**
+     * @return TaxCategoryInterface
+     */
     public function getCategory(): ?TaxCategoryInterface;
 
+    /**
+     * @return void
+     */
     public function setCategory(?TaxCategoryInterface $category): void;
 
+    /**
+     * @return string
+     */
     public function getName(): ?string;
 
+    /**
+     * @return void
+     */
     public function setName(?string $name): void;
 
     public function getAmount(): float;
 
     public function getAmountAsPercentage(): float;
 
+    /**
+     * @return void
+     */
     public function setAmount(?float $amount): void;
 
     public function isIncludedInPrice(): bool;
 
+    /**
+     * @return void
+     */
     public function setIncludedInPrice(?bool $includedInPrice): void;
 
+    /**
+     * @return string
+     */
     public function getCalculator(): ?string;
 
+    /**
+     * @return void
+     */
     public function setCalculator(?string $calculator): void;
 
+    /**
+     * @return string
+     */
     public function getLabel(): ?string;
 }

src/Sylius/Component/Taxonomy/Model/TaxonTranslationInterface.php

Doc Comments +12 added lines

@@ -19,11 +19,23 @@
 
 interface TaxonTranslationInterface extends SlugAwareInterface, ResourceInterface, TranslationInterface
 {
+    /**
+     * @return string|null
+     */
     public function getName(): ?string;
 
+    /**
+     * @return void
+     */
     public function setName(?string $name): void;
 
+    /**
+     * @return string|null
+     */
     public function getDescription(): ?string;
 
+    /**
+     * @return void
+     */
     public function setDescription(?string $description): void;
 }

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

Doc Comments +10 added lines

@@ -15,8 +15,14 @@ 
 
 interface CredentialsHolderInterface
 {
+    /**
+     * @return string|null
+     */
     public function getPlainPassword(): ?string;
 
+    /**
+     * @return void
+     */
     public function setPlainPassword(?string $plainPassword): void;
 
     /**
@@ -29,6 +35,9 @@ 
      */
     public function getPassword();
 
+    /**
+     * @return void
+     */
     public function setPassword(?string $encodedPassword): void;
 
     /**
@@ -45,6 +54,7 @@ 
      *
      * This is important if, at any given point, sensitive information like
      * the plain-text password is stored on this object.
+     * @return void
      */
     public function eraseCredentials();
 }

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

Doc Comments +3 added lines

@@ -520,6 +520,9 @@
         ] = $data;
     }
 
+    /**
+     * @param \DateTimeInterface|null $date
+     */
     protected function hasExpired(?\DateTimeInterface $date): bool
     {
         return null !== $date && new \DateTime() >= $date;

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

Doc Comments +73 added lines

@@ -31,6 +31,9 @@ 
 
     public function getEmail(): ?string;
 
+    /**
+     * @return void
+     */
     public function setEmail(?string $email): void;
 
     /**
@@ -38,49 +41,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;
 
     /**
@@ -93,8 +157,14 @@ 
      */
     public function hasRole(string $role): bool;
 
+    /**
+     * @return void
+     */
     public function addRole(string $role): void;
 
+    /**
+     * @return void
+     */
     public function removeRole(string $role): void;
 
     /**
@@ -104,5 +174,8 @@ 
 
     public function getOAuthAccount(string $provider): ?UserOAuthInterface;
 
+    /**
+     * @return void
+     */
     public function addOAuthAccount(UserOAuthInterface $oauth): void;
 }

src/Sylius/Bundle/LocaleBundle/Templating/Helper/LocaleHelper.php

Doc Comments +3 added lines

@@ -52,6 +52,9 @@
         return 'sylius_locale';
     }
 
+    /**
+     * @param string|null $localeCode
+     */
     private function getLocaleCode(?string $localeCode): ?string
     {
         if (null !== $localeCode) {

src/Sylius/Bundle/LocaleBundle/Templating/Helper/LocaleHelperInterface.php

Doc Comments +1 added lines

@@ -20,6 +20,7 @@
     /**
      * @param string $code The code to be converted to a name
      * @param string|null $localeCode The locale that the returned name should be in
+     * @return string
      */
     public function convertCodeToName(string $code, ?string $localeCode = null): ?string;
 }

src/Sylius/Bundle/ResourceBundle/Validator/EnabledValidator.php

Doc Comments +3 added lines

@@ -42,6 +42,9 @@
         }
     }
 
+    /**
+     * @param ToggleableInterface $value
+     */
     private function ensureValueImplementsToggleableInterface($value): void
     {
         if (!($value instanceof ToggleableInterface)) {

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

Doc Comments +11 added lines

@@ -22,6 +22,7 @@ 
 {
     /**
      * @throws ElementNotFoundException
+     * @return void
      */
     public function addToCart();
 
@@ -29,6 +30,7 @@ 
      * @param string $quantity
      *
      * @throws ElementNotFoundException
+     * @return void
      */
     public function addToCartWithQuantity($quantity);
 
@@ -36,6 +38,7 @@ 
      * @param string $variant
      *
      * @throws ElementNotFoundException
+     * @return void
      */
     public function addToCartWithVariant($variant);
 
@@ -43,6 +46,7 @@ 
      * @param string $optionValue
      *
      * @throws ElementNotFoundException
+     * @return void
      */
     public function addToCartWithOption(ProductOptionInterface $option, $optionValue);
 
@@ -58,9 +62,13 @@ 
 
     /**
      * @param string $url
+     * @return void
      */
     public function visit($url);
 
+    /**
+     * @return null|string
+     */
     public function getAttributeByName(string $name): ?string;
 
     /**
@@ -75,6 +83,7 @@ 
 
     /**
      * @param int $timeout
+     * @return void
      */
     public function waitForValidationErrors($timeout);
 
@@ -118,11 +127,13 @@ 
     /**
      * @param string $optionName
      * @param string $optionValue
+     * @return void
      */
     public function selectOption($optionName, $optionValue);
 
     /**
      * @param string $variantName
+     * @return void
      */
     public function selectVariant($variantName);