UserPassword
Edit this pageWarning: You are browsing the documentation for Symfony 2.5, which is no longer maintained.
Read the updated version of this page for Symfony 6.3 (the current stable version).
UserPassword
This validates that an input value is equal to the current authenticated user's password. This is useful in a form where a user can change their password, but needs to enter their old password for security.
Note
This should not be used to validate a login form, since this is done automatically by the security system.
Applies to | property or method |
Options | |
Class | UserPassword |
Validator | UserPasswordValidator |
Basic Usage
Suppose you have a `PasswordChange` class, that's used in a form where the user can change their password by entering their old password and a new password. This constraint will validate that the old password matches the user's current password:
1 2 3 4 5 6
# src/Acme/UserBundle/Resources/config/validation.yml
Acme\UserBundle\Form\Model\ChangePassword:
properties:
oldPassword:
- Symfony\Component\Security\Core\Validator\Constraints\UserPassword:
message: "Wrong value for your current password"
1 2 3 4 5 6 7 8 9 10 11 12 13 14
// src/Acme/UserBundle/Form/Model/ChangePassword.php
namespace Acme\UserBundle\Form\Model;
use Symfony\Component\Security\Core\Validator\Constraints as SecurityAssert;
class ChangePassword
{
/**
* @SecurityAssert\UserPassword(
* message = "Wrong value for your current password"
* )
*/
protected $oldPassword;
}
1 2 3 4 5 6 7 8 9 10 11 12 13 14
<!-- src/Acme/UserBundle/Resources/config/validation.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<constraint-mapping xmlns="http://symfony.com/schema/dic/constraint-mapping"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://symfony.com/schema/dic/constraint-mapping http://symfony.com/schema/dic/constraint-mapping/constraint-mapping-1.0.xsd">
<class name="Acme\UserBundle\Form\Model\ChangePassword">
<property name="oldPassword">
<constraint name="Symfony\Component\Security\Core\Validator\Constraints\UserPassword">
<option name="message">Wrong value for your current password</option>
</constraint>
</property>
</class>
</constraint-mapping>
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
// src/Acme/UserBundle/Form/Model/ChangePassword.php
namespace Acme\UserBundle\Form\Model;
use Symfony\Component\Validator\Mapping\ClassMetadata;
use Symfony\Component\Security\Core\Validator\Constraints as SecurityAssert;
class ChangePassword
{
public static function loadValidatorData(ClassMetadata $metadata)
{
$metadata->addPropertyConstraint('oldPassword', new SecurityAssert\UserPassword(array(
'message' => 'Wrong value for your current password',
)));
}
}