README

単体で動作するLaravelライクなルーティングライブラリを自作しました。

フレームワークを使う程では無い極小規模な開発で使用することを想定してます。

composerを使って導入できます。PHPのバージョンは7.1以上が必要です。

導入方法

方法1：composerを利用する方法

composer require laralike/laralike-router

<?php

use \laralike\LaralikeRouter as Route;

require_once __DIR__ . '/vendor/autoload.php';

Route::get('/', function () { echo 'hello milky'; });

.htaccess等を利用し、全てのアクセスをindex.phpに飛ばす様にしておく。

RewriteEngine On
RewriteCond %{REQUEST_FILENAME} !-d
RewriteCond %{REQUEST_FILENAME} !-f
RewriteRule ^ index.php [L]

使い方

ほとんどLaravelのルーティングと同じ使い方です。ただし名前付きルート・サブドメインルーティング・モデル結合ルート等一部機能は使えません。サンプル: LaralikeRouter/tests/index.php

基本的なルーティング

第1引数は、/から始めても、/から始めなくても、同じ様に動作します。

Route::get('/', function () { return 'hello milky'; });

Route::get('/foo', function () { return 'FOO'; });
Route::get('bar', function () { return 'BAR'; });

// returnされた値がarray型の場合は、
// `Content-Type: application/json`ヘッダを出力して、戻り値をjson_encodeして出力します。
Route::get('baz', function () { return ['BAZ']; });

コントローラーを利用する場合は以下の様にします。

Route::get('/', '\App\Controller\TestController@index');

省略して書く場合は以下の様にコントローラーのnamespaceを設定します。デフォルトではApp\Http\Controllers\が設定されています。

Route::setNamespace('\\App\\Controller\\');
Route::get('/', 'TestController@index');

Laravelと同じ方法でHTTPメソッドを定義できます。

Route::get($uri, $callback);
Route::post($uri, $callback);
Route::put($uri, $callback);
Route::patch($uri, $callback);
Route::delete($uri, $callback);
Route::options($uri, $callback);

Route::match(['get', 'post'], '/', $callback);
Route::any('/', $callback);

リダイレクトルート

Laravelと同じ方法でリダイレクトルートを定義できます。

Route::redirect('/here', '/there'); // 302
Route::redirect('/here', '/there', 301);
Route::permanentRedirect('/here', '/there'); // 301

Laravelには無い記法ですが、以下の様にも使用できます。

Route::get('/here', function () { Route::runRedirect('/there'); }); // 302
Route::get('/here', function () { Route::runRedirect('/there', 301); });

ルートグループ内で使った場合は以下の様に動作します。

Route::prefix('/foo')->group(function () {
	Route::redirect('/here', '/there'); // `/foo/here` => `/foo/there`
});

ビュールート

ビュールートを定義する場合は、ご自分で好きなテンプレートエンジンライブラリを入れ、以下の様な感じで設定してください。(以下はtwigの設定例)

function view ($viewfile, $parameters) {
  $loader = new \Twig\Loader\FilesystemLoader(__DIR__ . '/');
  $twig = new \Twig\Environment($loader, [
    'debug' => true
  ]);
  return $twig->render($viewfile, $parameters);
}
Route::setView(view:class);
Route::prefix('/view')->group(function () {
  // 以下の様に使用するなら`Route::setView`は不要です。
  Route::get('/twig1', function () { return view('test.html.twig', ['name' => 'lala']); });
  // 以下の様ビュールートを使用する場合は`Route::setView`で予め設定する必要がある。
  Route::view('/twig2', 'test.html.twig', ['name' => 'milky']);
});

ルートパラメーター

Laravelと同じ方法でルートパラメーターを定義できます。

デフォルトでは/を除く全ての文字を許可しています。

必須パラメーター

Route::get('user/{id}', function ($id) {
    return 'User '.$id;
});

Route::get('posts/{post}/comments/{comment}', function ($postId, $commentId) {
    //
});

任意パラメーター

Route::get('user/{name?}', function ($name = null) {
    return $name;
});

Route::get('user/{name?}', function ($name = 'lala') {
    return $name;
});

正規表現制約

正規表現制約は以下の様に定義します。 whereには必ず連想配列を渡してください。

Route::get('user/{id}', function ($id) {
    //
})->where(['id' => '[0-9]+']);
// NG: ->where('id', '[0-9]+');

Route::get('user/{id}/{name}', function ($id) {
    //
})->where(['id' => '[0-9]+', 'name' => '[a-z]+']);

ルートグループ

ルートグループは以下の様に定義します。

ネストにも対応しています。

Route::prefix('/foo')->group(function () {
    // `/foo/bar`で`FOOBAR`と出力される
	Route::get('/bar', function () { echo 'FOOBAR' });
});

Route::middleware([function () { echo 'Hello '; }])
  ->prefix('/hello')
  ->group(function () {
    // `hello/lala`で`Hello lala`と出力される
    Route::get('/lala', function () { echo 'lala'; });
    // `hello/hikaru`で`Hello hikaru`と出力される
    Route::get('/hikaru', function () { echo 'hikaru'; });
});

//　ネスト
Route::prefix('/hello')
  ->middleware([function () { echo 'Hello '; }])
  ->group(function () {
    Route::prefix('/cure')
      ->middleware([function () { echo 'Cure '; }])
      ->group(function () {
          // `hello/cure/milky`で`Hello Cure Milky`と出力される
          Route::get('/milky', function () { echo 'Milky'; });
      });
  });

フォールバックルート (404 Not Found)

Laravelと同じ方法で全てのルートに一致しない場合の処理を定義できます。

Route::fallback(function () {
  // 404
});

定義しなかった場合、自動でRoute::defaultFallback()が呼ばれます。

defaultFallbackの中身は以下の様な感じになっています。

  public static function defaultFallback()
  {
    header($_SERVER['SERVER_PROTOCOL'] . ' 404 Not Found');
    echo '404 Not Found';
  }

laralike / laralike-router

Maintainers

Details