オリジナルバリデータクラスを作成した際のメソッド名

Question

laravelを学習しているのですが、バリデータについてお聞きしたいことがあります。

<?php 
namespace App\Http\Validators;
use Illuminate\Validation\Validator;

class HelloValidator extends Validator
{
  public function validateHello($attribute,$value,$parameters)
  {
    return $value % 2 == 0;
  }
}

上記は、作成したオリジナルのバリデータクラス(HelloValidator.php)のコードになります。
お聞きしたい点なのですが、バリデーションで使われるルールとしまして、validateHelloメソッドを用意すれば、「hello」として扱われるようになるとのことなのですが、これは、必ずvalidateの後の文字は大文字にしなければならず、バリデーションのルール名は、先頭が小文字に変換される仕様なのでしょうか？

Answer 1

Laravelのソースコードとしては、以下コードを参照してください。
Validator.php

Laravel5.8.17段階で、validate文字数分の先頭八文字を削り取って、スネークケースに変換しています。
例: validateHelloWorldだと、hello_worldがルール名

__callというメソッドは、PHPのマジックメソッドという機能で、
クラスに存在しないメソッド名で、インスタンスメソッドが呼ばれたときに実行されるメソッドです。
PHPのマジックメソッド一覧と使い方まとめ

Comments

[toll_tree]

ご回答ありがとうございます。
ちゃんとした規則がやはりあったのですね。
貼って頂きましたGithubのリンクは、laravelが構成されているコードのようなものなのでしょうか...?

[aro10]

そうですね。
プロジェクトのvendorディレクトリにある、Laravelのコアのコードです。

Answer 2

変な本ではなく公式ドキュメントを参照したほうがいい。
一応残ってるけどもはや誰も使ってない機能はLaravelにも存在する。
ドキュメントに書かれてる使い方が普通。それ以外は特殊。

Validatorクラスを拡張する方法は5.0までしか書かれてない。
https://readouble.com/laravel/5.0/ja/validation.html#custom-validation-rules

Laravelはバージョンアップでもっと便利な機能が追加されてそっち使うのが普通になることが多いので古い情報は役に立たない。
一番重要なことはドキュメントに書かれてない機能はいずれ削除されるかもしれない。
「〇〇は削除されました。ドキュメントには書かれてなかったので影響は少ないでしょう」みたいな言い回しがたまに出てくる。

Comments

[mikkame]

readouble.comは公式じゃなくて日本語翻訳ですよ
https://github.com/laravel-ja/ja-docs-5.8

> 翻訳は公式ドキュメントと呼ばないでください。公式は原文の英語バージョンのみです。

[mikkame]

リポジトリへはreadouble.com の最下部のgithubへのリンクから繋がります

Answer 3

Laravel では、コーディングルールにPSR-2を採用しており、また、PSR-2はPSR-1に準拠しなければなりません。

そのPSR-1には

・メソッド名はcamelCase記法で定義しなければなりません。

と書かれています。

また、Validator クラスの拡張に関しては、公式ドキュメントには言及がありませんので、参考にしているソースコードの出展を明示してください。

Comments

[toll_tree]

PSR-2といったコーディング規約のようなものが存在していたんですね。
メソッド名がcamelCase記法で定義しなければいけないといった点で、なんとなくわかった気がします。