minor #18114 [SecurityBundle][PHPDoc] Added method doumentation for SecurityFactor… (aminemat)

nicolas-grekas · nicolas-grekas · commit afd31dae5e8a · 2016-03-15T14:44:54.000+01:00
This PR was submitted for the master branch but it was merged into the 2.3 branch instead (closes #18114). Discussion ---------- [SecurityBundle][PHPDoc] Added method doumentation for SecurityFactor… | Q | A | ------------- | --- | Branch | 2.7 | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #10870 | License | MIT | Doc PR | Commits ------- cfb3ea1 [SecurityBundle][PHPDoc] Added method doumentation for SecurityFactoryInterface
diff --git a/src/Symfony/Bundle/SecurityBundle/DependencyInjection/Security/Factory/SecurityFactoryInterface.php b/src/Symfony/Bundle/SecurityBundle/DependencyInjection/Security/Factory/SecurityFactoryInterface.php
@@ -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);
 
     /**
@@ -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
+     */
     public function getKey();
 
     public function addConfiguration(NodeDefinition $builder);
