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