发布于 2015-08-27 16:45:56 | 133 次阅读 | 评论: 0 | 来源: 网络整理
Validates that a value matches a regular expression.
| Applies to | property or method |
| Options | |
| Class | Regex |
| Validator | RegexValidator |
Suppose you have a description field and you want to verify that it begins
with a valid word character. The regular expression to test for this would
be /^w+/, indicating that you’re looking for at least one or more word
characters at the beginning of your string:
# src/Acme/BlogBundle/Resources/config/validation.yml
AcmeBlogBundleEntityAuthor:
properties:
description:
- Regex: '/^w+/'
// src/Acme/BlogBundle/Entity/Author.php
namespace AcmeBlogBundleEntity;
use SymfonyComponentValidatorConstraints as Assert;
class Author
{
/**
* @AssertRegex("/^w+/")
*/
protected $description;
}
<!-- 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">
<property name="description">
<constraint name="Regex">
<option name="pattern">/^w+/</option>
</constraint>
</property>
</class>
</constraint-mapping>
// src/Acme/BlogBundle/Entity/Author.php
namespace AcmeBlogBundleEntity;
use SymfonyComponentValidatorMappingClassMetadata;
use SymfonyComponentValidatorConstraints as Assert;
class Author
{
public static function loadValidatorMetadata(ClassMetadata $metadata)
{
$metadata->addPropertyConstraint('description', new AssertRegex(array(
'pattern' => '/^w+/',
)));
}
}
Alternatively, you can set the match option to false in order to assert
that a given string does not match. In the following example, you’ll assert
that the firstName field does not contain any numbers and give it a custom
message:
# src/Acme/BlogBundle/Resources/config/validation.yml
AcmeBlogBundleEntityAuthor:
properties:
firstName:
- Regex:
pattern: '/d/'
match: false
message: Your name cannot contain a number
// src/Acme/BlogBundle/Entity/Author.php
namespace AcmeBlogBundleEntity;
use SymfonyComponentValidatorConstraints as Assert;
class Author
{
/**
* @AssertRegex(
* pattern="/d/",
* match=false,
* message="Your name cannot contain a number"
* )
*/
protected $firstName;
}
<!-- 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">
<property name="firstName">
<constraint name="Regex">
<option name="pattern">/d/</option>
<option name="match">false</option>
<option name="message">Your name cannot contain a number</option>
</constraint>
</property>
</class>
</constraint-mapping>
// src/Acme/BlogBundle/Entity/Author.php
namespace AcmeBlogBundleEntity;
use SymfonyComponentValidatorMappingClassMetadata;
use SymfonyComponentValidatorConstraints as Assert;
class Author
{
public static function loadValidatorMetadata(ClassMetadata $metadata)
{
$metadata->addPropertyConstraint('firstName', new AssertRegex(array(
'pattern' => '/d/',
'match' => false,
'message' => 'Your name cannot contain a number',
)));
}
}
type: string [default option]
This required option is the regular expression pattern that the input will
be matched against. By default, this validator will fail if the input string
does not match this regular expression (via the preg_match PHP function).
However, if match is set to false, then validation will fail if the input
string does match this pattern.
type: string|Boolean default: null
This option specifies the pattern to use in the HTML5 pattern attribute.
You usually don’t need to specify this option because by default, the constraint
will convert the pattern given in the pattern option into an HTML5 compatible
pattern. This means that the delimiters are removed (e.g. /[a-z]+/ becomes [a-z]+).
However, there are some other incompatibilities between both patterns which
cannot be fixed by the constraint. For instance, the HTML5 pattern attribute
does not support flags. If you have a pattern like /[a-z]+/i, you need
to specify the HTML5 compatible pattern in the htmlPattern option:
# src/Acme/BlogBundle/Resources/config/validation.yml
AcmeBlogBundleEntityAuthor:
properties:
name:
- Regex:
pattern: "/^[a-z]+$/i"
htmlPattern: "^[a-zA-Z]+$"
// src/Acme/BlogBundle/Entity/Author.php
namespace AcmeBlogBundleEntity;
use SymfonyComponentValidatorConstraints as Assert;
class Author
{
/**
* @AssertRegex(
* pattern = "/^[a-z]+$/i",
* htmlPattern = "^[a-zA-Z]+$"
* )
*/
protected $name;
}
<!-- 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">
<property name="name">
<constraint name="Regex">
<option name="pattern">/^[a-z]+$/i</option>
<option name="htmlPattern">^[a-zA-Z]+$</option>
</constraint>
</property>
</class>
</constraint-mapping>
// src/Acme/BlogBundle/Entity/Author.php
namespace AcmeBlogBundleEntity;
use SymfonyComponentValidatorMappingClassMetadata;
use SymfonyComponentValidatorConstraints as Assert;
class Author
{
public static function loadValidatorMetadata(ClassMetadata $metadata)
{
$metadata->addPropertyConstraint('name', new AssertRegex(array(
'pattern' => '/^[a-z]+$/i',
'htmlPattern' => '^[a-zA-Z]+$',
)));
}
}
Setting htmlPattern to false will disable client side validation.
type: Boolean default: true
If true (or not set), this validator will pass if the given string matches
the given pattern regular expression. However, when this option is set
to false, the opposite will occur: validation will pass only if the given
string does not match the pattern regular expression.
type: string default: This value is not valid.
This is the message that will be shown if this validator fails.
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.