Merge pull request #2719 from Soullivaneuh/phpdoc-fixes

Phpdoc fixes

Author: XWB

Model/GroupInterface.php

@@ -20,7 +20,7 @@ interface GroupInterface
     /**
      * @param string $role
      *
-     * @return self
+     * @return static
      */
     public function addRole($role);
 
@@ -49,21 +49,21 @@ public function getRoles();
     /**
      * @param string $role
      *
-     * @return self
+     * @return static
      */
     public function removeRole($role);
 
     /**
      * @param string $name
      *
-     * @return self
+     * @return static
      */
     public function setName($name);
 
     /**
      * @param array $roles
      *
-     * @return self
+     * @return static
      */
     public function setRoles(array $roles);
 }

Model/GroupableInterface.php

@@ -46,7 +46,7 @@ public function hasGroup($name);
      *
      * @param GroupInterface $group
      *
-     * @return self
+     * @return static
      */
     public function addGroup(GroupInterface $group);
 
@@ -55,7 +55,7 @@ public function addGroup(GroupInterface $group);
      *
      * @param GroupInterface $group
      *
-     * @return self
+     * @return static
      */
     public function removeGroup(GroupInterface $group);
 }

Model/User.php

@@ -74,24 +74,24 @@ abstract class User implements UserInterface, GroupableInterface
     protected $plainPassword;
 
     /**
-     * @var \DateTime
+     * @var \DateTime|null
      */
     protected $lastLogin;
 
     /**
      * Random string sent to the user email address in order to verify it.
      *
-     * @var string
+     * @var string|null
      */
     protected $confirmationToken;
 
     /**
-     * @var \DateTime
+     * @var \DateTime|null
      */
     protected $passwordRequestedAt;
 
     /**
-     * @var Collection
+     * @var GroupInterface[]|Collection
      */
     protected $groups;
 
@@ -247,7 +247,7 @@ public function getPlainPassword()
     /**
      * Gets the last login time.
      *
-     * @return \DateTime
+     * @return \DateTime|null
      */
     public function getLastLogin()
     {

Model/UserInterface.php

@@ -35,7 +35,7 @@ public function getId();
      *
      * @param string $username
      *
-     * @return self
+     * @return static
      */
     public function setUsername($username);
 
@@ -51,12 +51,14 @@ public function getUsernameCanonical();
      *
      * @param string $usernameCanonical
      *
-     * @return self
+     * @return static
      */
     public function setUsernameCanonical($usernameCanonical);
 
     /**
      * @param string|null $salt
+     *
+     * @return static
      */
     public function setSalt($salt);
 
@@ -72,7 +74,7 @@ public function getEmail();
      *
      * @param string $email
      *
-     * @return self
+     * @return static
      */
     public function setEmail($email);
 
@@ -88,7 +90,7 @@ public function getEmailCanonical();
      *
      * @param string $emailCanonical
      *
-     * @return self
+     * @return static
      */
     public function setEmailCanonical($emailCanonical);
 
@@ -104,7 +106,7 @@ public function getPlainPassword();
      *
      * @param string $password
      *
-     * @return self
+     * @return static
      */
     public function setPlainPassword($password);
 
@@ -113,7 +115,7 @@ public function setPlainPassword($password);
      *
      * @param string $password
      *
-     * @return self
+     * @return static
      */
     public function setPassword($password);
 
@@ -127,7 +129,7 @@ public function isSuperAdmin();
     /**
      * @param bool $boolean
      *
-     * @return self
+     * @return static
      */
     public function setEnabled($boolean);
 
@@ -136,23 +138,23 @@ public function setEnabled($boolean);
      *
      * @param bool $boolean
      *
-     * @return self
+     * @return static
      */
     public function setSuperAdmin($boolean);
 
     /**
      * Gets the confirmation token.
      *
-     * @return string
+     * @return string|null
      */
     public function getConfirmationToken();
 
     /**
      * Sets the confirmation token.
      *
-     * @param string $confirmationToken
+     * @param string|null $confirmationToken
      *
-     * @return self
+     * @return static
      */
     public function setConfirmationToken($confirmationToken);
 
@@ -161,7 +163,7 @@ public function setConfirmationToken($confirmationToken);
      *
      * @param null|\DateTime $date
      *
-     * @return self
+     * @return static
      */
     public function setPasswordRequestedAt(\DateTime $date = null);
 
@@ -177,9 +179,9 @@ public function isPasswordRequestNonExpired($ttl);
     /**
      * Sets the last login time.
      *
-     * @param \DateTime $time
+     * @param \DateTime|null $time
      *
-     * @return self
+     * @return static
      */
     public function setLastLogin(\DateTime $time = null);
 
@@ -204,7 +206,7 @@ public function hasRole($role);
      *
      * @param array $roles
      *
-     * @return self
+     * @return static
      */
     public function setRoles(array $roles);
 
@@ -213,7 +215,7 @@ public function setRoles(array $roles);
      *
      * @param string $role
      *
-     * @return self
+     * @return static
      */
     public function addRole($role);
 
@@ -222,7 +224,7 @@ public function addRole($role);
      *
      * @param string $role
      *
-     * @return self
+     * @return static
      */
     public function removeRole($role);
 }

Model/UserManagerInterface.php

@@ -45,7 +45,7 @@ public function deleteUser(UserInterface $user);
      *
      * @param array $criteria
      *
-     * @return UserInterface
+     * @return UserInterface|null
      */
     public function findUserBy(array $criteria);
 
@@ -54,7 +54,7 @@ public function findUserBy(array $criteria);
      *
      * @param string $username
      *
-     * @return UserInterface or null if user does not exist
+     * @return UserInterface|null
      */
     public function findUserByUsername($username);
 
@@ -63,7 +63,7 @@ public function findUserByUsername($username);
      *
      * @param string $email
      *
-     * @return UserInterface or null if user does not exist
+     * @return UserInterface|null
      */
     public function findUserByEmail($email);
 
@@ -72,7 +72,7 @@ public function findUserByEmail($email);
      *
      * @param string $usernameOrEmail
      *
-     * @return UserInterface or null if user does not exist
+     * @return UserInterface|null
      */
     public function findUserByUsernameOrEmail($usernameOrEmail);
 
@@ -81,7 +81,7 @@ public function findUserByUsernameOrEmail($usernameOrEmail);
      *
      * @param string $token
      *
-     * @return UserInterface or null if user does not exist
+     * @return UserInterface|null
      */
     public function findUserByConfirmationToken($token);