Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit ec8cfc7

Browse filesBrowse files
ajgarlagajgarlag
committed
Fix phpdoc
1 parent 588f782 commit ec8cfc7
Copy full SHA for ec8cfc7

File tree

Expand file treeCollapse file tree

9 files changed

+49
-46
lines changed
Filter options
Expand file treeCollapse file tree

9 files changed

+49
-46
lines changed

‎src/Symfony/Bridge/Doctrine/Security/SessionRegistry/Schema.php

Copy file name to clipboardExpand all lines: src/Symfony/Bridge/Doctrine/Security/SessionRegistry/Schema.php
+3-3Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,7 @@
2222
final class Schema extends BaseSchema
2323
{
2424
/**
25-
* Constructor
26-
*
27-
* @param string $table
25+
* @param string $table The name of the table to create.
2826
*/
2927
public function __construct($table)
3028
{
@@ -35,6 +33,8 @@ public function __construct($table)
3533

3634
/**
3735
* Adds the session_information table to the schema
36+
*
37+
* @param string $table The name of the table to create.
3838
*/
3939
private function addSessionInformationTable($table)
4040
{

‎src/Symfony/Bridge/Doctrine/Security/SessionRegistry/SessionRegistryStorage.php

Copy file name to clipboardExpand all lines: src/Symfony/Bridge/Doctrine/Security/SessionRegistry/SessionRegistryStorage.php
+10-7Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,18 @@ class SessionRegistryStorage implements SessionRegistryStorageInterface
1515
private $connection;
1616
private $table;
1717

18+
/**
19+
* @param Connection $connection The DB connection
20+
* @param string $table The table name to store session information
21+
*/
1822
public function __construct(Connection $connection, $table)
1923
{
2024
$this->connection = $connection;
2125
$this->table = $table;
2226
}
2327

2428
/**
25-
* Obtains the maintained information for one session.
29+
* Gets the stored information for the given session.
2630
*
2731
* @param string $sessionId the session identifier key.
2832
* @return SessionInformation a SessionInformation object.
@@ -40,11 +44,11 @@ public function getSessionInformation($sessionId)
4044
}
4145

4246
/**
43-
* Obtains the maintained information for one user.
47+
* Gets the stored sessions information for the given username.
4448
*
45-
* @param string $username The user identifier.
46-
* @param bool $includeExpiredSessions.
47-
* @return array An array of SessionInformation objects.
49+
* @param string $username The user identifier.
50+
* @param bool $includeExpiredSessions If true, expired sessions information is included.
51+
* @return SessionInformations[] An array of SessionInformation objects.
4852
*/
4953
public function getSessionInformations($username, $includeExpiredSessions = false)
5054
{
@@ -68,7 +72,6 @@ public function getSessionInformations($username, $includeExpiredSessions = fals
6872
/**
6973
* Adds information for one session.
7074
*
71-
* @param string $sessionId the session identifier key.
7275
* @param SessionInformation a SessionInformation object.
7376
*/
7477
public function setSessionInformation(SessionInformation $sessionInformation)
@@ -122,7 +125,7 @@ public function setSessionInformation(SessionInformation $sessionInformation)
122125
}
123126

124127
/**
125-
* Deletes the maintained information of one session.
128+
* Deletes stored information of one session.
126129
*
127130
* @param string $sessionId the session identifier key.
128131
*/

‎src/Symfony/Bundle/SecurityBundle/Resources/config/security_listeners.xml

Copy file name to clipboardExpand all lines: src/Symfony/Bundle/SecurityBundle/Resources/config/security_listeners.xml
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -264,7 +264,7 @@
264264
<argument type="service" id="security.token_storage" />
265265
<argument type="service" id="security.http_utils" />
266266
<argument type="service" id="security.authentication.session_registry" />
267-
<argument /> <!-- Target-URL Path -->
267+
<argument /> <!-- Target-URL -->
268268
<argument type="service" on-invalid="null"/> <!-- Logout success handler -->
269269
<argument type="service" id="logger" on-invalid="null" />
270270
</service>

‎src/Symfony/Component/Security/Http/Firewall/ExpiredSessionListener.php

Copy file name to clipboardExpand all lines: src/Symfony/Component/Security/Http/Firewall/ExpiredSessionListener.php
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ public function addHandler(LogoutHandlerInterface $handler)
5858
/**
5959
* Handles the number of simultaneous sessions for a single user.
6060
*
61-
* @param GetResponseEvent $event A GetResponseEvent instance
61+
* @param GetResponseEvent $event A GetResponseEvent instance
6262
* @throws \RuntimeException if the successHandler exists and do not return a response
6363
*/
6464
public function handle(GetResponseEvent $event)

‎src/Symfony/Component/Security/Http/Session/CompositeSessionAuthenticationStrategy.php

Copy file name to clipboardExpand all lines: src/Symfony/Component/Security/Http/Session/CompositeSessionAuthenticationStrategy.php
+5-6Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,17 +16,17 @@
1616

1717
/**
1818
* A session authentication strategy that accepts multiple
19-
* SessionAuthenticationStrategyInterface implementations to delegate to. Each
20-
* SessionAuthenticationStrategyInterface is invoked in turn. The invocations are
21-
* short circuited if any exception, (i.e. SessionAuthenticationException) is
22-
* thrown.
19+
* SessionAuthenticationStrategyInterface implementations to delegate to.
20+
*
21+
* Each SessionAuthenticationStrategyInterface is invoked in turn. The
22+
* invocations are short circuited if any exception is thrown.
2323
*
2424
* @author Antonio J. García Lagar <aj@garcialagar.es>
2525
*/
2626
class CompositeSessionAuthenticationStrategy implements SessionAuthenticationStrategyInterface
2727
{
2828
/**
29-
* @var array
29+
* @var SessionAuthenticationStrategyInterface[]
3030
*/
3131
private $delegateStrategies = array();
3232

@@ -43,7 +43,6 @@ public function __construct(array $delegateStrategies)
4343
public function onAuthentication(Request $request, TokenInterface $token)
4444
{
4545
foreach ($this->delegateStrategies as $strategy) {
46-
/* @var $strategy SessionAuthenticationStrategyInterface */
4746
$strategy->onAuthentication($request, $token);
4847
}
4948
}

‎src/Symfony/Component/Security/Http/Session/ConcurrentSessionControlAuthenticationStrategy.php

Copy file name to clipboardExpand all lines: src/Symfony/Component/Security/Http/Session/ConcurrentSessionControlAuthenticationStrategy.php
+8-7Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,13 @@
1616
use Symfony\Component\Security\Core\Exception\MaxSessionsExceededException;
1717

1818
/**
19-
* ConcurrentSessionControlAuthenticationStrategy.
19+
* Strategy which handles concurrent session-control.
2020
*
21-
* Strategy which handles concurrent session-control, in addition to the functionality provided by the base class.
22-
* When invoked following an authentication, it will check whether the user in question should be allowed to proceed,
23-
* by comparing the number of sessions they already have active with the configured maximumSessions value.
24-
* The SessionRegistry is used as the source of data on authenticated users and session data.
21+
* When invoked following an authentication, it will check whether the user in
22+
* question should be allowed to proceed, by comparing the number of sessions
23+
* they already have active with the configured maximumSessions value.
24+
* The SessionRegistry is used as the source of data on authenticated users and
25+
* session data.
2526
*
2627
* @author Stefan Paschke <stefan.paschke@gmail.com>
2728
* @author Antonio J. García Lagar <aj@garcialagar.es>
@@ -87,7 +88,7 @@ public function setMaximumSessions($maximumSessions)
8788
}
8889

8990
/**
90-
* Allows subclasses to customise behaviour when too many sessions are detected.
91+
* Allows subclasses to customize behavior when too many sessions are detected.
9192
*
9293
* @param array $orderedSessions Array of SessionInformation ordered from
9394
* newest to oldest
@@ -110,7 +111,7 @@ protected function allowedSessionsExceeded($orderedSessions, $allowableSessions,
110111
/**
111112
* Method intended for use by subclasses to override the maximum number of sessions that are permitted for a particular authentication.
112113
*
113-
* @param string $username
114+
* @param string $username
114115
* @return int
115116
*/
116117
protected function getMaximumSessionsForThisUser($username)

‎src/Symfony/Component/Security/Http/Session/SessionInformation.php

Copy file name to clipboardExpand all lines: src/Symfony/Component/Security/Http/Session/SessionInformation.php
+4-4Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ public function __construct($sessionId, $username, \DateTime $lastRequest, \Date
3737
}
3838

3939
/**
40-
* Sets the session informations expired date to the current date and time.
40+
* Sets the session informations expiration date to the current date and time.
4141
*
4242
*/
4343
public function expireNow()
@@ -56,7 +56,7 @@ public function getLastRequest()
5656
}
5757

5858
/**
59-
* Obtains the username.
59+
* Gets the username.
6060
*
6161
* @return string
6262
*/
@@ -66,7 +66,7 @@ public function getUsername()
6666
}
6767

6868
/**
69-
* Obtain the session identifier.
69+
* Gets the session identifier key.
7070
*
7171
* @return string $sessionId the session identifier key.
7272
*/
@@ -76,7 +76,7 @@ public function getSessionId()
7676
}
7777

7878
/**
79-
* Return wether this session is expired.
79+
* Return whether this session is expired.
8080
*
8181
* @return bool
8282
*/

‎src/Symfony/Component/Security/Http/Session/SessionRegistry.php

Copy file name to clipboardExpand all lines: src/Symfony/Component/Security/Http/Session/SessionRegistry.php
+12-12Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
/**
1515
* SessionRegistry.
1616
*
17-
* Maintains a registry of SessionInformation instances.
17+
* Stores a registry of SessionInformation instances.
1818
*
1919
* @author Stefan Paschke <stefan.paschke@gmail.com>
2020
* @author Antonio J. García Lagar <aj@garcialagar.es>
@@ -29,22 +29,22 @@ public function __construct(SessionRegistryStorageInterface $sessionRegistryStor
2929
}
3030

3131
/**
32-
* Obtains all the known sessions for the specified user.
32+
* Returns all the sessions stored for the given user ordered from newest to oldest.
3333
*
34-
* @param string $username the specified user.
35-
* @param bool $includeExpiredSessions
36-
* @return array An array of SessionInformation objects.
34+
* @param string $username the given user.
35+
* @param bool $includeExpiredSessions
36+
* @return SessionInformation[] An array of SessionInformation objects.
3737
*/
3838
public function getAllSessions($username, $includeExpiredSessions = false)
3939
{
4040
return $this->sessionRegistryStorage->getSessionInformations($username, $includeExpiredSessions);
4141
}
4242

4343
/**
44-
* Obtains the session information for the specified sessionId.
44+
* Obtains the session information for the given sessionId.
4545
*
46-
* @param string $sessionId the session identifier key.
47-
* @return SessionInformation $sessionInformation
46+
* @param string $sessionId the session identifier key.
47+
* @return SessionInformation|null $sessionInformation
4848
*/
4949
public function getSessionInformation($sessionId)
5050
{
@@ -88,22 +88,22 @@ public function expireNow($sessionId)
8888
}
8989

9090
/**
91-
* Registers a new session for the specified user.
91+
* Registers a new session for the given user.
9292
*
9393
* @param string $sessionId the session identifier key.
94-
* @param string $username the specified user.
94+
* @param string $username the given user.
9595
* @param \DateTime $lastRequest
9696
*/
9797
public function registerNewSession($sessionId, $username, \DateTime $lastRequest = null)
9898
{
99-
$lastRequest = ($lastRequest) ?: new \DateTime();
99+
$lastRequest = $lastRequest ?: new \DateTime();
100100
$sessionInformation = new SessionInformation($sessionId, $username, $lastRequest);
101101

102102
$this->setSessionInformation($sessionInformation);
103103
}
104104

105105
/**
106-
* Deletes the maintained information of one session.
106+
* Deletes the stored information of one session.
107107
*
108108
* @param string $sessionId the session identifier key.
109109
*/

‎src/Symfony/Component/Security/Http/Session/SessionRegistryStorageInterface.php

Copy file name to clipboardExpand all lines: src/Symfony/Component/Security/Http/Session/SessionRegistryStorageInterface.php
+5-5Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,18 +24,18 @@ interface SessionRegistryStorageInterface
2424
/**
2525
* Obtains the session information for the specified sessionId.
2626
*
27-
* @param string $sessionId the session identifier key.
28-
* @return SessionInformation $sessionInformation
27+
* @param string $sessionId the session identifier key.
28+
* @return SessionInformation|null $sessionInformation
2929
*/
3030
public function getSessionInformation($sessionId);
3131

3232
/**
3333
* Obtains the maintained information for one user ordered from newest to
3434
* oldest
3535
*
36-
* @param string $username The user identifier.
37-
* @param bool $includeExpiredSessions
38-
* @return array An array of SessionInformation objects.
36+
* @param string $username The user identifier.
37+
* @param bool $includeExpiredSessions
38+
* @return SessionInformation[] An array of SessionInformation objects.
3939
*/
4040
public function getSessionInformations($username, $includeExpiredSessions = false);
4141

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.