minor #31813 fix type hint for salt in PasswordEncoderInterface (garak)

nicolas-grekas · nicolas-grekas · commit 0797ef28ed35 · 2019-06-03T21:38:32.000+02:00
This PR was squashed before being merged into the 3.4 branch (closes #31813). Discussion ---------- fix type hint for salt in PasswordEncoderInterface See issue #31812 | Q | A | ------------- | --- | Branch? | 3.4 | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #31812 | License | MIT | Doc PR | none Pretty self-explanatory Commits ------- 0e741f9 fix type hint for salt in PasswordEncoderInterface
diff --git a/src/Symfony/Component/Security/Core/Encoder/BasePasswordEncoder.php b/src/Symfony/Component/Security/Core/Encoder/BasePasswordEncoder.php
@@ -48,8 +48,8 @@ protected function demergePasswordAndSalt($mergedPasswordSalt)
     /**
      * Merges a password and a salt.
      *
-     * @param string $password The password to be used
-     * @param string $salt     The salt to be used
+     * @param string      $password The password to be used
+     * @param string|null $salt     The salt to be used
      *
      * @return string a merged password and salt
      *
diff --git a/src/Symfony/Component/Security/Core/Encoder/PasswordEncoderInterface.php b/src/Symfony/Component/Security/Core/Encoder/PasswordEncoderInterface.php
@@ -23,8 +23,8 @@ interface PasswordEncoderInterface
     /**
      * Encodes the raw password.
      *
-     * @param string $raw  The password to encode
-     * @param string $salt The salt
+     * @param string      $raw  The password to encode
+     * @param string|null $salt The salt
      *
      * @return string The encoded password
      *
@@ -36,9 +36,9 @@ public function encodePassword($raw, $salt);
     /**
      * Checks a raw password against an encoded password.
      *
-     * @param string $encoded An encoded password
-     * @param string $raw     A raw password
-     * @param string $salt    The salt
+     * @param string      $encoded An encoded password
+     * @param string      $raw     A raw password
+     * @param string|null $salt    The salt
      *
      * @return bool true if the password is valid, false otherwise
      *

Original file line number	Diff line number	Diff line change
`@@ -48,8 +48,8 @@ protected function demergePasswordAndSalt($mergedPasswordSalt)`
`48`	`48`	`/**`
`49`	`49`	`* Merges a password and a salt.`
`50`	`50`	`*`
`51`		`- * @param string $password The password to be used`
`52`		`- * @param string $salt The salt to be used`
	`51`	`+ * @param string $password The password to be used`
	`52`	`+ * @param string\|null $salt The salt to be used`
`53`	`53`	`*`
`54`	`54`	`* @return string a merged password and salt`
`55`	`55`	`*`
Original file line number	Diff line number	Diff line change
`@@ -23,8 +23,8 @@ interface PasswordEncoderInterface`
`23`	`23`	`/**`
`24`	`24`	`* Encodes the raw password.`
`25`	`25`	`*`
`26`		`- * @param string $raw The password to encode`
`27`		`- * @param string $salt The salt`
	`26`	`+ * @param string $raw The password to encode`
	`27`	`+ * @param string\|null $salt The salt`
`28`	`28`	`*`
`29`	`29`	`* @return string The encoded password`
`30`	`30`	`*`
`@@ -36,9 +36,9 @@ public function encodePassword($raw, $salt);`
`36`	`36`	`/**`
`37`	`37`	`* Checks a raw password against an encoded password.`
`38`	`38`	`*`
`39`		`- * @param string $encoded An encoded password`
`40`		`- * @param string $raw A raw password`
`41`		`- * @param string $salt The salt`
	`39`	`+ * @param string $encoded An encoded password`
	`40`	`+ * @param string $raw A raw password`
	`41`	`+ * @param string\|null $salt The salt`
`42`	`42`	`*`
`43`	`43`	`* @return bool true if the password is valid, false otherwise`
`44`	`44`	`*`