SecurityDataCollector
class SecurityDataCollector extends DataCollector implements LateDataCollectorInterface
Properties
| protected | $data | from DataCollector |
Methods
| serialize() | from DataCollector | |
| unserialize($data) | from DataCollector | |
| Data | cloneVar(mixed $var) Converts the variable into a serializable Data instance. | from DataCollector |
| callable[] | getCasters() | from DataCollector |
| __construct(TokenStorageInterface $tokenStorage = null, RoleHierarchyInterface $roleHierarchy = null, LogoutUrlGenerator $logoutUrlGenerator = null, AccessDecisionManagerInterface $accessDecisionManager = null, FirewallMapInterface $firewallMap = null, TraceableFirewallListener $firewall = null) | ||
| collect(Request $request, Response $response, Exception $exception = null) Collects data for the given Request and Response. | ||
| reset() Resets this data collector to its initial state. | ||
| lateCollect() Collects data as late as possible. | ||
| bool | isEnabled() Checks if security is enabled. | |
| string | getUser() Gets the user. | |
| array | getRoles() Gets the roles of the user. | |
| array | getInheritedRoles() Gets the inherited roles of the user. | |
| bool | supportsRoleHierarchy() Checks if the data contains information about inherited roles. Still the inherited roles can be an empty array. | |
| bool | isAuthenticated() Checks if the user is authenticated or not. | |
| isImpersonated() | ||
| getImpersonatorUser() | ||
| getImpersonationExitPath() | ||
| string | getTokenClass() Get the class name of the security token. | |
| Data | getToken() Get the full security token class as Data object. | |
| string | getLogoutUrl() Get the logout URL. | |
| string[] | getVoters() Returns the FQCN of the security voters enabled in the application. | |
| string | getVoterStrategy() Returns the strategy configured for the security voters. | |
| array | getAccessDecisionLog() Returns the log of the security decisions made by the access decision manager. | |
| array | getFirewall() Returns the configuration of the current firewall context. | |
| getListeners() | ||
| string | getName() Returns the name of the collector. |
Details
serialize()
unserialize($data)
Parameters
| $data |
protected Data cloneVar(mixed $var)
Converts the variable into a serializable Data instance.
This array can be displayed in the template using the VarDumper component.
Parameters
| mixed | $var |
Return Value
| Data |
protected callable[] getCasters()
Return Value
| callable[] | The casters to add to the cloner |
__construct(TokenStorageInterface $tokenStorage = null, RoleHierarchyInterface $roleHierarchy = null, LogoutUrlGenerator $logoutUrlGenerator = null, AccessDecisionManagerInterface $accessDecisionManager = null, FirewallMapInterface $firewallMap = null, TraceableFirewallListener $firewall = null)
Parameters
| TokenStorageInterface | $tokenStorage | |
| RoleHierarchyInterface | $roleHierarchy | |
| LogoutUrlGenerator | $logoutUrlGenerator | |
| AccessDecisionManagerInterface | $accessDecisionManager | |
| FirewallMapInterface | $firewallMap | |
| TraceableFirewallListener | $firewall |
collect(Request $request, Response $response, Exception $exception = null)
Collects data for the given Request and Response.
Parameters
| Request | $request | |
| Response | $response | |
| Exception | $exception |
reset()
Resets this data collector to its initial state.
lateCollect()
Collects data as late as possible.
bool isEnabled()
Checks if security is enabled.
Return Value
| bool | true if security is enabled, false otherwise |
string getUser()
Gets the user.
Return Value
| string | The user |
array getRoles()
Gets the roles of the user.
Return Value
| array | The roles |
array getInheritedRoles()
Gets the inherited roles of the user.
Return Value
| array | The inherited roles |
bool supportsRoleHierarchy()
Checks if the data contains information about inherited roles. Still the inherited roles can be an empty array.
Return Value
| bool | true if the profile was contains inherited role information |
bool isAuthenticated()
Checks if the user is authenticated or not.
Return Value
| bool | true if the user is authenticated, false otherwise |
isImpersonated()
getImpersonatorUser()
getImpersonationExitPath()
string getTokenClass()
Get the class name of the security token.
Return Value
| string | The token |
Data getToken()
Get the full security token class as Data object.
Return Value
| Data |
string getLogoutUrl()
Get the logout URL.
Return Value
| string | The logout URL |
string[] getVoters()
Returns the FQCN of the security voters enabled in the application.
Return Value
| string[] |
string getVoterStrategy()
Returns the strategy configured for the security voters.
Return Value
| string |
array getAccessDecisionLog()
Returns the log of the security decisions made by the access decision manager.
Return Value
| array |
array getFirewall()
Returns the configuration of the current firewall context.
Return Value
| array |
getListeners()
string getName()
Returns the name of the collector.
Return Value
| string | The collector name |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
https://api.symfony.com/4.1/Symfony/Bundle/SecurityBundle/DataCollector/SecurityDataCollector.html