vendor/symfony/security-bundle/Security/FirewallConfig.php line 70

Open in your IDE?
  1. <?php
  3. /*
  4. * This file is part of the Symfony package.
  5. *
  6. * (c) Fabien Potencier <fabien@symfony.com>
  7. *
  8. * For the full copyright and license information, please view the LICENSE
  9. * file that was distributed with this source code.
  10. */
  12. namespace Symfony\Bundle\SecurityBundle\Security;
  14. /**
  15. * @author Robin Chalas <robin.chalas@gmail.com>
  16. */
  17. final class FirewallConfig
  18. {
  19. private $name;
  20. private $userChecker;
  21. private $requestMatcher;
  22. private $securityEnabled;
  23. private $stateless;
  24. private $provider;
  25. private $context;
  26. private $entryPoint;
  27. private $accessDeniedHandler;
  28. private $accessDeniedUrl;
  29. private $authenticators;
  30. private $switchUser;
  32. public function __construct(string $name, string $userChecker, ?string $requestMatcher = null, bool $securityEnabled = true, bool $stateless = false, ?string $provider = null, ?string $context = null, ?string $entryPoint = null, ?string $accessDeniedHandler = null, ?string $accessDeniedUrl = null, array $authenticators = [], ?array $switchUser = null)
  33. {
  34. $this->name = $name;
  35. $this->userChecker = $userChecker;
  36. $this->requestMatcher = $requestMatcher;
  37. $this->securityEnabled = $securityEnabled;
  38. $this->stateless = $stateless;
  39. $this->provider = $provider;
  40. $this->context = $context;
  41. $this->entryPoint = $entryPoint;
  42. $this->accessDeniedHandler = $accessDeniedHandler;
  43. $this->accessDeniedUrl = $accessDeniedUrl;
  44. $this->authenticators = $authenticators;
  45. $this->switchUser = $switchUser;
  46. }
  48. public function getName(): string
  49. {
  50. return $this->name;
  51. }
  53. /**
  54. * @return string|null The request matcher service id or null if neither the request matcher, pattern or host
  55. * options were provided
  56. */
  57. public function getRequestMatcher(): ?string
  58. {
  59. return $this->requestMatcher;
  60. }
  62. public function isSecurityEnabled(): bool
  63. {
  64. return $this->securityEnabled;
  65. }
  67. /**
  68. * @deprecated since Symfony 5.4
  69. */
  70. public function allowsAnonymous(): bool
  71. {
  72. trigger_deprecation('symfony/security-bundle', '5.4', 'The "%s()" method is deprecated.', __METHOD__);
  74. return \in_array('anonymous', $this->authenticators, true);
  75. }
  77. public function isStateless(): bool
  78. {
  79. return $this->stateless;
  80. }
  82. public function getProvider(): ?string
  83. {
  84. return $this->provider;
  85. }
  87. /**
  88. * @return string|null The context key (will be null if the firewall is stateless)
  89. */
  90. public function getContext(): ?string
  91. {
  92. return $this->context;
  93. }
  95. public function getEntryPoint(): ?string
  96. {
  97. return $this->entryPoint;
  98. }
  100. public function getUserChecker(): string
  101. {
  102. return $this->userChecker;
  103. }
  105. public function getAccessDeniedHandler(): ?string
  106. {
  107. return $this->accessDeniedHandler;
  108. }
  110. public function getAccessDeniedUrl(): ?string
  111. {
  112. return $this->accessDeniedUrl;
  113. }
  115. /**
  116. * @deprecated since Symfony 5.4, use {@see getAuthenticators()} instead
  117. */
  118. public function getListeners(): array
  119. {
  120. trigger_deprecation('symfony/security-bundle', '5.4', 'Method "%s()" is deprecated, use "%s::getAuthenticators()" instead.', __METHOD__, __CLASS__);
  122. return $this->getAuthenticators();
  123. }
  125. public function getAuthenticators(): array
  126. {
  127. return $this->authenticators;
  128. }
  130. public function getSwitchUser(): ?array
  131. {
  132. return $this->switchUser;
  133. }
  134. }