10000 minor #20404 [Security] improve some firewall config comments (xabbuh) · symfony/symfony@706d925 · GitHub
[go: up one dir, main page]

Skip to content

Commit 706d925

Browse files
committed
minor #20404 [Security] improve some firewall config comments (xabbuh)
This PR was merged into the 3.2-dev branch. Discussion ---------- [Security] improve some firewall config comments | Q | A | ------------- | --- | Branch? | master | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #19398 | License | MIT | Doc PR | Commits ------- cb6c703 [Security] improve some firewall config comments
2 parents 9e2ad93 + cb6c703 commit 706d925

File tree

2 files changed

+22
-6
lines changed

2 files changed

+22
-6
lines changed

src/Symfony/Bundle/SecurityBundle/Resources/config/security.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -122,9 +122,9 @@
122122
<argument /> <!-- provider -->
123123
<argument /> <!-- context -->
124124
<argument /> <!-- entry_point -->
125-
<argument /> <!-- user_checker -->
126125
<argument /> <!-- access_denied_handler -->
127126
<argument /> <!-- access_denied_url -->
127+
<argument /> <!-- user_checker -->
128128
<argument type="collection" /> <!-- listeners -->
129129
</service>
130130

src/Symfony/Bundle/SecurityBundle/Security/FirewallConfig.php

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,19 @@ class FirewallConfig
2828
private $userChecker;
2929
private $listeners;
3030

31+
/**< 8000 /div>
32+
* @param string $name
33+
* @param string $requestMatcher
34+
* @param bool $securityEnabled
35+
* @param bool $stateless
36+
* @param string|null $provider
37+
* @param string|null $context
38+
* @param string|null $entryPoint
39+
* @param string|null $accessDeniedHandler
40+
* @param string|null $accessDeniedUrl
41+
* @param string|null $userChecker
42+
* @param string[] $listeners
43+
*/
3144
public function __construct($name, $requestMatcher, $securityEnabled = true, $stateless = false, $provider = null, $context = null, $entryPoint = null, $accessDeniedHandler = null, $accessDeniedUrl = null, $userChecker = null, $listeners = array())
3245
{
3346
$this->name = $name;
@@ -72,23 +85,23 @@ public function isStateless()
7285
}
7386

7487
/**
75-
* @return string The provider service id
88+
* @return string|null The provider service id
7689
*/
7790
public function getProvider()
7891
{
7992
return $this->provider;
8093
}
8194

8295
/**
83-
* @return string The context key
96+
* @return string|null The context key (will be null if the firewall is stateless)
8497
*/
8598
public function getContext()
8699
{
87100
return $this->context;
88101
}
89102

90103
/**
91-
* @return string The entry_point service id
104+
* @return string|null The entry_point service id if configured, null otherwise
92105
*/
93106
public function getEntryPoint()
94107
{
@@ -104,20 +117,23 @@ public function getUserChecker()
104117
}
105118

106119
/**
107-
* @return string The access_denied_handler service id
120+
* @return string|null The access_denied_handler service id if configured, null otherwise
108121
*/
109122
public function getAccessDeniedHandler()
110123
{
111124
return $this->accessDeniedHandler;
112125
}
113126

127+
/**
128+
* @return string|null The access_denied_handler URL if configured, null otherwise
129+
*/
114130
public function getAccessDeniedUrl()
115131
{
116132
return $this->accessDeniedUrl;
117133
}
118134

119135
/**
120-
* @return array An array of listener keys
136+
* @return string[] An array of listener keys
121137
*/
122138
public function getListeners()
123139
{

0 commit comments

Comments
 (0)
0