class NotCompromisedPassword
Checks if a password has been leaked in a data breach.
@author Kévin Dunglas <dunglas@gmail.com>
Hierarchy
- class \Symfony\Component\Validator\Constraint
- class \Symfony\Component\Validator\Constraints\NotCompromisedPassword extends \Symfony\Component\Validator\Constraint
Expanded class hierarchy of NotCompromisedPassword
File
-
vendor/
symfony/ validator/ Constraints/ NotCompromisedPassword.php, line 21
Namespace
Symfony\Component\Validator\ConstraintsView source
class NotCompromisedPassword extends Constraint {
public const COMPROMISED_PASSWORD_ERROR = 'd9bcdbfe-a9d6-4bfa-a8ff-da5fd93e0f6d';
protected const ERROR_NAMES = [
self::COMPROMISED_PASSWORD_ERROR => 'COMPROMISED_PASSWORD_ERROR',
];
public string $message = 'This password has been leaked in a data breach, it must not be used. Please use another password.';
public int $threshold = 1;
public bool $skipOnError = false;
/**
* @param array<string,mixed>|null $options
* @param positive-int|null $threshold The number of times the password should have been leaked to consider it is compromised (defaults to 1)
* @param bool|null $skipOnError Whether to ignore HTTP errors while requesting the API and thus consider the password valid (defaults to false)
* @param string[]|null $groups
*/
public function __construct(?array $options = null, ?string $message = null, ?int $threshold = null, ?bool $skipOnError = null, ?array $groups = null, mixed $payload = null) {
parent::__construct($options, $groups, $payload);
$this->message = $message ?? $this->message;
$this->threshold = $threshold ?? $this->threshold;
$this->skipOnError = $skipOnError ?? $this->skipOnError;
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
Constraint::$groups | public | property | The groups that the constraint belongs to. | ||
Constraint::$payload | public | property | Domain-specific data attached to a constraint. | ||
Constraint::addImplicitGroupName | public | function | Adds the given group if this constraint is in the Default group. | 2 | |
Constraint::CLASS_CONSTRAINT | public | constant | Marks a constraint that can be put onto classes. | ||
Constraint::DEFAULT_GROUP | public | constant | The name of the group given to all constraints with no explicit group. | ||
Constraint::getDefaultOption | public | function | Returns the name of the default option. | 28 | |
Constraint::getErrorName | public static | function | Returns the name of the given error code. | ||
Constraint::getRequiredOptions | public | function | Returns the name of the required options. | 22 | |
Constraint::getTargets | public | function | Returns whether the constraint can be put onto classes, properties or both. |
8 | |
Constraint::normalizeOptions | protected | function | |||
Constraint::PROPERTY_CONSTRAINT | public | constant | Marks a constraint that can be put onto properties. | ||
Constraint::validatedBy | public | function | Returns the name of the class that validates this constraint. | 9 | |
Constraint::__get | public | function | Returns the value of a lazily initialized option. | 2 | |
Constraint::__isset | public | function | 1 | ||
Constraint::__set | public | function | Sets the value of a lazily initialized option. | 1 | |
Constraint::__sleep | public | function | Optimizes the serialized value to minimize storage space. | ||
NotCompromisedPassword::$message | public | property | |||
NotCompromisedPassword::$skipOnError | public | property | |||
NotCompromisedPassword::$threshold | public | property | |||
NotCompromisedPassword::COMPROMISED_PASSWORD_ERROR | public | constant | |||
NotCompromisedPassword::ERROR_NAMES | protected | constant | Maps error codes to the names of their constants. | Overrides Constraint::ERROR_NAMES | |
NotCompromisedPassword::__construct | public | function | Overrides Constraint::__construct |