[SecurityBundle] fix return type declarations

nicolas-grekas · nicolas-grekas · commit d1989853ed8e · 2019-08-25T22:01:39.000+02:00
diff --git a/src/Symfony/Bundle/SecurityBundle/DataCollector/SecurityDataCollector.php b/src/Symfony/Bundle/SecurityBundle/DataCollector/SecurityDataCollector.php
@@ -231,7 +231,7 @@ public function getUser()
     /**
      * Gets the roles of the user.
      *
-     * @return array The roles
+     * @return array|Data
      */
     public function getRoles()
     {
@@ -241,7 +241,7 @@ public function getRoles()
     /**
      * Gets the inherited roles of the user.
      *
-     * @return array The inherited roles
+     * @return array|Data
      */
     public function getInheritedRoles()
     {
@@ -269,16 +269,25 @@ public function isAuthenticated()
         return $this->data['authenticated'];
     }
 
+    /**
+     * @return bool
+     */
     public function isImpersonated()
     {
         return $this->data['impersonated'];
     }
 
+    /**
+     * @return string|null
+     */
     public function getImpersonatorUser()
     {
         return $this->data['impersonator_user'];
     }
 
+    /**
+     * @return string|null
+     */
     public function getImpersonationExitPath()
     {
         return $this->data['impersonation_exit_path'];
@@ -287,7 +296,7 @@ public function getImpersonationExitPath()
     /**
      * Get the class name of the security token.
      *
-     * @return string The token
+     * @return string|Data|null The token
      */
     public function getTokenClass()
     {
@@ -297,7 +306,7 @@ public function getTokenClass()
     /**
      * Get the full security token class as Data object.
      *
-     * @return Data
+     * @return Data|null
      */
     public function getToken()
     {
@@ -307,7 +316,7 @@ public function getToken()
     /**
      * Get the logout URL.
      *
-     * @return string The logout URL
+     * @return string|null The logout URL
      */
     public function getLogoutUrl()
     {
@@ -317,7 +326,7 @@ public function getLogoutUrl()
     /**
      * Returns the FQCN of the security voters enabled in the application.
      *
-     * @return string[]
+     * @return string[]|Data
      */
     public function getVoters()
     {
@@ -337,7 +346,7 @@ public function getVoterStrategy()
     /**
      * Returns the log of the security decisions made by the access decision manager.
      *
-     * @return array
+     * @return array|Data
      */
     public function getAccessDecisionLog()
     {
@@ -347,13 +356,16 @@ public function getAccessDecisionLog()
     /**
      * Returns the configuration of the current firewall context.
      *
-     * @return array
+     * @return array|Data
      */
     public function getFirewall()
     {
         return $this->data['firewall'];
     }
 
+    /**
+     * @return array|Data
+     */
     public function getListeners()
     {
         return $this->data['listeners'];
diff --git a/src/Symfony/Bundle/SecurityBundle/DependencyInjection/Security/Factory/AbstractFactory.php b/src/Symfony/Bundle/SecurityBundle/DependencyInjection/Security/Factory/AbstractFactory.php
@@ -130,9 +130,9 @@ abstract protected function getListenerId();
      * @param ContainerBuilder $container
      * @param string           $id
      * @param array            $config
-     * @param string           $defaultEntryPointId
+     * @param string|null      $defaultEntryPointId
      *
-     * @return string the entry point id
+     * @return string|null the entry point id
      */
     protected function createEntryPoint($container, $id, $config, $defaultEntryPointId)
     {
diff --git a/src/Symfony/Bundle/SecurityBundle/DependencyInjection/Security/Factory/SecurityFactoryInterface.php b/src/Symfony/Bundle/SecurityBundle/DependencyInjection/Security/Factory/SecurityFactoryInterface.php
@@ -24,10 +24,10 @@ interface SecurityFactoryInterface
     /**
      * Configures the container services required to use the authentication listener.
      *
-     * @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
+     * @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|null $defaultEntryPoint
      *
      * @return array containing three values:
      *               - the provider id

Original file line number	Diff line number	Diff line change
`@@ -231,7 +231,7 @@ public function getUser()`
`231`	`231`	`/**`
`232`	`232`	`* Gets the roles of the user.`
`233`	`233`	`*`
`234`		`- * @return array The roles`
	`234`	`+ * @return array\|Data`
`235`	`235`	`*/`
`236`	`236`	`public function getRoles()`
`237`	`237`	`{`
`@@ -241,7 +241,7 @@ public function getRoles()`
`241`	`241`	`/**`
`242`	`242`	`* Gets the inherited roles of the user.`
`243`	`243`	`*`
`244`		`- * @return array The inherited roles`
	`244`	`+ * @return array\|Data`
`245`	`245`	`*/`
`246`	`246`	`public function getInheritedRoles()`
`247`	`247`	`{`
`@@ -269,16 +269,25 @@ public function isAuthenticated()`
`269`	`269`	`return $this->data['authenticated'];`
`270`	`270`	`}`
`271`	`271`
	`272`	`+ /**`
	`273`	`+ * @return bool`
	`274`	`+ */`
`272`	`275`	`public function isImpersonated()`
`273`	`276`	`{`
`274`	`277`	`return $this->data['impersonated'];`
`275`	`278`	`}`
`276`	`279`
	`280`	`+ /**`
	`281`	`+ * @return string\|null`
	`282`	`+ */`
`277`	`283`	`public function getImpersonatorUser()`
`278`	`284`	`{`
`279`	`285`	`return $this->data['impersonator_user'];`
`280`	`286`	`}`
`281`	`287`
	`288`	`+ /**`
	`289`	`+ * @return string\|null`
	`290`	`+ */`
`282`	`291`	`public function getImpersonationExitPath()`
`283`	`292`	`{`
`284`	`293`	`return $this->data['impersonation_exit_path'];`
`@@ -287,7 +296,7 @@ public function getImpersonationExitPath()`
`287`	`296`	`/**`
`288`	`297`	`* Get the class name of the security token.`
`289`	`298`	`*`
`290`		`- * @return string The token`
	`299`	`+ * @return string\|Data\|null The token`
`291`	`300`	`*/`
`292`	`301`	`public function getTokenClass()`
`293`	`302`	`{`
`@@ -297,7 +306,7 @@ public function getTokenClass()`
`297`	`306`	`/**`
`298`	`307`	`* Get the full security token class as Data object.`
`299`	`308`	`*`
`300`		`- * @return Data`
	`309`	`+ * @return Data\|null`
`301`	`310`	`*/`
`302`	`311`	`public function getToken()`
`303`	`312`	`{`
`@@ -307,7 +316,7 @@ public function getToken()`
`307`	`316`	`/**`
`308`	`317`	`* Get the logout URL.`
`309`	`318`	`*`
`310`		`- * @return string The logout URL`
	`319`	`+ * @return string\|null The logout URL`
`311`	`320`	`*/`
`312`	`321`	`public function getLogoutUrl()`
`313`	`322`	`{`
`@@ -317,7 +326,7 @@ public function getLogoutUrl()`
`317`	`326`	`/**`
`318`	`327`	`* Returns the FQCN of the security voters enabled in the application.`
`319`	`328`	`*`
`320`		`- * @return string[]`
	`329`	`+ * @return string[]\|Data`
`321`	`330`	`*/`
`322`	`331`	`public function getVoters()`
`323`	`332`	`{`
`@@ -337,7 +346,7 @@ public function getVoterStrategy()`
`337`	`346`	`/**`
`338`	`347`	`* Returns the log of the security decisions made by the access decision manager.`
`339`	`348`	`*`
`340`		`- * @return array`
	`349`	`+ * @return array\|Data`
`341`	`350`	`*/`
`342`	`351`	`public function getAccessDecisionLog()`
`343`	`352`	`{`
`@@ -347,13 +356,16 @@ public function getAccessDecisionLog()`
`347`	`356`	`/**`
`348`	`357`	`* Returns the configuration of the current firewall context.`
`349`	`358`	`*`
`350`		`- * @return array`
	`359`	`+ * @return array\|Data`
`351`	`360`	`*/`
`352`	`361`	`public function getFirewall()`
`353`	`362`	`{`
`354`	`363`	`return $this->data['firewall'];`
`355`	`364`	`}`
`356`	`365`
	`366`	`+ /**`
	`367`	`+ * @return array\|Data`
	`368`	`+ */`
`357`	`369`	`public function getListeners()`
`358`	`370`	`{`
`359`	`371`	`return $this->data['listeners'];`
Original file line number	Diff line number	Diff line change
`@@ -130,9 +130,9 @@ abstract protected function getListenerId();`
`130`	`130`	`* @param ContainerBuilder $container`
`131`	`131`	`* @param string $id`
`132`	`132`	`* @param array $config`
`133`		`- * @param string $defaultEntryPointId`
	`133`	`+ * @param string\|null $defaultEntryPointId`
`134`	`134`	`*`
`135`		`- * @return string the entry point id`
	`135`	`+ * @return string\|null the entry point id`
`136`	`136`	`*/`
`137`	`137`	`protected function createEntryPoint($container, $id, $config, $defaultEntryPointId)`
`138`	`138`	`{`