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


関連記事

laravel logo

Laravelのコントローラの基礎

1 はじめに2 ルーティング2.1 使用可能なメソッド2.2 リダイレクト2.3 Viewの返却2.4 ルートパラメータ2.5 ミドルウェア2.6 プレフィックス3 バリデーション3.1 コントローラ ...

Go言語

Go 1.16でのgo getとgo installの変更点

1 はじめに2 go getとgo installの役割2.1 go getの役割2.2 go installの役割3 この変更で何が改善されたのか3.1 go:generateと併用する4 その他の ...

rails

Active Strageを使用してユーザーのアバターを登録、表示する

1 はじめに1.1 環境2 セットアップ2.1 前準備2.2 マイグレーションファイル作成2.3 設定ファイル3 実際に使って見る3.1 モデル3.2 コントローラー3.3 ビュー4 個人的メモ4.1 ...

js

Moment Timezoneを使ってJavaScriptで日付を変換する

1 はじめに2 Moment Timezone2.1 セットアップ2.2 使用例3 Moment Timezoneの機能3.1 タイムゾーンの一覧を表示する3.2 現在のタイムゾーンを表示する3.3 ...

rails

Shrineをモデルに関連付けないで使用してハマったこと

1 はじめに2 アップロード時にリサイズする3 アップロード時のバリデーション4 アップロード時に古いファイルを削除する5 さいごに はじめに ShrineはRailsでのアップロードを簡単に行えるよ ...

フォロー

blog-page_side_responsive

2019年5月
 1234
567891011
12131415161718
19202122232425
262728293031  

アプリ情報

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