Route on ララジャパン

Laravel 8.x更新で変わったこと（２）Route関連の変更

Wed, 03 Nov 2021 12:00:43 +0900

引き続いて、Laravel 8.x更新で変わったことです。今回はRoute関連の話です。

Laravel 8.x以前では、routes/web.phpの中身はこんな感じでした。

routes/web.php

Route::namespace('Auth')->middleware('guest')->group(function () {

    // Authentication Routes...
    Route::get('', 'LoginController@showLoginForm');
    Route::get('login', 'LoginController@showLoginForm')->name('login');
    Route::post('login', 'LoginController@login')->name('login-post');

    // Password Reset Routes...
    Route::get('password/reset', 'ForgotPasswordController@showLinkRequestForm')->name('password.forgot');
    Route::post('password/email', 'ForgotPasswordController@sendResetLinkEmail')->name('password.email');
    Route::get('password/reset/{token}', 'ResetPasswordController@showResetForm')->name('password.reset');
    Route::post('password/reset', 'ResetPasswordController@reset')->name('password.reset-post');
});

これが、Laravel 8.xでは、

routes/web.php

use App\Http\Controllers\Admin;
use App\Http\Controllers\Auth;
use App\Http\Controllers\User;
use Illuminate\Support\Facades\Route;

Route::middleware('guest')->group(function () {

    // Authentication Routes...
    Route::get('', [Auth\LoginController::class, 'showLoginForm']);
    Route::get('login', [Auth\LoginController::class, 'showLoginForm'])->name('login');
    Route::post('login', [Auth\LoginController::class, 'login'])->name('login-post');

    // Password Reset Routes...
    Route::get('password/reset', [Auth\ForgotPasswordController::class, 'showLinkRequestForm'])->name('password.forgot');
    Route::post('password/email', [Auth\ForgotPasswordController::class, 'sendResetLinkEmail'])->name('password.email');
    Route::get('password/reset/{token}', [Auth\ResetPasswordController::class, 'showResetForm'])->name('password.reset');
    Route::post('password/reset', [Auth\ResetPasswordController::class, 'reset'])->name('password.reset-post');

});

となります。

何が変わったかというと、今までのコントローラクラス名＠メソッド名（例：‘LoginController@showLoginForm’）が、コントローラクラスパスとメソッド名の配列（[Auth\LoginController::class, ‘showLoginForm’]）となりました。

この変更が動作するためには、RouteServiceProvider.phpのファイルの編集も必要です。 L7.xのバージョンでは、以下のように$namespaceがありますが、

app/Providers/RouteServiceProvider.php

namespace App\Providers;

use Illuminate\Foundation\Support\Providers\RouteServiceProvider as ServiceProvider;
use Illuminate\Support\Facades\Route;

class RouteServiceProvider extends ServiceProvider
{
    /**
     * This namespace is applied to your controller routes.
     *
     * In addition, it is set as the URL generator's root namespace.
     *
     * @var string
     */
    protected $namespace = 'App\Http\Controllers';

...
    /**
     * Define the "web" routes for the application.
     *
     * These routes all receive session state, CSRF protection, etc.
     *
     * @return void
     */
    protected function mapWebRoutes()
    {
        Route::middleware('web')
            ->namespace($this->namespace)
            ->group(base_path('routes/web.php'));
    }

    /**
     * Define the "api" routes for the application.
     *
     * These routes are typically stateless.
     *
     * @return void
     */
    protected function mapApiRoutes()
    {
        Route::prefix('api')
            ->middleware('api')
            ->namespace($this->namespace)
            ->group(base_path('routes/api.php'));
    }
}

L8.xのバージョンでは、それを削除します。mapWebRoute()とmapApiRoute()からもnamespace()を削除します。

app/Providers/RouteServiceProvider.php

namespace App\Providers;

use Illuminate\Foundation\Support\Providers\RouteServiceProvider as ServiceProvider;
use Illuminate\Support\Facades\Route;

class RouteServiceProvider extends ServiceProvider
{

...
    /**
     * Define the "web" routes for the application.
     *
     * These routes all receive session state, CSRF protection, etc.
     *
     * @return void
     */
    protected function mapWebRoutes()
    {
        Route::middleware('web')
            ->group(base_path('routes/web.php'));
    }

    /**
     * Define the "api" routes for the application.
     *
     * These routes are typically stateless.
     *
     * @return void
     */
    protected function mapApiRoutes()
    {
        Route::prefix('api')
            ->middleware('api')
            ->group(base_path('routes/api.php'));
    }
}

さて、上の変更によりプログラムの実行が速くなったとかのメリットはないと思いますが、この形式になることにより改善されたのは、vscodeのようなエディターにおいてweb.phpのファイル内から簡単にコントローラクラスの定義にジャンプできることです。エディターあるいはエディターのプラグインがクラスを認識できるようになったためです。

とは言え、このコード変更を手動でやるのはとても面倒ですね。私の大きいプロジェクトでrouteがたくさんあり、242箇所も変更が必要な部分があります。このようなときには、Laravel Shiftのサービスを使用することを勧めます。以前に、ここで紹介していますが、あれから数年、サイトのデザインとか変わっていますが基本的には同じサービスです。

最後に、上で編集したweb.phpやRouteServiceProvider.phpを何も編集せずにしておくことも可能です。それでも問題なくL8.xで動作します。

Laravel 7.x更新で発見したこと（3）ルートのキャッシュ

Sun, 21 Mar 2021 04:16:59 +0900

Laravelはプログラム実行において読み込むファイルの数は非常に多いです。実行速度を最適化するにはいろいろな方法がありますが、一番簡単に実行できる方法があります。遠い昔にも紹介しましたが、ルートのキャッシュです。しかし、バージョン７への更新によりちょっと問題が発生です。

ルートのキャッシュ

お客さんのプロジェクトでは、routes/web.phpやapi.phpで定義されているルート（routeのことです）は結構あります。現在445あります。毎回毎回これを読み込みLaravelが処理するにはシステムに負荷がかかります。Laravelでは以前から、それを最適化してキャッシュするコマンドがあります。

まず、L7.xでプロジェクトを作成して、その時点で動作確認したところで、ルートをキャッシュしまするのですが、

その前にちょっとした作業が必要です。なぜなら、そのキャッシュのコマンドはクロージャのルートでエラーとなってしまうからです。それはL6.xでも同じことです。

ということで、以下の２つのファイルにおいてコメントアウトが必要です。

routes/api.php

...
// 以下コメントアウト
// Route::middleware('auth:api')->get('/user', function (Request $request) {
//    return $request->user();
// });

routes/web.php

...
// 以下コメントアウト
// Route::get('/', function () {
//    return view('welcome');
//});

Auth::routes();

Route::get('/home', 'HomeController@index')->name('home');

これでルートのキャッシュ化のコマンドを実行です。

$ php artisan route:cache
Route cache cleared!
Routes cached successfully!

成功しましたね。そしてディレクトリには以下のように、

bootstrap/cache
├── packages.php
├── routes-v7.php
└── services.php

キャッシュされたroutes-v7.phpのファイルが作成されています。L6.xではファイル名は、routes.phpでした。

重複のルート名はL6.xではOKだったのに

L7.xになってこのコマンドの実行において前バージョンから１つ変わったことあります。L6.xにおいては、ルート名の重複が許されていたのですが、L7.xではそれが許されません。比較してみましょう。

まず、L6.xの環境で、以下のようなルートの設定をします。

routes/web.php

// Route::get('/', function () {
//     return view('welcome');
// });

// Auth::routes(); // 左の関数から以下を抽出
Route::get('login', 'Auth\LoginController@showLoginForm')->name('login');
Route::post('login', 'Auth\LoginController@login')->name('login');

// Route::get('/home', 'HomeController@index')->name('home');

Auth::routes()で設定されているルートから、loginのルート定義を取り出して、意図的にgetとpostに同じloginという名前となるように設定します。->name(’login’)の部分です。

$ php artisan route:list

を実行すると、

+--------+----------+-------+-------+---------------------------------------------------------+------------+
| Domain | Method   | URI   | Name  | Action                                                  | Middleware |
+--------+----------+-------+-------+---------------------------------------------------------+------------+
|        | GET|HEAD | login | login | App\Http\Controllers\Auth\LoginController@showLoginForm | web,guest  |
|        | POST     | login | login | App\Http\Controllers\Auth\LoginController@login         | web,guest  |
+--------+----------+-------+-------+---------------------------------------------------------+------------+

そして、キャッシュのコマンドの実行もOKです。

$ php artisan route:cache
Route cache cleared!
Routes cached successfully!

重複のルート名でも、GETとPOSTと使用されるメソッドが違うので使用には問題がありませんでした。

以上は、L6.xでの話ですが、L7.xでは。。。

L7.xでの問題

L7.xにおいて、先と同じようにルートをweb.phpで設定して、

$ php artisan route:list

を実行すると、

+--------+----------+-------+-------+---------------------------------------------------------+------------+
| Domain | Method   | URI   | Name  | Action                                                  | Middleware |
+--------+----------+-------+-------+---------------------------------------------------------+------------+
|        | GET|HEAD | login | login | App\Http\Controllers\Auth\LoginController@showLoginForm | web        |
|        |          |       |       |                                                         | guest      |
|        | POST     | login | login | App\Http\Controllers\Auth\LoginController@login         | web        |
|        |          |       |       |                                                         | guest      |
+--------+----------+-------+-------+---------------------------------------------------------+------------+

OKそうですね。そして、キャッシュのコマンドを実行すると、

Route cache cleared!

   LogicException 

  Unable to prepare route [login] for serialization. Another route has already been assigned name [login].
...

と、「もうloginの名前は使われているよ」というエラーが表示されます。

そうなら、重複とならないようにルートの名前を変えてみます。

...
Route::get('login', 'Auth\LoginController@showLoginForm')->name('login');
Route::post('login', 'Auth\LoginController@login')->name('login-post');
...

今度はキャッシュのコマンドの実行はOKとなりました。

$ php artisan route:cache
Route cache cleared!
Routes cached successfully!

そして、今度はpostのルートの名前を外してみます。オリジナルの定義と同じです。

...
Route::get('login', 'Auth\LoginController@showLoginForm')->name('login');
Route::post('login', 'Auth\LoginController@login');
...

これでも、キャッシュのコマンドの実行は成功となります。

どうなっているのか？と以下を実行してみると、

$ php aritsan route:list
+--------+----------+-------+-----------------------------+---------------------------------------------------------+------------+
| Domain | Method   | URI   | Name                        | Action                                                  | Middleware |
+--------+----------+-------+-----------------------------+---------------------------------------------------------+------------+
|        | GET|HEAD | login | login                       | App\Http\Controllers\Auth\LoginController@showLoginForm | web        |
|        |          |       |                             |                                                         | guest      |
|        | POST     | login | generated::Jhj05XtQrWTdgVlP | App\Http\Controllers\Auth\LoginController@login         | web        |
|        |          |       |                             |                                                         | guest      |
+--------+----------+-------+-----------------------------+---------------------------------------------------------+------------+

名が無かったルートには、 generated::Jhj05XtQrWTdgVlPと自動で名前が付けられていました。便利ですね。

最後に

ルート名がそのキャッシュ化において重複を許さなくなったL7.xの更新は、既存のコードをブレイクするという報告がいくつか出ていました。もちろんこれにより私のプロジェクトでも変更がいくつか必要となりました。ここの部分更新時には注意要です。

それから、ルートのキャッシュでもうひとつ注意することは、ルートの定義ファイルを変更したら必ず、キャッシュコマンドを再実行する必要があります。

ときどきこれを忘れてどうして変更が反映していないのか考え込んでしまう経験が過去にありました。それゆえに私の開発環境ではキャッシュせずに、本環境のみにおいてキャッシュ化を実行するようにしています。

Laravelへの移行（１）他のプログラムの認証セッションを認識

Sun, 12 Jul 2020 07:52:38 +0900

長いこと開発者をやっていると自分が開発した古いphpのプログラムの管理が悩みの種になります。なぜならLaravelのフレームワークが使われていないからです。年々新しい機能を追加したりしていると複雑になってくるし、ある昔のフレームワークで書かれたプロジェクトではphpunitも使えなく検証も容易にできません。このままで進んでいくにはますます管理において頭が痛くなります。しかし、すべて書き直してLaravelへの移行となると、日数とコストは大変なものです。さらに、外見がほとんど変わらずに中身だけの変更なので、お客さんを説得するのも難しい。

しかし、機会は訪れるもので、その悩みのプロジェクトのひとつにおいて、お客さんから大きな新規のリクエストが来ました。その新規のリクエストは現在の機能とは独立して扱える部分が多いので、こちらを独立させてLaravelで開発することにして、完成したら現行の機能を徐々にLaravelに移行していく、ということになりました。

嬉しい前進ですが、このプロジェクトに関して１つの必須条件は、現行のプログラムの認証を使用して（まだ使われるので）、新規のLaravelのプログラムの方では再度ログインを必要としてはいけない、というものです。

現行のプログラムの認証セッション

現行のプログラムもLaravelと同様に、ユーザー認証後ブラウザのクッキーを使用してそのユーザーのためだけの認証セッションを作成します。

以下は、現行のプログラムの認証セッションをシミュレートするプログラムですが、ログインしたユーザーの情報（ここでは、user_id）をセッションの情報に保存します。

start.php

ini_set('session.save_path', "/usr/www/repos/session");
ini_set('session.cookie_secure', '1'); // only secure
ini_set('session.name', 'admin');

session_start();
$_SESSION = ['user_id' => 1];

このプログラムをウェブでアクセスすると、アクセスしたクライアント、つまりブラウザでは、そのドメインで、adminという名前のクッキーが作成され、t20fa2tc05dd5gda1sfs1tsrofのような値が保存されます。そして、サーバー側では、指定した場所、つまり、/usr/www/repos/sessionのディレクトリに、sess_t20fa2tc05dd5gda1sfs1tsrofのセッションファイルが作成されます。その中身は以下のようになります。phpの$_SESSION変数の中身がそこで保存されています。

$ sudo cat /usr/www/repos/session/sess_t20fa2tc05dd5gda1sfs1tsrof
user_id|i:1;

認証セッションの認識

さて、問題は先の他のphpプログラムでの認証セッションをどうやってLaravelで認識して、あたかも自分の認証とするか、です。しかし、phpのセッションの構造は、Laravelの認証後に作成されるセッションとは違い、Laravelで簡単に共有というわけにはいきません。

そこで、私が考えたのは、まず、新規のLaravelのプログラムが認証を必要するときに、現行のプログラムですでに作成された認証セッションを認識して、それが正しいものなら、改めてLaravelの認証を実行することです。幸い、Auth::login($user);のようにログイン画面を通さずに認証する関数もあります。

まず、routeの設定部分を見てみましょう。

routes/web.php

Route::get('/', function () {
    return view('welcome');
});

Auth::routes();

Route::get('/home', 'HomeController@index')->name('home');

上では、/homeにアクセスすると、ログイン画面、/loginにリダイレクトされますが、それはHomeControllerのコンストラクタで以下のようにガードされているからです。

app/Http/Controlers/HomeController.php

namespace App\Http\Controllers;

use Illuminate\Http\Request;

class HomeController extends Controller
{
    /**
     * Create a new controller instance.
     *
     * @return void
     */
    public function __construct()
    {
        $this->middleware('auth:admin');　// ここで保護
    }

    /**
     * Show the application dashboard.
     *
     * @return \Illuminate\Contracts\Support\Renderable
     */
    public function index()
    {
        return view('home');
    }
}

しかし、以下のようにAuthenticateのミドルウェアのauthenticate()を上書き定義すると、

app/Http/Middleware/Authenticate.php

namespace App\Http\Middleware;

use Illuminate\Auth\Middleware\Authenticate as Middleware;

use Auth;
use App\User;

class Authenticate extends Middleware
{
    /**
     * Determine if the user is logged in to any of the given guards.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  array  $guards
     * @return void
     *
     * @throws \Illuminate\Auth\AuthenticationException
     */
    protected function authenticate($request, array $guards)
    {
        if (empty($guards)) {
            $guards = [null];
        }

       if (in_array('admin', $guards)) {
            // すでにLaravel側で認証されているなら、OK
            if ($this->auth->guard('admin')->check()) {
                return $this->auth->shouldUse('admin');
            }

            // 現行のプログラムの認証セッションから情報を取得

            ini_set('session.save_path', "/usr/www/repos/session");
            ini_set('session.cookie_secure', '1'); // only secure
            ini_set('session.name', 'admin');

            session_start();

            if (isset($_SESSION['user_id'])) {
                if ($user = User::find($_SESSION['user_id'])) {
                    // ユーザーが存在するなら、Laravelで認証
                    Auth::guard('admin')->login($user);
                }
            }
        }

        foreach ($guards as $guard) {
            if ($this->auth->guard($guard)->check()) {
                return $this->auth->shouldUse($guard);
            }
        }

        $this->unauthenticated($request, $guards);
    }
...

すでに、現行のプログラムで認証されているなら、そのセッションの値を取得してLaravel側でも認証とします。

注意点としては、現行のプログラムと新規のLaravelのプログラムとで２つの認証セッションが存在することになります。両方とも違うセッションでお互いの存在を知らないので、セッションの期間が異なることになります。現行の方の認証が期限切れとなってもLaravelの方ではまだ期限内かもしれません。しかし、逆にLaravelのセッションが期限切れとなっても現行のプログラムのセッションが期限内なら、再度Laravelでセッションを作成するので問題はありません。

それから、現行のプログラムもLaravel側でも認証されていなときに、Laravel側にアクセスされたら、現行のプログラムのログイン画面にリダイレクトすることが必要です。それは以下のように、先のAuthenticateのクラスで、unauthenticated()を定義することにより可能です。

app/Http/Middleware/Authenticate.php

...
   /**
     * Handle an unauthenticated user.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  array  $guards
     * @return void
     *
     * @throws \Illuminate\Auth\AuthenticationException
     */
    protected function unauthenticated($request, array $guards)
    {
        if (in_array('admin', $guards)) {
           throw new AuthenticationException(
                'Unauthenticated.', $guards, 'http://localhost/app/admin/login' //現行のログイン画面
            );
        }
    }
...

最後に、現行のプログラムも新規のLaravelでも、セッションのクッキーパスが同じとすることをお忘れずに。そうでないと、新規のLaravelでは現行のプログラムのセッションにアクセスできません。上では両方ともクッキーパスはデフォルトの/となっています。

コントローラのコンストラクタで引数を取り出す

Sat, 09 Feb 2019 00:00:40 +0900

以前に、Laravel 5.3　コントローラのコンストラクタの重要な変更として、コントローラで定義するメソッド間で共有するコードをコンストラクタに入れることが可能なことを説明しました。今度は同じコンストラクタ内で、コントローラのメソッドに渡される引数の取り出しかたを説明します。何を言っているかというと、まずは準備から。

準備

例として、routes/web.phpにおいて、以下のようなrouteを定義します。

...
Route::resource('product', 'ProductController');
...

これは、以下のようなURIを生成します。

+--------+-----------+-------------------------------+-----------------------+------------------------------------------------------------------------+----------------------------------------------+
| Domain | Method    | URI                           | Name                  | Action                                                                 | Middleware                                   |
+--------+-----------+-------------------------------+-----------------------+------------------------------------------------------------------------+----------------------------------------------+
|        | GET|HEAD  | product                       | product.index         | App\Http\Controllers\ProductController@index                           | web                                          |
|        | POST      | product                       | product.store         | App\Http\Controllers\ProductController@store                           | web                                          |
|        | GET|HEAD  | product/create                | product.create        | App\Http\Controllers\ProductController@create                          | web                                          |
|        | GET|HEAD  | product/{product}             | product.show          | App\Http\Controllers\ProductController@show                            | web                                          |
|        | PUT|PATCH | product/{product}             | product.update        | App\Http\Controllers\ProductController@update                          | web                                          |
|        | DELETE    | product/{product}             | product.destroy       | App\Http\Controllers\ProductController@destroy                         | web                                          |
|        | GET|HEAD  | product/{product}/edit        | product.edit          | App\Http\Controllers\ProductController@edit                            | web                                          |
+--------+-----------+-------------------------------+-----------------------+------------------------------------------------------------------------+----------------------------------------------+

そして、ProductController.phpを以下のように定義します。

namespace App\Http\Controllers;

use Illuminate\Http\Request;
use App\Models\Product;

class ProductController extends Controller
{
   /**
     * 情報画面
     *
     * @param  \App\Models\Product  $product
     * @return \Illuminate\View\View
     */
    public function show(Product $product)
    {
　　　  //
    }

   /**
     * 編集画面
     *
     * @param  \App\Models\Product  $product
     * @return \Illuminate\View\View
     */
    public function edit(Product $product)
    {
      //
    }

   /**
     * 編集保存
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  \App\Models\Product  $product
     * @return \Illuminate\Http\RedirectResponse
     */
    public function update(Request $request, Product $product)
    {
      //
    }
}

コンストラクタで引数を取り出す

用意ができたところで、

例えば、

product/456

のGETのアクセスでは、id = 456に対応するProductのEloquentオブジェクトがshow()のメソッドの引数$productの値として渡されます。

そして、

product/456/edit

のGETは、id = 456に対応するProductのオブジェクトがedit()のメソッドの引数$productの値として渡されます。

さて、このid = 456のProductのオブジェクト、それぞれのメソッドの引数と渡される前に、コンストラクタで取り出すには？

namespace App\Http\Controllers;

use Illuminate\Http\Request;
use App\Models\Product;

class ProductController extends Controller
{
    public function __construct()
    {
        parent::__construct();

        $this->middleware(function ($request, $next) {

            $product = $request->product;　//id = 456のProductのオブジェクトを取得

            debug(get_class($product), $product->id);

            return $next($request);
        });
    }
...

と、middleware()の関数を使えば、その匿名関数の中で簡単に取り出せますね！

product/456

のURIにブラウザでアクセスすれば、Debugbarでは、

debug　App\Models\Product
debug 456

とデバッグ文を表示します。

product/456/edit

でも

product/456/update

でも、同じようにそれぞれのメソッドを実行する前に、引数にアクセスすることが可能となります。

ひとつここで疑うのは、Productのオブジェクトを取得するために以下のようなSQL文が、middleware()で１回、そしてさらにshow()のようなメソッドの引数でもう１回、計２回実行されることになるか、です。

select * from product where id = 456

これもDebugbarのQueryの出力で１回しか実行されていないことを確認しました。一度作成したオブジェクトを同じコントローラ内で２度作成することはなりません。

取り出して、それからどうする？

ここが大事なのですが、例えば、この商品（product）がEコマースで販売される商品とします。商品の登録や編集は、裏側の管理画面で商品の製造元の店舗がログインして行います。しかし、複数の店舗が存在するので、店舗Aが店舗Bの商品を編集できては困ります。しかし、URIには商品のIDが表示されるので、IDの数字を変えて他の店舗の商品を閲覧（公開されていない情報がある）や編集することが可能となってしまいます。それを防ぐためには、

...
    public function __construct()
    {
        parent::__construct();

        $this->middleware(function ($request, $next) {

            $product = $request->product; //id = 456のProductのオブジェクトを取得 

            $user = auth('shop')->user(); // 現在ログインしている店舗のユーザー

            if ($product->shop_id != $user->shop_id) { //この商品の店舗ではない！
               abort(404);
            }

            return $next($request);
        });
    }
...

のように設定すれば、いちいちshow()やedit()やupdate()などで、同様なコードを繰り返さずに済みプログラムの管理性が高まる、ということです。

Route::match

Sat, 02 Dec 2017 06:32:00 +0900

プログラマというのは、その性質上、いかにプログラムの行数を少なくして、やりたいことをクリーンに明確に表現できるかに時間を費やしたりします。そして、重複の表現はすぐに気づき、忌み嫌い、どうしたらそれをなくすことができることを日夜考えます。

私もそのひとりで、例えば、昔以下のようなコードありました、「どうにかならんかな？」と気になっていました。

routes/web.php

..
// 会員登録     
Route::get ('member/signup',  'MemberController@signup')->name('member.signup');                                                                                                                                                                                     
Route::post('member/signup',  'MemberController@postSignup')->name('member.signup');  
..

見ての通り、どちらもメソッド（get, post）は違いますが、URLは同じmember/signupとなります。もちろん、Route::resourceを使うことも可能ですが、URLは、createでなくsignupとしたいし、必要な処理も登録だけです。

上のコードのphp artisan route:listでの出力はこんな感じです。

+--------+----------+-------------------+---------------+---------------------------------------------------+--------------+
| Domain | Method   | URI               | Name          | Action                                            | Middleware   |
+--------+----------+-------------------+---------------+---------------------------------------------------+--------------+
|        | GET|HEAD | member/signup     | member.signup | App\Http\Controllers\MemberController@signup      | web,guest    |
|        | POST     | member/signup     | member.signup | App\Http\Controllers\MemberController@postSignup  | web,guest    |
+--------+----------+-------------------+---------------+---------------------------------------------------+--------------+

2行も必要でしょうかね？

こう思っているのは私だけではなかったようです。LaravelのマニュアルにRoute::matchを見つけました。

先の2行のルートの指定を以下のように1行にすることができました。

routes/web.php

..
// 会員登録     
Route::match(['get', 'post'], 'member/signup',  'MemberController@signup')->name('member.signup');                                                                                                                                                                                     
..

php artisan route:listでの出力はこうなりました。

+--------+---------------+-------------------+---------------+---------------------------------------------------+--------------+
| Domain | Method        | URI               | Name          | Action                                            | Middleware   |
+--------+---------------+-------------------+---------------+---------------------------------------------------+--------------+
|        | GET|POST|HEAD | member/signup     | member.signup | App\Http\Controllers\MemberController@signup      | web,guest    |
+--------+---------------+-------------------+---------------+---------------------------------------------------+--------------+

素晴らしい！と思うとともに、さてどうやって１つのメソッドsignupでGETとPOSTの２つに対応したらよいものか？

解決方法は、

MemberController

namespace App\Http\Controllers;
                                                                                                                                                                                
use Illuminate\Http\Request                                                                                                                                                                                                                                                                                                                                                        
use App\Models\Member;                                                                                                                                                                                            
                                                                                                                                                                                                                   
class MemberController extends Controller {
...
	/**
	 * Signup
	 *
	 * @param  \Illuminate\Http\Request $request
	 * @return \Illuminate\Http\Response
	 */
	public function signup(Request $request)
	{
		if ($request->method() == 'POST')
		{
			return $this->postSignup($request);
		}

		return view('user/member_add');
	}

	/**
	 * Save Signup
	 *
	 * @param  \Illuminate\Http\Request $request
	 * @return \Illuminate\Http\Response
	 */
	public function postSignup(Request $request)
	{
...
}

のように、signupメソッドにおいて、POSTで呼ばれたかを判断して、postSignupをコールします。

しかし、routesは1行になったけれど、コントローラはちょっとわかりにくいかな、とも思いますね。

Laravel 5.3　resourceでの名前付きrouteの変更

Sat, 22 Oct 2016 04:42:28 +0900

以前に、Route::resourceの便利さを紹介しました。

routesを使いこなす（１）resourceを使う

routesを使いこなす（２）resourceを使いこなす

また、名前付きrouteがもたらす便宜さも紹介しました。

routesを使いこなす（４）routeを名付ける

しかし、Laravel 5.3のバージョンアップで「ちょっと、それはないよ」みたいな問題が出てきました。

Route::resourceでは、名前付きrouteが自動で作成されます。

例えば、Laravel 5.2では、routes.phpにこう設定すると、

routes.php

Route::group(['prefix' => 'admin', 'middleware' => 'web', 'namespace' => 'Admin'], function () {

    Route::resource('product', 'ProductController');

});

以下のように名前付きroutesがprefixをもとに設定されます。「Name」の列です。

php artisan route:list

+--------+-----------+------------------------------+-----------------------+---------------------------------------------------------------+------------+
| Domain | Method    | URI                          | Name                  | Action                                                        | Middleware |
+--------+-----------+------------------------------+-----------------------+---------------------------------------------------------------+------------+
|        | POST      | admin/product                | admin.product.store   | App\Http\Controllers\Admin\ProductController@store            | web,web    |
|        | GET|HEAD  | admin/product                | admin.product.index   | App\Http\Controllers\Admin\ProductController@index            | web,web    |
|        | GET|HEAD  | admin/product/create         | admin.product.create  | App\Http\Controllers\Admin\ProductController@create           | web,web    |
|        | DELETE    | admin/product/{product}      | admin.product.destroy | App\Http\Controllers\Admin\ProductController@destroy          | web,web    |
|        | PUT|PATCH | admin/product/{product}      | admin.product.update  | App\Http\Controllers\Admin\ProductController@update           | web,web    |
|        | GET|HEAD  | admin/product/{product}      | admin.product.show    | App\Http\Controllers\Admin\ProductController@show             | web,web    |
|        | GET|HEAD  | admin/product/{product}/edit | admin.product.edit    | App\Http\Controllers\Admin\ProductController@edit             | web,web    |
+--------+-----------+------------------------------+-----------------------+---------------------------------------------------------------+------------+

しかし、おなじ、routes.phpをLaravel 5.3に持っていくと（もちろん、web.phpと改名して、app/Httpからroutes/のディレクトリに移して）、

php artisan route:list

+--------+-----------+------------------------------+-----------------+---------------------------------------------------------------+------------+
| Domain | Method    | URI                          | Name            | Action                                                        | Middleware |
+--------+-----------+------------------------------+-----------------+---------------------------------------------------------------+------------+
|        | POST      | admin/product                | product.store   | App\Http\Controllers\Admin\ProductController@store            | web,web    |
|        | GET|HEAD  | admin/product                | product.index   | App\Http\Controllers\Admin\ProductController@index            | web,web    |
|        | GET|HEAD  | admin/product/create         | product.create  | App\Http\Controllers\Admin\ProductController@create           | web,web    |
|        | DELETE    | admin/product/{product}      | product.destroy | App\Http\Controllers\Admin\ProductController@destroy          | web,web    |
|        | PUT|PATCH | admin/product/{product}      | product.update  | App\Http\Controllers\Admin\ProductController@update           | web,web    |
|        | GET|HEAD  | admin/product/{product}      | product.show    | App\Http\Controllers\Admin\ProductController@show             | web,web    |
|        | GET|HEAD  | admin/product/{product}/edit | product.edit    | App\Http\Controllers\Admin\ProductController@edit             | web,web    |
+--------+-----------+------------------------------+-----------------+---------------------------------------------------------------+------------+

なんと！ admin.product.store ⇒ product.store　とadmin.が皆消えてしまいました。

ドキュメントを読むと、どうもこのprefixの設定は、resourceの名前付きrouteに反映される意図はなかったとのことで、5.3で修正という訳です。

以前と同様な、名前付きのrouteとするためには、asを使用して、以下のように設定します。

routes.php

Route::group(['prefix' => 'admin', 'as' => 'admin.', 'middleware' => 'web', 'namespace' => 'Admin'], function () {

    Route::resource('product', 'ProductController');

});

注意：adminでなく、admin.です。最後にドットが必要。

あるいは、ひとつひとつを命名するというオプションもあります。しかし、これはちょっと。。

routes.php

Route::group(['prefix' => 'admin', 'middleware' => 'web', 'namespace' => 'Admin'], function () {

    Route::resource('product', 'ProductController', ['names' => ['index' => 'admin.product.index']]);

});

routesを使いこなす（５）モデルとのバインディング

Fri, 26 Aug 2016 12:22:41 +0900

ユーザーがアクセスするURLを理解して、必要な関数にマップするのがroutes.phpの基本的な仕事です。

それらのURLには、以下のようにいろいろな形があります。

http://localhost/admin/login
http://localhost/admin/product/156
http://localhost/admin/product/156/edit

さて、上の例の156の数字は、DBテーブルのproductの主キーの値なのですが、Laravelはこの値をどのようにコントローラに取り込むのでしょう？

まず、前回のroutes.phpの設定を見てみましょう。

Route::resource('product', 'ProductController');

は、

php artisan route:list

の出力では以下のようなマップになります。

+--------+-----------+------------------------------------+------------------------+-----------------------------------------------------------------------+-----------------+
| Domain | Method    | URI                                | Name                   | Action                                                                | Middleware      |
+--------+-----------+------------------------------------+------------------------+-----------------------------------------------------------------------+-----------------+
|        | POST      | admin/product                      | admin.product.store    | App\Http\Controllers\Admin\ProductController@store                    | web             |
|        | GET|HEAD  | admin/product                      | admin.product.index    | App\Http\Controllers\Admin\ProductController@index                    | web             |
|        | GET|HEAD  | admin/product/create               | admin.product.create   | App\Http\Controllers\Admin\ProductController@create                   | web             |
|        | GET|HEAD  | admin/product/{product}            | admin.product.show     | App\Http\Controllers\Admin\ProductController@show                     | web             |
|        | DELETE    | admin/product/{product}            | admin.product.destroy  | App\Http\Controllers\Admin\ProductController@destroy                  | web             |
|        | PUT|PATCH | admin/product/{product}            | admin.product.update   | App\Http\Controllers\Admin\ProductController@update                   | web             |
|        | GET|HEAD  | admin/product/{product}/edit       | admin.product.edit     | App\Http\Controllers\Admin\ProductController@edit                     | web             |
+--------+-----------+------------------------------------+------------------------+-----------------------------------------------------------------------+-----------------+

URIの部分を見てください。

例えば、7行目の

admin/product/{product}

は、

ProductController@show

にマップされています。

そして156のIDは、この{product}の部分に対応します。

admin/product/{product}/edit

も同じことです。

対応するコントローラのメソッドを見ると、

ProductController.php

namespace App\Http\Controllers;
 
use Illuminate\Http\Request;
use App\Http\Requests;
use App\Models\Product;

class ProductController extends Controller
{
    /**
     * 表示画面
     *
     * @param  \App\Models\Product $product
     * @return \Illuminate\Http\Response
     */
    public function show(Product $product)
    {
        return $product->name; //画面に商品名を表示
    }
...

showのパラメータが、数字でなくモデルのProductのタイプになっていますね。これは、Laravelが自動的に、IDの数字をもとに、

$product = Product::find(156);

のようなモデルバインディング（紐づけ）操作を行って、Eloquentのオブジェクトを生成して、メソッドの中で使用できるようにしてくれているのです。便利ですね。

さて、product_id = 156に対応するDBレコードがない場合はどうなるのでしょう？

Sorry, the page you are looking for could not be found.
2/2 NotFoundHttpException in Handler.php line 102: No query results for model [App\Product]. 

1/2 ModelNotFoundException in Builder.php line 290: No query results for model [App\Product].

「検索結果が空」の404エラーとなります。

今度は、上のshowの関数のパラメータ名を以下のように変えたとしたら、どうなるのでしょう？

    public function show(Product $a_product)
    {
        return $a_product_name;//画面は空
    }

この場合、$a_project_nameにはDBレコードが入らず、単にProjectの新規オブジェクトとなり、画面には何も表示されません。

つまり、パラメータ名は、{product}とまったく同じ名前である必要があるということです。ミススペルに気をつけましょう。

さて、今度は、product_idではなく、例えば、skuという商品番号の項目の値でレコードを引っ張ってきたいときはどうするのでしょう？　

つまり、

http://localhost/admin/product/ABCDE

でアクセスしたい。そこでは、ABCDがskuの値とします。

その場合は、Productのモデルの定義で、

Product.php

namespace App;

use Illuminate\Database\Eloquent\Model;

class Product extends Model
{
    protected $table = 'product';
    protected $primaryKey = 'product_id';

    public function getRouteKeyName()
    {
        return 'sku';
    }
　　...
}

のように、getRouteKeyNameの関数を作成して、skuをリターンすれば、product_idの代わりに以下のようにオブジェクトを作成してくれます。

$product = Product::where('sku', 'ABCD')->first();

もちろん、skuは、productのDBテーブルで、主キーと同様に１つのレコードを特定するためにユニークなキーを持つ必要あります。

最後に、

http://localhost/admin/product/156?print=Y

の場合、printの値はどう取ってくるのでしょう？

これはshowメソッドを以下のように変更して、

ProductController.php

...
    /**
     * 表示画面
     *
     * @param  \App\Models\Product $product
     * @param  \Illuminate\Http\Request
     * @return \Illuminate\Http\Response
     */
    public function show(Product $product, Request $request)
    {
        $print = $request->input('print');

        return $print;
    }
...

printの値の取得が可能です。ここ、関数のパラメータの順番はURLでの順番とは関係ありません。逆でも同じ結果となります。先に説明したように、{product}の名前と一致する変数名でLaravelは判断するからです。

routesを使いこなす（４）routeを名付ける

Sat, 13 Aug 2016 08:28:31 +0900

Laravelでは、routeに名前を付けることができます。いったいそれがどうした？と思いますが、これができることで便利なことが増えます。

まず、routeの名前の付け方から、

Route::get('admin/ranking/download', 'RankingController@download');

とroutes.phpに指定して、

php artisan route:list

を実行すると、

+--------+-----------+-------------------------+------------------------+-------------------------------------------------------+
| Domain | Method    | URI                     | Name                   | Action                                                |
+--------+-----------+-------------------------+------------------------+-------------------------------------------------------+
|        | GET|HEAD  | admin/ranking/download  |                        | App\Http\Controllers\Admin\RankingController@download |

を出力します。3列名のNameの列に注目してください。

今は空ですね。

しかし、

Route::get('admin/ranking/download', 'RankingController@download')->name('admin.ranking.download');

とすると、

+--------+-----------+-------------------------+------------------------+-------------------------------------------------------+
| Domain | Method    | URI                     | Name                   | Action                                                |
+--------+-----------+-------------------------+------------------------+-------------------------------------------------------+
|        | GET|HEAD  | admin/ranking/download  | admin.ranking.download | App\Http\Controllers\Admin\RankingController@download |

admin.ranking.downloadと名前が付きます。

現在は、URIのスラッシュ(/)をピリオド(.)に置き換えたフォーマットですが、admin:ranking_downloadでも、admin::rankingdownloadでもOKです。

さて、routeにresourceを使用するときはどうなるのでしょう？

例えば、

Route::resource('product', 'ProductController');

は、

+--------+-----------+------------------------------------+------------------------+-----------------------------------------------------------------------+-----------------+
| Domain | Method    | URI                                | Name                   | Action                                                                | Middleware      |
+--------+-----------+------------------------------------+------------------------+-----------------------------------------------------------------------+-----------------+
|        | POST      | admin/product                      | admin.product.store    | App\Http\Controllers\Admin\ProductController@store                    | web             |
|        | GET|HEAD  | admin/product                      | admin.product.index    | App\Http\Controllers\Admin\ProductController@index                    | web             |
|        | GET|HEAD  | admin/product/create               | admin.product.create   | App\Http\Controllers\Admin\ProductController@create                   | web             |
|        | GET|HEAD  | admin/product/{product}            | admin.product.show     | App\Http\Controllers\Admin\ProductController@show                     | web             |
|        | DELETE    | admin/product/{product}            | admin.product.destroy  | App\Http\Controllers\Admin\ProductController@destroy                  | web             |
|        | PUT|PATCH | admin/product/{product}            | admin.product.update   | App\Http\Controllers\Admin\ProductController@update                   | web             |
|        | GET|HEAD  | admin/product/{product}/edit       | admin.product.edit     | App\Http\Controllers\Admin\ProductController@edit                     | web             |
+--------+-----------+------------------------------------+------------------------+-----------------------------------------------------------------------+-----------------+

と自動で名前を付けてくれます。

routeに名前が付いたところで、どう使用するか見てみましょう。

echo route('admin.ranking.download');

は、

http://localhost/admin/ranking/download

となります。もちろん、localhostはライブ環境では実際のドメイン名となります。

ということは、

echo url('admin/ranking/download');

と同じになります。

引数があるときは、

echo route('admin.product.edit', 12);
echo url('admin/product', [12, 'edit']);

の出力は、両方とも、

http://localhost/admin/product/12/edit

となりますが、名前付きの方がわかりやすいですね。

このroute()は、

return redirect()->route('admin.product.show', 12);

のようにリダイレクトや、

{!! Form::open(['route' => ['admin.product.store'], 'method' => 'post']) !!}

のようにテンプレートでも使用可能です。

もちろん、名前付きのrouteをプログラムで使用するなら、そのrouteのURIを変えても何もプログラムで変更は要らないことになります。便利ですね。

さらに、URIに比べて比較的扱いやすい文字列なので、名前付きのrouteに対してユーザーの権限をDBで定義すれば、例えば、ログインしたユーザーの役割により、特定のrouteを実行するかどうかの権限の判断にも使用可能です。将来、この連載で扱う予定のトピックです。

routesを使いこなす（３）prefixでgroupを分割

Wed, 03 Aug 2016 23:37:08 +0900

開発しているプログラムの機能が増えてくると、必然的に定義するrouteの数が増えてきます。特に、マルチ認証ともなると、関わるプレイヤーの分だけで倍増する可能性があります。

例えば、ECのプロジェクトで、会員と管理者がプレイヤーとすると、ログインだけでも2通りのURIが必要となり、routeの設定は以下のように４つ必要となります。

routes.php

Route::group(['middleware' => 'web'], function () {
	Route::get('user/login', 'User\Auth\AuthController@showLoginForm');
	Route::post('user/login', 'User\Auth\AuthController@login');
	Route::get('admin/login', 'Admin\Auth\AuthController@showLoginForm');
	Route::post('admin/login', 'Admin\Auth\AuthController@login');
});

実際作成されるrouteは、

php artisan route:list

の実行によると、

+--------+----------+-------------+------+--------------------------------------------------------------+-----------------+
| Domain | Method   | URI         | Name | Action                                                       | Middleware      |
+--------+----------+-------------+------+--------------------------------------------------------------+-----------------+
|        | POST     | admin/login |      | App\Http\Controllers\Admin\Auth\AuthController@login         | web,guest:admin |
|        | GET|HEAD | admin/login |      | App\Http\Controllers\Admin\Auth\AuthController@showLoginForm | web,guest:admin |
|        | POST     | user/login  |      | App\Http\Controllers\User\Auth\AuthController@login          | web,guest       |
|        | GET|HEAD | user/login  |      | App\Http\Controllers\User\Auth\AuthController@showLoginForm  | web,guest       |
+--------+----------+-------------+------+--------------------------------------------------------------+-----------------+

これに他のいくつもの機能を加えていくと、管理が大変になってきます。現在私が管理しているプロジェクトでは、管理画面だけで300近いrouteが存在します。そうなると、タイプミスも増えるでしょうし、一目見て理解もしにくいです。

管理性を高める１つの方法は、prefixを使用してroutesのgroupを分割します。

先の例では、userとadminのprefixを用いて、それぞれのプレイヤーに１つのgroupを作成します。

Route::group(['prefix' => 'user', 'namespace' => 'User', 'middleware' => 'web'], function () {
	Route::get('login', 'Auth\AuthController@showLoginForm');
	Route::post('login', 'Auth\AuthController@login');
});

Route::group(['prefix' => 'admin', 'namespace' => 'Admin', 'middleware' => 'web'], function () {
	Route::get('login', 'Auth\AuthController@showLoginForm');
	Route::post('login', 'Auth\AuthController@login');
});

行数が少し増えたかもしれませんが、重複部分がなくなってすっきりしただけでなく、グループ分けで理解しやすいコードとなりましたね。さらに、namespaceを使用することで、コントローラのnamespaceも重複も省いています。

さて、実際生成されるrouteはどうなのでしょう？この変更で変わってしまっては問題です。

php artisan route:list

を実行すると、

+--------+----------+-------------+------+--------------------------------------------------------------+-----------------+
| Domain | Method   | URI         | Name | Action                                                       | Middleware      |
+--------+----------+-------------+------+--------------------------------------------------------------+-----------------+
|        | POST     | admin/login |      | App\Http\Controllers\Admin\Auth\AuthController@login         | web,guest:admin |
|        | GET|HEAD | admin/login |      | App\Http\Controllers\Admin\Auth\AuthController@showLoginForm | web,guest:admin |
|        | POST     | user/login  |      | App\Http\Controllers\User\Auth\AuthController@login          | web,guest       |
|        | GET|HEAD | user/login  |      | App\Http\Controllers\User\Auth\AuthController@showLoginForm  | web,guest       |
+--------+----------+-------------+------+--------------------------------------------------------------+-----------------+

まったく先と同じです。

routesを使いこなす（２）resourceを使いこなす

Thu, 28 Jul 2016 13:39:45 +0900

resourceを使い始めて、まず思うのは、いつもいつも index, store, create, edit, update, destroyの一式が必要というわけではないことです。

例えば、以下のようなレポートタイプのコントローラなら、

indexだけで十分なので、以下のようにonlyを使い他のrouteを無効にします。

Route::resource('ranking', 'RankingController.php', ['only' => ['index']]);

また、追加と編集だけで、削除が要らないコントローラなら、exceptを使い、index, store, create, edit, updateだけの使用を可能にします。

Route::resource('no_destroy', 'NoDestroyController.php', ['except' => ['destroy']]);

便利ですね。

さらに、 index, store, create, edit, update, destroyだけでないrouteが必要なときもあります。

例えば、先の「売上ランキング」のレポートに、結果をCSVでダウンロードしたいとします。

今のところ、indexしか使用していないので、storeでも使う？

しかし、名前がいまひとつ。理想は、ranking/downloadとしたいです。

このような場合は、

Route::get('admin/ranking/download', 'RankingController@download');
Route::resource('admin/ranking', 'RankingController', ['only' => ['index']]);

と、独自のrouteをRoute::resourceの前に追加します。

php artisan route:list

の出力は、

+--------+-----------+-------------------------+------------------------+-------------------------------------------------------+
| Domain | Method    | URI                     | Name                   | Action                                                |
+--------+-----------+-------------------------+------------------------+-------------------------------------------------------+
|        | GET|HEAD  | admin/ranking           | admin.ranking.index    | App\Http\Controllers\Admin\RankingController@index    |
|        | GET|HEAD  | admin/ranking/download  |                        | App\Http\Controllers\Admin\RankingController@download |

routesを使いこなす（１）resourceを使う

Mon, 18 Jul 2016 04:46:59 +0900

私が開発・管理しているプロジェクトのひとつは、もともとは過去に人気があったCodeIgniterで書かれたもの。過去２年の間に、それをLaravelのバージョン４で書き直し、さらに更新して現在はLaravelのバージョン5.2となっています。

それゆえに、最初のLaravelを使っての書き換えは、Laravelを勉強しながらの書き換えで、知らないことが多く、Route::controllerを多用していました。

コントローラは以下のように作成して、

ProductController.php

class ProductController extends Controller
{
...
	public function getAdd() {...}
	public function postAdd() {...}
	public function getEdit(Product $product) {..}
	public function postEdit(Product $product) {..}
...
}

メソッドには、getやpostのプリフィックスが必要です。次は、routeを設定します。

routes.php

...
	Route::controller('product', 'ProductController.php');
...

これを

php artisan route::list

で実行して見るとこんな感じに出力されます。

+--------+--------------------------------+------------------------------------------------------------+-----------------------+-----------------------------------------------------------------------+-----------------+
| Domain | Method                         | URI                                                        | Name                  | Action                                                                | Middleware      |
+--------+--------------------------------+------------------------------------------------------------+-----------------------+-----------------------------------------------------------------------+-----------------+
|        | GET|HEAD                       | admin/product/add/{one?}/{two?}/{three?}/{four?}/{five?}  |                       | App\Http\Controllers\Admin\ProductController@getAdd                  | web             |
|        | POST                           | admin/product/add/{one?}/{two?}/{three?}/{four?}/{five?}  |                       | App\Http\Controllers\Admin\ProductController@postAdd                 | web             |
|        | GET|HEAD                       | admin/product/edit/{one?}/{two?}/{three?}/{four?}/{five?} |                       | App\Http\Controllers\Admin\ProductController@getEdit                 | web             |
|        | POST                           | admin/product/edit/{one?}/{two?}/{three?}/{four?}/{five?} |                       | App\Http\Controllers\Admin\ProductController@postEdit                | web             |
|        | GET|HEAD|POST|PUT|PATCH|DELETE | admin/product/{_missing}                                  |                       | App\Http\Controllers\Admin\ProductController@missingMethod           | web             |

さて、ここでの問題は、デフォルトでは、URIが、

admin/product/edit/{one?}/{two?}/{three?}/{four?}/{five?}

となりgetEditの関数のパラメータがrouteに反映されないことです。

うえは、

admin/product/{product}/edit

とあるべきです。

これを正しくするには、

routes.php

...
Route::model('product', 'App\Models\Product');  
...
Route::get('product/add', 'ProductController@getAdd');
Route::post('product/add', 'ProductController@getAdd');
Route::get('product/{product}/edit', 'ProductController@getEdit');
Route::post('product/{product}/edit', 'ProductController@getEdit');
...

と、やたらroutes.phpにおいての記述が多くなってしまいます。ウェブのアプリのほとんどは、DBでのレコードの閲覧、作成、編集、削除などの定型です。簡単にならないものでしょうか？

そこで、Route::resourceの登場です。

ちなみに、Route::controllerは、バージョン5.1まではLaravelのマニュアルに説明がありましたが、現バージョン5.2ではなくなりました（コードではまた対応はしているようです）。

もうRoute::controllerはリタイヤが近づいているということで、Route::resourceに切り替えるちょうど良い機会です。

まず、以下のコマンドを実行してひな形を作成します。

php artisan make:controller ProductController –resource

作成されたファイルを編集して、

ProductController.php

namespace App\Http\Controllers;

use Illuminate\Http\Request;

use App\Http\Requests;

use App\Models\Product;

class ProductController extends Controller
{
    /**
     * 検索表示
     *
     * @return \Illuminate\Http\Response
     */
    public function index()
    {
        //
    }

    /**
     * 新規作成画面
     *
     * @return \Illuminate\Http\Response
     */
    public function create()
    {
        //
    }

    /**
     * DBレコード新規作成
     *
     * @param  \Illuminate\Http\Request  $request
     * @return \Illuminate\Http\Response
     */
    public function store(Request $request)
    {
        //
    }

    /**
     * 表示画面
     *
     * @param  \App\Models\Product $product
     * @return \Illuminate\Http\Response
     */
    public function show(Product $product)
    {
        //
    }

    /**
     * 編集画面
     *
     * @param  \App\Models\Product $product
     * @return \Illuminate\Http\Response
     */
    public function edit(Product $product)
    {
        //
    }

    /**
     * DBレコード編集
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  \App\Models\Product $product
     * @return \Illuminate\Http\Response
     */
    public function update(Request $request, Product $product)
    {
        //
    }

    /**
     * DBレコード削除
     *
     * @param  \App\Models\Product $product
     * @return \Illuminate\Http\Response
     */
    public function destroy(Product $product)
    {
        //
    }
}

Route::Controllerと比較すると、resourceのメソッドは、

getAdd   → create
postAdd  → store
getEdit  → edit
postEdit → update

となります。

routesを設定すると、

routes.php

...
	Route::resource('product', 'ProductController.php');
...

php artisan route:list

の出力は、

+--------+-----------+------------------------------------+-----------------------+-----------------------------------------------------------------------+-----------------+
| Domain | Method    | URI                                | Name                  | Action                                                                | Middleware      |
+--------+-----------+------------------------------------+-----------------------+-----------------------------------------------------------------------+-----------------+
|        | POST      | admin/product                      | admin.product.store   | App\Http\Controllers\Admin\ProductController@store                    | web             |
|        | GET|HEAD  | admin/product                      | admin.product.index   | App\Http\Controllers\Admin\ProductController@index                    | web             |
|        | GET|HEAD  | admin/product/create               | admin.product.create  | App\Http\Controllers\Admin\ProductController@create                   | web             |
|        | GET|HEAD  | admin/product/{product}            | admin.product.show    | App\Http\Controllers\Admin\ProductController@show                     | web             |
|        | PUT|PATCH | admin/product/{product}            | admin.product.update  | App\Http\Controllers\Admin\ProductController@update                   | web             |
|        | DELETE    | admin/product/{product}            | admin.product.destroy | App\Http\Controllers\Admin\ProductController@destroy                  | web             |
|        | GET|HEAD  | admin/product/{product}/edit       | admin.product.edit    | App\Http\Controllers\Admin\ProductController@edit                     | web             |
|

URIも自動で設定され、さらに名前付きのroute (named route)も設定されていますね。

さて、admin.product.updateのPUTやPATCHはどうbladeのフォームで対応するのでしょう？HTMLの

のactionにはGETとPOST以外見たことありませんね。

もちろん、簡単です。

<form method="POST" action="admin/product/{{$product->product_id}}">
     {!! method_field('put') !!}
     . . .
</form>

method_field()は、Laravelのヘルパー関数で、以下と同じです。

<input type="hidden" name="_method" value="PUT">

そして、以前紹介した、Laravel Collectiveのフォームを使用するなら、

{!! Form::open(['route' => ['admin.product.update', $product->product_id], 'method' => 'put']) !!}
..
{!! Form::close !!}

namespaceを指定してroutesすっきり

Mon, 13 Jun 2016 08:37:02 +0900

以前、マルチ認証の説明で以下のような、routes.phpを掲載しました（ユーザー認証（１０）Laravel 5.2 マルチ認証）。

   Route::group(['middleware' => 'guest:users'], function()
    {
        Route::get('login', 'user\AuthController@getLogin');
        Route::post('login', 'user\AuthController@postLogin');
        Route::get('signup', 'user\SignupController@getSignup');
        Route::post('signup', 'user\SignupController@postSignup');
        Route::get('password/email', 'user\PasswordController@getEmail');
        Route::post('password/email', 'user\PasswordController@postEmail');
        Route::get('password/reset/{token}', 'user\PasswordController@getReset');
        Route::post('password/reset', 'user\PasswordController@postReset');
    });

ここ、user\AuthControllerとか、user\SignupControllerとか、namespaceのuser</code>がいつも繰り返されていて、面倒だなあと思いませんでしたか？


賢くなるものです。最近、ここnamespaceを使用して、user</code>を削除することが可能なこと見つけました。

   Route::group(['middleware' => 'guest:users', 'namespace' => 'user'], function()
    {
        Route::get('login', 'AuthController@getLogin');
        Route::post('login', 'AuthController@postLogin');
        Route::get('signup', 'SignupController@getSignup');
        Route::post('signup', 'SignupController@postSignup');
        Route::get('password/email', 'PasswordController@getEmail');
        Route::post('password/email', 'PasswordController@postEmail');
        Route::get('password/reset/{token}', 'PasswordController@getReset');
        Route::post('password/reset', 'PasswordController@postReset');
    });
すっきりしましたね。
また、php artisan route:listの実行でrouteをチェックしても、変更の前後ではまったく変わりません。

Route on ララジャパン

Laravel 8.x更新で変わったこと（２）Route関連の変更

Laravel 7.x更新で発見したこと（3）ルートのキャッシュ

ルートのキャッシュ

重複のルート名はL6.xではOKだったのに

L7.xでの問題

最後に

Laravelへの移行（１）他のプログラムの認証セッションを認識

現行のプログラムの認証セッション

認証セッションの認識

コントローラのコンストラクタで引数を取り出す

準備

コンストラクタで引数を取り出す

取り出して、それからどうする？

Route::match

Laravel 5.3 resourceでの名前付きrouteの変更

routesを使いこなす（５）モデルとのバインディング

routesを使いこなす（４）routeを名付ける

routesを使いこなす（３）prefixでgroupを分割

routesを使いこなす（２）resourceを使いこなす

routesを使いこなす（１）resourceを使う

namespaceを指定してroutesすっきり

Laravel 5.3　resourceでの名前付きrouteの変更