[Security] improve some firewall config comments

This commit is contained in:
Christian Flothmann 2016-11-04 09:25:13 +01:00
parent 9e2ad932e9
commit cb6c7035ff
2 changed files with 22 additions and 6 deletions

View File

@ -122,9 +122,9 @@
<argument /> <!-- provider --> <argument /> <!-- provider -->
<argument /> <!-- context --> <argument /> <!-- context -->
<argument /> <!-- entry_point --> <argument /> <!-- entry_point -->
<argument /> <!-- user_checker -->
<argument /> <!-- access_denied_handler --> <argument /> <!-- access_denied_handler -->
<argument /> <!-- access_denied_url --> <argument /> <!-- access_denied_url -->
<argument /> <!-- user_checker -->
<argument type="collection" /> <!-- listeners --> <argument type="collection" /> <!-- listeners -->
</service> </service>

View File

@ -28,6 +28,19 @@ class FirewallConfig
private $userChecker; private $userChecker;
private $listeners; private $listeners;
/**
* @param string $name
* @param string $requestMatcher
* @param bool $securityEnabled
* @param bool $stateless
* @param string|null $provider
* @param string|null $context
* @param string|null $entryPoint
* @param string|null $accessDeniedHandler
* @param string|null $accessDeniedUrl
* @param string|null $userChecker
* @param string[] $listeners
*/
public function __construct($name, $requestMatcher, $securityEnabled = true, $stateless = false, $provider = null, $context = null, $entryPoint = null, $accessDeniedHandler = null, $accessDeniedUrl = null, $userChecker = null, $listeners = array()) public function __construct($name, $requestMatcher, $securityEnabled = true, $stateless = false, $provider = null, $context = null, $entryPoint = null, $accessDeniedHandler = null, $accessDeniedUrl = null, $userChecker = null, $listeners = array())
{ {
$this->name = $name; $this->name = $name;
@ -72,7 +85,7 @@ class FirewallConfig
} }
/** /**
* @return string The provider service id * @return string|null The provider service id
*/ */
public function getProvider() public function getProvider()
{ {
@ -80,7 +93,7 @@ class FirewallConfig
} }
/** /**
* @return string The context key * @return string|null The context key (will be null if the firewall is stateless)
*/ */
public function getContext() public function getContext()
{ {
@ -88,7 +101,7 @@ class FirewallConfig
} }
/** /**
* @return string The entry_point service id * @return string|null The entry_point service id if configured, null otherwise
*/ */
public function getEntryPoint() public function getEntryPoint()
{ {
@ -104,20 +117,23 @@ class FirewallConfig
} }
/** /**
* @return string The access_denied_handler service id * @return string|null The access_denied_handler service id if configured, null otherwise
*/ */
public function getAccessDeniedHandler() public function getAccessDeniedHandler()
{ {
return $this->accessDeniedHandler; return $this->accessDeniedHandler;
} }
/**
* @return string|null The access_denied_handler URL if configured, null otherwise
*/
public function getAccessDeniedUrl() public function getAccessDeniedUrl()
{ {
return $this->accessDeniedUrl; return $this->accessDeniedUrl;
} }
/** /**
* @return array An array of listener keys * @return string[] An array of listener keys
*/ */
public function getListeners() public function getListeners()
{ {