Warning: You are browsing the documentation for Symfony 3.1, which is no longer maintained.
Read the updated version of this page for Symfony 5.3 (the current stable version).
Metadata
Metadata¶
The Symfony\Component\Validator\Mapping\ClassMetadata class
represents and manages all the configured constraints on a given class.
Properties¶
The Validator component can validate public, protected or private properties.
The following example shows how to validate that the $firstName property of
the Author class has at least 3 characters:
// ...
use Symfony\Component\Validator\Mapping\ClassMetadata;
use Symfony\Component\Validator\Constraints as Assert;
class Author
{
private $firstName;
public static function loadValidatorMetadata(ClassMetadata $metadata)
{
$metadata->addPropertyConstraint('firstName', new Assert\NotBlank());
$metadata->addPropertyConstraint(
'firstName',
new Assert\Length(array("min" => 3))
);
}
}
Getters¶
Constraints can also be applied to the value returned by any public getter
method, which are the methods whose names start with get, has or is.
This feature allows to validate your objects dynamically.
Suppose that, for security reasons, you want to validate that a password field
doesn’t match the first name of the user. First, create a public method called
isPasswordSafe() to define this custom validation logic:
public function isPasswordSafe()
{
return $this->firstName !== $this->password;
}
Then, add the Validator component configuration to the class:
// ...
use Symfony\Component\Validator\Mapping\ClassMetadata;
use Symfony\Component\Validator\Constraints as Assert;
class Author
{
public static function loadValidatorMetadata(ClassMetadata $metadata)
{
$metadata->addGetterConstraint('passwordSafe', new Assert\IsTrue(array(
'message' => 'The password cannot match your first name',
)));
}
}
This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.