如何创建自定义验证约束
编辑本页警告:您正在浏览的文档欧宝体育电话欧宝娱乐app下载地址Symfony 5.1,现已不再维护。
读本页的更新版本用于Sy欧宝娱乐app下载地址mfony 6.2(当前稳定版本)。
如何创建自定义验证约束
您可以通过扩展基约束类来创建自定义约束,约束.作为示例,您将创建一个基本验证器,用于检查字符串是否只包含字母数字字符。
创建约束类
首先,您需要创建一个Constraint类并进行扩展约束:
12 3 4 5 6 7 8 9 10 11 12
/ / src /验证器/ ContainsAlphanumeric.php名称空间应用程序\验证器;使用欧宝娱乐app下载地址\组件\验证器\约束;/ * * *@Annotation* /类ContainsAlphanumeric扩展约束{公共$消息=字符串“{{string}}”包含一个非法字符:它只能包含字母或数字。;}
请注意
的@Annotation
注释对于这个新约束来说是必要的,以便可以通过注释在类中使用它。约束的选项在约束类上表示为公共属性。
创建验证器本身
如您所见,约束类是相当小的。实际的验证由另一个“约束验证器”类执行。约束验证器类由约束的类指定validatedBy ()
方法,该方法具有如下默认逻辑:
1 2 3 4 5
//在Symfony基本的\C欧宝娱乐app下载地址omponent\Validator\Constraint类公共函数validatedBy(){返回静态::类。“验证”;}
换句话说,如果您创建了一个自定义约束
(如。MyConstraint
), 欧宝娱乐app下载地址Symfony会自动寻找另一个类,MyConstraintValidator
在实际执行验证时。
验证器类只有一个必需的方法validate ()
:
12 34 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38
/ / src /验证器/ ContainsAlphanumericValidator.php名称空间应用程序\验证器;使用欧宝娱乐app下载地址\组件\验证器\约束;使用欧宝娱乐app下载地址\组件\验证器\ConstraintValidator;使用欧宝娱乐app下载地址\组件\验证器\异常\UnexpectedTypeException;使用欧宝娱乐app下载地址\组件\验证器\异常\UnexpectedValueException;类ContainsAlphanumericValidator扩展ConstraintValidator{公共函数验证($价值、约束$约束){如果(!$约束运算符ContainsAlphanumeric) {扔新UnexpectedTypeException ($约束, ContainsAlphanumeric::类);}//自定义约束应该忽略null和空值//其他约束(NotBlank, notull等)来处理如果(零= = =$价值||”= = =$价值){返回;}如果(!is_string ($价值)) {//如果您的验证器不能处理传递的类型,则抛出此异常,以便将其标记为无效扔新UnexpectedValueException ($价值,“字符串”);//使用管道分离多个类型//抛出新的UnexpectedValueException($value, 'string|int');}如果(!preg_match (' / ^ [a-zA-Z0-9] + $ / ',$价值,$匹配)) {//参数必须是字符串或实现__toString()的对象$这->上下文->buildViolation ($约束->消息)->setParameter ('{{string}}',$价值)->addViolation ();}}}
内部验证
,则不需要返回值。相反,您可以在验证器中添加违例上下文
属性和值将被认为是有效的,如果它没有导致违规。的buildViolation ()
方法将错误消息作为其参数,并返回ConstraintViolationBuilderInterface.的addViolation ()
方法调用最后将违例添加到上下文。
使用新的验证器
您可以使用自定义验证器,例如Symfony本身提供的验证器:欧宝娱乐app下载地址
- 注释
- YAML
- XML
- PHP
12 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
/ / src /实体/ AcmeEntity.php名称空间应用程序\实体;使用应用程序\验证器作为AcmeAssert;使用欧宝娱乐app下载地址\组件\验证器\约束作为断言;类AcmeEntity{/ /……/ * * *@Assert\ NotBlank *@AcmeAssert\ ContainsAlphanumeric * /受保护的$的名字;/ /……}
1 2 3 4 5 6
#配置/验证器/ validation.yaml应用\ \ AcmeEntity实体:属性:名称:-NotBlank:~-App \验证器\ ContainsAlphanumeric:~
12 3 4 5 6 7 8 9 10 11 12 13
<!--config/validator/validation.xml --><??> . xml version="1.0" encoding="UTF-8"<constraint-mappingxmlns=“http://欧宝娱乐app下载地址www.oldmanjams.com/schema/dic/constraint-mapping”xmlns: xsi=“http://www.w3.org/2001/XMLSchema-instance”xsi: schemaLocation=“http://欧宝娱乐app下载地址www.oldmanjams.com/schema/dic/constraint-mapping //www.oldmanjams.com/schema/dic/constraint-mapping/constraint-mapping-1.0.xsd”><类的名字=“应用程序\实体\ AcmeEntity”><财产的名字=“名称”><约束的名字=“NotBlank”/><约束的名字=“应用程序\验证器\ ContainsAlphanumeric”/>财产>类>constraint-mapping>
12 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
/ / src /实体/ AcmeEntity.php名称空间应用程序\实体;使用应用程序\验证器\ContainsAlphanumeric;使用欧宝娱乐app下载地址\组件\验证器\约束\NotBlank;使用欧宝娱乐app下载地址\组件\验证器\映射\ClassMetadata;类AcmeEntity{公共$的名字;公共静态函数loadValidatorMetadata(ClassMetadata$元数据){$元数据->addPropertyConstraint (“名字”,新NotBlank ());$元数据->addPropertyConstraint (“名字”,新ContainsAlphanumeric ());}}
如果约束包含选项,那么它们应该是前面创建的自定义constraint类上的公共属性。这些选项可以像Symfony核心约束上的选项一样配置。欧宝娱乐app下载地址
带有依赖项的约束验证器
如果你在用默认的服务。yaml的配置,那么您的验证器已经注册为服务和标记用必要的validator.constraint_validator
.这意味着你可以注入服务或配置和其他服务一样。
类约束验证器
除了验证单个属性外,约束还可以将整个类作为其作用域。您只需要将此添加到约束
类:
1 2 3 4
公共函数getTargets(){返回自我::CLASS_CONSTRAINT;}
有了这个,验证器validate ()
方法获取一个对象作为其第一个参数:
1 2 3 4 5 6 7 8 9 10 11
类ProtocolClassValidator扩展ConstraintValidator{公共函数验证($协议、约束$约束){如果($协议->getFoo () ! =$协议->getBar ()) {$这->上下文->buildViolation ($约束->消息)->atPath (“foo”)->addViolation ();}}}
提示
的atPath ()
方法定义验证错误关联的属性。使用任何有效的PropertyAccess语法来定义这个属性。
类约束验证器应用于类本身,而不是属性:
- 注释
- YAML
- XML
- PHP
1 2 3 4 5 6 7
/ * * *@AcmeAssert\ ProtocolClass * /类AcmeEntity{/ /……}
1 2 3 4
#配置/验证器/ validation.yaml应用\ \ AcmeEntity实体:约束:-App \验证器\ ProtocolClass:~
1 2 3 4
<!--config/validator/validation.xml --><类的名字=“应用程序\实体\ AcmeEntity”><约束的名字=“应用程序\验证器\ ProtocolClass”/>类>
12 3 4 5 6 7 8 9 10 11 12 13 14 15
/ / src /实体/ AcmeEntity.php名称空间应用程序\实体;使用应用程序\验证器\ProtocolClass;使用欧宝娱乐app下载地址\组件\验证器\映射\ClassMetadata;类AcmeEntity{/ /……公共静态函数loadValidatorMetadata(ClassMetadata$元数据){$元数据->addConstraint (新ProtocolClass ());}}