Laravelの知られざる5つの機能

Japanese (日本語) translation by Takashi Yamamoto (you can also view the original English article)

Laravelを使って開発をしている人は数多くいますが、フレームワークの機能にまで手を入れる人はごくわずかでしょう。実際Laravelのドキュメントはほとんどの場面を網羅しています。しかしすべてを網羅している訳ではありません。

誤解してほしくないのですが、Laravelのでキュメントは素晴らしいもので必要なことは大抵記載してあります。しかし全てを記載するということは難しいことです。これからその記載されていない知られざる機能について紹介します。

Cascading Views

利用可能: v4.0.0以降
ドキュメント: なし

LaravelのViewはconfigurationファイルと同じように入れ子にする事ができます。Cascading Viewsは拡張しやすいテーマシステムを導入するのに非常に便利です。下がディレクトリ構成の例です。

/app
    /views
        /blog
            /index.blade.php
/themes
    /default
        /views
            /blog
                /index.blade.php
            /theme.blade.php

この構成でreturn View::make('theme::blog.index'); とした時に、最初にthemes/default/viewsにviewファイルを探しに行き、見つからなければapp/viewsディレクトリを探しに行くようになります。

この機能を使用するためにView::addNamespace で２つのデレクトリを登録するがあります。

View::addNamespace('theme', [
    base_path().'/themes/default/views',
    app_path().'/views'
]);

Collections

利用可能: v4.0.0以降
ドキュメント: 一部あり

Collectionsは配列の操作・管理のための素晴らしいツールです。Collectionsには多くの手軽なメソッドと、 ArrayableInterface, IteratorAggregate,JsonableInterfaceなど便利なインターフェイスの実装が含まれています。

ブログシステムを構築する例で使い方を紹介しましょう。

ブログの記事を表すAriticleクラスのインスタンスで構成される配列を操作したい場合は、最初にそれを引数にしてCollectionクラスを作る必要があります。

$articles = new Illuminate\Support\Collection($arrayOfArticles);

Sorting

Collectionsを使うと記事の並び替えが可能です。例えば記事一覧を最近更新された順に並び替えてみましょう。記事一覧がファイルシステムから読み込まれた時に、ArticleクラスのupdateAtに最終更新日が設定される場合、並び替えは以下の様にします。

$articles->sortByDesc(function ($article) { 
    return $article->updatedAt; 
});

sortByとsortByDesc メソッドは並び替えに必要な値を返すcallbackを引数にとり配列の並び替えを実行します。このケースでは単純に記事の最終更新日を返していて、Collectionsはそれを元に降順で並び替えをしています。

Filtering

配列に対して並び替えだけでなく絞り込みをする事も可能です。MySQLでWHERE句を使うように簡単に出来ます。先程の記事一覧を絞り込んでみましょう。

<?php

$searchQuery = 'Laravel rocks!';

$results = $articles->filter(function ($article) use ($searchQuery) {
    return preg_match(sprintf('/%s/m', $searchQuery), $article->body);
});

filterメソッドは絞り込みを適用した新しいIlluminate\Support\Collectionのインスタンスを返すので、$resultsにそれを代入する必要があります。新しい配列には本文に"Laravel rocks!"が含まれる記事のみが含まれる様になります。

Pagination

Collectionsを使ってページ送りを実装する事も出来ます。1ページに全ての記事を載せる必要はありません。

$perPage = 1;

$page = Input::get('page', 1);

if ($page > ($articles->count() / $perPage)) {
    $page = 1;
}

$pageOffset = ($page * $perPage) - $perPage;

$results = $articles->slice($pageOffset, $perPage);

sliceソッドを使って、必要な位置の記事一覧を切り出して、$results variable.

この方法でLaravelのPaginatorインスタンスを生成することも出来ます。全てのページのページ番号とリンクを作ることもが出来るのです。

そしてさらに！

記事の順番をランダムにするのも簡単です。

$article = $articles->random();

配列のようにfor句でループさせる事も出来ます。IteratorAggregateとArrayIteratorインターフェイスを実装しているからです。

foreach ($articles as $article) {
    echo $article->body;
}

普通の配列やJSONに変換するのも簡単です。

$array = $articles->toArray();
$json = $articles->toJson();

数あるメソッドの中で最もクールなものの一つがgroupByでしょう。一つのキーを元に配列をグループ化することが出来ます。

ブログ記事一覧の例で言えば、記事のプロパティのcategoryでグループ化するには以下のようにします。

$results = $articles->groupBy('category');

これで全ての記事はカテゴリ毎にグループ化されました。更に特定のカテゴリの記事一覧を取得するには以下の様にします。

foreach ($results->get('tutorial') as $article) { 
    echo $article->body; 
}

CollectionsはLaravelが提供する知られざる機能の中で最も便利な物の1つです。

Regular Expression Filters

利用可能: v4.1.19以降
ドキュメント:なし

ルートのフィルタリングはほとんどのプロジェクトで行う、よくある作業です。ルーティングの際にユーザー認証や年齢制限などをかける事も出来ます。Router::filterでフィルターを作成して、個別にルートティングを設定したり、ルーティングをグループ化して、Router::whenを使ってurlに適用させて使用します。

Route::filter('restricted', function($route, $request, $group)
{
    // Restrict user access based on the value of $group
});

Route::when('admin/*', 'restricted:admin');

上の例では最初にrestrictedを作成して、urladminに適用しています。フィルターには$groupパラメーターを渡すように設定されています。( $routeと$requestはbefore filterにいつも渡されるパラメーターです。 )

しかしより柔軟に適応したい場合はどうすれば良いでしょうか？例えばurladminにはフィルターを適用したいけど、admin/loginにはフィルターを適用したくない時です。一つの方法としてroute groupを作成して、ログインページだけそこから外す方法があります。そしてもう一つの方法としてRoute::whenRegexを使い正規表現で適用させる方法です。

Route::whenRegex('/^admin(\/(?!login)\S+)?$/', 'restricted:admin');

この正規表現はurladminには適用するけど、後ろに/loginが付いているものには適用しないというパターンです。素晴らしい事にこれだけでadmin/login以外の全てのadminページに適用するrestricted:adminフィルターになります。/p>

The Message Bag

利用可能: v4.0.0以降
ドキュメント: 一部あり

あなたが自覚していなくても、Illuminate\Support\MessageBag をどこかで使っているはずです。MessageBagの最大の役割はLaravelに組み込まれているValidatorを使った時に、そのエラーを保持することです。

全てのviewに存在する$errors変数は空のMessageBagインスタンスかRedirect::to('/')->withErrors($validator);でセッションにフラッシュしたインスタンスを保持しています。

フォームでの入力エーの時に、正しい入力方法を表示する時などにこれは使えます。

{{ Form::text('username', null) }}
@if($errors->has('username'))
    <div class="error">{{ $errors->first('username') }}></div>;
@endif

上のテンプレートのif句は実は必要ありません。firstメソッドを使い２つ目の引数にdivブロックを渡せば、メッセージを簡単にdivで囲う事が出来ます。

    {{ Form::text('username', null) }}
    {{ $errors->first('username', '<div class="error">:message</div>') }}

テンプレートが本当に良い感じになりましたね！

Fluent

利用可能: v3.0.0以降
ドキュメント: 一部あり

Fluentクラスは割りと昔からある機能で、最近ではフレームワークのスキーマビルダーによるマイグレーション処理に使われています。このクラスはLaravel3からLaravel4になっても殆ど変更はありません。唯一の大きな変更といえばインターフェイスがいくつか追加された事でしょう。

Fluentクラスを使うのに必要な事はインスタンスを生成して任意にメソッドを呼び出すだけです。

$user = new Illuminate\Support\Fluent;
$user->name('Jason')->country('Australia')->subscriber();

これで$userインスタンスには値が"Json"のname属性、値が"Australia"のcountry属性、booleanで"true"の値を持つsubscriber属性が定義されました。

Laravel4.2以降はJsonSerializableインターフェイスが追加されたので、json_encodeメソッドに対してダイレクトにこのインスタンスを渡す事が出来ます。

Laravel4.0まではインスタンスを通じての属性のsetとgetしか出来ませんでしたが、4.1以降はtoArray、toJsonメソッドが追加され属性の配列での取得や、JSONフォーマットでの取得が可能になりました。

まだまだあります！

5つの便利な機能について、紹介して来ましたが、察しの通りこのフレームワークにはまだまだ機能があります。

Laravelがどんな機能を提供しているか知るための一番良い方法は、ソースを解読していくことです。決して難しい事ではありません、そしてフレームワークについてより深く理解が進むでしょう。

もしも他の知られていない便利な機能をみつけたら、是々非々コメント欄で紹介してください！