发布于 2015-08-27 16:51:26 | 104 次阅读 | 评论: 0 | 来源: 网络整理
Validates that a value is true. Specifically, this checks to see if
the value is exactly true, exactly the integer 1, or exactly the
string “1”.
Also see False.
| Applies to | property or method |
| Options | |
| Class | True |
| Validator | TrueValidator |
This constraint can be applied to properties (e.g. a termsAccepted property
on a registration model) or to a “getter” method. It’s most powerful in the
latter case, where you can assert that a method returns a true value. For
example, suppose you have the following method:
// src/Acme/BlogBundle/Entity/Author.php
namespace AcmeBlogBundleEntity;
class Author
{
protected $token;
public function isTokenValid()
{
return $this->token == $this->generateToken();
}
}
Then you can constrain this method with True.
# src/Acme/BlogBundle/Resources/config/validation.yml
AcmeBlogBundleEntityAuthor:
getters:
tokenValid:
- 'True':
message: The token is invalid.
// src/Acme/BlogBundle/Entity/Author.php
namespace AcmeBlogBundleEntity;
use SymfonyComponentValidatorConstraints as Assert;
class Author
{
protected $token;
/**
* @AssertTrue(message = "The token is invalid")
*/
public function isTokenValid()
{
return $this->token == $this->generateToken();
}
}
<!-- src/Acme/Blogbundle/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="AcmeBlogBundleEntityAuthor">
<getter property="tokenValid">
<constraint name="True">
<option name="message">The token is invalid.</option>
</constraint>
</getter>
</class>
</constraint-mapping>
// src/Acme/BlogBundle/Entity/Author.php
namespace AcmeBlogBundleEntity;
use SymfonyComponentValidatorMappingClassMetadata;
use SymfonyComponentValidatorConstraintsTrue;
class Author
{
protected $token;
public static function loadValidatorMetadata(ClassMetadata $metadata)
{
$metadata->addGetterConstraint('tokenValid', new True(array(
'message' => 'The token is invalid.',
)));
}
public function isTokenValid()
{
return $this->token == $this->generateToken();
}
}
If the isTokenValid() returns false, the validation will fail.
警告
When using YAML, be sure to surround True with quotes ('True')
or else YAML will convert this into a true Boolean value.
type: string default: This value should be true.
This message is shown if the underlying data is not true.
type: mixed default: null
2.6 新版功能: The payload option was introduced in Symfony 2.6.
This option can be used to attach arbitrary domain-specific data to a constraint. The configured payload is not used by the Validator component, but its processing is completely up to.
For example, you may want to used several error levels to present failed constraint differently in the front-end depending on the severity of the error.