Hapicode

# Laravel 5.1 から 8.1 にバージョンアップ

仕事の関係で laravel のアップグレード作業をしましたが、簡単にできると思ったけど意外とハマったことを記録します。
laravel5.7 か 8 から使い始めたので 5.1 ってそんなに変わらないだろうと単純に思ったことが一番のミス。特に認証周りですが、laravel のデフォルト auth 機能使っていたらそんなに問題ないかもしれませんが、カスタマイズドライバーの自己流認証に出会って、いろいろ大変でした。当たり前ですが、5.1 触ったことない人間はまず 5.1 と 5.2 のドキュメントを読んで変更該当箇所のロジックを理解して修正した方がスムーズに行くはずです。

# 5.1 から 5.2

5.1 から 5.2 へのアップグレード (opens new window)

# 認証

  • config/app.php
  • config/auth.php
  • app/Providers/AuthServiceProvider.php

# 設定ファイル

  • config/auth.php
<?php

return [

    'defaults' => [
        'guard' => 'web',
        'passwords' => 'users',
    ],
    'guards' => [
        'web' => [
            'driver' => 'session',
            'provider' => 'users',
        ],
        'api' => [
            'driver' => 'token',
            'provider' => 'users',
        ],
    ],
    'providers' => [
        'users' => [
            'driver' => 'webEloquent',
            'model' => App\Models\User::class,
        ],
    ],
];

# カスタイムドライバ

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

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

app/Providers/AuthServiceProvider.php

    public function boot(GateContract $gate)
    {
        parent::registerPolicies($gate);

        $this->app['request']->server->set('HTTPS', env('APP_ENV') == 'production');
        $this->app['auth']->provider('webEloquent', function ($app) {
            return
                new webEloquentUserProvider(
                    new \Illuminate\Hashing\Hasher,
                    \Config::get('auth.providers.users.model')
                );
        });
    }

# サービスプロバイダ

app.php 設定ファイルのサービスプロバイダリストから

  • Illuminate\Foundation\Providers\ArtisanServiceProvider
  • Illuminate\Routing\ControllerServiceProvider

を削除

# 5.2 から 5.3

5.2 から 5.3.0 へのアップグレード (opens new window)

# Providers

App\Providers\EventServiceProvider.php 修正

    public function boot()
    {
        parent::boot();
    }

In RouteServiceProvider.php line 25:

Declaration of App\Providers\RouteServiceProvider::boot(Illuminate\Routing\Router $router) should be compatible with Illuminate
\Foundation\Support\Providers\RouteServiceProvider::boot()

App\Providers\RouteServiceProvider.php 修正

    public function boot()
    {
        parent::boot();
    }

In ValidatorServiceProvider.php line 19:

Declaration of App\Providers\ValidatorServiceProvider::boot(Illuminate\Routing\Router $router) should be compatible with Illuminate\Foundation\Support\Providers\RouteServiceProvider::boot()

App\Providers\ValidatorServiceProvider.php 修正

    public function boot()
    {
        // $attributes設定すると、各自のRequest Classのattributesの設定を、
        // 設定しないと、resource/lang/ja(app.localeの設定)/validation.phpのattributesの設定を見に行く。
        Validator::resolver(function($translator, $data, $rules, $messages, $attributes) {
            return new CustomValidator($translator, $data, $rules, $messages, $attributes);
        });

    }

# 配列

配列ヘルパーキーと値順序変更 💩

first last whereメソッドに渡すクロージャの、最初の引数として「値」が渡されます。

Arr::first($array, function ($value, $key) {
    return ! is_null($value);
});

# コレクション

コレクションメソッドキーと値順序変更 :hankey

first last containsコレクションメソッドでは、指定されたコールバッククロージャの 第１引数に「値」 が渡されます。

$collection->first(function ($value, $key) {
    return ! is_null($value);
});

# 設定

config/app.php設定ファイルの中に、以下の設定オプションを追加してください。

'name' => 'アプリケーション名',

# コントローラー

コンストラクターの中からセッションアクセス

Laravel5.3 では、セッションや認証済みユーザにコントローラのコンストラクタではアクセスできません。なぜなら、ミドルウェアがまだ実行されていないからです。

代わりに、クロージャベースのミドルウェアをコントローラのコンストラクタで直接で意義できます。この機能を使用する前に、アプリケーションが Laravel5.3.4 以上で実行されていることを確認してください。
代わりに、クロージャベースのミドルウェアをコントローラのコンストラクタで直接で意義できます。

    public function __construct()
    {
        $this->middleware(function ($request, $next) {
            $this->projects = Auth::user()->projects;

            return $next($request);
        });
    }

$value = $request->session()->get('key');は OK

# DB コレクション

Fluent なクエリビルダ (opens new window)が普通の配列の代わりに、Illuminate\Support\Collection インスタンスを返すようになりました。

  • AppServiceProvider の boot メソッドで、以下のように morphMap を定義する必要があります。
use Illuminate\Database\Eloquent\Relations\Relation;

Relation::morphMap([
    'user' => User::class,
]);

# 結論

php や laravel だけのアップグレードは難しいものではないが、5.1 から 5.2 へアップグレードする時のカスタマイズ認証のところが一番大変でした。グーグル先生に聞いても答えがなく、5.1 のドキュメントを繰り返して読んで、カスタマイズ認証のやり方を先ず学習してからなんとか 5.2 にアップグレードできました。そもそもこれってメジャーの変更ではないか？でも思いました。それ以降のアップグレードは sessionn あたりや array 配列ヘルパーなどの変更がありました。あと、注意点としてphp artian cache:clear php artisan config:clear php aritsan view:clear 系のキャッシュをクリアはまめにした方が無難ですね。
複数 git ブランチ切り替えて作業する場合はcomposer updateする前に vendor ディレクトリ削除と composer.lock 削除した作業効率的になります。
session が見つからないエラーは何回か出ましたが、結局php artisan key:generateで解消できました。

2020-10-12
  • php
  • laravel

関連記事

Laravel を API サーバーとしての初期設定

Laravel インストールからローカル環境のSail docker開発、初期設定までプロジェクト構...

Laravel リクエストログ出力

Laravelでリクエストログを出力する手順をまとめました。...

Carbon で php date 日付の日数・月数差を計算

Laravel Carbonは、DateTimeクラスよりもシンプルで読みやすいコードを書くことがで...

Laravel 429 Too Many Requests

Laravel 19使ってAPIサーバー構築とフロントはReact nextjsで構築しています。複...

Laravel Email バリデーションについて

Laravel Validation Email チェックする際の注意点、バリデーションルールオプシ...

Laravel Sanctum 使って API トークン JWT 認証と SPA 認証

Laravel JWT APIトークンの仕組みと Laravel Sanctum SPA認証使って認...

AWS SES メール開封確認　 DB に集計

メール送信の開封確認して DB更新するために使う AWS サービス SES SNS LAMBDA と...

Laravel logger でエラーログを chatwork に自動送信

Laravel 使ってエラー発生した場合、chatworkにエラー内容をリアルタイムで連絡するcha...

php CSV データ取得は fgetcsv 使う

PHP csvアップロードしてデータインポート作業がありましたが、fgetcsv使ってcsv処理につ...

Laravel tinker 使って DB データベース接続とコマンド

Laravel tinker REPLツール使ってDBアクセス、環境確認など対話式で楽しく遊べる...

Laravel Test についてのメモ

Laravel自動テスト行う際のコマンドと設定 faker 使ってデータ生成...

Laravel Log の基本設定＆使い方

Laravel Logの基本設定 エラー発生時にslackに連絡通知する設定方法 tailコマンド使...

Exception: Class 'ZipArchive' not found

エクセル操作でZipArchive classが見つからないエラーがあったので、対応しました。...

Laravel Sail で Docker 環境構築

Laravel Sail で Docker 開発環境PHP Mysql phpMyAdmin構築 s...

PHP 文字列長さ・文字列の幅を取得方法

PHP 文字列操作関数 マルチバイト文字列日本語韓国語中国語の長さ取得など...

Codeigniter 画像アップロードとリサイズ

Codeigniter アップロード画像リサイズと回転するなど画像操作するライブラリの使い方...

Laravel Lumen Faker 日本語設定

Laravel Faker 日本語化設定 fakerphpの使い方とよく使うオプション 名前や住所の...

laravel method の基本 get post put options

Laravel Routeでget post メソッド同時に設定したい！Laravel ルート制約の...

Laravel schedule 設定

Laravel スケジュール管理の基本とtimezone設定などlaravel 8最新メソッド説明...

Class 'Imagick' not found Error

phpで画像操作したらimagickエラーで動かなくなったため、imagickモジュールをインストを...

Laravel eloquent model の規約

最新Laravel開発eloquent model設定資料まとめ...

PHP mbconvertkana 全角半角英数カナ変換

php カナコンバートなら mb_convert_kana を使う！全角半角、英数字や記号など簡単に...

Codeigniter APPPATH BASEPATH FCPATH 各種パスと URL 取得

codeigniter host url取得方法と APPPATH BASEPATHの意味を紹介...

Laravel timestamp() auto update 有効化無効化

Laravel updated_at timestamp自動にしたい！MysqlはすぐにできるけどS...

Lumen8 で JWT ユーザー認証

Lumen8でJWT認証のAPIサーバー構築してみた、便利になった時代だなあ...

Laravel toSql パラメータ付きで出力

Laravel Query Builder toSqlで出力したsql文にパラメータを自動でセット...

Lumen8 で API 開発

codeigniter 愛用者がLumenでAPIサーバーを立ててみた...

php Exception エラーキャッチでメール送信

エラーメッセージ、エラーコード、エラー詳細取得、php例外処理exceptionのいろいろ...

Smarty HTTP URL 取得できるサーバー関数

スマーティで取得するサーバー関数URLとenvなど...

Laravel blade foreach loop と current url

laravel blade foreach loop変数とurlのプロパティ対照表...

laravel session を制する

laravel sesssion 使い方を紹介、読込保存削除を使えるようになったらsession制覇...

PHP empty isset is_null の違い

PHP empty, isset, is_nullの違い よく使うPHP isset と if の違...

PHP 8 リリース新機能と変更

php8がリリースされたので、新機能と特徴などの資料まとめました。25周年迎えたPHPは更に速いプロ...

FlattenException deprecated

laravelバージョンアップ作業する際にFlattenException deprecatedにつ...

php.ini 初期設定のいろいろ

php ini ローカル環境や新規リモート環境の初期設定...

PHP 7.4 にアップグレードして使えなくなる機能

php 5 から php7.4 にアップする作業があったので、アップグレード時のエラーと7.4では動...

開発時によく使うゼロ埋めパディング作業まとめ

mysql twig phpとjavascriptでよく使うゼロ埋めのいろいろ...

解決！phpMyAdmin テーブル構造の内容が表示されない問題

phpmyadmin5.0.1のxampp入れたら テーブル構造メニューが真っ白になって表示されない...

codeigniter email ライブラリでメール送信 日本語対応

codeigniterメール送信で日本語文字化け対策、改行コードとSMTP項目設定...

Composer コマンドとオプション

composer install updateの違い post-install-cmdとpost-u...

爆速軽量フレームワーク codeigniter PHP 開発

ルーター設定もなく、初期設定も少ない！軽量と爆速で動いてくれるフレームワーク codeigniter...

nuxtjs と codeigniter で jwt システム構築

nuxtjsとcodeigniterでシステム構築する際のメモ...

Lumen と Laravel 違い比較

軽量で速いマイクロフレームワークlumenとlaravelの違い、使い方比較と本当にlumen必要か...

HTML から PDF に変換 PHP ライブラリ mPDF の設定

HTMLレンダリングしてPDFに変換出力するライブリmpdfを使いこなせるための設定いろいろ...

twig 3 人気 PHP テンプレートエンジンがバージョンアップ

以前からtwigテンプレートエンジン使っていて、非常にパワーフルで使いやすさに魅了しました。15日に...

正規表現一覧 よく使う検索・置換のパターン

よく使う正規表現、文字検索・置換をまとめてみました。...

Apache 初期設定メモ

LAMP環境のApache初期設定メモ...

開発におけるコーディングルール・規約

コーディングルールと規約を大事にする、複数人で開発しても、一人で開発してもメンテナンスやコードのわか...

Laravel Error についてのメモ

laravelを使う時に出てくるエラー対応...

laravel に vuejs 使うための初期設定

PHPフレームワークlaravelにvuejs入れる時の初期設定まとめ、備忘録的...

php curl 使って クリックなしで POST 送信

PHP curl_setopt使ってシンプルにデータ転送してpost投げます。PHPは本当に短いソー...

allowurlinclude の設定で ftp_connect()エラー

FTPサーバーとやりとりする時にftp_connect()エラーが発生、PHP７にアップしたばかりで...