minor#8823 [Security] [2.2] Added doc comments and missing use statem…

…ent (piotrantosik) This PR was merged into the 2.2 branch. Discussion ---------- [Security] [2.2] Added doc comments and missing use statement | Q | A | ------------- | --- | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | - | License | MIT | Doc PR | - Commits ------- 7ee39a6 Added doc comments
symfony · Sep 27, 2013 · 279a686 · 279a686
2 parents 54e2abd + 7ee39a6
commit 279a686
Show file tree

Hide file tree

Showing 18 changed files with 84 additions and 10 deletions.
diff --git a/src/Symfony/Component/Security/Http/AccessMap.php b/src/Symfony/Component/Security/Http/AccessMap.php
@@ -36,6 +36,9 @@ public function add(RequestMatcherInterface $requestMatcher, array $roles = arra
         $this->map[] = array($requestMatcher, $roles, $channel);
     }
 
+    /**
+     * {@inheritDoc}
+     */
     public function getPatterns(Request $request)
     {
         foreach ($this->map as $elements) {

diff --git a/src/Symfony/Component/Security/Http/Authentication/DefaultAuthenticationFailureHandler.php b/src/Symfony/Component/Security/Http/Authentication/DefaultAuthenticationFailureHandler.php
@@ -64,7 +64,7 @@ public function onAuthenticationFailure(Request $request, AuthenticationExceptio
     {
         if ($failureUrl = $request->get($this->options['failure_path_parameter'], null, true)) {
              $this->options['failure_path'] = $failureUrl;
-         }
+        }
 
         if (null === $this->options['failure_path']) {
             $this->options['failure_path'] = $this->options['login_path'];

diff --git a/src/Symfony/Component/Security/Http/Authorization/AccessDeniedHandlerInterface.php b/src/Symfony/Component/Security/Http/Authorization/AccessDeniedHandlerInterface.php
@@ -12,6 +12,7 @@
 namespace Symfony\Component\Security\Http\Authorization;
 
 use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\Security\Core\Exception\AccessDeniedException;
 use Symfony\Component\HttpFoundation\Response;
 

diff --git a/src/Symfony/Component/Security/Http/EntryPoint/BasicAuthenticationEntryPoint.php b/src/Symfony/Component/Security/Http/EntryPoint/BasicAuthenticationEntryPoint.php
@@ -30,6 +30,9 @@ public function __construct($realmName)
         $this->realmName = $realmName;
     }
 
+    /**
+     * {@inheritdoc}
+     */
     public function start(Request $request, AuthenticationException $authException = null)
     {
         $response = new Response();

diff --git a/src/Symfony/Component/Security/Http/EntryPoint/DigestAuthenticationEntryPoint.php b/src/Symfony/Component/Security/Http/EntryPoint/DigestAuthenticationEntryPoint.php
@@ -38,6 +38,9 @@ public function __construct($realmName, $key, $nonceValiditySeconds = 300, Logge
         $this->logger = $logger;
     }
 
+    /**
+     * {@inheritdoc}
+     */
     public function start(Request $request, AuthenticationException $authException = null)
     {
         $expiryTime = microtime(true) + $this->nonceValiditySeconds * 1000;
@@ -62,11 +65,17 @@ public function start(Request $request, AuthenticationException $authException =
         return $response;
     }
 
+    /**
+     * @return string
+     */
     public function getKey()
     {
         return $this->key;
     }
 
+    /**
+     * @return string
+     */
     public function getRealmName()
     {
         return $this->realmName;

diff --git a/src/Symfony/Component/Security/Http/EntryPoint/FormAuthenticationEntryPoint.php b/src/Symfony/Component/Security/Http/EntryPoint/FormAuthenticationEntryPoint.php
@@ -30,7 +30,7 @@ class FormAuthenticationEntryPoint implements AuthenticationEntryPointInterface
     private $httpUtils;
 
     /**
-     * Constructor
+     * Constructor.
      *
      * @param HttpKernelInterface $kernel
      * @param HttpUtils           $httpUtils  An HttpUtils instance

diff --git a/src/Symfony/Component/Security/Http/EntryPoint/RetryAuthenticationEntryPoint.php b/src/Symfony/Component/Security/Http/EntryPoint/RetryAuthenticationEntryPoint.php
@@ -34,6 +34,9 @@ public function __construct($httpPort = 80, $httpsPort = 443)
         $this->httpsPort = $httpsPort;
     }
 
+    /**
+     * {@inheritdoc}
+     */
     public function start(Request $request, AuthenticationException $authException = null)
     {
         $scheme = $request->isSecure() ? 'http' : 'https';

diff --git a/src/Symfony/Component/Security/Http/Event/InteractiveLoginEvent.php b/src/Symfony/Component/Security/Http/Event/InteractiveLoginEvent.php
@@ -15,10 +15,14 @@
 use Symfony\Component\EventDispatcher\Event;
 use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
 
+/**
+ * InteractiveLoginEvent
+ *
+ * @author Fabien Potencier <fabien@symfony.com>
+ */
 class InteractiveLoginEvent extends Event
 {
     private $request;
-
     private $authenticationToken;
 
     /**

diff --git a/src/Symfony/Component/Security/Http/Event/SwitchUserEvent.php b/src/Symfony/Component/Security/Http/Event/SwitchUserEvent.php
@@ -15,10 +15,14 @@
 use Symfony\Component\Security\Core\User\UserInterface;
 use Symfony\Component\EventDispatcher\Event;
 
+/**
+ * SwitchUserEvent
+ *
+ * @author Fabien Potencier <fabien@symfony.com>
+ */
 class SwitchUserEvent extends Event
 {
     private $request;
-
     private $targetUser;
 
     public function __construct(Request $request, UserInterface $targetUser)
@@ -27,11 +31,17 @@ public function __construct(Request $request, UserInterface $targetUser)
         $this->targetUser = $targetUser;
     }
 
+    /**
+     * @return Request
+     */
     public function getRequest()
     {
         return $this->request;
     }
 
+    /**
+     * @return UserInterface
+     */
     public function getTargetUser()
     {
         return $this->targetUser;

diff --git a/src/Symfony/Component/Security/Http/Firewall.php b/src/Symfony/Component/Security/Http/Firewall.php
@@ -71,6 +71,9 @@ public function onKernelRequest(GetResponseEvent $event)
         }
     }
 
+    /**
+     * {@inheritDoc}
+     */
     public static function getSubscribedEvents()
     {
         return array(KernelEvents::REQUEST => array('onKernelRequest', 8));

diff --git a/src/Symfony/Component/Security/Http/Firewall/ExceptionListener.php b/src/Symfony/Component/Security/Http/Firewall/ExceptionListener.php
@@ -161,6 +161,13 @@ public function onKernelException(GetResponseForExceptionEvent $event)
         $event->setResponse($response);
     }
 
+    /**
+     * @param Request                 $request
+     * @param AuthenticationException $authException
+     *
+     * @return Response
+     * @throws AuthenticationException
+     */
     private function startAuthentication(Request $request, AuthenticationException $authException)
     {
         if (null === $this->authenticationEntryPoint) {
@@ -181,6 +188,9 @@ private function startAuthentication(Request $request, AuthenticationException $
         return $this->authenticationEntryPoint->start($request, $authException);
     }
 
+    /**
+     * @param Request $request
+     */
     protected function setTargetPath(Request $request)
     {
         // session isn't required when using http basic authentication mechanism for example

diff --git a/src/Symfony/Component/Security/Http/Firewall/LogoutListener.php b/src/Symfony/Component/Security/Http/Firewall/LogoutListener.php
@@ -37,7 +37,7 @@ class LogoutListener implements ListenerInterface
     private $csrfProvider;
 
     /**
-     * Constructor
+     * Constructor.
      *
      * @param SecurityContextInterface      $securityContext
      * @param HttpUtils                     $httpUtils       An HttpUtilsInterface instance
@@ -77,9 +77,8 @@ public function addHandler(LogoutHandlerInterface $handler)
      *
      * @param GetResponseEvent $event A GetResponseEvent instance
      *
-     * @throws InvalidCsrfTokenException if the CSRF token is invalid
+     * @throws LogoutException if the CSRF token is invalid
      * @throws \RuntimeException if the LogoutSuccessHandlerInterface instance does not return a response
-     * @throws LogoutException
      */
     public function handle(GetResponseEvent $event)
     {

diff --git a/src/Symfony/Component/Security/Http/Firewall/RememberMeListener.php b/src/Symfony/Component/Security/Http/Firewall/RememberMeListener.php
@@ -35,7 +35,7 @@ class RememberMeListener implements ListenerInterface
     private $dispatcher;
 
     /**
-     * Constructor
+     * Constructor.
      *
      * @param SecurityContextInterface       $securityContext
      * @param RememberMeServicesInterface    $rememberMeServices

diff --git a/src/Symfony/Component/Security/Http/Firewall/X509AuthenticationListener.php b/src/Symfony/Component/Security/Http/Firewall/X509AuthenticationListener.php
@@ -36,6 +36,9 @@ public function __construct(SecurityContextInterface $securityContext, Authentic
         $this->credentialKey = $credentialKey;
     }
 
+    /**
+     * {@inheritdoc}
+     */
     protected function getPreAuthenticatedData(Request $request)
     {
         if (!$request->server->has($this->userKey)) {

diff --git a/src/Symfony/Component/Security/Http/FirewallMap.php b/src/Symfony/Component/Security/Http/FirewallMap.php
@@ -25,11 +25,19 @@ class FirewallMap implements FirewallMapInterface
 {
     private $map = array();
 
+    /**
+     * @param RequestMatcherInterface $requestMatcher
+     * @param array                   $listeners
+     * @param ExceptionListener       $exceptionListener
+     */
     public function add(RequestMatcherInterface $requestMatcher = null, array $listeners = array(), ExceptionListener $exceptionListener = null)
     {
         $this->map[] = array($requestMatcher, $listeners, $exceptionListener);
     }
 
+    /**
+     * {@inheritDoc}
+     */
     public function getListeners(Request $request)
     {
         foreach ($this->map as $elements) {

diff --git a/src/Symfony/Component/Security/Http/HttpUtils.php b/src/Symfony/Component/Security/Http/HttpUtils.php
@@ -13,6 +13,7 @@
 
 use Symfony\Component\Security\Core\SecurityContextInterface;
 
+use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\RedirectResponse;
 use Symfony\Component\Routing\Matcher\UrlMatcherInterface;
@@ -37,6 +38,8 @@ class HttpUtils
      *
      * @param UrlGeneratorInterface                       $urlGenerator A UrlGeneratorInterface instance
      * @param UrlMatcherInterface|RequestMatcherInterface $urlMatcher   The Url or Request matcher
+     *
+     * @throws \InvalidArgumentException
      */
     public function __construct(UrlGeneratorInterface $urlGenerator = null, $urlMatcher = null)
     {
@@ -123,9 +126,11 @@ public function checkRequestPath(Request $request, $path)
      * Generates a URI, based on the given path or absolute URL.
      *
      * @param Request $request A Request instance
-     * @param string $path A path (an absolute path (/foo), an absolute URL (http://...), or a route name (foo))
+     * @param string  $path    A path (an absolute path (/foo), an absolute URL (http://...), or a route name (foo))
      *
      * @return string An absolute URL
+     *
+     * @throws \LogicException
      */
     public function generateUri($request, $path)
     {

diff --git a/src/Symfony/Component/Security/Http/RememberMe/AbstractRememberMeServices.php b/src/Symfony/Component/Security/Http/RememberMe/AbstractRememberMeServices.php
@@ -40,7 +40,7 @@ abstract class AbstractRememberMeServices implements RememberMeServicesInterface
     private $userProviders;
 
     /**
-     * Constructor
+     * Constructor.
      *
      * @param array           $userProviders
      * @param string          $key
@@ -80,6 +80,9 @@ public function getRememberMeParameter()
         return $this->options['remember_me_parameter'];
     }
 
+    /**
+     * @return string
+     */
     public function getKey()
     {
         return $this->key;
@@ -94,6 +97,7 @@ public function getKey()
      * @return TokenInterface|null
      *
      * @throws CookieTheftException
+     * @throws \RuntimeException
      */
     final public function autoLogin(Request $request)
     {
@@ -219,6 +223,9 @@ final public function loginSuccess(Request $request, Response $response, TokenIn
      */
     abstract protected function processAutoLoginCookie(array $cookieParts, Request $request);
 
+    /**
+     * @param Request $request
+     */
     protected function onLoginFail(Request $request)
     {
     }

diff --git a/src/Symfony/Component/Security/Http/RememberMe/ResponseListener.php b/src/Symfony/Component/Security/Http/RememberMe/ResponseListener.php
@@ -22,6 +22,9 @@
  */
 class ResponseListener implements EventSubscriberInterface
 {
+    /**
+     * @param FilterResponseEvent $event
+     */
     public function onKernelResponse(FilterResponseEvent $event)
     {
         $request = $event->getRequest();
@@ -32,6 +35,9 @@ public function onKernelResponse(FilterResponseEvent $event)
         }
     }
 
+    /**
+     * {@inheritDoc}
+     */
     public static function getSubscribedEvents()
     {
         return array(KernelEvents::RESPONSE => 'onKernelResponse');