Laravel 5.2 アップグレードガイド

5.1から5.2.0へのアップグレード

アップデートにかかる時間の見積もり:1時間以下

注意: フレームワークに影響が起きるだろう変更を包括的にリストしました。皆さんのアプリケーションの大半では、変更する必要がないものも多いでしょう。

依存パッケージの更新

composer.jsonファイルの内容をlaravel/framework 5.2.*へ更新してください。

composer.jsonファイルのrequire-devセクションへ、"symfony/dom-crawler": "~3.0""symfony/css-selector": "~3.0"を追加してください。

認証

設定ファイル

https://github.com/laravel/laravel/blob/master/config/auth.phpへ、config/auth.php設定ファイルを更新してください。

新しいバージョンの内容に更新したら、古い設定ファイルの内容を元に、認証設定オプションを指定してください。Laravel5.1で使用できるEloquentベースの認証サービスが一般的には使われていますが、ほとんどの値はそのまま使用できるでしょう。

新しいauth.php設定ファイルのpasswords.users.email設定オプションへ特に注意を払ってください。デフォルトではLaravel5.2で変更になったらビューへのパスになっていますので、これがアプリケーションの実際のビューパスと一致しているか確認してください。新しい設定ファイルのデフォルト値が実際のビューと一致していない場合は、設定オプションをそれに合わせて変更してください。

契約

Illuminate\Contracts\Auth\Authenticatable契約を実装しているが、Authenticatableトレイトを使っていない場合は、新しいgetAuthIdentifierNameメソッドをその契約の実装に追加してください。通常、このメソッドはauthenticatableエンティティの「主キー」のカラム名を返します。たとえば、idです。

このインターフェイスを自分で実装していない限り、アプリケーションに影響することはまずないでしょう。

カスタイムドライバ

ユーザを取得するカスタムメソッドを定義するAuth::extendメソッドを使っている場合、カスタムユーザプロバイダを定義するためのAuth::providerを使ってください。カスタムプロバイダを定義したら、新しいauth.php設定ファイルのproviders配列の中でそれを設定してください。

カスタム認証プロバイダについての詳細は、認証の完全なドキュメントで調べてください。

リダイレクト

Illuminate\Foundation\Auth\AuthenticatesUsersからloginPath()メソッドが削除されました。そのため、AuthController$loginPath変数を設定しておく必要が無くなりました。デフォルトで、認証エラーがあった場合、トレイトがデフォルトで以前の場所へ毎回リダイレクトします。

認証

Illuminate\Auth\Access\UnauthorizedExceptionIlluminate\Auth\Access\AuthorizationExceptionへリネームされました。この例外を自分で補足していない限り、アプリケーションに影響は通常ありません。

コレクション

Eloquentベースコレクション

Eloquentコレクションインスタンスのpluckkeyszipcollapseflattenflipメソッドは、ベースコレクション(Illuminate\Support\Collection)を返すようになりました。

キーの保存

slicechunkreverseメソッドは、コレクションにキーを残すようになりました。これらのメソッドでキーを保存したくない場合は、Collectionインスタンスのvaluesメソッドを使ってください。

Composerクラス

Illuminate\Foundation\ComposerクラスはIlluminate\Support\Composerクラスへ移動しました。このクラスを直接使っていない限り、アプリケーションに通常影響しないでしょう。

コマンドバスとハンドラ

自己処理コマンドバス

ジョブやコマンドのSelfHandling契約を実装する必要は、もうありません。全ジョブは現在デフォルトで、自己処理型になりました。そのためクラスから、このインターフェイスは取り除いてください。

コマンドバスとハンドラの分離

Laravel5.2コマンドバスは自己処理コマンドのみのサポートとなったため、コマンドとハンドラーの分離はもうサポートされません。

続けてコマンドとハンドラを分けて使いたい場合は、後方コンパチブルをサポートしているLaravel Collectiveパッケージをインストールしてください。(https://github.com/LaravelCollective/bus

設定

環境値

app.php設定ファイルのenvオプションにデフォルト値が追加され、以下のようになりました。

'env' => env('APP_ENV', 'production'),

キャッシュとenv

config:cacheコマンドを開発中に使っている場合、設定ファイル中からのみenv関数を呼び出しており、アプリケーションの他の場所では使用していないことを確実に確かめるべきです。

アプリケーション内部でenvを呼び出しているなら、envの呼び出しをconfigへ変換できるように、設定ファイルには実際の設定値を追加し、代わりにその場所からenvを呼び出す方法を強く推奨します。

コンパイル済みクラス

config/compile.phpの中のfiles配列に、以下の2行があれば削除してください。

realpath(__DIR__.'/../app/Providers/BusServiceProvider.php'),
realpath(__DIR__.'/../app/Providers/ConfigServiceProvider.php'),

上記のサービスプロバイダーが存在していないと、php artisan optimizeを実行時にエラーがでます。

CSRFバリデーション

CSRFバリデーションはユニットテスト時に自動的に実行されなくなりました。アプリケーションには影響はないでしょう。

データベース

MySQLの日付

MySQL5.7以降では、strictモードがデフォルトで有効になったため、0000-00-00 00:00:00が有効な日付として取り扱われなくなりました。全タイムスタンプカラムは、データベースにレコードを挿入する時に、有効なデフォルト値を指定する必要があります。現時点のタイムスタンプをタイムスタンプカラムのデフォルト値にするため、マイグレーションでuseCurrentメソッドを使うか、null値を許可するためにnullableメソッドを指定してください。

$table->timestamp('foo')->nullable();

$table->timestamp('foo')->useCurrent();

$table->nullableTimestamps();

MySQL JSONカラムタイプ

jsonカラムはMySQLドライバにより、実際のJSONカラムが生成されるようになりました。MySQL5.7位上を使用していない場合、このカラムタイプは使用できません。代わりにtextカラムをマイグレーションで使用してください。

シーディング

データベースシーディング(初期値設定)を実行時、全Eloquentモデルは保護されなく(unguard)なりました。以前はModel::unguard()の呼び出しが必要でした。シーディング中にモデルの保護が必要であれば、DatabaseSeederクラスのトップでModel::reguard()を呼び出してください。

Eloquent

日付キャスト

モデルやモデルのコレクションでtoArrayを呼び出した時に、$castsプロパティにdatedatetimeとして追加した属性が、文字列に変換されるようになりました。これにより、日付キャスト変換が$dates配列で指定された日付と一貫性が取れるようになりました。

グローバルスコープ

グローバルスコープの実装が、とても使いやすくなるように実装しなおしました。グローバルスコープにはremoveメソッドは必要なくなりました。そのため、既に書かれたグローバルスコープから削除してください。

裏で動作しているクエリビルダインスタンスへアクセスするため、EloquentクエリビルダのgetQueryを呼び出しているなら、toBaseを呼び出すようにしてください。

何らかの理由により、removeメソッドを直接呼び出している場合、代わりに$eloquentBuilder->withoutGlobalScope($scope)のように呼び出してください。

新しくwithoutGlobalScopewithoutGlobalScopesメソッドをEloquentクエリビルダへ追加しました。$model->removeGlobalScopes($builder)の呼び出しは、$builder->withoutGlobalScopes()へ変更してください。

主キー

デフォルトでEloquentは主キーが整数と仮定しており、整数へ自動的にキャストしています。整数ではない主キーを使用している場合、Eloquentモデルの$incrementingプロパティをオーバーライドし、falseにしてください。

/**
 * IDが自動増分
 *
 * @var bool
 */
public $incrementing = true;

イベント

コアイベントオブジェクト

Laravelが発行するコアイベントのいくつかが、文字列と動的パラメータの代わりに、イベントオブジェクトを使うようになりました。以下のリストは、旧イベント名とオブジェクトベースの対応するイベントクラスです。

旧イベント名 新イベントクラス
artisan.start Illuminate\Console\Events\ArtisanStarting
auth.attempting Illuminate\Auth\Events\Attempting
auth.login Illuminate\Auth\Events\Login
auth.logout Illuminate\Auth\Events\Logout
cache.missed Illuminate\Cache\Events\CacheMissed
cache.hit Illuminate\Cache\Events\CacheHit
cache.write Illuminate\Cache\Events\KeyWritten
cache.delete Illuminate\Cache\Events\KeyForgotten
connection.{name}.beginTransaction Illuminate\Database\Events\TransactionBeginning
connection.{name}.committed Illuminate\Database\Events\TransactionCommitted
connection.{name}.rollingBack Illuminate\Database\Events\TransactionRolledBack
illuminate.query Illuminate\Database\Events\QueryExecuted
illuminate.queue.before Illuminate\Queue\Events\JobProcessing
illuminate.queue.after Illuminate\Queue\Events\JobProcessed
illuminate.queue.failed Illuminate\Queue\Events\JobFailed
illuminate.queue.stopping Illuminate\Queue\Events\WorkerStopping
mailer.sending Illuminate\Mail\Events\MessageSending
router.matched Illuminate\Routing\Events\RouteMatched

各イベントオブジェクトはLaravel5.1のイベントハンドラへ渡されていたものと、完全に同じパラメータを含んでいます。たとえば、5.1.*のDB::listenを使用していたなら、5.2では次のように更新します。

DB::listen(function ($event) {
    dump($event->sql);
    dump($event->bindings);
});

新しいオブジェクトクラスを調べ、publicプロパティを確認してください。

例外ハンドラ

App\Exceptions\Handlerクラスの$dontReportプロパティは以下の例外タイプの最低1つを含むように更新してください。

use Illuminate\Validation\ValidationException;
use Illuminate\Auth\Access\AuthorizationException;
use Illuminate\Database\Eloquent\ModelNotFoundException;
use Symfony\Component\HttpKernel\Exception\HttpException;

/**
 * レポートしたくない例外のリスト
 *
 * @var array
 */
protected $dontReport = [
    AuthorizationException::class,
    HttpException::class,
    ModelNotFoundException::class,
    ValidationException::class,
];

ヘルパ関数

url()ヘルパ関数が、引数のパスの指定がない場合にIlluminate\Routing\UrlGeneratorを返すようになりました。

暗黙のモデル結合

Laravel5.2は「暗黙のモデル結合」を導入しました。URIに現れる識別子を元にルートとコントローラへモデルインスタンスを自動的に依存注入する新しい機能です。しかし、これによりモデルインスタンスをタイプヒントしたルートとコントローラの振る舞いがかわりました。

ルートやコントローラでモデルインスタンスをタイプヒントし、空のモデルインスタンスが注入されることを期待している場合、タイプヒントを削除し、ルートかコントローラ内で直接空のモデルを生成してください。そうしなければ、LaravelはルートURIにあるIDを元にデータベースから既存のモデルインスタンスを取得しようとします。

IronMQ

IronMQキュードライバーはそれ自身のパッケージから削除されたため、コアフレームワークには含まれなくなりました。

ジョブ/キュー

php artisan make:jobコマンドは、デフォルトで「キュー投入(queued)」ジョブクラスを定義するようになりました。「同期(sync)」ジョブを生成したい場合は、コマンド実行時に--syncオプションを付けてください。

メール

pretendメール設定オプションは削除されました。代わりにlogメールドライバを使ってください。pretendと同じ機能で、メールメッセージについてより情報がログされます。

ペジネーション

フレームワークが生成する他のURLとの一貫性を保つため、ペジネーションURLは最後のスラッシュを含まないようになりました。これがアプリケーションに影響を与えることはないでしょう。

サービスプロバイダ

app.php設定ファイルのサービスプロバイダリストから、Illuminate\Foundation\Providers\ArtisanServiceProviderを削除してください。

app.php設定ファイルのサービスプロバイダリストから、Illuminate\Routing\ControllerServiceProviderを削除してください。

セッション

認証システムの変更により、Laravel5.2へアップグレードした時点で、既存のセッションは無効になります。

データベースセッションドライバ

ユーザID、IPアドレス、ユーザエージェントのような情報をより含む、新しいdatabaseセッションドライバが書かれました。古いドライバーを使い続けたい場合は、session.php設定ファイルへlegacy-databaseドライバを指定してください。

新しいドライバーを使用する場合、セッションのデータベーステーブルへ、user_id (NULL値を許す整数)ip_address (NULL値を許す整数)user_agent (テキスト)カラムを追加してください。

Stringy

"Stringy"ライブラリはフレームワーク含まれなくなりました。アプリケーションで使用したい場合は、Composerを使いインストールしてください。

バリデーション

例外タイプ

ValidatesRequestsトレイトはIlluminate\Http\Exception\HttpResponseExceptionインスタンスの代わりに、Illuminate\Foundation\Validation\ValidationExceptionインスタンスを投げるようになりました。自分でこの例外を補足していなければ、アプリケーションに影響はないでしょう。

非推奨

以下の機能は5.2で非推奨になり、2016年6月の5.3のリリースで削除されます。

5.1.11へのアップグレード

Laravel5.1.11は認可ポリシーをサポートします。既存のLaravel5.1アプリケーションへこれらの新しい機能を組み込むのも簡単です。

注目: これらのアップグレードは任意です。行わなくてもアプリケーションの実行に影響は与えません。

ポリシーディレクトリの作成

まずアプリケーションへ空のapp/Policiesディレクトリを作成してください。

AuthServiceProviderとGateファサードの作成と登録

app/ProvidersディレクトリにAuthServiceProviderを作成します。 GitHubからデフォルトプロバイダの内容をコピーしてください。もしアプリケーションでカスタム名前空間を使用している場合はプロバイダの名前空間を変更してください。プロバイダを作成したら、app.php設定ファイルのproviders配列へ確実に登録してください。

さらに、Gateファサードをapp.phpファイルのaliases配列へ登録する必要もあります。

'Gate' => Illuminate\Support\Facades\Gate::class,

Userモデルの更新

手順の2つ目は、App\UserモデルへIlluminate\Foundation\Auth\Access\Authorizableトレイトのuseと、Illuminate\Contracts\Auth\Access\Authorizable契約を追加します。

<?php

namespace App;

use Illuminate\Auth\Authenticatable;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Auth\Passwords\CanResetPassword;
use Illuminate\Foundation\Auth\Access\Authorizable;
use Illuminate\Contracts\Auth\Authenticatable as AuthenticatableContract;
use Illuminate\Contracts\Auth\Access\Authorizable as AuthorizableContract;
use Illuminate\Contracts\Auth\CanResetPassword as CanResetPasswordContract;

class User extends Model implements AuthenticatableContract,
                                    AuthorizableContract,
                                    CanResetPasswordContract
{
    use Authenticatable, Authorizable, CanResetPassword;
}

ベースコントローラーの更新

続いて、App\Http\Controllers\ControllerベースコントローラーでIlluminate\Foundation\Auth\Access\AuthorizesRequestsトレイトをuseするように更新します。

<?php

namespace App\Http\Controllers;

use Illuminate\Foundation\Bus\DispatchesJobs;
use Illuminate\Routing\Controller as BaseController;
use Illuminate\Foundation\Validation\ValidatesRequests;
use Illuminate\Foundation\Auth\Access\AuthorizesRequests;

abstract class Controller extends BaseController
{
    use AuthorizesRequests, DispatchesJobs, ValidatesRequests;
}

5.1.0へのアップグレード

アップデートにかかる時間の見積もり:1時間以下

bootstrap/autoload.phpの更新

bootstrap/autoload.phpの中の$compiledPath変数を次のように変更してください。

$compiledPath = __DIR__.'/cache/compiled.php';

bootstrap/cacheディレクトリ作成

bootstrapディレクトリの中に、cacheディレクトリ(bootstrap/cache)を作成してください。.gitignoreファイルをこのディレクトリに以下の内容で作成してください。

*
!.gitignore

compiled.phproutes.phpconfig.phpservices.jsonなど一時的な最適化のためのファイルをフレームワークが保存するために使用します。

BroadcastServiceProviderプロバイダ追加

config/app.php設定ファイルのproviders配列にIlluminate\Broadcasting\BroadcastServiceProviderを追加します。

認証

AuthenticatesAndRegistersUsersトレイトを使用しているAuthControllerを使用している場合は、新しいユーザのバリデーションと生成方法に多少変更が必要です。

最初に、GuardRegistrarをベースのコンストラクターに渡す必要は無くなりました。コントローラーのコンストラクターから、これらの依存指定を削除できます。

次に、Laravel5.0で使用していたApp/Services/Registrarクラスは必要ありません。このクラスからvalidatorcreateメソッドをそのままAuthControllerにコピー&ペーストしてください。これ以上の変更は必要ありませんが、AuthControllerの最初でValidatorファサードとUserモデルをインポートする必要はあるでしょう。

Passwordコントローラー

Laravelに含まれているPasswordControllerは、依存をコンストラクターで要求する必要が無くなりました。5.0以下で必要であった依存は両方共取り除いてください。

バリデーション

もしベースコントローラクラスのformatValidationErrorsメソッドをオーバーライドしているなら、Illuminate\Validation\Validator具象クラスの代わりにIlluminate\Contracts\Validation\Validator契約をタイプヒントで指定する必要があります。

同様に、ベースコントローラークラスのformatErrorsメソッドをオーバーライドしているなら、Illuminate\Validation\Validator具象クラスの代わりにIlluminate\Contracts\Validation\Validator契約をタイプヒントで指定する必要があります。

マイグレーション

SQLiteデータベースのカラム名を変更したり、カラムをドロップするマイグレーションが存在する場合、composer.jsonファイルにdoctrine/dbal依存パッケージを追加し、このライブラリをインストールするために、端末でcomposer updateコマンドを実行する必要があります。

Eloquent

createメソッド

Eloquentのcreateメソッドが引数無しで呼び出せるようになりました。もしモデルのcreateメソッドをオーバーライドしている場合は、$attributes引数にデフォルト値として配列を指定してください。

public static function create(array $attributes = [])
{
    // カスタム実装…
}

findメソッド

モデルでfindメソッドをオーバーライドし、そのカスタムメソッド中でparent::find()を呼んでいるなら、Eloquentクエリビルダのfindメソッドを呼び出すように変更してください。

public static function find($id, $columns = ['*'])
{
    $model = static::query()->find($id, $columns);

    // ...

    return $model;
}

listsメソッド

Eloquentのクエリ―のlistsメソッドは通常の配列の代わりに「コレクション」インスタンスを返すようになりました。コレクションを通常の配列に変換したい場合は、allメソッドを使用してください。

User::lists('id')->all();

クエリビルダのlistsはそのまま配列を返すことに注意してください。

日付のフォーマット

これまでは保存されるEloquentの日付フィールドのフォーマットは、モデルのgetDateFormatメソッドをオーバーライドすることで変更できました。これはまだ有効ですが、メソッドをオーバーライドする代わりに、モデルインスタンスの$dateFormatプロパティーを指定するほうが簡単で便利でしょう。

日付フォーマットはモデルを配列やJSONにシリアライズするときにも適用されるようになりました。Laravelを5.0から5.1へアップグレードすると、JSONシリアライズされたデータフィールドのフォーマットは変わってしまいます。シリアライズされるモデルへ日付フォーマットを指定するには、モデルのserializeDate(DateTime $date)メソッドをオーバーライドしてください。このメソッドにより、保存されるフォーマットを変更せずに、シリアライズされるEloquentの日付フィールドのフォーマットを柔軟にコントロールできます。

コレクションクラス

sortメソッド

sortメソッドは既存のコレクションを変更する代わりに、新しいコレクションインスタンスを返すようになりました。

$collection = $collection->sort($callback);

sortByメソッド

sortByメソッドは既存のコレクションを更新する代わりに、新しいコレクションインスタンスを返すようになりました。

$collection = $collection->sortBy('name');

groupByメソッド

groupBeメソッドは親のCollectionの中の各アイテムごとにCollectionを返すようになりました。全アイテムをプレーンな配列に戻したい場合は、mapを適用してください。

$collection->groupBy('type')->map(function($item)
{
    return $item->all();
});

listsメソッド

listsメソッドは通常の配列の代わりに「コレクション」インスタンスを返すようになりました。コレクションを通常の配列に変換したい場合は、allメソッドを使用してください。

$collection->lists('id')->all();

コマンドとハンドラ

app/Commandsディレクトリはapp/Jobsへ名前が変更されました。しかし、コマンドを全部新しい場所へ移動する必要はありませんし、make:commandhandler:command Artisanコマンドも続けて使用できます。

同様に、app/Handlersディレクトリはapp/Listenersに名前が変更され、イベントリスナだけが含まれるようになりました。しかし、既に存在するコマンドとイベントハンドラを移動したり、名前を変えたりする必要はありません。handler:eventコマンドもイベントハンドラを生成するために続けて使用できます。

Laravel5.0フォルダー構造との後方互換性を提供しているので、アプリケーションをLaravel5.1へアップグレードし、都合の良い時にイベントとコマンドを新しい場所へゆっくりアップグレードしてください。

Blade

BladeコンパイラーからcreateMatchercreateOpenMatchercreatePlainMatcherメソッドが削除されました。Laravel5.1のBladeでは新しいdirectiveメソッドでカスタムディレクティブを作成してください。Bladeの拡張のドキュメントで詳細を確認してください。

テスト

tests/TestCase.phpファイルにprotectedの$baseUrlプロパティーを追加してください。

protected $baseUrl = 'http://localhost';

言語ファイル

ベンダーパッケージの公開言語ファイルのデフォルトディレクトリが変更になりました。ベンダーパッケージ言語ファイルはresources/lang/パッケージ/{ローカル}/{名前空間}からresources/lang/ベンダー/{名前空間}/{ローカル}へ移動してください。たとえばAcme/Anvilパッケージのacme/anvil::foo名前空間、英語の言語ファイルはresources/lang/packages/en/acme/anvil/foo.phpからresources/lang/vendor/acme/anvil/en/foo.phpへ移動します。

Amazon WebサービスSDK

AWS SQSキュードライバかAWS SES メールドライバを使っている場合は、インストール済みのAWS PHP SDKをバージョン3.0へアップデートする必要があります。

Amazon S3ファイルシステムドライバを使用している場合は、コンポーザにより対応するファイルシステムパッケージを更新する必要があります。

非推奨

以下のLaravelの機能は非推奨になり、2015年12月にリリースされるLaravel 5.2で完全に削除されます。

  • より好ましいミドルウェアにより、ルートフィルターは非推奨となりました。
  • Illuminate\Contracts\Routing\Middleware契約は非推奨になりました。ミドルウェアには契約が必要ありません。さらに、TerminableMiddleware契約も非推奨になりました。インターフェイスの代わりに、ミドルウェアでterminateメソッドをシンプルに定義するだけです。
  • より好ましいIlluminate\Contracts\Queue\ShouldQueueにより、Illuminate\Contracts\Queue\ShouldBeQueued契約は非推奨となりました。
  • Iron.ioの「Pushキュー」は非推奨となり、通常のIron.ioキューとqueue listenersの使用が推奨されます。
  • Illuminate\Foundation\Bus\DispatchesCommandsトレイトは非推奨となりました。リネームされたIlluminate\Foundation\Bus\DispatchesJobsを使用してください。
  • Illuminate\Container\BindingResolutionExceptionは非推奨となり、代わりにIlluminate\Contracts\Container\BindingResolutionExceptionとなります。
  • サービスコンテナのbindSharedメソッドは非推奨となり、より好ましいsingletonメソッドが推奨されます。
  • Eloquentとクエリビルダのpluckメソッドは非推奨となり、valueへリネームされました。
  • コレクションのfetchメソッドは非推奨となり、pluckメソッドが推奨されます。
  • array_fetchヘルパは非推奨となり、より好ましいarray_pluckメソッドが推奨されます。

5.0.16へのアップグレード

bootstrap/autoload.phpファイル中の$compiledPath変数を変更してください。

$compiledPath = __DIR__.'/../vendor/compiled.php';

サービスプロバイダ

app.php設定ファイルのサービスプロバイダリストから、App\Providers\BusServiceProviderを削除してください。

app.php設定ファイルのサービスプロバイダリストから、App\Providers\ConfigServiceProviderを削除してください。

4.2から5.0へのアップグレード

新しくインストール、その後で移行

推奨するアップグレード方法は、新しくLaravel5.0をインストールし、それから4.2サイト独自のファイルを新しくインストールした環境へコピーすることです。コピーするファイルにはコントローラー、ルート、Eloquentモデル、Artisanコマンド、アセット、その他あなたのアプリケーション限定のコードを含みます。

まずローカル環境の新しいディレクトリへLaravel5.0アプリケーションをインストールしてください。5.0よりも新しいバージョンはインストールしないでください。最初に5.0へのマイグレーションを完了させる必要があります。各手順の詳細は、以降で紹介します。

Composerの依存とパッケージ

追加しているComposerの依存パッケージを5.0アプリケーションへコピーするのを忘れないでください。SDKのような、サードパーティのコードも忘れずに。

リリース後しばらく、Laravel限定のパッケージはLaravel5と互換性がないかも知れません。Laravel5向きの対応バージョンが用意されるか、メンテナーに確認しましょう。Composerの依存パッケージをアプリケーションに追加したら、composer updataを実行する必要があります。

名前空間

Laravel4のデフォルトでは、アプリケーションのコードに名前空間は使用されていません。そのため、例えば、全Eloquentモデルとコントローラーは、ただ「グローバル」な名前空間下に置かれています。手早く移行するには、Laravel5でも同様にグローバル名前空間下へ、それらのクラスを設置しましょう。

設定

環境変数の移行

新しい.env.exampleファイルを.envへコピーします。古いバージョンの.env.phpファイルに該当します。APP_ENVAPP_KEY(暗号化キー)、データベース接続情報、キャッシュやセッションのドライバのような値を適切に設置してください。

さらに、古い.env.phpファイル中で変更した値を.env(ローカル環境で本当に使用される値)と.env.example(他のチームメンバーに参考にしてもらう値)にコピーします。

環境設定の詳細は、ドキュメントを読んでください。

注意: Laravel5アプリケーションを本番サーバーへデプロイする前に、適切な値を設置した.envファイルを用意しておく必要があります。

設定ファイル

Laravel5.0では、特定の環境のために設定ファイルを指定する、app/config/{環境名}/ディレクトリ構造はもう使われません。代わりに、各環境に用意する.envへ設定値を移動します。それから、設定ファイル中でenv('キー', 'デフォルト値')を使用して、値にアクセスします。config/database.php設定ファイルに設定例があります。

configディレクトリ下の設定ファイルには、全環境に渡り変更しない値を直接設置するか、環境ごとに変化する値をロードするためenv()を使うか、どちらかで設定値を指定します。

.envファイルにキーを追加したら、同様に参考値を.env.exampleファイルへ追加するのを忘れないでください。これにより、あなたのチームメンバーが自分の.envファイルを作成しやすくなります。

ルート

古いroutes.phpを新しいapp/Http/routes.phpへ、コピー&貼付けしてください。

コントローラー

次に、全コントローラーをapp/Http/Controllersディレクトリへ移動します。このガイドでは名前空間を利用した以降を行わないため、composer.jsonファイルのclassmapディレクティブへ、app/Http/Controllersを追加してください。次に、app/Http/Controllers/Controller.php抽象ベースクラスから、名前空間を削除します。移行するコントローラーはこのベースクラスを拡張していることを確認してください。

app/Providers/RouteServiceProvider.phpファイルの中で、namespaceプロパティをnullに設定してください。

ルートフィルター

フィルターの定義をapp/filters.phpから、app/Providers/RouteServiceProvider.phpboot()メソッドの中へコピーします。app/Providers/RouteServiceProvider.phpuse Illuminate\Support\Facades\Route;の1行を追加し、Routeファサードを使い続けられるようにします。

authcsrfのような、Laravel4デフォルトフィルターは移動しないでください。ミドルウェアとしてLaravel5に用意されています。ルートやコントローラーで、古いデフォルトフィルターの使用箇所(例えば、['before' => 'auth'])を新しいミドルウェアを使用するように書き換えてください。(例えば、['middleware' => 'auth']

フィルターはLaravel5でも廃止されていません。カスタムフィルターを定義して、beforeafterを使用し指定できます。

グローバルCSRF

デフォルトで、CSRF保護が、全ルートで有効になりました。これを無効にするか、特定のルートだけに手動で有効にしたいのでしたら、以下の行をApp\Http\Kernelファイル中のmiddleware配列から削除してください。

'App\Http\Middleware\VerifyCsrfToken',

続いて、次の1行を$routeMiddlewareに追加します。

'csrf' => 'App\Http\Middleware\VerifyCsrfToken',

これで、個別のルート/コントローラーに対し、['middleware' => 'csrf']を指定することで、ミドルウェアを追加できるようになります。ミドルウェアの詳細は、ドキュメントを参照してください。

Eloquentモデル

Eloquentモデルを設置するために、app/Modelsディレクトリを作成することもできます。その場合、このディレクトリをcomposer.jsonclassmapディレクティブへ追加してください。

SoftDeletingTraitを使用しているモデルでは、Illuminate\Database\Eloquent\SoftDeletesを使うように変更します。

Eloquentキャッシュ

Eloquentは、クエリ結果をキャッシュするためのrememberメソッドを提供しなくなりました。Cache::remember機能を使用し、手動でクエリをキャッシュする必要があります。キャッシュの詳細は、ドキュメントに全て記載されています。

User認証モデル

UserモデルをLaravel5の認証システム向けにアップグレードするには、以下の指示に従ってください。

useブロックから、以下の行を削除する

use Illuminate\Auth\UserInterface;
use Illuminate\Auth\Reminders\RemindableInterface;

useブロックに、以下の行を追加する

use Illuminate\Auth\Authenticatable;
use Illuminate\Auth\Passwords\CanResetPassword;
use Illuminate\Contracts\Auth\Authenticatable as AuthenticatableContract;
use Illuminate\Contracts\Auth\CanResetPassword as CanResetPasswordContract;

UserInterfaceとRemindableInterfaceインターフェイスを削除する

クラスで以下のインターフェイスを実装宣言する

implements AuthenticatableContract, CanResetPasswordContract

クラスの宣言で、以下のトレイトを取り込む

use Authenticatable, CanResetPassword;

この方法を取る場合、クラスのuse宣言ブロックから、Illuminate\Auth\Reminders\RemindableTraitIlluminate\Auth\UserTraitを取り除いてください。

Cashierの変更

Artisanコマンド

古いapp/commandsディレクトリからコマンドクラスを全部、新しいapp/Console/Commandsディレクトリへ移動します。次に、composer.jsonファイルのclassmapディレクティブに、app/Console/Commandsを追加します。

Then, copy your list of Artisan commands from start/artisan.php into the commands array of the app/Console/Kernel.php file.

データベースマイグレーションと初期値設定

データベースにusersテーブルが既に存在しているでしょうから、Laravel5.0に含まれている2つのマイグレーションを削除します。

app/database/migrationsディレクトリのマイグレートクラスを、新しいdatabase/migrationsへ移動します。初期値設定(seed)クラスをapp/database/seedsから、database/seedsへ移動します。

グローバルIoC結合

start/global.phpの中のIoC結合は全て、app/Providers/AppServiceProvider.phpファイルのregisterメソッドへ移動します。Appファサードをインポートする必要があります。

そうした結合定義をカテゴリー毎に別々のサービスプロバイダへ分割する選択肢もあります。

ビュー

app/views中のビューを新しいresources/viewsディレクトリへ移動します。

Bladeタグ変更

デフォルトでもセキュリティーを強化するために、Laravel5.0では{{ }}{{{ }}}の両Blade記法で出力がエスケープされます。新しい{!! !!}記法により、出力をエスケープせずにそのまま表示します。アプリケーションをアップデートする場合の一番安全な選択肢は、明らかにそのまま出力をしても安全なところでだけで、新しい{!! !!}記法を使うことでしょう。

しかし、古いBlade記法を使わなくてはならないのでしたら、AppServiceProvider@registerの最後に、以下の数行を追加してください。

\Blade::setRawTags('{{', '}}');
\Blade::setContentTags('{{{', '}}}');
\Blade::setEscapedContentTags('{{{', '}}}');

これは気軽に行うべきではありません。XSS攻撃に対しアプリケーションを脆弱にしてしまうかもしれません。また、{{--を使用したコメントは廃止されました。

言語ファイル

app/lang下の言語ファイルは、新しいresources/langディレクトリへ移動します。

Publicディレクトリ

4.2アプリケーションのpublicディレクトリから、公開しているアセットを新しいアプリケーションのpublicディレクトリへコピーします。5.0バージョンのindex.phpは変更しないように気をつけてください。

テスト

app/testsからテストを、新しいtestsディレクトリへ移動します。

その他のファイル

プロジェクトの他のファイルをコピーしましょう。例えば、.scrutinizer.ymlbower.json、その他の似たようなツールの設定ファイルなどです。

SassやLess、CoffeeScriptをお好きな場所へ移動しましょう。resources/assetsディレクトリがデフォルトの場所として最適でしょう。

FormとHTMLヘルパ

FormかHTMLヘルパを使用している場合、class 'Form' not foundclass 'Html' not foundのエラーになります。FormとHTMLヘルパはLaravel5.0には含まれなくなりました。しかし、Laravel Collectiveによりメンテナンスされているコミュニティー主体の代替パッケージが存在しています。

例えば、"laravelcollective/html": "~5.0"composer.jsonrequireセクションへ追加してください。

それから、FormとHTMLファサードとサービスプロバイダを追加する必要があります。config/app.phpを編集し、providers配列に以下の行を追加します。

'Collective\Html\HtmlServiceProvider',

次に、aliases配列へ以下を追加します。

'Form' => 'Collective\Html\FormFacade',
'Html' => 'Collective\Html\HtmlFacade',

キャッシュマネージャー

Laravelのキャッシュでファサードを使用せず、Illuminate\Cache\CacheManagerをコードで注入している場合、代わりにIlluminate\Contracts\Cache\Repositoryを注入してください。

ペジネーション

$paginator->links()の呼び出しを$paginator->render()へ変更してください。

$paginator->getFrom()$paginator->getTo()の呼び出しをそれぞれ$paginator->firstItem()$paginator->lastItem()へ置き換えてください。

$paginator->getPerPage()$paginator->getCurrentPage()$paginator->getLastPage()$paginator->getTotal()の呼び出しから、"get"プレフィックスを取り除いてください。(例:$paginator->perPage()

Beanstalkキュー

Laravel5.0では、"pda/pheanstalk": "~2.1"の代わりに、"pda/pheanstalk": "~3.0"が必要になります。

Remote

Remoteコンポーネントは廃止されました。

Workbench

Workbenchコンポーネントは廃止されました。

4.1から4.2へのアップグレード

PHP 5.4+

Laravel4.2を動作させるにはPHP 5.4.0以上が必要です。

暗号化のデフォルト

app/config/app.php設定ファイルに、新しいcipherオプションが追加されました。このオプションの値は、MCRYPT_RIJNDAEL_256にすべきでしょう。

'cipher' => MCRYPT_RIJNDAEL_256

この設定は、Laravelの暗号機能により使用される、デフォルトcipherをコントロールするために使用されます。

注意: Laravel4.2では、最も安全な暗号化であると考えられる、MCRYPT_RIJNDAEL_128 (AES)がデフォルトの暗号化です。cipherをMCRYPT_RIJNDAEL_256へ戻すことが必要になるのは、Laravel4.1以前のバージョンで暗号化されたクッキー/値を解読する場合です。

ソフトデリートは、トレイトを使用するようになりました

モデルのソフトデリートを使用している場合、softDeletesプロパティーは必要なくなりました。SoftDeletingTraitを次のように使用してください。

use Illuminate\Database\Eloquent\SoftDeletingTrait;

class User extends Eloquent
{
    use SoftDeletingTrait;
}

それから、datesプロパティーにdeleted_atカラムを追記してください。

class User extends Eloquent
{
    use SoftDeletingTrait;

    protected $dates = ['deleted_at'];
}

ソフトデリート操作のAPIは、今までと変わりありません。

注意: SoftDeletingTraitは、ベースモデルで使用してはいけません。実際のモデルクラスで使用します。

View/PaginationのEnvironmentクラスの名前変更

もし、Illuminate\View\Environmentクラスか、Illuminate\Pagination\Environmentクラスを直接参照している場合、Illuminate\View\FactoryIlluminate\Pagination\Factoryを代わりに参照するように、コードを変更してください。この2つのクラスは、機能をより良く表すように名前が変更されました。

ペジネーションプレゼンテーターの引数追加

Illuminate\Pagination\Presenterクラスを拡張している場合、getPageLinkWrapper抽象メソッドに、rel引数を追加するように変更してください。

abstract public function getPageLinkWrapper($url, $page, $rel = null);

Iron.Ioキューの暗号化

Iron.ioキュードライバを使用している場合、新しいencryptオプションをキュー設定ファイルに追加する必要があります。

'encrypt' => true

4.1.x以下から4.1.29へのアップグレード

Laravel4.1.29では、全データベースドライバのカラムクオーティングが向上しました。Eloquentモデルにfillableを使用していない場合の、複数代入に関する脆弱性からアプリケーションを保護します。複数代入されるのを防ぐためにモデルにfillableプロパティを使用している場合には、アプリケーションに脆弱性はありません。しかし、guardedを使用し、ユーザがコントロールできる配列を"update"や"save”タイプの機能に渡しているのでしたら、複数代入のリスクにアプリケーションがさらされているため、4.1.29へすぐアップグレードすべきでしょう。

Laravel4.1.29へアップグレードするには、composer updateを実行するだけです。このリリースには、ソース修正が必要な変更は含まれていません。

4.1.25以下から、4.1.26へのアップグレード

Laravel 4.1.26では、"Remember me"クッキーへのセキュリティーが強化されました。このアップデート以前は、Remeberクッキーが悪意のあるユーザによりハイジャックされ、本当のユーザがアカウントのパスワードをリセットしたり、ログアウトしたりしても、クッキーが長期に渡り有効なままにされてしまいました。

今回の変更により、usersテーブル(もしくはユーザ管理を行うためのテーブル)へ、新しいremember_tokenカラムを追加する必要があります。この変更により、ユーザがアプリケーションにログインするたびに、真新しいトークンが割り当てられます。このトークンはユーザがアプリケーションからログアウトするたびに、再生成されます。この実装により、もしも"Remember me"クッキがーハイジャックされても、アプリケーションからログアウトすれば、そのクッキーは無効になります。

アップデート法

最初に、新しいremember_token(null値可能なVARCHAR(100)かTEXTなど)カラムをusersテーブルに追加してください。

次に、Eloquent認証ドライバを使用しているのであれば、Userクラスへ以下の3クラスを追加してください。

public function getRememberToken()
{
    return $this->remember_token;
}

public function setRememberToken($value)
{
    $this->remember_token = $value;
}

public function getRememberTokenName()
{
    return 'remember_token';
}

注意: この変更により、現在使用中の"Remember me"セッションは無効となるため、全ユーザはアプリケーションへの再認証を強制されます。

パッケージメンテナーの方へ

Illuminate\Auth\UserProviderInterfaceへ、新しいメソッドが2つ追加されました。実装のサンプルは、デフォルトドライバをご覧ください。

public function retrieveByToken($identifier, $token);

public function updateRememberToken(UserInterface $user, $token);

Illuminate\Auth\UserInterfaceにも、「アップデート法」で説明している、新しい3つのメソッドが追加されました。

4.0から4.1へアップグレード

コンポーザ依存パッケージのアップグレード

アプリケーションをLaravel4.1へアップグレードするには、composer.jsonファイルの中のlaravel/frameworkのバージョンを4.1に変更します。

ファイルの置き換え

public/index.phpファイルをリポジトリーのこのファイルで置き換えてください。

artisanファイルをリポジトリーのこのファイルで置き換えてください。

設定ファイルとオプションの追加

app/config/app.php設定ファイル中のaliasesproviders配列を更新します。変更する内容はこのファイルで確認して下さい。自分で追加したサービスプロバーダーとエイリアスを書き戻すのを忘れないで下さい。

新規にapp/config/remote.phpファイルをこのリポジトリーから取得し、追加して下さい。

app/config/session.phpファイルへ新しいexpire_on_close設定オプションを追加して下さい。デフォルト値はfalseです。

app/config/queue.phpファイルへ新しいfailed設定セクションを追加して下さい。セクションのデフォルト値は以下の通りです。

'failed' => [
    'database' => 'mysql', 'table' => 'failed_jobs',
],

(オプション):app/config/view.phpファイル中のpagination設定オプションをpagination::slider-3に変更することもできます。

コントローラーの更新

もし、app/controllers/BaseController.phpが頭のところでuse文を使用していたら、use Illuminate\Routing\Controllers\Controller;use Illuminate\Routing\Controller;へ変更して下さい。

パスワードリマインダーの更新

パスワードリマインダーは自由度を増すために全体的に見なおされました。php artisan auth:reminders-controller Artisanコマンドを実行し、作成される新しいスタブコントローラーを調べてみて下さい。もしくは、更新されたドキュメントを読み、それに従ってアプリケーションを更新して下さい。

app/lang/en/reminders.php言語ファイルをこちらの更新済みファイルに合わせて変更して下さい。

環境決定の更新

セキュリティーの観点から、アプリケーションの環境を決定するためにURLのドメインはもう使用されなくなりました。これらの値は簡単に偽装でき、リクエストの環境を変更する攻撃が可能です。コンピューターのホスト名を利用するように、環境決定コードを変更して下さい。(hostnameコマンドがMac、Linux、Windowsで使用できます。)

ログファイルの単純化

今回よりLaravelは、app/storage/logs/laravel.logファイルのみを作成、使用するようになりました。しかし、この動作はapp/start/global.phpファイルで設定できるままになっています。

Trailing Slashリダイレクトの削除

bootstrap/start.phpファイルの中から、$app->redirectIfTrailingSlash()の呼び出しを削除して下さい。この機能はフレームワークに含まれている.htaccessファイルで処理されるようになったため、メソッドは必要なくなりました。

次に、Apacheの.htaccessファイルを最後のスラッシュを処理する新バージョンへ置き換えて下さい。

現在のルートへのアクセス

現在のルートへアクセスするには、Route::getCurrentRoute()の代わりに、Route::current()が使えるようになりました。

Composerの更新

以上の変更を行ったら、アプリケーションのコアファイルを更新するために、composer updateを実行して下さい!クラスのロードエラーになった場合は、updateコマンドを--no-scriptsオプションを付け、実行してみてください。ですから、composer update --no-scriptsと実行します。

ワイルドカードイベントリスナ

ワイルドカードイベントリスナは、ハンドラ関数の引数にイベントを渡さなくなりました。発行されたイベントを見つける必要がある場合は、Event::firing()を使用してください。

ドキュメント章別ページ

ヘッダー項目移動

注目:アイコン:ページ内リンク設置(リンクがないヘッダーへの移動では、リンクがある以前のヘッダーのハッシュをURLへ付加します。

移動

クリックで即時移動します。

バージョン

設定

適用ボタンクリック後に、全項目まとめて適用されます。

カラーテーマ
和文指定 Pagination
和文指定 Scaffold
Largeスクリーン表示幅
インデント
本文フォント
コードフォント
フォント適用確認

フォントの指定フィールドから、フォーカスが外れると、当ブロックの内容に反映されます。EnglishのDisplayもPreviewしてください。

フォント設定時、表示に不具合が出た場合、当サイトのクッキーを削除してください。

バックスラッシュを含むインライン\Code\Blockの例です。

以下はコードブロックの例です。

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class User extends Model
{
    /**
     * ユーザに関連する電話レコードを取得
     */
    public function phone()
    {
        return $this->hasOne('App\Phone');
    }
}

設定を保存する前に、表示が乱れないか必ず確認してください。CSSによるフォントファミリー指定の知識がない場合は、フォントを変更しないほうが良いでしょう。

キーボード・ショートカット

オープン操作

PDC

ページ(章)移動の左オフキャンバスオープン

HA

ヘッダー移動モーダルオープン

MS

移動/設定の右オフキャンバスオープン

ヘッダー移動

T

最初のヘッダーへ移動

E

最後のヘッダーへ移動

NJ

次ヘッダー(H2〜H4)へ移動

BK

前ヘッダー(H2〜H4)へ移動

その他

?

このヘルプページ表示
閉じる