minor #24342 removed useless PHPDoc (OskarStark)

fabpot · fabpot · commit 009aa8ef00d0 · 2017-09-30T07:00:25.000-07:00
This PR was squashed before being merged into the 2.7 branch (closes #24342).

Discussion
----------

removed useless PHPDoc

| Q             | A
| ------------- | ---
| Branch?       | 2.7
| Bug fix?      | no
| New feature?  | no &lt;!-- don't forget updating src/**/CHANGELOG.md files --&gt;
| BC breaks?    | no
| Deprecations? | no &lt;!-- don't forget updating UPGRADE-*.md files --&gt;
| Tests pass?   | yes
| Fixed tickets |
| License       | MIT
| Doc PR        | n/a

Commits
-------

5ee9043d8b removed useless PHPDoc
diff --git a/Authentication/AuthenticationProviderManager.php b/Authentication/AuthenticationProviderManager.php
@@ -35,8 +35,6 @@ class AuthenticationProviderManager implements AuthenticationManagerInterface
     private $eventDispatcher;
 
     /**
-     * Constructor.
-     *
      * @param AuthenticationProviderInterface[] $providers        An array of AuthenticationProviderInterface instances
      * @param bool                              $eraseCredentials Whether to erase credentials after authentication or not
      *
diff --git a/Authentication/AuthenticationTrustResolver.php b/Authentication/AuthenticationTrustResolver.php
@@ -24,8 +24,6 @@ class AuthenticationTrustResolver implements AuthenticationTrustResolverInterfac
     private $rememberMeClass;
 
     /**
-     * Constructor.
-     *
      * @param string $anonymousClass
      * @param string $rememberMeClass
      */
diff --git a/Authentication/Provider/AnonymousAuthenticationProvider.php b/Authentication/Provider/AnonymousAuthenticationProvider.php
@@ -25,8 +25,6 @@ class AnonymousAuthenticationProvider implements AuthenticationProviderInterface
     private $key;
 
     /**
-     * Constructor.
-     *
      * @param string $key The key shared with the authentication token
      */
     public function __construct($key)
diff --git a/Authentication/Provider/DaoAuthenticationProvider.php b/Authentication/Provider/DaoAuthenticationProvider.php
@@ -32,8 +32,6 @@ class DaoAuthenticationProvider extends UserAuthenticationProvider
     private $userProvider;
 
     /**
-     * Constructor.
-     *
      * @param UserProviderInterface   $userProvider               An UserProviderInterface instance
      * @param UserCheckerInterface    $userChecker                An UserCheckerInterface instance
      * @param string                  $providerKey                The provider key
diff --git a/Authentication/Provider/PreAuthenticatedAuthenticationProvider.php b/Authentication/Provider/PreAuthenticatedAuthenticationProvider.php
@@ -34,8 +34,6 @@ class PreAuthenticatedAuthenticationProvider implements AuthenticationProviderIn
     private $providerKey;
 
     /**
-     * Constructor.
-     *
      * @param UserProviderInterface $userProvider An UserProviderInterface instance
      * @param UserCheckerInterface  $userChecker  An UserCheckerInterface instance
      * @param string                $providerKey  The provider key
diff --git a/Authentication/Provider/RememberMeAuthenticationProvider.php b/Authentication/Provider/RememberMeAuthenticationProvider.php
@@ -23,8 +23,6 @@ class RememberMeAuthenticationProvider implements AuthenticationProviderInterfac
     private $providerKey;
 
     /**
-     * Constructor.
-     *
      * @param UserCheckerInterface $userChecker An UserCheckerInterface interface
      * @param string               $key         A key
      * @param string               $providerKey A provider key
diff --git a/Authentication/Provider/UserAuthenticationProvider.php b/Authentication/Provider/UserAuthenticationProvider.php
@@ -33,8 +33,6 @@ abstract class UserAuthenticationProvider implements AuthenticationProviderInter
     private $providerKey;
 
     /**
-     * Constructor.
-     *
      * @param UserCheckerInterface $userChecker                An UserCheckerInterface interface
      * @param string               $providerKey                A provider key
      * @param bool                 $hideUserNotFoundExceptions Whether to hide user not found exception or not
diff --git a/Authentication/RememberMe/PersistentToken.php b/Authentication/RememberMe/PersistentToken.php
@@ -25,8 +25,6 @@ final class PersistentToken implements PersistentTokenInterface
     private $lastUsed;
 
     /**
-     * Constructor.
-     *
      * @param string    $class
      * @param string    $username
      * @param string    $series
diff --git a/Authentication/Token/AbstractToken.php b/Authentication/Token/AbstractToken.php
@@ -31,8 +31,6 @@ abstract class AbstractToken implements TokenInterface
     private $attributes = array();
 
     /**
-     * Constructor.
-     *
      * @param (RoleInterface|string)[] $roles An array of roles
      *
      * @throws \InvalidArgumentException
diff --git a/Authentication/Token/AnonymousToken.php b/Authentication/Token/AnonymousToken.php
@@ -23,8 +23,6 @@ class AnonymousToken extends AbstractToken
     private $key;
 
     /**
-     * Constructor.
-     *
      * @param string          $key   The key shared with the authentication provider
      * @param string|object   $user  The user can be a UserInterface instance, or an object implementing a __toString method or the username as a regular string
      * @param RoleInterface[] $roles An array of roles
diff --git a/Authentication/Token/PreAuthenticatedToken.php b/Authentication/Token/PreAuthenticatedToken.php
@@ -24,8 +24,6 @@ class PreAuthenticatedToken extends AbstractToken
     private $providerKey;
 
     /**
-     * Constructor.
-     *
      * @param string|object            $user        The user can be a UserInterface instance, or an object implementing a __toString method or the username as a regular string
      * @param mixed                    $credentials The user credentials
      * @param string                   $providerKey The provider key
diff --git a/Authentication/Token/RememberMeToken.php b/Authentication/Token/RememberMeToken.php
@@ -24,8 +24,6 @@ class RememberMeToken extends AbstractToken
     private $providerKey;
 
     /**
-     * Constructor.
-     *
      * @param UserInterface $user
      * @param string        $providerKey
      * @param string        $key
diff --git a/Authentication/Token/UsernamePasswordToken.php b/Authentication/Token/UsernamePasswordToken.php
@@ -24,8 +24,6 @@ class UsernamePasswordToken extends AbstractToken
     private $providerKey;
 
     /**
-     * Constructor.
-     *
      * @param string|object            $user        The username (like a nickname, email address, etc.), or a UserInterface instance or an object implementing a __toString method
      * @param mixed                    $credentials This usually is the password of the user
      * @param string                   $providerKey The provider key
diff --git a/Authorization/AccessDecisionManager.php b/Authorization/AccessDecisionManager.php
@@ -32,8 +32,6 @@ class AccessDecisionManager implements AccessDecisionManagerInterface
     private $allowIfEqualGrantedDeniedDecisions;
 
     /**
-     * Constructor.
-     *
      * @param VoterInterface[] $voters                             An array of VoterInterface instances
      * @param string           $strategy                           The vote strategy
      * @param bool             $allowIfAllAbstainDecisions         Whether to grant access if all voters abstained or not
diff --git a/Authorization/AuthorizationChecker.php b/Authorization/AuthorizationChecker.php
@@ -31,8 +31,6 @@ class AuthorizationChecker implements AuthorizationCheckerInterface
     private $alwaysAuthenticate;
 
     /**
-     * Constructor.
-     *
      * @param TokenStorageInterface          $tokenStorage
      * @param AuthenticationManagerInterface $authenticationManager An AuthenticationManager instance
      * @param AccessDecisionManagerInterface $accessDecisionManager An AccessDecisionManager instance
diff --git a/Authorization/Voter/AuthenticatedVoter.php b/Authorization/Voter/AuthenticatedVoter.php
@@ -32,8 +32,6 @@ class AuthenticatedVoter implements VoterInterface
     private $authenticationTrustResolver;
 
     /**
-     * Constructor.
-     *
      * @param AuthenticationTrustResolverInterface $authenticationTrustResolver
      */
     public function __construct(AuthenticationTrustResolverInterface $authenticationTrustResolver)
diff --git a/Authorization/Voter/ExpressionVoter.php b/Authorization/Voter/ExpressionVoter.php
@@ -31,8 +31,6 @@ class ExpressionVoter implements VoterInterface
     private $roleHierarchy;
 
     /**
-     * Constructor.
-     *
      * @param ExpressionLanguage                   $expressionLanguage
      * @param AuthenticationTrustResolverInterface $trustResolver
      * @param RoleHierarchyInterface|null          $roleHierarchy
diff --git a/Authorization/Voter/RoleVoter.php b/Authorization/Voter/RoleVoter.php
@@ -24,8 +24,6 @@ class RoleVoter implements VoterInterface
     private $prefix;
 
     /**
-     * Constructor.
-     *
      * @param string $prefix The role prefix
      */
     public function __construct($prefix = 'ROLE_')
diff --git a/Encoder/BCryptPasswordEncoder.php b/Encoder/BCryptPasswordEncoder.php
@@ -27,8 +27,6 @@ class BCryptPasswordEncoder extends BasePasswordEncoder
     private $cost;
 
     /**
-     * Constructor.
-     *
      * @param int $cost The algorithmic cost that should be used
      *
      * @throws \RuntimeException         When no BCrypt encoder is available
diff --git a/Encoder/MessageDigestPasswordEncoder.php b/Encoder/MessageDigestPasswordEncoder.php
@@ -25,8 +25,6 @@ class MessageDigestPasswordEncoder extends BasePasswordEncoder
     private $iterations;
 
     /**
-     * Constructor.
-     *
      * @param string $algorithm          The digest algorithm to use
      * @param bool   $encodeHashAsBase64 Whether to base64 encode the password hash
      * @param int    $iterations         The number of iterations to use to stretch the password hash
diff --git a/Encoder/Pbkdf2PasswordEncoder.php b/Encoder/Pbkdf2PasswordEncoder.php
@@ -34,8 +34,6 @@ class Pbkdf2PasswordEncoder extends BasePasswordEncoder
     private $length;
 
     /**
-     * Constructor.
-     *
      * @param string $algorithm          The digest algorithm to use
      * @param bool   $encodeHashAsBase64 Whether to base64 encode the password hash
      * @param int    $iterations         The number of iterations to use to stretch the password hash
diff --git a/Encoder/PlaintextPasswordEncoder.php b/Encoder/PlaintextPasswordEncoder.php
@@ -23,8 +23,6 @@ class PlaintextPasswordEncoder extends BasePasswordEncoder
     private $ignorePasswordCase;
 
     /**
-     * Constructor.
-     *
      * @param bool $ignorePasswordCase Compare password case-insensitive
      */
     public function __construct($ignorePasswordCase = false)
diff --git a/Role/Role.php b/Role/Role.php
@@ -22,8 +22,6 @@ class Role implements RoleInterface
     private $role;
 
     /**
-     * Constructor.
-     *
      * @param string $role The role name
      */
     public function __construct($role)
diff --git a/Role/RoleHierarchy.php b/Role/RoleHierarchy.php
@@ -22,8 +22,6 @@ class RoleHierarchy implements RoleHierarchyInterface
     protected $map;
 
     /**
-     * Constructor.
-     *
      * @param array $hierarchy An array defining the hierarchy
      */
     public function __construct(array $hierarchy)
diff --git a/Role/SwitchUserRole.php b/Role/SwitchUserRole.php
@@ -24,8 +24,6 @@ class SwitchUserRole extends Role
     private $source;
 
     /**
-     * Constructor.
-     *
      * @param string         $role   The role as a string
      * @param TokenInterface $source The original token
      */
diff --git a/User/InMemoryUserProvider.php b/User/InMemoryUserProvider.php
@@ -27,8 +27,6 @@ class InMemoryUserProvider implements UserProviderInterface
     private $users;
 
     /**
-     * Constructor.
-     *
      * The user array is a hash where the keys are usernames and the values are
      * an array of attributes: 'password', 'enabled', and 'roles'.
      *

Original file line number	Diff line number	Diff line change
`@@ -35,8 +35,6 @@ class AuthenticationProviderManager implements AuthenticationManagerInterface`
`35`	`35`	`private $eventDispatcher;`
`36`	`36`
`37`	`37`	`/**`
`38`		`- * Constructor.`
`39`		`- *`
`40`	`38`	`* @param AuthenticationProviderInterface[] $providers An array of AuthenticationProviderInterface instances`
`41`	`39`	`* @param bool $eraseCredentials Whether to erase credentials after authentication or not`
`42`	`40`	`*`
Original file line number	Diff line number	Diff line change
`@@ -31,8 +31,6 @@ abstract class AbstractToken implements TokenInterface`
`31`	`31`	`private $attributes = array();`
`32`	`32`
`33`	`33`	`/**`
`34`		`- * Constructor.`
`35`		`- *`
`36`	`34`	`* @param (RoleInterface\|string)[] $roles An array of roles`
`37`	`35`	`*`
`38`	`36`	`* @throws \InvalidArgumentException`