验证（Validation）

验证（Validation）

Phalcon\Validation 对Phalcon来说是一个相对独立的组件，它可以对任意的数据进行验证。当然也可以用来对非模型内的数据进行验证。

下面的例子展示了一些基本的使用方法：

<?php
use Phalcon\Validation;
use Phalcon\Validation\Validator\Email;
use Phalcon\Validation\Validator\PresenceOf;
$validation = new Validation();
$validation->add(
    "name",
    new PresenceOf(
        [
            "message" => "The name is required",
        ]
    )
);
$validation->add(
    "email",
    new PresenceOf(
        [
            "message" => "The e-mail is required",
        ]
    )
);
$validation->add(
    "email",
    new Email(
        [
            "message" => "The e-mail is not valid",
        ]
    )
);
$messages = $validation->validate($_POST);
if (count($messages)) {
    foreach ($messages as $message) {
        echo $message, "<br>";
    }
}

由于此模型是松耦合设计的，故此我们也可以使用自己书写的验证工具：

初始化验证（Initializing Validation）

我们可以直接在 Phalcon\Validation 初始化时添加验证链。我们可以把验证器放在一个单独的文件中以提高代码的重用率及可组织性：

<?php
use Phalcon\Validation;
use Phalcon\Validation\Validator\Email;
use Phalcon\Validation\Validator\PresenceOf;
class MyValidation extends Validation
{
    public function initialize()
    {
        $this->add(
            "name",
            new PresenceOf(
                [
                    "message" => "The name is required",
                ]
            )
        );
        $this->add(
            "email",
            new PresenceOf(
                [
                    "message" => "The e-mail is required",
                ]
            )
        );
        $this->add(
            "email",
            new Email(
                [
                    "message" => "The e-mail is not valid",
                ]
            )
        );
    }
}

Then initialize and use your own validator:

<?php
$validation = new MyValidation();
$messages = $validation->validate($_POST);
if (count($messages)) {
    foreach ($messages as $message) {
        echo $message, "<br>";
    }
}

验证器（Validators）

Phalcon的验证组件中内置了一些验证器：

下面的例子中展示了如何创建自定义的验证器：

<?php
use Phalcon\Validation;
use Phalcon\Validation\Message;
use Phalcon\Validation\Validator;
class IpValidator extends Validator
{
    /**
     * 执行验证
     *
     * @param Phalcon\Validation $validator
     * @param string $attribute
     * @return boolean
     */
    public function validate(Validation $validator, $attribute)
    {
        $value = $validator->getValue($attribute);
        if (!filter_var($value, FILTER_VALIDATE_IP, FILTER_FLAG_IPV4 | FILTER_FLAG_IPV6)) {
            $message = $this->getOption("message");
            if (!$message) {
                $message = "The IP is not valid";
            }
            $validator->appendMessage(
                new Message($message, $attribute, "Ip")
            );
            return false;
        }
        return true;
    }
}

最重要的一点即是难证器要返回一个布尔值以标识验证是否成功：

Callback Validator

By using Phalcon\Validation\Validator\Callback you can execute custom function which must return boolean or new validator class which will be used to validate the same field. By returning true validation will be successful, returning false will mean validation failed. When executing this validator Phalcon will pass data depending what it is - if it’s an entity then entity will be passed, otherwise data. There is example:

<?php
use \Phalcon\Validation;
use \Phalcon\Validation\Validator\Callback;
use \Phalcon\Validation\Validator\PresenceOf;
$validation = new Validation();
$validation->add(
    "amount",
    new Callback(
        [
            "callback" => function($data) {
                return $data["amount"] % 2 == 0;
            },
            "message" => "Only even number of products are accepted"
        ]
    )
);
$validation->add(
    "amount",
    new Callback(
        [
            "callback" => function($data) {
                if($data["amount"] % 2 == 0) {
                    return $data["amount"] != 2;
                }
                return true;
            },
            "message" => "You can't buy 2 products"
        ]
    )
);
$validation->add(
    "description",
    new Callback(
        [
            "callback" => function($data) {
                if($data["amount"] >= 10) {
                    return new PresenceOf(
                        [
                            "message" => "You must write why you need so big amount."
                        ]
                    );
                }
                return true;
            }
        ]
    )
);
$messages = $validation->validate(["amount" => 1]); // will return message from first validator
$messages = $validation->validate(["amount" => 2]); // will return message from second validator
$messages = $validation->validate(["amount" => 10]); // will return message from validator returned by third validator

验证信息（Validation Messages）

Phalcon\Validation 内置了一个消息子系统，这提供了一个非常好的验证消息回传机制，以便在验证结束后取得验证信息，比如失败原因等。

每个消息由一个 Phalcon\Validation\Message 类的实例构成。验证过程产生的消息可以使用:code:`getMessages()`方法取得。每条消息都有一些扩展的信息组成比如产生错误的属性或消息的类型等：

<?php
$messages = $validation->validate();
if (count($messages)) {
    foreach ($messages as $message) {
        echo "Message: ", $message->getMessage(), "\n";
        echo "Field: ", $message->getField(), "\n";
        echo "Type: ", $message->getType(), "\n";
    }
}

我们也可以传送一个message参数以覆盖验证器中默认的信息：

<?php
use Phalcon\Validation\Validator\Email;
$validation->add(
    "email",
    new Email(
        [
            "message" => "The e-mail is not valid",
        ]
    )
);

默认，:code:`getMessages()`方法会返回在验证过程中所产生的信息。我们可以使用:code:`filter()`方法来过滤我们感兴趣的消息：

<?php
$messages = $validation->validate();
if (count($messages)) {
    // Filter only the messages generated for the field 'name'
    $filteredMessages = $messages->filter("name");
    foreach ($filteredMessages as $message) {
        echo $message;
    }
}

过滤数据（Filtering of Data）

我们可以在数据被验证之前对其先进行过滤，以确保那些恶意的或不正确的数据不被验证。

<?php
use Phalcon\Validation;
$validation = new Validation();
$validation->add(
    "name",
    new PresenceOf(
        [
            "message" => "The name is required",
        ]
    )
);
$validation->add(
    "email",
    new PresenceOf(
        [
            "message" => "The email is required",
        ]
    )
);
// Filter any extra space
$validation->setFilters("name", "trim");
$validation->setFilters("email", "trim");

这里我们使用 filter 组件进行过滤。我们还可以使用自定义的或内置的过滤器。

验证事件（Validation Events）

当在类中执行验证时，我们可以在:code:`beforeValidation()`或:code:`afterValidation()`方法（事件）中执行额外的检查，过滤，清理等工作。如果:code:`beforeValidation()`方法返回了false 则验证会被中止：

<?php
use Phalcon\Validation;
class LoginValidation extends Validation
{
    public function initialize()
    {
        // ...
    }
    /**
     * 验证执行之前执行
     *
     * @param array $data
     * @param object $entity
     * @param Phalcon\Validation\Message\Group $messages
     * @return bool
     */
    public function beforeValidation($data, $entity, $messages)
    {
        if ($this->request->getHttpHost() !== "admin.mydomain.com") {
            $messages->appendMessage(
                new Message("Only users can log on in the administration domain")
            );
            return false;
        }
        return true;
    }
    /**
     * 验证之后执行
     *
     * @param array $data
     * @param object $entity
     * @param Phalcon\Validation\Message\Group $messages
     */
    public function afterValidation($data, $entity, $messages)
    {
        // ... Add additional messages or perform more validations
    }
}

取消验证（Cancelling Validations）

默认所有的验证器都会被执行，不管验证成功与否。我们可以通过设置 cancelOnFail 参数为 true 来指定某个验证器验证失败时中止以后的所有验证：

<?php
use Phalcon\Validation;
use Phalcon\Validation\Validator\Regex;
use Phalcon\Validation\Validator\PresenceOf;
$validation = new Validation();
$validation->add(
    "telephone",
    new PresenceOf(
        [
            "message"      => "The telephone is required",
            "cancelOnFail" => true,
        ]
    )
);
$validation->add(
    "telephone",
    new Regex(
        [
            "message" => "The telephone is required",
            "pattern" => "/\+44 [0-9]+/",
        ]
    )
);
$validation->add(
    "telephone",
    new StringLength(
        [
            "messageMinimum" => "The telephone is too short",
            "min"            => 2,
        ]
    )
);

第一个验证器中 cancelOnFail 参数设置为 true 则表示如果此验证器验证失败则验证链中接下的验证不会被执行。

我们可以在自定义的验证器中设置 cancelOnFail 为 true 来停止验证链：

<?php
use Phalcon\Validation;
use Phalcon\Validation\Message;
use Phalcon\Validation\Validator;
class MyValidator extends Validator
{
    /**
     * 执行验证
     *
     * @param Phalcon\Validation $validator
     * @param string $attribute
     * @return boolean
     */
    public function validate(Validation $validator, $attribute)
    {
        // If the attribute value is name we must stop the chain
        if ($attribute === "name") {
            $validator->setOption("cancelOnFail", true);
        }
        // ...
    }
}

避免验证空值（Avoid validate empty values）

我们可以向所有内建的验证器传入选项 ‘allowEmpty’ 以避免在传入的值为空时执行验证。

<?php
use Phalcon\Validation;
use Phalcon\Validation\Validator\Regex;
$validation = new Validation();
$validation->add(
    "telephone",
    new Regex(
        [
            "message"    => "The telephone is required",
            "pattern"    => "/\+44 [0-9]+/",
            "allowEmpty" => true,
        ]
    )
);

递归验证（Recursive Validation）

我们可以通过 afterValidation() 方法，在一个验证器中运行另一个验证器。在本例中，CompanyValidation 验证实例会同时执行 PhoneValidation 验证器。

<?php
use Phalcon\Validation;
class CompanyValidation extends Validation
{
    /**
     * @var PhoneValidation
     */
    protected $phoneValidation;
    public function initialize()
    {
        $this->phoneValidation = new PhoneValidation();
    }
    public function afterValidation($data, $entity, $messages)
    {
        $phoneValidationMessages = $this->phoneValidation->validate(
            $data["phone"]
        );
        $messages->appendMessages(
            $phoneValidationMessages
        );
    }
}