【Laravel基礎学習21】Laravelのファイルの扱いについて解説

laravelアイキャッチ 未分類
2019.10.29

こんにちは、かつコーチです。

Laravelでファイルを扱うときは、いくつか注意点があります。

storage:linkなどは基本ですが、扱える関数なども含めて詳しく解説します。

php artisan storage:link コマンド

php artisan storage:link コマンドは、Laravelのストレージディレクトリ（storage/app/public）を

公開ディレクトリ（public/storage）とリンクさせるために使用されます。

背景:

Laravelはセキュリティ上、アップロードされたファイルを

アプリケーションのディレクトリに直接保存しません。

通常、ファイルは storage/app ディレクトリに保存されます。

特に公開ファイル（ユーザーがアクセス可能なファイル）は storage/app/public に保存しますが、

これだけではユーザーが直接ファイルにアクセスできません。

php artisan storage:link とは

このコマンドを実行すると、シンボリックリンクが作成され、

storage/app/public のファイルが public/storage ディレクトリからアクセスできるようになります。

これにより、ユーザーは public/storage/{filename} のURLから

アップロードされたファイルにアクセスできるようになります。

コマンドの使い方

php artisan storage:link

これを実行すると、public/storage ディレクトリが作成され、

そこから storage/app/public に保存されたファイルにアクセスできるようになります。

ファイルアップロードに関する関数

Laravelはファイルを扱う際に、アップロードされたファイルを操作するための便利な関数を提供しています。以下はその代表的なものです。

getClientOriginalName()

getClientOriginalName() は、ユーザーがアップロードしたファイルの元のファイル名を取得します。

通常、ファイルを保存する際は、同名ファイルとの衝突を避けるために

ユニークな名前に変更することが推奨されていますが、元のファイル名が必要な場面で役立ちます。

使い方:

$file = $request->file('upload_file');
$originalName = $file->getClientOriginalName();

getClientOriginalExtension()

getClientOriginalExtension() は、ファイルの元の拡張子を取得します。

これにより、ファイルの種類を確認したり、保存名に拡張子を付加したりすることができます。

使い方:

$file = $request->file('upload_file');
$extension = $file->getClientOriginalExtension();

store() メソッド

store() メソッドは、ファイルを指定したディレクトリに保存します。

このメソッドはファイル名を自動生成し、保存パスを返します。

使い方:

$filePath = $request->file('upload_file')->store('uploads'); // 'uploads'ディレクトリに保存

storeAs() メソッド

storeAs() は、ファイルを指定した名前で保存します。

ファイル名を手動で指定したい場合に使用します。

使い方:

$file = $request->file('upload_file');
$customFileName = 'custom_name.' . $file->getClientOriginalExtension();
$file->storeAs('uploads', $customFileName);

move() メソッド

move() メソッドは、ファイルを指定ディレクトリに移動します。

このメソッドでは、ファイルの保存先とファイル名を指定できます。

使い方:

$file = $request->file('upload_file');
$file->move(public_path('uploads'), 'new_filename.jpg');

ファイルを扱う際のベストプラクティス

ファイルのユニーク名

ファイルを保存する際には、同名ファイルが上書きされることを防ぐために、

ユニークな名前を使用することが推奨されます。

通常、time() や uniqid() などを使ってユニーク名を生成しますが、

Laravelでは store() メソッドがデフォルトでユニークなファイル名を生成してくれます。

storage_path() ヘルパー

storage_path() ヘルパーは、ストレージディレクトリへの完全なパスを返します。

storage_path('app/public/filename.jpg') のように使用することで、

ファイルのパスを安全に取得できます。

使い方:

$path = storage_path('app/public/' . $filename);

アクセス権限

ファイルをアップロードする際には、アクセス権限にも注意が必要です。

特に公開用のファイルと機密データのファイルを分けて管理することで、

セキュリティを確保できます。

ファイルのダウンロード

Laravelでは、ファイルを簡単にダウンロードさせるための download() メソッドも提供しています。

使い方

return response()->download(storage_path('app/public/' . $filename));

全体の流れ

  1. ファイルアップロードの準備:
    ファイルが public/storage からアクセスできるように php artisan storage:link でシンボリックリンクを作成します。
  2. フォームからのファイルアップロード:
    ユーザーがファイルをフォームからアップロードし、それを $request->file() で取得します。
  3. ファイル名や拡張子の取得:
    getClientOriginalName() や getClientOriginalExtension() で元のファイル名や拡張子を取得し、必要に応じてファイル名をカスタマイズします。
  4. ファイルの保存:
    store() や storeAs() でファイルを保存します。保存先は storage/app/public などが一般的です。
  5. ファイルのアクセス:
    保存されたファイルには asset() や url() を使って、public/storage/{filename} でアクセスできます。
  6. ファイルのダウンロード:
    ファイルをダウンロードさせたい場合は、download() メソッドを使用します。

これらを踏まえてファイル操作を行うことで、Laravelの強力なファイル管理機能を効率的に活用することができます。

タイトルとURLをコピーしました