嵌套数组验证laravel


Nested array validation laravel

我正在构建一个基于REST的API,其中一个API具有以下请求

{
   "categories_id" :"1",
   "product_name" : "Pen",
   "product_description" : "this is pen",
   "tags" : "pen,write",
   "image_count" : "4",
   "skus": 
      {
          "is_shippable":"n",
          "actual_price":"100.55", 
          "selling_price":"200.45",
          "quantity_type":"bucket",
          "quantity_total":"10",
          "bucket_value":"instock",
          "sort_order":"1"
      }
}

这些是我的验证规则

protected $rules = [
        ValidatorInterface::RULE_CREATE => [
        'users_id' => 'required',
        'user_profiles_id' => 'required',
        'categories_id' => 'required',
        'product_name' => 'required|max:100',
        'product_description' => 'required|max:1000',
        'tags' => 'required',
        'image_count'=>'required|integer',
        'creation_mode'=>'required|integer',
        'skus.is_shippable'=>'in:y,n',
        'skus.actual_price'=>'regex:/^'s*(?=.*[1-9])'d*(?:'.'d{1,2})?'s*$/',
        'skus.selling_price' => 'regex:/^'s*(?=.*[1-9])'d*(?:'.'d{1,2})?'s*$/',
        'skus.quantity_type' => 'sometimes|required|in:finite,infinite,bucket',
        'skus.quantity_total' => 'integer|required_if:skus.quantity_type,finite', 
        'skus.bucket_value'=>'in:instock,soldout,limited|required_if:skus.quantity_type,bucket',
        'skus.sort_order'=> 'required|integer'
        ],
        ValidatorInterface::RULE_UPDATE => [
        ]
    ];

正在正确验证上述请求。但是sku内部可以有多个实体,如下面的请求

{
       "categories_id" :"1",
       "product_name" : "Pen",
       "product_description" : "this is pen",
       "tags" : "pen,write",
       "image_count" : "4",
       "skus": 
          [{
              "is_shippable":"n",
              "actual_price":"100.55", 
              "selling_price":"200.45",
              "quantity_type":"bucket",
              "quantity_total":"10",
              "bucket_value":"instock",
              "sort_order":"1"
          },
          {
              "is_shippable":"n",
              "actual_price":"100.55", 
              "selling_price":"200.45",
              "quantity_type":"bucket",
              "quantity_total":"10",
              "bucket_value":"instock",
              "sort_order":"1"
          }]
    }

如何验证是否存在多个嵌套实体?

您使用的是什么版本的Laravel?如果你正在使用Laravel 5.2,或者你不介意更新到它,有一个现成的解决方案。

阵列验证

在Laravel 5.2中,验证数组形式的输入字段要容易得多。对于例如,验证给定数组输入字段中的每个电子邮件是否唯一,您可以执行以下操作:

$validator = Validator::make($request->all(), [
    'person.*.email' => 'email|unique:users'
]);

同样,在指定验证时可以使用*字符语言文件中的消息,使用单个基于数组的字段的验证消息:

'custom' => [
    'person.*.email' => [
        'unique' => 'Each person must have a unique e-mail address',
    ]
],

Laravel新闻的另一个例子:

假设您有一个表单,其中包含一组输入字段,如下所示:

<p>
<input type="text" name="person[1][id]">
<input type="text" name="person[1][name]">
</p>
<p>
<input type="text" name="person[2][id]">
<input type="text" name="person[2][name]">
</p>

在Laravel 5.1中,添加验证规则需要循环通过和单独添加规则。不必做所有的事情被"放大"成这样:

$v = Validator::make($request->all(), [
  'person.*.id' => 'exists:users.id',
  'person.*.name' => 'required:string',
]);

因此,如果你不想使用Laravel 5.2,你将不得不手动进行,如果你更新到Laravel 520,你可以使用新的阵列验证,它将是这样的:

protected $rules = [
        ValidatorInterface::RULE_CREATE => [
        'users_id' => 'required',
        'user_profiles_id' => 'required',
        'categories_id' => 'required',
        'product_name' => 'required|max:100',
        'product_description' => 'required|max:1000',
        'tags' => 'required',
        'image_count'=>'required|integer',
        'creation_mode'=>'required|integer',
        'skus.*.is_shippable'=>'in:y,n',
        'skus.*.actual_price'=>'regex:/^'s*(?=.*[1-9])'d*(?:'.'d{1,2})?'s*$/',
        'skus.*.selling_price' => 'regex:/^'s*(?=.*[1-9])'d*(?:'.'d{1,2})?'s*$/',
        'skus.*.quantity_type' => 'sometimes|required|in:finite,infinite,bucket',
        'skus.*.quantity_total' => 'integer|required_if:skus.quantity_type,finite', 
        'skus.*.bucket_value'=>'in:instock,soldout,limited|required_if:skus.quantity_type,bucket',
        'skus.*.sort_order'=> 'required|integer'
        ],
        ValidatorInterface::RULE_UPDATE => [
        ]
    ];

编辑

添加此额外验证逻辑的最佳方法是扩展Validator类,创建CustomValidator,这可能有点过头了,但当Laravel 5.2发布时,您可以删除CustomValidator并继续使用Laravel的5.2 Validator,而无需对代码进行任何更改。

如何?首先,我们在app/下创建了一个文件夹。我决定将此文件夹命名为Validator。您可以随心所欲地命名它,只需记住更新以下类的名称空间。接下来,我们将在此文件夹中创建3.php文件CustomValidator.phpCustomValidatorServiceProvider.phpFactory.php

自定义验证器.php

<?php
namespace App'Validator;
use Illuminate'Support'Arr;
use Illuminate'Support'Str;
use Illuminate'Validation'Validator;
use Symfony'Component'Translation'TranslatorInterface;
class CustomValidator extends Validator
{
    /**
     * Create a new Validator instance.
     *
     * @param  'Symfony'Component'Translation'TranslatorInterface  $translator
     * @param  array  $data
     * @param  array  $rules
     * @param  array  $messages
     * @param  array  $customAttributes
     * @return void
     */
    public function __construct(TranslatorInterface $translator, array $data, array $rules, array $messages = [], array $customAttributes = [])
    {
        $this->translator = $translator;
        $this->customMessages = $messages;
        $this->data = $this->parseData($data);
        $this->customAttributes = $customAttributes;
        // Explode the rules first so that the implicit ->each calls are made...
        $rules = $this->explodeRules($rules);
        $this->rules = array_merge((array) $this->rules, $rules);
    }
    /**
     * Explode the rules into an array of rules.
     *
     * @param  string|array  $rules
     * @return array
     */
    protected function explodeRules($rules)
    {
        foreach ($rules as $key => $rule) {
            if (Str::contains($key, '*')) {
                $this->each($key, $rule);
                unset($rules[$key]);
            } else {
                $rules[$key] = (is_string($rule)) ? explode('|', $rule) : $rule;
            }
        }
        return $rules;
    }

    /**
     * Define a set of rules that apply to each element in an array attribute.
     *
     * @param  string  $attribute
     * @param  string|array  $rules
     * @return void
     *
     * @throws 'InvalidArgumentException
     */
    public function each($attribute, $rules)
    {
        $data = Arr::dot($this->data);
        foreach ($data as $key => $value) {
            if (Str::startsWith($key, $attribute) || Str::is($attribute, $key)) {
                foreach ((array) $rules as $ruleKey => $ruleValue) {
                    if (! is_string($ruleKey) || Str::endsWith($key, $ruleKey)) {
                        $this->mergeRules($key, $ruleValue);
                    }
                }
            }
        }
    }

    /**
     * Get the inline message for a rule if it exists.
     *
     * @param  string  $attribute
     * @param  string  $lowerRule
     * @param  array   $source
     * @return string|null
     */
    protected function getInlineMessage($attribute, $lowerRule, $source = null)
    {
        $source = $source ?: $this->customMessages;
        $keys = ["{$attribute}.{$lowerRule}", $lowerRule];
        // First we will check for a custom message for an attribute specific rule
        // message for the fields, then we will check for a general custom line
        // that is not attribute specific. If we find either we'll return it.
        foreach ($keys as $key) {
            foreach (array_keys($source) as $sourceKey) {
                if (Str::is($sourceKey, $key)) {
                    return $source[$sourceKey];
                }
            }
        }
    }
    /**
     * Get the custom error message from translator.
     *
     * @param  string  $customKey
     * @return string
     */
    protected function getCustomMessageFromTranslator($customKey)
    {
        $shortKey = str_replace('validation.custom.', '', $customKey);
        $customMessages = Arr::dot(
            (array) $this->translator->trans('validation.custom')
        );
        foreach ($customMessages as $key => $message) {
            if ($key === $shortKey || (Str::contains($key, ['*']) && Str::is($key, $shortKey))) {
                return $message;
            }
        }
        return $customKey;
    }
}

这个自定义验证器拥有Laravel 5.2上所做的所有更改,您可以在这里查看

现在,由于我们有了一个新的CustomValidator类,我们必须找到一种使用它的方法,为此,我们必须扩展ValidatorServiceProviderValidator工厂

自定义验证器服务提供者.php

<?php
namespace App'Validator;

class CustomValidatorServiceProvider extends 'Illuminate'Validation'ValidationServiceProvider
{
    /**
     * Register the validation factory.
     *
     * @return void
     */
    protected function registerValidationFactory()
    {
        $this->app->singleton('validator', function ($app) {
            $validator = new Factory($app['translator'], $app);
            // The validation presence verifier is responsible for determining the existence
            // of values in a given data collection, typically a relational database or
            // other persistent data stores. And it is used to check for uniqueness.
            if (isset($app['validation.presence'])) {
                $validator->setPresenceVerifier($app['validation.presence']);
            }
            return $validator;
        });
    }
}

Factory.php

<?php
namespace App'Validator;
use App'Validator'CustomValidator as Validator;
class Factory extends 'Illuminate'Validation'Factory
{
    /**
     * Resolve a new Validator instance.
     *
     * @param  array  $data
     * @param  array  $rules
     * @param  array  $messages
     * @param  array  $customAttributes
     * @return App'Test'CustomValidator
     */
    protected function resolve(array $data, array $rules, array $messages, array $customAttributes)
    {
        if (is_null($this->resolver)) {
            return new Validator($this->translator, $data, $rules, $messages, $customAttributes);
        }
        return call_user_func($this->resolver, $this->translator, $data, $rules, $messages, $customAttributes);
    }
}

现在,我们已经扩展了验证以支持嵌套语法sku.*.id

我们只需要将Validator交换到我们的CustomValidator,最后一步是更改文件config/app.php,在ServiceProviders数组中查找ValidatorServiceProvider。只需注释该行并添加我们的扩展服务提供商,如下所示:

....
// Illuminate'Validation'ValidationServiceProvider::class,
App'Validator'CustomValidatorServiceProvider::class,
....

我们之所以将其注释掉,是因为每当您将Laravel 5.1更新到5.2时,您只想取消注释,从列表中删除我们的CustomValidatorServiceProvider,然后删除我们的app/Validator文件夹,因为我们不再需要它了。