Declare exceptions that are already thrown by implementations

This commit is contained in:
Stefan Kruppa 2019-01-04 17:03:46 +01:00
parent a1c8da08f6
commit f4cc30b72b

View File

@ -11,6 +11,8 @@
namespace Symfony\Component\Security\Core\Encoder; namespace Symfony\Component\Security\Core\Encoder;
use Symfony\Component\Security\Core\Exception\BadCredentialsException;
/** /**
* PasswordEncoderInterface is the interface for all encoders. * PasswordEncoderInterface is the interface for all encoders.
* *
@ -25,6 +27,9 @@ interface PasswordEncoderInterface
* @param string $salt The salt * @param string $salt The salt
* *
* @return string The encoded password * @return string The encoded password
*
* @throws BadCredentialsException If the raw password is invalid, e.g. excessively long
* @throws \InvalidArgumentException If the salt is invalid
*/ */
public function encodePassword($raw, $salt); public function encodePassword($raw, $salt);
@ -36,6 +41,8 @@ interface PasswordEncoderInterface
* @param string $salt The salt * @param string $salt The salt
* *
* @return bool true if the password is valid, false otherwise * @return bool true if the password is valid, false otherwise
*
* @throws \InvalidArgumentException If the salt is invalid
*/ */
public function isPasswordValid($encoded, $raw, $salt); public function isPasswordValid($encoded, $raw, $salt);
} }