如何创建一个定制的验证约束
编辑该页面警告:你浏览的文档欧宝官网下载appob娱乐下载Symfony 2.4,不再维护。
读这个页面的更新版本Symfob娱乐下载ony 6.3(当前的稳定版本)。
如何创建一个定制的验证约束
您可以创建一个自定义约束通过扩展基础约束类,约束。例如你要创建一个简单的验证器,检查一个字符串是否只包含字母数字字符。
创建约束类
首先,您需要创建一个约束类和扩展约束:
1 2 3 4 5 6 7 8 9 10 11 12
/ / src / Acme / DemoBundle /验证器/约束/ ContainsAlphanumeric.php名称空间Acme\DemoBundle\验证器\约束;使用ob娱乐下载\组件\验证器\约束;/ * * *@Annotation* /类ContainsAlphanumeric扩展约束{公共美元消息=字符串的字符串“% %”包含非法字符:它只能包含字母或数字。;}请注意
的@Annotation注释是必要的对于这一新的约束,以使其在类通过使用注释。选择你的约束表示为约束类的公共属性。
创建验证器本身
正如你所看到的,一个约束类相当最小。实际的验证是由另一个“约束验证器”类。指定的约束验证器类约束的validatedBy ()方法,其中包括一些简单的缺省逻辑:
1 2 3 4 5
/ /在基地Symfony \ob娱乐下载 \验证器\约束类组件公共函数validatedBy(){返回get_class (美元这)。“验证”;}换句话说,如果你创建一个自定义约束(如。MyConstraint),Sob娱乐下载ymfony会自动寻找另一个类,MyConstraintValidator当实际执行验证。
确认器类也很简单,只有一个方法validate ():
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
/ / src / Acme / DemoBundle /验证器/约束/ ContainsAlphanumericValidator.php名称空间Acme\DemoBundle\验证器\约束;使用ob娱乐下载\组件\验证器\约束;使用ob娱乐下载\组件\验证器\ConstraintValidator;类ContainsAlphanumericValidator扩展ConstraintValidator{公共函数验证(美元价值、约束美元约束){如果(! preg_match (' / ^ [a-zA-Za0-9] + $ / ',美元价值,美元匹配)){美元这- >上下文- >addViolation (美元约束- >消息,数组(“%字符串%”= >美元价值));}}}请注意
的验证方法不返回一个值;相反,它增加了验证器的受侵犯上下文财产的addViolation方法调用如果验证失败。因此,一个值可以被认为是有效的,如果它没有造成违规添加到上下文。的第一个参数addViolation打电话是违反使用的错误消息。
使用新确认器
使用自定义验证器非常简单,就像那些由Symfony提供本身:ob娱乐下载
1 2 3 4 5 6
# src / Acme / BlogBundle /资源/ config / validation.ymlAcme \ DemoBundle \ \ AcmeEntity实体:属性:名称:- - - - - -NotBlank:~- - - - - -Acme \ DemoBundle \验证器\ \ ContainsAlphanumeric约束:~如果你的约束包含选项,那么他们应该在前面创建的自定义约束类公共属性。这些选项可以配置选项在核心Symfony约束。ob娱乐下载
约束验证器和依赖关系
如果你的约束验证器有依赖关系,如数据库连接之后,它将需要配置作为服务的依赖注入容器。该服务必须包括validator.constraint_validator标签和一个别名属性:
1 2 3 4 5
服务:validator.unique.your_validator_name:类:完全限定\ \验证器类\ \的名字标签:- - - - - -{名称:validator.constraint_validator,别名:alias_name}约束类现在应该使用此别名引用适当验证器:
1 2 3 4
公共函数validatedBy(){返回“alias_name”;}如前所述,Symfony会自动寻找一个类ob娱乐下载命名约束,验证器附加。如果你的约束验证器被定义为一种服务,重要的是你覆盖validatedBy ()方法返回时用到的别名定义您的服务,否则Symfony不会使用约束验证器服务,并将实例化类相反,没有任何依赖项注入。ob娱乐下载
类约束验证器
在验证一个类属性,一个约束可以上课通过提供一个目标的范围约束类:
1 2 3 4
公共函数getTargets(){返回自我::CLASS_CONSTRAINT;}为此,验证程序validate ()方法得到一个对象作为它的第一个参数:
1 2 3 4 5 6 7 8 9 10 11 12 13 14
类ProtocolClassValidator扩展ConstraintValidator{公共函数验证(美元协议、约束美元约束){如果(美元协议- >getFoo () ! =美元协议- >getBar ()) {美元这- >上下文- >addViolationAt (“foo”,美元约束- >消息,数组(),零);}}}注意,一个类约束验证器应用于类本身,而不是财产:
1 2 3 4
# src / Acme / BlogBundle /资源/ config / validation.ymlAcme \ DemoBundle \ \ AcmeEntity实体:约束:- - - - - -Acme \ DemoBundle \验证器\ \ ContainsAlphanumeric约束:~
