2. 驗證器 Validator

ZouZhipeng發表於2021-02-23
系列文章：
1. 輔助函式 dd() 2. 驗證器 Validator 在非 laravel 專案中使用 laravel 的特性 3. 資料庫 database & Eloquent ORM

安裝

composer require illuminate/validation

引入提示訊息

專案根目錄建立 lang/zh_cn/validation.php 檔案

<?php

return [

    /*
    |--------------------------------------------------------------------------
    | Validation Language Lines
    |--------------------------------------------------------------------------
    |
    | The following language lines contain the default error messages used by
    | the validator class. Some of these rules have multiple versions such
    | as the size rules. Feel free to tweak each of these messages here.
    |
    */

    'accepted' => ':attribute必須接受',
    'active_url' => ':attribute必須是一個合法的 URL',
    'after' => ':attribute 必須是 :date 之後的一個日期',
    'after_or_equal' => ':attribute 必須是 :date 之後或相同的一個日期',
    'alpha' => ':attribute只能包含字母',
    'alpha_dash' => ':attribute只能包含字母、數字、中劃線或下劃線',
    'alpha_num' => ':attribute只能包含字母和數字',
    'array' => ':attribute必須是一個陣列',
    'before' => ':attribute 必須是 :date 之前的一個日期',
    'before_or_equal' => ':attribute 必須是 :date 之前或相同的一個日期',
    'between' => [
        'numeric' => ':attribute 必須在 :min 到 :max 之間',
        'file' => ':attribute 必須在 :min 到 :max KB 之間',
        'string' => ':attribute 必須在 :min 到 :max 個字元之間',
        'array' => ':attribute 必須在 :min 到 :max 項之間',
    ],
    'boolean' => ':attribute字元必須是 true 或false, 1 或 0 ',
    'confirmed' => ':attribute 二次確認不匹配',
    'date' => ':attribute 必須是一個合法的日期',
    'date_format' => ':attribute 與給定的格式 :format 不符合',
    'different' => ':attribute 必須不同於 :other',
    'digits' => ':attribute必須是 :digits 位.',
    'digits_between' => ':attribute 必須在 :min 和 :max 位之間',
    'dimensions' => ':attribute具有無效的圖片尺寸',
    'distinct' => ':attribute欄位具有重複值',
    'email' => ':attribute必須是一個合法的電子郵件地址',
    'exists' => '選定的 :attribute 是無效的.',
    'file' => ':attribute必須是一個檔案',
    'filled' => ':attribute的欄位是必填的',
    'image' => ':attribute必須是 jpeg, png, bmp 或者 gif 格式的圖片',
    'in' => '選定的 :attribute 是無效的',
    'in_array' => ':attribute 欄位不存在於 :other',
    'integer' => ':attribute 必須是個整數',
    'ip' => ':attribute必須是一個合法的 IP 地址。',
    'json' => ':attribute必須是一個合法的 JSON 字串',
    'max' => [
        'numeric' => ':attribute 的最大長度為 :max 位',
        'file' => ':attribute 的最大為 :max',
        'string' => ':attribute 的最大長度為 :max 字元',
        'array' => ':attribute 的最大個數為 :max 個.',
    ],
    'mimes' => ':attribute 的檔案型別必須是 :values',
    'min' => [
        'numeric' => ':attribute 的最小長度為 :min 位',
        'file' => ':attribute 大小至少為 :min KB',
        'string' => ':attribute 的最小長度為 :min 字元',
        'array' => ':attribute 至少有 :min 項',
    ],
    'not_in' => '選定的 :attribute 是無效的',
    'numeric' => ':attribute 必須是數字',
    'present' => ':attribute 欄位必須存在',
    'regex' => ':attribute 格式是無效的',
    'required' => ':attribute 欄位必填',
    'required_if' => ':attribute 欄位是必須的當 :other 是 :value',
    'required_unless' => ':attribute 欄位是必須的，除非 :other 是在 :values 中',
    'required_with' => ':attribute 欄位是必須的當 :values 是存在的',
    'required_with_all' => ':attribute 欄位是必須的當 :values 是存在的',
    'required_without' => ':attribute 欄位是必須的當 :values 是不存在的',
    'required_without_all' => ':attribute 欄位是必須的當 沒有一個 :values 是存在的',
    'same' => ':attribute和:other必須匹配',
    'size' => [
        'numeric' => ':attribute 必須是 :size 位',
        'file' => ':attribute 必須是 :size KB',
        'string' => ':attribute 必須是 :size 個字元',
        'array' => ':attribute 必須包括 :size 項',
    ],
    'string' => ':attribute 必須是一個字串',
    'timezone' => ':attribute 必須是個有效的時區.',
    'unique' => ':attribute 已存在',
    'url' => ':attribute 無效的格式',

    /*
    |--------------------------------------------------------------------------
    | Custom Validation Language Lines
    |--------------------------------------------------------------------------
    |
    | Here you may specify custom validation messages for attributes using the
    | convention "attribute.rule" to name the lines. This makes it quick to
    | specify a specific custom language line for a given attribute rule.
    |
    */

    'custom' => [
        'attribute-name' => [
            'rule-name' => 'custom-message',
        ],
    ],

    /*
    |--------------------------------------------------------------------------
    | Custom Validation Attributes
    |--------------------------------------------------------------------------
    |
    | The following language lines are used to swap attribute place-holders
    | with something more reader friendly such as E-Mail Address instead
    | of "email". This simply helps us make messages a little cleaner.
    |
    */

    'attributes' => [
        // 'name'         => '名字',
        // 'age'         => '年齡',
    ],

];

## 封裝 handler src/Handlers/Validator.php

  • $translation_path 定位到剛剛建立的 lang 目錄
  • $translation_locale 為多語言目錄名，即 zh_cn
<?php

namespace App\Handlers;

use Illuminate\Filesystem\Filesystem;
use Illuminate\Translation\FileLoader;
use Illuminate\Translation\Translator;
use Illuminate\Validation\Factory;

class Validator extends Factory
{
    /**
     * 建立例項
     *
     * @return Factory
     */
    public static function getInstance()
    {
        static $validator = null;
        if ($validator === null) {
            $translation_path = __DIR__ . '/../../lang';
            $translation_locale = 'zh_cn';
            $translation_file_loader = new FileLoader(new Filesystem(), $translation_path);
            $translator = new Translator($translation_file_loader, $translation_locale);
            $validator = new Factory($translator);
        }
        return $validator;
    }
}

composer.json 檔案新增自動載入，並執行 composer du

{
  "autoload": {
    .
    .
    .
    "psr-4": {
      "App\\": "src"
    }
  }
}

使用

直接使用 index/validator.php

<?php

require_once __DIR__ . '/../vendor/autoload.php';

use App\Handlers\Validator;

// 接參
$data['title'] = '1234567890';
$data['content'] = '123';

// 驗證 可惜不能直接丟擲異常，留個坑
$validator = Validator::getInstance()->make($data, [
    'title' => 'required|min:10',
    'content' => 'required|min:10',
]);

if ($validator->fails()) {
    dd($validator->errors()->all());
}

dd('success');

命令列開啟服務 php -S localhost:8000 並訪問 http://localhost:8000/index/validator.php 即可。

自定義訊息提示和定義屬性名稱

// 接參
$data['title'] = '1234567890';
$data['content'] = '123';

// 規則
$rules = [
    'title' => 'required|min:10',
    'content' => 'required|min:10',
];
// 自定義訊息提示
$messages = [
    'title.required' => ':title欄位必須',
];
//屬性名稱
$attributes = [
    'title' => '標題',
    'content' => '內容',
];
// 驗證
$validator = Validator::getInstance()->make($data, $rules, $messages, $attributes);

PS：驗證規則請前往 Laravel Validator 文件 檢視

專案目錄結構

# tree -I vendor
.
├── composer.json
├── composer.lock
├── config
├── helpers
│   └── laravel_helpers.php
├── index
│   ├── dd.php
│   └── validator.php
├── lang
│   └── zh_cn
│       └── validation.php
└── src
    └── Handlers
        └── Validator.php

finish!

參考 致謝

  1. 在非 Laravel 專案中使用 Validator 驗證器
本作品採用《CC 協議》，轉載必須註明作者和本文連結

相關文章