pamil / Sylius

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

Doc Comments +18 added lines

@@ -20,12 +20,24 @@ 
 
 interface TaxCategoryInterface extends CodeAwareInterface, TimestampableInterface, ResourceInterface
 {
+    /**
+     * @return string
+     */
     public function getName(): ?string;
 
+    /**
+     * @return void
+     */
     public function setName(?string $name): void;
 
+    /**
+     * @return string
+     */
     public function getDescription(): ?string;
 
+    /**
+     * @return void
+     */
     public function setDescription(?string $description): void;
 
     /**
@@ -33,8 +45,14 @@ 
      */
     public function getRates(): Collection;
 
+    /**
+     * @return void
+     */
     public function addRate(TaxRateInterface $rate): void;
 
+    /**
+     * @return void
+     */
     public function removeRate(TaxRateInterface $rate): void;
 
     public function hasRate(TaxRateInterface $rate): bool;

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/Taxation/Resolver/TaxRateResolverInterface.php

Unused Use Statements +1 added lines, -1 removed lines

@@ -13,8 +13,8 @@
 
 namespace Sylius\Component\Taxation\Resolver;
 
-use Sylius\Component\Taxation\Model\TaxableInterface;
 use Sylius\Component\Taxation\Model\TaxRateInterface;
+use Sylius\Component\Taxation\Model\TaxableInterface;
 
 interface TaxRateResolverInterface
 {

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

Doc Comments +33 added lines

@@ -36,6 +36,7 @@ 
 
     /**
      * @param TaxonInterface|null $taxon
+     * @return void
      */
     public function setParent(?self $taxon): void;
 
@@ -58,36 +59,68 @@ 
 
     /**
      * @param TaxonInterface $taxon
+     * @return void
      */
     public function addChild(self $taxon): void;
 
     /**
      * @param TaxonInterface $taxon
+     * @return void
      */
     public function removeChild(self $taxon): void;
 
     public function getName(): ?string;
 
+    /**
+     * @return void
+     */
     public function setName(?string $name): void;
 
     public function getDescription(): ?string;
 
+    /**
+     * @return void
+     */
     public function setDescription(?string $description): void;
 
+    /**
+     * @return integer|null
+     */
     public function getLeft(): ?int;
 
+    /**
+     * @return void
+     */
     public function setLeft(?int $left): void;
 
+    /**
+     * @return integer|null
+     */
     public function getRight(): ?int;
 
+    /**
+     * @return void
+     */
     public function setRight(?int $right): void;
 
+    /**
+     * @return integer|null
+     */
     public function getLevel(): ?int;
 
+    /**
+     * @return void
+     */
     public function setLevel(?int $level): void;
 
+    /**
+     * @return integer|null
+     */
     public function getPosition(): ?int;
 
+    /**
+     * @return void
+     */
     public function setPosition(?int $position): void;
 
     /**

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/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)) {