8000 [SecurityBundle][PHPDoc] Added method doumentation for SecurityFactor… by aminemat · Pull Request #18114 · symfony/symfony · GitHub
[go: up one dir, main page]
Skip to content

[SecurityBundle][PHPDoc] Added method doumentation for SecurityFactor… #18114

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
+20 −0
Closed

[SecurityBundle][PHPDoc] Added method doumentation for SecurityFactor… #18114

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions ...y/Bundle/SecurityBundle/DependencyInjection/Security/Factory/SecurityFactoryInterface.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,20 @@
*/
interface SecurityFactoryInterface
{
/**
* Configures the container services required to use the authentication listener.
*
* @param ContainerBuilder $container
* @param string $id The unique id of the firewall
* @param array $config The options array for the listener
* @param string $userProvider The service id of the user provider
* @param string $defaultEntryPoint
*
* @return array containing three values:
* - the provider id
* - the listener id
* - the entry point id
*/
public function create(ContainerBuilder $container, $id, $config, $userProvider, $defaultEntryPoint);

/**
Expand All @@ -31,6 +45,12 @@ public function create(ContainerBuilder $container, $id, $config, $userProvider,
*/
public function getPosition();

/**
* Defines the configuration key used to reference the provider
* in the firewall configuration.
*
* @return string
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you verify if it's really just the key or if it's the context? The context is the option you can pass along to a firewall in case they share they share context but have a different name. By default the context (if not provided) is the firewall name.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@iltar this is not the key or context of a firewall, it's just the name of the node in the configuration: https://github.com/symfony/security-bundle/blob/7f04a9ae1ff1dd4eeb6ad20b5df48fdd9c2230e3/DependencyInjection/MainConfiguration.php#L285

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, got me really confused there, I'd expect something like authenticator name or similar :)

You can ignore my comment

*/
public function getKey();

public function addConfiguration(NodeDefinition $builder);
Expand Down
0