コントローラクラスの名前空間
コントローラクラスを導入することで、リスト2のようにルーティング登録のコードはシンプルになり、web.phpはメンテナンスしやすくなります。一方で、Controllersディレクトリにコントローラクラスが増殖することになります。となると、Controllersディレクトリにサブディレクトリを作成し、整理したくなります。ただ、その場合は1つ注意が必要です。
ここでは、前回のリスト5を題材に、ControllersディレクトリにサブディレクトリとしてChap4ディレクトリを作成し、その中にコントローラクラスHelloToSomeoneControllerクラスを作成してみましょう。リスト3のようになります。
<?php
namespace App\Http\Controllers\Chap4; // (1)
use App\Http\Controllers\Controller;
class HelloToSomeoneController extends Controller
{
public function __invoke()
{
$data["name"] = "中野"; // (2)
return view("chap3.hello", $data); // (2)
}
}
(2)は前回のリスト5のコールバック関数内に記述したコードと全く同じです。
リスト3で注意するべきことは1点だけです。それは、namespace宣言の時に、(1)のように実際のディレクトリ構造に合わせてサブディレクトリも記述することです。リスト3はControllersディレクトリ内のChap4ディレクトリに作成したクラスなので、名前空間も
App\Http\Controllers\Chap4
としています。
次に、このクラスをルーティング登録する際にも注意が必要です。それは、リスト4のようになります。
Route::get("/chap4/helloToSomeone", "Chap4\HelloToSomeoneController");
ここでは、ルーティング登録メソッドの第2引数に、単にコントローラクラス名(非修飾名)を記述するのではなく、Controllersからの修飾名を記述する点に注意してください。HelloToSomeoneControllerの完全修飾名は
\App\Http\Controllers\Chap4\HelloToSomeoneController
となります。
そのため、Controllersまでを省略した以下の記述となります。
Chap4\HelloToSomeoneController
実際に、以下のURLにアクセスしてみます。
- http://localhost/firstlaravel/public/chap4/helloToSomeone
すると、図2の画面が表示され、無事、サブディレクトリ内のコントローラクラスで処理が行われたのがわかります。
複数処理をまとめたコントローラクラス
前節までで、無事コントローラクラスが利用でき、さらに、それらのコントローラクラスを整理できるようになりました。ここからはさらにもう一歩進んで、コントローラクラスに処理をまとめていきます。
__invoke()を使わないコントローラクラス
ここまでで紹介してきた__invoke()メソッドを利用したコントローラクラスは、1つのコントローラクラスに1つの処理しか記述できません。このことから「シングル」アクションコントローラと命名されています。
それら複数のシングルアクションコントローラクラスを、サブディレクトリを使って整理する方法もいいのですが、クラスというのはもともと複数のメソッドを記述できます。なので、コントローラクラスにも複数のメソッドを記述し、サブディレクトリに複数作成していたクラス群を1つのクラスにまとめることができます。
では、実際に作成してみましょう。Controllersディレクトリにリスト5のChap4Controller.phpを作成してください。なお、(2)はリスト1の(5)と同じコード、(4)はリスト3の(2)と同じコードです。
<?php
namespace App\Http\Controllers;
use App\Http\Controllers\Controller;
class Chap4Controller extends Controller
{
public function helloMusha() // (1)
{
$data["name"] = "武者小路"; // (2)
return view("helloWithData", $data); // (2)
}
public function helloNakano() // (3)
{
$data["name"] = "中野"; // (4)
return view("chap3.hello", $data); // (4)
}
}
名前空間の付け方、継承する親クラスについては、これまで紹介してきたコントローラクラスと同じです。ここでのポイントは(1)と(3)です。__invoke()を使わずに、通常のメソッド名同様に、任意のメソッド名を記述できるうえ、処理ごとに複数記述できます。
コントローラクラス内メソッドのルーティング登録
では、リスト5のhelloMusha()メソッドとhelloNakano()メソッドをそれぞれルーティング登録するにはどのように記述すればいいのでしょうか。これは、リスト6のようになります。
Route::get("/chap4/helloMusha", "Chap4Controller@helloMusha"); // (1)
Route::get("/chap4/helloNakano", "Chap4Controller@helloNakano"); // (2)
ルーティング登録メソッドの第2引数の記述を見てください。以下の書式になっています。
コントローラクラス名@メソッド名
これが、複数メソッドが記述されたコントローラクラスのルーティング登録方法です。リスト6の(1)ではリスト5の(1)のhelloMusha()メソッドを、リスト6の(2)ではリスト5の(3)のhelloNakano()メソッドを登録しています。
この書式で注意したいのは、メソッド名の後に()の記述は不要な点です。
実際に、以下のURLにアクセスしてみます。
- http://localhost/firstlaravel/public/chap4/helloMusha
すると、図1と同じ画面が表示されます。一方、以下のURLにアクセスしてみます。
- http://localhost/firstlaravel/public/chap4/helloNakano
すると、図2と同じ画面が表示されます。
このように、__invoke()メソッドを使わないコントローラクラスでは、複数のメソッドを記述し、それらをそれぞれルーティング登録することで、関連した複数の処理を1つのクラス内にまとめることができます。この方がメンテナンス性が向上するので、通常、コントローラクラスを作成する場合は、この方法を採用します。
