BackEnd

Laravelで画像アップロード実装が楽になるかもしれないlaravel-imageup

投稿日:

はじめに

こんにちは。webアプリケーションを作る際にファイルアップロードはごく当然の機能で、Laravelでももちろん標準でサポートされています。が、今回は要件次第では実装がほとんど不要になるライブラリ laravel-imageup を紹介します。
(要件次第で、と前置きをつけた理由は後述します)

環境

  • PHP 7.3.3
  • Laravel 5.8.4
  • MariaDB 10.3.13

導入

公式のREADMEに従って、composerでサクッとインストールします。
なお、依存先のライブラリである Intervention Image がPHPのGD拡張もしくはImagick拡張に依存するので、あらかじめ入れておきましょう。

あとはライブラリを /config/app.php に登録して導入完了です。

実装

チュートリアルでお馴染みの make:auth でログイン機能を生成し、登録画面に画像アップロードのフォームを追加します。
なおマイグレーション処理は省略しますが User テーブルにファイル名を保存するための avatar カラムを追加済みとします。

モデルクラス /app/User.php にプロパティを追記します。

User テーブルにレコードを作成する処理ところで、 avatar カラムに値を入れるためのコードを追記します。

実際にはRequestクラスでのバリデーションなどありますが、これで最低限の実装完了です。フォームを送信してみましょう。
アップロードした画像が /app/storage/app/public/uploads に保存されていれば成功です。

個人的にハマったこと

配列はダメ

私がこのライブラリを使った時、実装の要件として「複数のファイルを一度にアップロードできる」というのがありました。当初は特に深く考えず以下のようなhtmlを書いてましたが、ここで軽くハマりました。

この状態のままだと、前述の $data['avatar'] に配列で格納され、ライブラリの自動アップロードが効かなくなるばかりかエラーを吐いてしまいます。
そもそもライブラリ側が Illuminate\Http\UploadedFile を受け取ることが前提なので、この場合は以下2つの解決策があります。

  • inputのname要素を name="avatar_1" name="avatar_2" というようにユニークな値で記述する
  • 自動アップロードを無効化して(デフォルトでは有効)、foreachなどでひとつずつ手動でアップロードする

私は後者で解決しました。
自動アップロードを無効化する場合は設定ファイルで 'auto_upload_images' => false としてもよいのですが、アプリケーション全体に影響してしまうので、モデルクラスで以下のようにプロパティを設定します。

あとは $model->uploadImage($uploadedFile, 'avatar'); で、配列に格納されている UploadedFile オブジェクトをひとつずつ渡せばOKです。

PHPStanで引っかかる

uploadImage メソッドが、PHPコードを静的解析するツールであるPHPStanでエラーを吐きます。
ライブラリのPHPDocが以下のようになっているため「第二引数 $field がNULLのみ受け付ける」という意味になってしまっています。

これは uploadImage をオーバーライドするか、モデルクラスに適当なメソッドを作って、その中で uploadImage を呼ぶようにしましょう。

さいごに

少々面倒なファイルアップロード処理を少ないコードで実装できる laravel-imageup を紹介しました。中身とその挙動を把握した上で使えばかなり便利だと思います。また、Laravel本体のバージョンに追随している点も地味に長所だと思います。

おすすめ書籍

PHPフレームワーク Laravel Webアプリケーション開発 バージョン5.5 LTS対応 PHPフレームワーク Laravel入門

blog-page_footer_336




blog-page_footer_336




-BackEnd
-,

執筆者:


comment

メールアドレスが公開されることはありません。 が付いている欄は必須項目です

CAPTCHA


関連記事

rails

configに追記したのに、rails runnerが起動しない?

1 はじめに1.1 環境2 rails runnerを使用してみる2.1 バッチファイルの作成2.2 configにパスを追記2.3 実行3 ところが…3.1 解決方法4 おまけ(runnerコマンド ...

rails

RailsでAjax処理で画面を更新する

1 はじめに2 View(遷移元)の設定3 Controllerの実装4 View(遷移先)の実装5 参考6 さいごに はじめに RailsでAjax処理で画面を更新する方法を簡単に紹介します。 Vi ...

laravel logo

[Laravel] middlewareでHTTPリクエストの前後に処理を入れる

1 はじめに2 middlewareとは3 実装3.1 middleware作成3.2 コード実装4 middleware定義4.1 常に呼び出す4.2 特定のURLにアクセスした時のみ呼び出す4.3 ...

Stripe Connectでダイレクト支払い導入編

1 はじめに2 事前準備3 StripeConnectの導入3.1 stripeパッケージの導入3.2 envの実装4 店舗アカウントの登録4.1 Stripe Connectの設定4.2 Oauth ...

rails

【Puma】アプリサーバのチューニング

1 はじめに2 チューニングで注意する項目3 子プロセスの数3.1 最低3つの子プロセスを割り当てる3.2 最大子プロセス数3.3 CPUコア数と子プロセス数3.4 なぜPumaの子プロセス数を増やす ...

フォロー

blog-page_side_responsive

2019年5月
 1234
567891011
12131415161718
19202122232425
262728293031  

アプリ情報

私たちは無料アプリもリリースしています、ぜひご覧ください。 下記のアイコンから無料でダウンロードできます。