Resource on ララジャパン

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を使いこなす（２）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 !!}