ルーティングの際のwhereメソッドについて

Question

laravelを学習していた際のことなのですが、ルーティングで使用される「whereメソッド」について、お聞きしたい点があります。

<?php

/*
|--------------------------------------------------------------------------
| Web Routes
|--------------------------------------------------------------------------
|
| Here is where you can register web routes for your application. These
| routes are loaded by the RouteServiceProvider within a group which
| contains the "web" middleware group. Now create something great!
|
*/

Route::get('/', 'PostsController@index');
// Route::get('/posts/{id}', 'PostsController@show');
Route::get('/posts/{post}', 'PostsController@show')->where('post', '[0-9]+');
Route::get('/posts/create', 'PostsController@create');

上記のwhereメソッドなのですが、laravelの公式マニュアルで調べていたのですが、Illuminate\Support\Collectionクラスのwhereメソッドしか見当たりませんでした。
Illuminate\Support\Collectionクラスのwhereメソッドであるとするならば、ファイルに「use　Illuminate\Support\Collection」として、使用しなければならないと思った為、Collectionクラスのメソッドではないのではないかと思いました。
whereメソッドにつきまして、ご存じの方いましたら教えてください。
よろしくお願いします

Answer 1

見ている公式マニュアルがどんなものか分からないけど、
もしもそこまで調べる気があるのならまずはAPIドキュメントを見る。するとwhereの使い方が書いてある。
更に下のほうまで行くと、Routeにはどんなメソッドが定義されているかの紹介をするリンク先まである
https://laravel.com/api/5.7/Illuminate/Routing/Route.html#method_where
これを見ると、URL見るだけでもCollectionじゃないんだなーって事は分かる

理解しようとしている事に対して水差されるのは嫌かもしれないけど、とりあえずwhereをAPIドキュメントの説明通りに使う、それで対処しきれなくなったら仕方ないのでコアのソースとかを読む、って感じにした方が楽ですよ

Comments

[toll_tree]

ご回答ありがとうございます。
laravelの公式マニュアルのようなサイトってAPIドキュメントっていうんですね...
いえ、調べ方などを提示頂けれるのは助かります。
ドキュメントの方調べてみたいと思います

[hentaiman]

いやいや、名称は公式マニュアルでもAPIドキュメントでも良いんだけど、『公式マニュアル調べてもRouteのWhereがよく分からない』と書いてあったので、whereの説明の無いマニュアルサイトが存在してるんだろうと思って回答しただけです
公式マニュアルと書くだけでなくリンクも一緒に貼っといてくれたらより分かりやすくていいんだけど

[toll_tree]

次回質問する際は、リンクも貼っておこうと思います

[m.ts10806]

間違った理解をされては困るので横から失礼しますが、
リンクされているreadouble.comのほうは「川瀬裕久さんという有志が作っている日本語訳ドキュメント」ですよ。
Footerのコピーライト参照。
URLのjaをenにかえたら英語原文がでてきますがそちらはLaravelの制作者であるTaylor Otwell氏がコピーライトされています。
本当の公式は2つ目のリンクがされていない　https://laravel.com/ で https://laravel.com/docs/5.8 の方。
「APIドキュメント」はあくまで「規約説明書（仕様書）」という意味合いで使われるので、
「あれはAPIドキュメントと言うよ」とそのまんま言葉だけで覚えると恥かきます。

[hentaiman]

言葉気にせず書いててすいません

[m.ts10806]

あいえ、hentaimanさんへの指摘ではないです。
「hentaimanさんはAPIドキュメントという単語はこういう意味で使っているわけであって固有名詞ではないよ」と補足したかっただけです。
（丁寧な解説をしても、読んでも、間違った解釈をし続ける質問者のほうが問題ありとおおよその人は見ます）
それに出展の提示がないのは今に始まったことではなく、以前から指摘され続けていることなので。

[m.ts10806]

あと、私に限らず指摘のコメントが増えて自分の都合が悪くなってきたら「理解できたことにして」締めてしまうところとか、お世辞にもいいとは言えません。

[hentaiman]

最近の他の質問では結構コメントで何回も質問重ねていたので、「理解できた"ことにして"」たわけではなく「理解できた」と思っているんだと思う。これは予想だけど、テストコードをいくつも書いて動作の確認をするということをしていないんでしょうね。だから「理解できた"つもり"」になってしまうのかなと思う

[m.ts10806]

失敗して覚えることが多いですよね。プログラミングはエラーとデバッグの繰り返しで試行錯誤を続けていくものと思います。
プログラミングは目よりも頭と手を使わないと…。
この質問者はあまりにも「思った」が多すぎますね。書いた通りにしか動かないのに。滅茶苦茶なコード書いて動かせばエラーはいて教えてくれるのに。

[hentaiman]

自分も以前マニュアル読めって回答した事あるけれど、今はマニュアル見て頑張っているようなので良くなってると思います。しかしlaravelマニュアル読むには読めるだけのphp自体の技術力は必要なので躓くのでしょうけど。
mtsさんが以前コメントしていたように、laravelなんて使わないで素のphpとhtmlだけで書いていくところから始めたら伸びそうなタイプには見えるんですけどねえ

[m.ts10806]

>laravelマニュアル読むには読めるだけのphp自体の技術力は必要なので躓くのでしょうけど。

ここですね。
内部でどういう処理をしているかある程度イメージがつけられれば（あと何かあればコアソースを読んでいけるくらいの検証能力があれば）仕様として飲み込めるんでしょうけど、必要な土台や基礎がないとただ混乱してとりあえず何が問題か分からないまま丸投げてしまう感じになってしまいますね。
せめて「PHP本来の機能」なのか「Laravelで構築された機能」なのかの区別くらいはつけられるようにならないとずっとこのままのように思います。
PHPやLaravelを学習する目的は分からないですけど、今のやり方を見ていると現場では使いづらいですね。

Answer 2

RouteクラスのDOCを見る限り、where を持つのは、\Illuminate\Routing\RouteRegistrar です。

<?php

namespace Illuminate\Support\Facades;

/**
 * @method static \Illuminate\Routing\Route get(string $uri, \Closure|array|string|callable|null $action = null)
 * @method static \Illuminate\Routing\Route post(string $uri, \Closure|array|string|callable|null $action = null)
 * @method static \Illuminate\Routing\Route put(string $uri, \Closure|array|string|callable|null $action = null)
 * @method static \Illuminate\Routing\Route delete(string $uri, \Closure|array|string|callable|null $action = null)
 * @method static \Illuminate\Routing\Route patch(string $uri, \Closure|array|string|callable|null $action = null)
 * @method static \Illuminate\Routing\Route options(string $uri, \Closure|array|string|callable|null $action = null)
 * @method static \Illuminate\Routing\Route any(string $uri, \Closure|array|string|callable|null $action = null)
 * @method static \Illuminate\Routing\Route match(array|string $methods, string $uri, \Closure|array|string|callable|null $action = null)
 * @method static \Illuminate\Routing\RouteRegistrar prefix(string  $prefix)
 * @method static \Illuminate\Routing\RouteRegistrar where(array  $where)
 * @method static \Illuminate\Routing\PendingResourceRegistration resource(string $name, string $controller, array $options = [])
 * @method static \Illuminate\Routing\PendingResourceRegistration apiResource(string $name, string $controller, array $options = [])
 * @method static void apiResources(array $resources)
 * @method static \Illuminate\Routing\RouteRegistrar middleware(array|string|null $middleware)
 * @method static \Illuminate\Routing\Route substituteBindings(\Illuminate\Support\Facades\Route $route)
 * @method static void substituteImplicitBindings(\Illuminate\Support\Facades\Route $route)
 * @method static \Illuminate\Routing\RouteRegistrar as(string $value)
 * @method static \Illuminate\Routing\RouteRegistrar domain(string $value)
 * @method static \Illuminate\Routing\RouteRegistrar name(string $value)
 * @method static \Illuminate\Routing\RouteRegistrar namespace(string $value)
 * @method static \Illuminate\Routing\Router|\Illuminate\Routing\RouteRegistrar group(array|\Closure|string $attributes, \Closure|string $routes)
 * @method static \Illuminate\Routing\Route redirect(string $uri, string $destination, int $status = 302)
 * @method static \Illuminate\Routing\Route permanentRedirect(string $uri, string $destination)
 * @method static \Illuminate\Routing\Route view(string $uri, string $view, array $data = [])
 * @method static void bind(string $key, string|callable $binder)
 * @method static void model(string $key, string $class, \Closure|null $callback = null)
 * @method static \Illuminate\Routing\Route current()
 * @method static string|null currentRouteName()
 * @method static string|null currentRouteAction()
 *
 * @see \Illuminate\Routing\Router
 */
class Route extends Facade
{
    /**
     * Get the registered name of the component.
     *
     * @return string
     */
    protected static function getFacadeAccessor()
    {
        return 'router';
    }
}

Comments

[toll_tree]

ご回答ありがとうございます。
公式マニュアルには「\Illuminate\Routing\RouteRegistrar」こちらのクラスのwhereメソッドに関する説明などがされているページは存在しますでしょうか？

[退会済みユーザー]

詳しくは書かかれていないけど、一応書いてある
https://readouble.com/laravel/5.7/ja/routing.html

[toll_tree]

本当ですね。
正規表現制約という欄に書いてありました。
一点だけ疑問に思ったのですが、マニュアルのこちらの部分「ルートインスタンスのwhereメソッドを使用しルートパラメータのフォーマットを制約できます。」
ということは、Route::get()こちらの関数でルートインスタンスが生成されているため、whereメソッドが使えるといった解釈で正しいでしょうか？

[退会済みユーザー]

あなたは原理原則を理解することが目的になっているようですね。

> Route::get()こちらの関数でルートインスタンスが生成されているため、whereメソッドが使えるといった解釈で正しいでしょうか？

自分はこのようには理解することを目的にはしていないので、全く気にならない。目的のプロダクトを生み出すために必要であれば覚えるし、必要なければスルーする。
この場合なら,whereってパラメータの検証したい時に使えばいいんだなと理解すればそれで十分だと思います。

「インスタンス」どうのこうのというのは、Laravelの話ではなくてPHPのクラスの話だし。