summaryrefslogtreecommitdiffstats
path: root/Http
diff options
context:
space:
mode:
authorFabien Potencier <fabien.potencier@gmail.com>2014-11-30 17:59:09 +0100
committerFabien Potencier <fabien.potencier@gmail.com>2014-11-30 17:59:09 +0100
commitf9c498153d663c0cf0710ff9c89a11d2a4833cdc (patch)
treefe2c86b4887eef95757f849324e26d20965766bc /Http
parent748e258f7683a17e9803ded49ae94ab3e24e6c68 (diff)
parente5dfe6a3e96c71e87c0ca9aa84115accd9ebb229 (diff)
downloadsymfony-security-f9c498153d663c0cf0710ff9c89a11d2a4833cdc.zip
symfony-security-f9c498153d663c0cf0710ff9c89a11d2a4833cdc.tar.gz
symfony-security-f9c498153d663c0cf0710ff9c89a11d2a4833cdc.tar.bz2
minor #12774 Docblock Fixes (GrahamCampbell)
This PR was merged into the 2.3 branch. Discussion ---------- Docblock Fixes | Q | A | ------------- | --- | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | N/A | License | MIT | Doc PR | N/A ##### This pull request fixes the docblock alignment as requested in #12760. It was also necessary for me to ensure the `@return` annotations were correctly separated in order to accurately align the `@param` annotations. Commits ------- 443307e Docblock fixes
Diffstat (limited to 'Http')
-rw-r--r--Http/Firewall/LogoutListener.php2
-rw-r--r--Http/HttpUtils.php2
-rw-r--r--Http/RememberMe/TokenBasedRememberMeServices.php18
3 files changed, 11 insertions, 11 deletions
diff --git a/Http/Firewall/LogoutListener.php b/Http/Firewall/LogoutListener.php
index 2faf9c7..a558c2c 100644
--- a/Http/Firewall/LogoutListener.php
+++ b/Http/Firewall/LogoutListener.php
@@ -76,7 +76,7 @@ class LogoutListener implements ListenerInterface
*
* @param GetResponseEvent $event A GetResponseEvent instance
*
- * @throws LogoutException 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
*/
public function handle(GetResponseEvent $event)
diff --git a/Http/HttpUtils.php b/Http/HttpUtils.php
index 50d4f26..50e68d3 100644
--- a/Http/HttpUtils.php
+++ b/Http/HttpUtils.php
@@ -96,7 +96,7 @@ class HttpUtils
* @param Request $request A Request instance
* @param string $path A path (an absolute path (/foo), an absolute URL (http://...), or a route name (foo))
*
- * @return bool true if the path is the same as the one from the Request, false otherwise
+ * @return bool true if the path is the same as the one from the Request, false otherwise
*/
public function checkRequestPath(Request $request, $path)
{
diff --git a/Http/RememberMe/TokenBasedRememberMeServices.php b/Http/RememberMe/TokenBasedRememberMeServices.php
index 7581a68..132831e 100644
--- a/Http/RememberMe/TokenBasedRememberMeServices.php
+++ b/Http/RememberMe/TokenBasedRememberMeServices.php
@@ -73,7 +73,7 @@ class TokenBasedRememberMeServices extends AbstractRememberMeServices
* @param string $hash1 The first hash
* @param string $hash2 The second hash
*
- * @return bool true if the two hashes are the same, false otherwise
+ * @return bool true if the two hashes are the same, false otherwise
*/
private function compareHashes($hash1, $hash2)
{
@@ -114,10 +114,10 @@ class TokenBasedRememberMeServices extends AbstractRememberMeServices
/**
* Generates the cookie value.
*
- * @param string $class
- * @param string $username The username
- * @param int $expires The Unix timestamp when the cookie expires
- * @param string $password The encoded password
+ * @param string $class
+ * @param string $username The username
+ * @param int $expires The Unix timestamp when the cookie expires
+ * @param string $password The encoded password
*
* @throws \RuntimeException if username contains invalid chars
*
@@ -136,10 +136,10 @@ class TokenBasedRememberMeServices extends AbstractRememberMeServices
/**
* Generates a hash for the cookie to ensure it is not being tempered with
*
- * @param string $class
- * @param string $username The username
- * @param int $expires The Unix timestamp when the cookie expires
- * @param string $password The encoded password
+ * @param string $class
+ * @param string $username The username
+ * @param int $expires The Unix timestamp when the cookie expires
+ * @param string $password The encoded password
*
* @throws \RuntimeException when the private key is empty
*