pamil / Sylius

Canonicalizer/CanonicalizerInterface.php

Doc Comments +3 added lines

@@ -15,5 +15,8 @@
 
 interface CanonicalizerInterface
 {
+    /**
+     * @return string
+     */
     public function canonicalize(?string $string): ?string;
 }

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

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;

Model/UserAwareInterface.php

Doc Comments +8 added lines

@@ -15,7 +15,15 @@
 
 interface UserAwareInterface
 {
+    /**
+     * @return UserInterface|null
+     */
     public function getUser(): ?UserInterface;
 
+    /**
+     * @param User $user
+     *
+     * @return void
+     */
     public function setUser(?UserInterface $user);
 }

Model/UserInterface.php

Doc Comments +74 added lines

@@ -31,58 +31,120 @@ 
 {
     public const DEFAULT_ROLE = 'ROLE_USER';
 
+    /**
+     * @return string|null
+     */
     public function getEmail(): ?string;
 
+    /**
+     * @return void
+     */
     public function setEmail(?string $email): void;
 
     /**
      * Gets normalized email (should be used in search and sort queries).
+     * @return string|null
      */
     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;
 
+    /**
+     * @return void
+     */
     public function setPasswordResetToken(?string $passwordResetToken): void;
 
+    /**
+     * @return \DateTimeInterface|null
+     */
     public function getPasswordRequestedAt(): ?\DateTimeInterface;
 
+    /**
+     * @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;
 
+    /**
+     * @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 +157,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 +174,13 @@ 
 
     public function getOAuthAccount(string $provider): ?UserOAuthInterface;
 
+    /**
+     * @return void
+     */
     public function addOAuthAccount(UserOAuthInterface $oauth): void;
 
+    /**
+     * @return void
+     */
     public function setEncoderName(?string $encoderName): void;
 }

Model/UserOAuthInterface.php

Doc Comments +24 added lines

@@ -17,19 +17,43 @@
 
 interface UserOAuthInterface extends UserAwareInterface, ResourceInterface
 {
+    /**
+     * @return string|null
+     */
     public function getProvider(): ?string;
 
+    /**
+     * @return void
+     */
     public function setProvider(?string $provider): void;
 
+    /**
+     * @return string|null
+     */
     public function getIdentifier(): ?string;
 
+    /**
+     * @return void
+     */
     public function setIdentifier(?string $identifier): void;
 
+    /**
+     * @return string|null
+     */
     public function getAccessToken(): ?string;
 
+    /**
+     * @return void
+     */
     public function setAccessToken(?string $accessToken): void;
 
+    /**
+     * @return string|null
+     */
     public function getRefreshToken(): ?string;
 
+    /**
+     * @return void
+     */
     public function setRefreshToken(?string $refreshToken): void;
 }

Security/PasswordUpdaterInterface.php

Doc Comments +3 added lines

@@ -17,5 +17,8 @@
 
 interface PasswordUpdaterInterface
 {
+    /**
+     * @return void
+     */
     public function updatePassword(CredentialsHolderInterface $user): void;
 }