Laravel – アップロード画像の保存・登録

2021-10-28 / tau / コメントする

概要

フォームで選択した画像ファイルをサーバーに保存し、画像ファイルへのパスを含むデータをデータベースに登録する手順を整理する。

要点は以下のとおり。

フォームリクエストからアップロード画像を取得
画像を公開エリアに保存し、パスを取得
画像へのパスをデータベースに登録

一般的なアップロードファイルの保存方法についてはこちらを参照。

画像ファイル保存・登録後の画像の表示についてはこちらを参照。また、保存済みの画像ファイルの変更・削除についてはこちらを参照。

コントローラー～store

フォームで画像選択後にsubmitボタンを押すと、POSTメソッドでコントローラーのstoreアクションへルーティングされる。storeアクションでの処理は以下のとおり。

フォームリクエストから画像ファイルのインスタンスを取得
一時保存領域に保存されたファイル本体を、store()メソッドで公開領域に保存
store()メソッドの戻り値として返される、画像ファイルへのパスを取得
Itemsデータの他の項目とともに、ファイルへのパスをデータベースへ登録

class ItemController extends Controller
{
    ........
    public function store(ItemRequest $request)
    {
        // アップロードされたファイルの取得
        $image = $request->file('image');
        // ファイルの保存とパスの取得
        $path = isset($image) ? $image->store('items', 'public') : '';

        // 商品をデータベースに登録
        Item::create([
            'name' => $request->name,
            'price' => $request->price,
            'image' => $path,
        ]);

        return redirect()->route('items.index');
    }
    ........
}

class ItemController extends Controller

{

........

public function store(ItemRequest $request)

{

// アップロードされたファイルの取得

$image = $request->file('image');

// ファイルの保存とパスの取得

$path = isset($image) ? $image->store('items', 'public') : '';

// 商品をデータベースに登録

Item::create([

'name' => $request->name,

'price' => $request->price,

'image' => $path,

]);

return redirect()->route('items.index');

}

........

}

ここでは、store()の第1引数と第2引数を指定し、publicディスク内のitemsディレクトリー下にファイルを保存している。

publicディスクは環境設定でstorage/app/publicが充てられる
ファイルの実体はstorage/app/public/itemsディレクトリー下に保存される。

データ登録確認

indexページで新規データを登録した結果を、MySQLのコンソールで確認した例。

mysql> select * from items\G
*************************** 1. row ***************************
        id: 1
      name: item1
     price: 100
     image:
created_at: 2021-10-27 10:00:51
updated_at: 2021-10-27 10:00:51
*************************** 2. row ***************************
        id: 2
      name: 商品2
     price: 250
     image: items/KeeAWS296C5TPymJm8BwmzJbAcsEb2jqONOUZXcZ.jpg
created_at: 2021-10-27 10:01:03
updated_at: 2021-10-27 10:01:19
2 rows in set (0.00 sec)

mysql> select * from items\G

*************************** 1. row ***************************

id: 1

name: item1

price: 100

image:

created_at: 2021-10-27 10:00:51

updated_at: 2021-10-27 10:00:51

*************************** 2. row ***************************

id: 2

name: 商品2

price: 250

image: items/KeeAWS296C5TPymJm8BwmzJbAcsEb2jqONOUZXcZ.jpg

created_at: 2021-10-27 10:01:03

updated_at: 2021-10-27 10:01:19

2 rows in set (0.00 sec)

画像ファイルはファイル名にランダム文字列が与えられ、publicディスク下のitemsディレクトリー内に保存される。imageカラムにitemsディレクトリー以下のパスが登録されている。

publicディスクが充てられているstorage/app/publicディレクトリーを確認すると、itemsディレクトリー内に上記のファイルが保存されているのが確認できる。

$ ls storage/app/public/items/
KeeAWS296C5TPymJm8BwmzJbAcsEb2jqONOUZXcZ.jpg
no_image.png

$ ls storage/app/public/items/

KeeAWS296C5TPymJm8BwmzJbAcsEb2jqONOUZXcZ.jpg

no_image.png

no_image.pngは、画像が登録されていない場合に表示するプレースホルダー画像。

Laravel – アップロード画像の入力

2021-10-28 / tau / コメントする

概要

画像ファイルを含むフォームの作り方、画像ファイルに対するバリデーションについて整理する。

アップロード画像処理～準備で枠組みを作った商品データのアプリケーションを加工していく。

一般的なアップロードファイルの入力・取得についてはこちらを参照。

入力・登録後のアップロード画像の登録・保存についてはこちらを参照。

ルーティング

通常のリソースベースでは、新規データの入力はcreateルートが想定されているが、ここではindexページに商品入力フォームを配置し、そこで商品データの内容や商品画像を入力する。

+--------+----------+-------+-------------+-------------------------------------------+------------+
| Domain | Method   | URI   | Name        | Action                                    | Middleware |
+--------+----------+-------+-------------+-------------------------------------------+------------+
........
|        | GET|HEAD | items | items.index | App\Http\Controllers\ItemController@index | web        |
........
+--------+----------+-------+-------------+-------------------------------------------+------------+

+--------+----------+-------+-------------+-------------------------------------------+------------+

+--------+----------+-------+-------------+-------------------------------------------+------------+

........

........

+--------+----------+-------+-------------+-------------------------------------------+------------+

商品入力ページ～index.blade.php

indexページに商品入力フォームを配置し、そこに商品画像ファイルの選択要素を含める。画像選択を含むフォームに関する要点は以下のとおり。

form要素に以下のオプションを加える
- enctype="multipart/form-data"
input要素でtype="file"を指定する

なおリソースベースによるデータ登録の場合、createアクションでルーティングされるページに入力フォームを置くことが想定されているが、ここでは商品一覧を表示するindexページで商品入力も行い、その入力フォームからstoreアクションを呼び出す。

<!DOCTYPE html>
<html lang="ja" dir="ltr">
  <head>
    <meta charset="utf-8">
    <title>商品一覧・入力</title>
  </head>
  <body>
    <h1>商品一覧・入力</h1>

    <form method="post" action="{{ route('items.store') }}" enctype="multipart/form-data">
      @csrf
      <div>
        <input type="text" name="name" placeholder="商品名を入力">
      </div>
      <div>
        <input type="number" name="price" placeholder="価格を入力">
      </div>
      <div>
        <input type="file" name="image">
      </div>
      <input type="submit" value="商品登録">
    </form>
  </body>
</html>

<!DOCTYPE html>

<head>

</head>

<body>

@csrf

<div>

</div>

<div>

</div>

<div>

</div>

</form>

</body>

</html>

フォームリクエスト

フォームリクエストでバリデーションを行う。フォームリクエストItemRequestは以下のコマンドで作成。

$ php artisan make:request ItemRequest
Request created successfully.

1 2	$ php artisan make:request ItemRequest Request created successfully.

生成されたフォームリクエストの雛形で、以下を編集。

authorize()の戻り値をtrueに変更
rules()の戻り値の配列にバリデーションルールを記述

<?php

namespace App\Http\Requests;

use Illuminate\Foundation\Http\FormRequest;

class ItemRequest extends FormRequest
{
    public function authorize()
    {
        return true;
    }

    public function rules()
    {
        return [
            'name' => ['required'],
            'price' => ['required', 'integer', 'min:0'],
            'image' => ['file', 'mimes:jpeg,jpg,png',
                        'dimensions:min_width=100,min_height=100,max_width=2000,max_height=2000'],
        ];
    }
}

<?php

namespace App\Http\Requests;

use Illuminate\Foundation\Http\FormRequest;

class ItemRequest extends FormRequest

{

public function authorize()

{

return true;

}

public function rules()

{

return [

'name' => ['required'],

'price' => ['required', 'integer', 'min:0'],

'image' => ['file', 'mimes:jpeg,jpg,png',

'dimensions:min_width=100,min_height=100,max_width=2000,max_height=2000'],

];

}

コントローラー～index/store

コントローラーでは2つのアクションメソッドを定義している。

indexアクションではindexページを表示するのみ
storeアクションでは、フォームデータに基づいてItemインスタンスをデータベースに登録
- ただし現段階では、画像ファイルパスを格納するimageに、仮置きで空文字列''をセットしている。
- この変数へのファイルパスの設定は、別項のアップロード画像ファイルの保存・登録で実装する。

<?php

namespace App\Http\Controllers;

use App\Item;
use Illuminate\Http\Request;

use App\Http\Requests\ItemRequest;

class ItemController extends Controller
{
    public function index()
    {
        return view('items.index');
    }

    public function store(ItemRequest $request)
    {
        // 商品をデータベースに登録
        Item::create([
            'name' => $request->name,
            'price' => $request->price,
            'image' => '',
        ]);
    }
}

<?php

namespace App\Http\Controllers;

use App\Item;

use Illuminate\Http\Request;

use App\Http\Requests\ItemRequest;

class ItemController extends Controller

{

public function index()

{

return view('items.index');

}

public function store(ItemRequest $request)

{

// 商品をデータベースに登録

Item::create([

'name' => $request->name,

'price' => $request->price,

'image' => '',

]);

}

ここでの留意点は以下のとおり。

作成したフォームリクエストItemRequestをuseでインポートし、メソッドインジェクションをRequestからItemRequestに変更している
create()メソッドがマスアサインメントのため、Itemモデルで$fillableの定義が必要

Itemモデルでの$fillable定義は以下の部分を追記。

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class Item extends Model
{
    protected $fillable = ['name', 'price', 'image'];
}

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class Item extends Model

{

protected $fillable = ['name', 'price', 'image'];

}

データ登録確認

この状況でアプリケーションを実行し、フォームでデータを登録したのが以下の例。

画像ファイルのパスは、まだ未登録の状態。

mysql> select * from items;
+----+-------+-------+-------+---------------------+---------------------+
| id | name  | price | image | created_at          | updated_at          |
+----+-------+-------+-------+---------------------+---------------------+
|  1 | item1 |   100 |       | 2021-10-25 21:25:52 | 2021-10-25 21:25:52 |
+----+-------+-------+-------+---------------------+---------------------+
1 row in set (0.00 sec)

mysql> select * from items;

+----+-------+-------+-------+---------------------+---------------------+

+----+-------+-------+-------+---------------------+---------------------+

| 1 | item1 | 100 | | 2021-10-25 21:25:52 | 2021-10-25 21:25:52 |

+----+-------+-------+-------+---------------------+---------------------+

1 row in set (0.00 sec)

Laravel – アップロード画像処理

2021-10-28 / tau / コメントする

概要

ユーザーのプロフィール画像や商品画像をアップロードし、ユーザーデータや商品データに関連付けて保存・更新・削除する。

ファイルへのパスをデータベースに保存し、ファイル本体はサーバーに保存する。

準備

仕様

全体仕様は以下の通り。

商品管理を扱う
商品データは商品名、商品価格と商品画像で、入力フォームで入力／選択
入力データはデータベースに保存
- DBには商品名と画像ファイルへのパスを登録
登録結果はindexページで一覧表示され、そのページに入力フォームも組み込む
- 画像未登録の場合はプレースホルダー画像を表示
各商品に商品名と画像、更新ボタン・商品削除ボタンを備える
更新ボタンを押すと更新ページに遷移
- 更新ページでは対象商品の商品名・現在の画像、商品名入力要素・画像選択要素、更新実行ボタンを表示
- 更新実行ボタンを押すと編集後の内容でデータを更新し、画像が選択されていれば商品画像を変更
商品削除ボタンを押すと画像と商品データを削除

モデルとコントローラーの作成

$ php artisan make:model Item --controller --migration
Model created successfully.
Created Migration: 2021_10_21_225313_create_items_table
Controller created successfully.

$ php artisan make:model Item --controller --migration

Model created successfully.

Created Migration: 2021_10_21_225313_create_items_table

Controller created successfully.

ルーティング

ルーティングはリソースベースとし、createとshow以外の全てを設定。

Route::resource('items', 'ItemController')
  ->except(['create', 'show']);

1 2	Route::resource('items', 'ItemController') ->except(['create', 'show']);

自動設定されるルーティング。

$ php artisan route:list
+--------+-----------+-------------------+---------------+---------------------------------------------+------------+
| Domain | Method    | URI               | Name          | Action                                      | Middleware |
+--------+-----------+-------------------+---------------+---------------------------------------------+------------+
.........
|        | GET|HEAD  | items             | items.index   | App\Http\Controllers\ItemController@index   | web        |
|        | POST      | items             | items.store   | App\Http\Controllers\ItemController@store   | web        |
|        | DELETE    | items/{item}      | items.destroy | App\Http\Controllers\ItemController@destroy | web        |
|        | PUT|PATCH | items/{item}      | items.update  | App\Http\Controllers\ItemController@update  | web        |
|        | GET|HEAD  | items/{item}/edit | items.edit    | App\Http\Controllers\ItemController@edit    | web        |
.........
+--------+-----------+-------------------+---------------+---------------------------------------------+------------+

$ php artisan route:list

+--------+-----------+-------------------+---------------+---------------------------------------------+------------+

+--------+-----------+-------------------+---------------+---------------------------------------------+------------+

.........

| | DELETE | items/{item} | items.destroy | App\Http\Controllers\ItemController@destroy | web |

| | PUT|PATCH | items/{item} | items.update | App\Http\Controllers\ItemController@update | web |

| | GET|HEAD | items/{item}/edit | items.edit | App\Http\Controllers\ItemController@edit | web |

.........

+--------+-----------+-------------------+---------------+---------------------------------------------+------------+

マイグレーション

マイグレーションファイルの編集

商品名、価格、画像ファイルへのパスのカラムを追加し、日付は2038問題対応でdatetime型に変更。

class CreateItemsTable extends Migration
{
    public function up()
    {
        Schema::create('items', function (Blueprint $table) {
            $table->bigIncrements('id');

            // 商品名
            $table->string('name');
            // 価格
            $table->integer('price');
            // 画像ファイルパス
            $table->string('image');

            //$table->timestamps();
            $table->datetime('created_at');
            $table->datetime('updated_at');
        });
    }
    ........
}

class CreateItemsTable extends Migration

{

public function up()

{

Schema::create('items', function (Blueprint $table) {

$table->bigIncrements('id');

// 商品名

$table->string('name');

// 価格

$table->integer('price');

// 画像ファイルパス

$table->string('image');

//$table->timestamps();

$table->datetime('created_at');

$table->datetime('updated_at');

});

}

........

}

マイグレーション

マイグレーションを実行。

$ php artisan migrate
Migrating: 2021_10_21_225313_create_items_table
Migrated:  2021_10_21_225313_create_items_table (0.02 seconds)

$ php artisan migrate

Migrating: 2021_10_21_225313_create_items_table

Migrated: 2021_10_21_225313_create_items_table (0.02 seconds)

アップロード画像処理の実装

実装の流れ

準備ができたアプリケーションに対して、以下の順番でアップロード画像処理を実装していく。

入力・アップロード

入力・アップロードでは以下のことを整理する。

画像ファイルの選択を含む入力フォーム
画像ファイル選択要素のバリデーション

処理の流れは以下のとおり。

画像ファイルを選択してフォームの送信ボタンを押す
ファイル本体がアップロードされ、サーバーの一時保存領域に保存される
アップロードファイルのインスタンスがリクエストから取得可能となる

要点は以下の通り。

form要素のオプションにenctype="multipart/form-data"を加える
input要素のオプションでtype="file"とする
画像ファイルに関するバリデーションルールは、['file', 'mimes=jpeg,jpg,png', ...]など

詳細はアップロード画像 – 入力を参照。

アップロード画像の保存・登録

アップロード画像の保存・登録では以下のことを整理する。

storeルートによるデータ保存
リクエストからの画像インスタンスの取得
画像ファイルの公開エリアへの保存
画像ファイルへのパスのデータベース登録

処理の流れは以下の通り。

画像ファイルのインスタンスをリクエストから取得
- たとえば$image = $request->image
画像ファイルの保存とパスの取得
- $path = $image->store('ディレクトリー', 'ディスク')
- ただしフォームで画像ファイルが選択されているときだけ処理する
画像ファイルへのパスのデータベース登録
- create([..., $image => $path, ...])

詳細はアップロード画像 – 登録・保存を参照。

アップロード画像の表示

画像の表示では以下のことを整理する。

画像ファイルが保存されたpublicディスクのシンボリックリンクの作成
画像ファイルへのパスを含むデータの取得
パスを介した画像ファイルの表示

要点は以下の通り。

画像ファイルを保存しているpublicディスクはstorage/app/publicディレクトリーに充てられているが、Web上は非公開
このpublicディスクへのシンボリックリンクを、アプリケーションのpublicディレクトリーに作成
- php artisan storage:link
コントローラーで画像ファイルへのパスを含むデータをデータベースから取得
- $items = Item::all();
データを1つずつ取り出しながら、ビューのimg要素で画像ファイルを表示
- <img src="{{ \Storage::url($item->image) }}">

詳細はアップロード画像の表示を参照。

アップロード画像の変更・削除

画像の変更・削除機能では以下のことを整理する。

edit～updateルートによるデータの編集と更新
destroyルートによるデータの削除
ディスクに保存された画像ファイルの削除
データ編集と編集内容によるデータ更新
ファイルとデータの削除

要点は以下のとおり。

ディスクに保存されたファイルの削除方法
- \Storage::disk('ディスク')->delete('ファイルパス')

詳細はアップロード画像の変更・削除を参照。

Laravel – view()とredirect()

2021-10-25 / tau / コメントする

概要

コントローラーのアクションでの処理の後、returnで指定するview()とredirect()の違い。

view()

view()はブレードテンプレートとそれに渡す変数・値を指定して、テンプレートの内容を表示(レンダリング)させる。

return view('ブレードテンプレート名', ['変数名' => 変数の内容, ...]);

1	return view('ブレードテンプレート名', ['変数名' => 変数の内容, ...]);

テンプレート名は、resources/views/以下のディレクトリー、ファイルを'.'で繋ぎ、テンプレート名の'.blade.php'は書かない。

たとえばテンプレートファイルのパスが

resources/views/products/index.blade.php

のとき、view()では以下のように指定する。

view('products.index');

1	view('products.index');

redirect()

リダイレクトはURLかルート名を指定して、コントローラーの処理とその後のレンダリングを実行させる。

// ドメイン名以下のURLを指定する場合
return redirect('URLパス');

// ルーティングで設定されたルート名を指定する場合
return redirect()->route('ルート名');

// ドメイン名以下のURLを指定する場合

return redirect('URLパス');

// ルーティングで設定されたルート名を指定する場合

return redirect()->route('ルート名');

たとえば以下のようなルーティング設定の場合。

+--------+-----------+----------+----------------+----------------------------------------------+------------+
| Domain | Method    | URI      | Name           | Action                                       | Middleware |
+--------+-----------+----------+----------------+----------------------------------------------+------------+
........
|        | GET|HEAD  | products | products.index | App\Http\Controllers\ProductController@index | web        |
........
+--------+-----------+----------+----------------+----------------------------------------------+------------+

+--------+-----------+----------+----------------+----------------------------------------------+------------+

+--------+-----------+----------+----------------+----------------------------------------------+------------+

........

........

+--------+-----------+----------+----------------+----------------------------------------------+------------+

リダイレクトは以下のように指定する。

// ドメイン名以下のURLを指定する場合
return redirect('/index');

// ルーティングで設定されたルート名を指定する場合
return redirect()->route('products.index');

// ドメイン名以下のURLを指定する場合

return redirect('/index');

// ルーティングで設定されたルート名を指定する場合

return redirect()->route('products.index');

Laravel – バリデーションエラー

2021-10-25 / tau / コメントする

概要

バリデーションの結果エラーが発生した場合、$errorsにメッセージ群が格納され、ビュー側でそれを参照できる。

全てのエラー

`$errors->all()`

$errorsは単なるコレクションではなくIlluminate\Support\MessageBagのインスタンス。ビューですべてのメッセージを一つずつ取り出すには例えば以下の様に記述する。

@foreach ($errors->all() as $error)
  <p>{{ $error }}</p>
@endforeach

@foreach ($errors->all() as $error)

<p>{{ $error }}</p>

@endforeach

たとえばフォームリクエストで以下のようなバリデーションルールを設定した場合。

class ItemRequest extends FormRequest
{
    ........
    public function rules()
    {
        return [
            'name' => ['required'],
            'price' => ['required', 'integer', 'min:0'],
            'image' => ['file', 'mimes:jpeg,jpg,png',
                        'dimensions:min_width=100,min_height=100,max_width=800,max_height=600'],
        ];
    }
}

class ItemRequest extends FormRequest

{

........

public function rules()

{

return [

'name' => ['required'],

'price' => ['required', 'integer', 'min:0'],

'image' => ['file', 'mimes:jpeg,jpg,png',

'dimensions:min_width=100,min_height=100,max_width=800,max_height=600'],

];

}

フォームで何も入力しないでPOSTすると、以下のエラーが表示される。

名前は必ず指定してください。

priceは必ず指定してください。

imageにはファイルを指定してください。

imageにはjpeg, jpg, pngタイプのファイルを指定してください。

imageの図形サイズが正しくありません。

名前は必ず指定してください。

priceは必ず指定してください。

imageにはファイルを指定してください。

imageにはjpeg, jpg, pngタイプのファイルを指定してください。

imageの図形サイズが正しくありません。

特定の項目のエラー

`$errors->has('項目名')`と`$errors->first('項目名')`

has()メソッドはフォームの入力項目名を指定して、それに対するエラーがあるかどうかを判定し、first()メソッドは入力項目に対するエラーのうち1つを得る。

これら2つを組み合わせて、特定項目のエラーを1つだけ表示させる例は以下の通り。

@if ($errors->has('image'))
  <p>{{ $errors->first('image') }}</p>
@endif

@if ($errors->has('image'))

<p>{{ $errors->first('image') }}</p>

@endif

先ほどの例では、imageの項目でファイルを選択しないと3つのエラーが表示されたが、この場合はそのうちの1つだけが表示される。

imageにはファイルを指定してください。

1	imageにはファイルを指定してください。

`$errors->get('項目名')`

get()メソッドは、指定した項目に関するすべてのエラーをコレクションで返す。先ほどの例で、imageに関するエラーだけを全て表示するには以下のように書く。

@foreach ($errors->get('image') as $error)
  <p>{{ $error }}</p>
@endforeach

@foreach ($errors->get('image') as $error)

<p>{{ $error }}</p>

@endforeach

ファイルを選択せずにPOSTすると、imageに関するバリデーションエラーがすべて表示される。

imageにはファイルを指定してください。

imageにはjpeg, jpg, pngタイプのファイルを指定してください。

imageの図形サイズが正しくありません。

imageにはファイルを指定してください。

imageにはjpeg, jpg, pngタイプのファイルを指定してください。

imageの図形サイズが正しくありません。

Laravel – アップロードファイルの削除

2021-10-22 / tau / コメントする

ファイル削除の流れ

Storageファサードでファイルを保存したディスクを指定して、delete()メソッドの引数にファイルパスを渡して削除を実行。

\Storage::disk('ディスク')->delete('ファイルパス');

1	\Storage::disk('ディスク')->delete('ファイルパス');

ディスクは保存時と同じものを指定
ファイルパスは保存時にstore()で得られた戻り値、データベースに登録しているパスをそのまま使う。

実装例

ビュー

storageに保存したファイルのURLで使ったビューに、画像削除のフォームとボタンを追加する。

ファイルが保存されパスがセットされていれば、hidden属性のinput要素でそのパスを渡している
画像削除ボタンを押すと/images/deleteへルーティング

<!DOCTYPE html>
<html lang="ja" dir="ltr">
  <head>
    <meta charset="utf-8">
    <title>画像選択</title>
  </head>
  <body>
    <h1>画像選択</h1>
    <form method="post" action="{{ route('images.store') }}" enctype="multipart/form-data">
      @csrf
      <input type="file" name="image">
      <input type="submit" value="登録">
    </form>

    {{-- バリデーションエラー表示 --}}
    @foreach ($errors->all() as $error)
      <p>{{ $error }}</p>
    @endforeach

    {{-- 画像ファイルのURLと画像を表示 --}}
    @isset ($path)
      <p>{{ $path }}</p>
      <p>{{ asset('storage/' . $path) }}</p>
      <p>{{ url('storage/' . $path) }}</p>
      <p>{{ \Storage::url($path) }}</p>
      <img src="{{ asset('storage/' . $path) }}">
      <img src="{{ url('storage/' . $path) }}">
      <img src="{{ \Storage::url($path) }}">
    @else
      <p>ファイルはアップロードされていません</p>
    @endisset

    {{-- 画像を削除 --}}
    <form method="post" action="/images/delete">
      @csrf
      <input type="hidden" name="path" value="{{ isset($path) ? $path : '' }}">
      <input type="submit" value="画像削除">
    </form>
  </body>
</html>

<!DOCTYPE html>

<head>

</head>

<body>

@csrf

</form>

@foreach ($errors->all() as $error)

<p>{{ $error }}</p>

@endforeach

@isset ($path)

<p>{{ asset('storage/' . $path) }}</p>

<p>{{ url('storage/' . $path) }}</p>

<p>{{ \Storage::url($path) }}</p>

@else

<p>ファイルはアップロードされていません</p>

@endisset

@csrf

</form>

</body>

</html>

ルーティング

ルーティングは以下のように設定。リソースベースだとURLにidを含めなければならないので、ここでは別途設定し、destroyアクションにルーティングしている。

Route::post('/images/delete', 'ImageController@destroy');

1	Route::post('/images/delete', 'ImageController@destroy');

コントローラー

storageに保存したファイルのURLで使ったコントローラーに、destroyアクションを追加する。

フォームのhidden属性のinput要素からパスを取得
パスがセットされていれば削除を実行
indexページにリダイレクト

class ImageController extends Controller
{
    ........
    public function destroy(ImageRequest $request) {
        $path = $request->path;
        if (isset($path)) {
            \Storage::disk('public')->delete($path);
        }

        return redirect()->route('images.index');
    }
}

class ImageController extends Controller

{

........

public function destroy(ImageRequest $request) {

$path = $request->path;

if (isset($path)) {

\Storage::disk('public')->delete($path);

}

return redirect()->route('images.index');

}

Laravel – storageに保存したファイルのURL

2021-10-21 / tau / コメントする

概要

たとえば保存されたアップロードファイルなど、storageディレクトリー下に保存したファイルのパスを取得する手順を整理する。

storage/app/public直下またはそのサブディレクトリー下に保存されたファイルを対象とする
artisanにより、storage/app/publicへのシンボリックリンクstorageをpublicディレクトリー下に作成
publicディレクトリー内は公開されるので、以下のいずれかの方法でURLを取得
- asset()ヘルパーやurl()ヘルパーの引数に'storage/' . $pathを与えてURLを取得
- \Storage::url()の引数に$pathを与えてドキュメントルート以下のパスを取得

公開領域

Laravelのファイルの公開場所は以下の様になっている。

publicディレクトリー下のファイル、あるいはそのサブディレクトリー下のファイルは公開対象
URLでの指定方法は、publicディレクトリー下のディレクトリー・ファイル構成をドメイン名に続けて指定

たとえば以下の例では、publicディレクトリー下にサブディレクトリーtestがあって、その下にbar.txtファイルがある。

$ cat public/foo/bar.txt
サンプルテキスト

1 2	$ cat public/foo/bar.txt サンプルテキスト

このファイルは公開されていて、このアプリケーションをlocalhostで確認する場合、ブラウザーで以下のようなURLを指定するとファイルの内容がブラウザーに表示される。

localhost:3000/foo/bar.txt

1	localhost:3000/foo/bar.txt

storage下のファイルの公開

以下のコマンドを実行すると公開領域にシンボリックリンクstorageが作成され、それがstorage/app/publicディレクトリーを指す。

php artisan storage:link

1	php artisan storage:link

publicディレクトリー下にシンボリックリンクstorageが作成される
リンクstorageはstorage/app/publicを指す
ディレクトリー下にアクセスするURLは以下のとおり
- ドメイン名/storage/....

$ php artisan storage:link
The [public/storage] directory has been linked.
$ ls -Al public
合計 16
-rw-rw-r--. 1 vagrant vagrant  593  9月  7 20:19 .htaccess
-rw-rw-r--. 1 vagrant vagrant    0  9月  7 20:19 favicon.ico
-rw-rw-r--. 1 vagrant vagrant 1823  9月  7 20:19 index.php
-rw-rw-r--. 1 vagrant vagrant   24  9月  7 20:19 robots.txt
lrwxrwxrwx. 1 vagrant vagrant   70 10月 21 21:15 storage -> /home/..../アプリケーション/storage/app/public
-rw-rw-r--. 1 vagrant vagrant 1194  9月  7 20:19 web.config

$ php artisan storage:link

The [public/storage] directory has been linked.

$ ls -Al public

合計 16

-rw-rw-r--. 1 vagrant vagrant 593 9月 7 20:19 .htaccess

-rw-rw-r--. 1 vagrant vagrant 0 9月 7 20:19 favicon.ico

-rw-rw-r--. 1 vagrant vagrant 1823 9月 7 20:19 index.php

-rw-rw-r--. 1 vagrant vagrant 24 9月 7 20:19 robots.txt

lrwxrwxrwx. 1 vagrant vagrant 70 10月 21 21:15 storage -> /home/..../アプリケーション/storage/app/public

-rw-rw-r--. 1 vagrant vagrant 1194 9月 7 20:19 web.config

たとえばアプリケーションがlocalhostで稼働している場合、storage/app/public/foo/bar.pngにアクセスするURLは以下のとおり。

localhost:3000/storage/foo/bar.png

1	localhost:3000/storage/foo/bar.png

画像ファイルを表示する例

コントローラー

アップロードファイルの保存で保存された画像ファイルを表示させる例を示す。

画像ファイルをフォームで選択してPOSTすると、コントローラーのstoreアクションにルーティングされるとする。

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;

use App\Http\Requests\ImageRequest;

class ImageController extends Controller
{
    public function index() {
        return view('images.index');
    }

    public function store(ImageRequest $request) {
        // 一時保存されたUploadedFileの取得
        $image = $request->file('image');
        // ファイルの保存と保存されたファイルのパス取得
        $path = '';
        if (isset($image)) {
            $path = $image->store('images', 'public');
        }

        return view('images.index', ['path' => $path]);
    }
}

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;

use App\Http\Requests\ImageRequest;

class ImageController extends Controller

{

public function index() {

return view('images.index');

}

public function store(ImageRequest $request) {

// 一時保存されたUploadedFileの取得

$image = $request->file('image');

// ファイルの保存と保存されたファイルのパス取得

$path = '';

if (isset($image)) {

$path = $image->store('images', 'public');

}

return view('images.index', ['path' => $path]);

}

コントローラーの処理は以下の通り。

storeアクションで、フォームリクエストからファイルオブジェクトを取得
画像ファイル本体をpublicディスクのimagesディレクトリーに保存
その際、ランダム文字列で生成されるファイル名が戻り値となり、これを$pathに保存
$pathを渡してimages.indexビューをレンダリング

ビュー

ページを表示するテンプレートは以下の通り。

<!DOCTYPE html>
<html lang="ja" dir="ltr">
  <head>
    <meta charset="utf-8">
    <title>画像選択</title>
  </head>
  <body>
    <h1>画像選択</h1>
    <form method="post" action="{{ route('images.store') }}" enctype="multipart/form-data">
      @csrf
      <input type="file" name="image">
      <input type="submit" value="登録">
    </form>

    {{-- バリデーションエラー表示 --}}
    @foreach ($errors->all() as $error)
      <p>{{ $error }}</p>
    @endforeach

    {{-- 画像ファイルのURLと画像を表示 --}}
    @isset ($path)
      <p>{{ $path }}</p>
      <p>{{ asset('storage/' . $path) }}</p>
      <p>{{ url('storage/' . $path) }}</p>
      <p>{{ \Storage::url($path) }}</p>
      <img src="{{ asset('storage/' . $path) }}">
      <img src="{{ url('storage/' . $path) }}">
      <img src="{{ \Storage::url($path) }}">
    @else
      <p>ファイルはアップロードされていません</p>
    @endisset
  </body>
</html>

<!DOCTYPE html>

<head>

</head>

<body>

@csrf

</form>

@foreach ($errors->all() as $error)

<p>{{ $error }}</p>

@endforeach

@isset ($path)

<p>{{ asset('storage/' . $path) }}</p>

<p>{{ url('storage/' . $path) }}</p>

<p>{{ \Storage::url($path) }}</p>

@else

<p>ファイルはアップロードされていません</p>

@endisset

</body>

</html>

ファイル関係の表示は後ろの方で、$pathの内容とasset()、url()2つのヘルパーの結果を表示し、ヘルパーで生成されたURLで画像を表示させている。

$pathの内容

画像ファイルを保存した後の$pathの内容は以下の通りで、storeアクションでの処理により、images/ランダム文字列によるファイル名となっている(拡張子はそのまま)。

images/kn2NdjJUL9k20kE0xLhmTwAZcFycySvLcFcLkybz.jpg

1	images/kn2NdjJUL9k20kE0xLhmTwAZcFycySvLcFcLkybz.jpg

asset(), url()によるURL

ファイルは公開領域のstorageディレクトリーから参照されるが、そのURLはasset()、url()の何れでも同じ結果を与える。

http://localhost:3000/storage/images/kn2NdjJUL9k20kE0xLhmTwAZcFycySvLcFcLkybz.jpg
http://localhost:3000/storage/images/kn2NdjJUL9k20kE0xLhmTwAZcFycySvLcFcLkybz.jpg

1 2	http://localhost:3000/storage/images/kn2NdjJUL9k20kE0xLhmTwAZcFycySvLcFcLkybz.jpg http://localhost:3000/storage/images/kn2NdjJUL9k20kE0xLhmTwAZcFycySvLcFcLkybz.jpg

\Storage::url()によるドキュメントルート下のパス

\Storageファサードのurl()メソッドに$pathを指定すると、ドキュメントルート下の画像ファイルのパスが得られる。

/storage/images/Sa6Oicpvoma4j53WCbZcyaICusRvxYzwZvhNBMX4.jpg

1	/storage/images/Sa6Oicpvoma4j53WCbZcyaICusRvxYzwZvhNBMX4.jpg

img要素のsrcの指定

先のビューでは、asset()、url()、\Storage::url()の結果をimg要素のsrcの値に指定していて、いずれも同じ画像が表示される。

Laravel – アップロードファイルの保存

2021-10-20 / tau / コメントする

概要

フォームからアップロードされたファイルをサーバーの場所を指定して保存する手順について整理する。

フォームから取得したUploadedFileオブジェクトを介して、一時保存されたファイルの実体を、store()メソッドやstoreAs()メソッドで所定の場所に保存する。

ファイル取得

ここでは画像ファイルのアップロードを題材とし、アップロードファイルのUploadedFileオブジェクトを取得済みとする。

アップロードファイルの取得についてはこちらを参照。

ファイル保存の流れ

フォームでファイルを選択・アップロードし、それをサーバーに保存する流れは以下の通り。

フォームのname属性値からUploadedFileオブジェクトを取得
store()メソッドやstoreAs()メソッドで保存
メソッドの戻り値から、保存されたファイルのパスを取得
パスをデータベースに保存するなどの処理を実行

実装例

アップロードファイル取得のコード中、storeアクションの内容を以下の様に書き換える。ここでは得られたファイルパスを表示させて、そこで実行を停止している。

class ImageController extends Controller
{
    ........
    public function store(ImageRequest $request) {
        // 一時保存されたUploadedFileの取得
        $image = $request->file('image');
        // ファイルの保存と保存されたファイルのパス取得
        $path = '';
        if (isset($image)) {
            $path = $image->store('');
        }
        dd($path);
    }
    ........
}

class ImageController extends Controller

{

........

public function store(ImageRequest $request) {

// 一時保存されたUploadedFileの取得

$image = $request->file('image');

// ファイルの保存と保存されたファイルのパス取得

$path = '';

if (isset($image)) {

$path = $image->store('');

}

dd($path);

}

........

}

store()/storeAs()

UploadedFile::store()メソッド

標準形

パス文字列 = [UploadedFileのインスタンス]->store('ディレクトリー', 'ディスク');

1	パス文字列 = [UploadedFileのインスタンス]->store('ディレクトリー', 'ディスク');

引数にファイルを保存するディレクトリーとディスクを指定する
→省略不可
指定した場所にアップロードファイルが保存される
戻り値として、ランダム文字列化されたファイル名を含むパスが返される

引数が`''`の場合

引数を”とすると、アップロードファイルはstorage/app直下に保存される
→デフォルトのdiskはstorage/appに設定されている

        // ファイルの保存と保存されたファイルのパス取得
        $path = '';
        if (isset($image)) {
            $path = $image->store('');
        }

// ファイルの保存と保存されたファイルのパス取得

$path = '';

if (isset($image)) {

$path = $image->store('');

}

ファイルパスの内容。

"HEwMbd1eE53Gmgq8SSUa4KCKl5GoJSSVfRw1W6rS.jpg"

1	"HEwMbd1eE53Gmgq8SSUa4KCKl5GoJSSVfRw1W6rS.jpg"

保存されたファイルの確認。

$ ls storage/app
HEwMbd1eE53Gmgq8SSUa4KCKl5GoJSSVfRw1W6rS.jpgひ

1 2	$ ls storage/app HEwMbd1eE53Gmgq8SSUa4KCKl5GoJSSVfRw1W6rS.jpgひ

引数にディレクトリーを指定

ここでは引数に'test'というディレクトリーを指定している。

        // ファイルの保存と保存されたファイルのパス取得
        $path = '';
        if (isset($image)) {
            $path = $image->store('test');
        }

// ファイルの保存と保存されたファイルのパス取得

$path = '';

if (isset($image)) {

$path = $image->store('test');

}

戻り値のパスは、testディレクトリー下にファイルが位置している。

"test/GvZKLW48CBEZCP7441pQyxCfuNWF6WlKL6u8teSF.jpg"

1	"test/GvZKLW48CBEZCP7441pQyxCfuNWF6WlKL6u8teSF.jpg"

storage/appの下にtestディレクトリーが存在すればその下に、存在しなければ新たにtestディレクトリーが作成されてその下にファイルが保存される。

$ ls storage/app/test/
GvZKLW48CBEZCP7441pQyxCfuNWF6WlKL6u8teSF.jpg

1 2	$ ls storage/app/test/ GvZKLW48CBEZCP7441pQyxCfuNWF6WlKL6u8teSF.jpg

第2引数にディスクを指定

以下の例では、store()の第2引数に'public'を指定している。filesystems.phpでのpublicディスクの定義から、この場合のアップロードファイルはstorage/app/public下のtestディレクトリーの下に保存される。

store('ディスク内のディレクトリー', 'ディスク');

        // ファイルの保存と保存されたファイルのパス取得
        $path = '';
        if (isset($image)) {
            $path = $image->store('test', 'public');
        }
        dd($path);

// ファイルの保存と保存されたファイルのパス取得

$path = '';

if (isset($image)) {

$path = $image->store('test', 'public');

}

dd($path);

戻り値のパス。ディスク内のtestディレクトリーに続いてランダム文字列でファイル名が生成されている。

"<span class="sf-dump-str" title="49 characters">test/eGjEzTioHRgClfYIXIbjQ7kvwCgqjRjp4pRRjI6o.jpg</span>"

1	"<span class="sf-dump-str" title="49 characters">test/eGjEzTioHRgClfYIXIbjQ7kvwCgqjRjp4pRRjI6o.jpg</span>"

確認すると、確かにstorage/app/public/testの下にファイルが保存されている。なおtestディレクトリーが存在しないときは、新たに作成される。

$ ls storage/app/public/test/
eGjEzTioHRgClfYIXIbjQ7kvwCgqjRjp4pRRjI6o.jpg

1 2	$ ls storage/app/public/test/ eGjEzTioHRgClfYIXIbjQ7kvwCgqjRjp4pRRjI6o.jpg

UploadedFile::storeAs()メソッド

store()メソッドはアップロードファイルに新たにランダム文字列でファイル名をつけるが、特定の名前を与えて保存したいときにはstoreAs()メソッドを使う。使い方や戻り値はstore()と同じ。

storeAs('ディスク内のディレクトリー', 'ファイル名', 'ディスク');

1	storeAs('ディスク内のディレクトリー', 'ファイル名', 'ディスク');

第3引数は省略可能で、その場合はstore()で第2引数を省略した時と同じ場所にファイルが保存される。

以下の例ではpublicディスクを指定しているが、その場所はfilesystems.phpでstorage/app/publicと定義されている。

        $path = '';
        if (isset($image)) {
            $path = $image->storeAs('test', 'specific_name.jpg', 'public');
        }
        dd($path);

$path = '';

if (isset($image)) {

$path = $image->storeAs('test', 'specific_name.jpg', 'public');

}

dd($path);

戻り値のファイルパス。ディレクトリーの後に指定したファイル名が続いている。

"test/specific_name.jpg"

1	"test/specific_name.jpg"

指定された場所にファイルが保存されているのが確認できる。

$ ls storage/app/public/test/
specific_name.jpg

1 2	$ ls storage/app/public/test/ specific_name.jpg

ファイルのパスのデータベース登録

store()/storeAs()の戻り値で得られたパスをデータベースに保存することで、画像表示などに活用できる。

具体的には、以下の例の様にパス名を登録するカラムにstore()の戻り値がセットされた$pathの内容を登録する。

class ImageController extends Controller
{
    ........
    public function store(ImageRequest $request) {
        // 一時保存されたUploadedFileの取得
        $image = $request->file('image');
        // ファイルの保存と保存されたファイルのパス取得
        $path = '';
        if (isset($image)) {
            $path = $image->store('');
        }

        // データベース登録
        Image::create([
            'image' => $path;
        ]);
    }
    ........
}

class ImageController extends Controller

{

........

public function store(ImageRequest $request) {

// 一時保存されたUploadedFileの取得

$image = $request->file('image');

// ファイルの保存と保存されたファイルのパス取得

$path = '';

if (isset($image)) {

$path = $image->store('');

}

// データベース登録

Image::create([

'image' => $path;

]);

}

........

}

Laravel – publicディスクの場所

2021-10-19 / tau / コメントする

Laravelでアップロードファイルを保存するときなどに、UploadedFileクラスのstore()やstoreAs()を使う。

これらの第2引数や第3引数でディスクを指定することができ、通常は’public’が指定される。

このpublicディスクがどの場所を指しているかは、アプリケーションディレクトリー下のconfig/filesystems.phpに書かれている。

<?php

return [

    'default' => env('FILESYSTEM_DRIVER', 'local'),

    'cloud' => env('FILESYSTEM_CLOUD', 's3'),

    'disks' => [

        'local' => [
            'driver' => 'local',
            'root' => storage_path('app'),
        ],

        'public' => [
            'driver' => 'local',
            'root' => storage_path('app/public'),
            'url' => env('APP_URL').'/storage',
            'visibility' => 'public',
        ],

        's3' => [
            'driver' => 's3',
            'key' => env('AWS_ACCESS_KEY_ID'),
            'secret' => env('AWS_SECRET_ACCESS_KEY'),
            'region' => env('AWS_DEFAULT_REGION'),
            'bucket' => env('AWS_BUCKET'),
            'url' => env('AWS_URL'),
            'endpoint' => env('AWS_ENDPOINT'),
        ],

    ],

];

<?php

return [

'default' => env('FILESYSTEM_DRIVER', 'local'),

'cloud' => env('FILESYSTEM_CLOUD', 's3'),

'disks' => [

'local' => [

'driver' => 'local',

'root' => storage_path('app'),

'public' => [

'driver' => 'local',

'root' => storage_path('app/public'),

'url' => env('APP_URL').'/storage',

'visibility' => 'public',

's3' => [

'driver' => 's3',

'key' => env('AWS_ACCESS_KEY_ID'),

'secret' => env('AWS_SECRET_ACCESS_KEY'),

'region' => env('AWS_DEFAULT_REGION'),

'bucket' => env('AWS_BUCKET'),

'url' => env('AWS_URL'),

'endpoint' => env('AWS_ENDPOINT'),

];

この中で'root' => storage_path('app/public')というのがあるが、storage_path()はアプリケーションのstorageディレクトリーからの相対パスを指定してパスを返すので、publicディスクの場所はstorage/app/publicということになる。

Laravel – アップロードファイルの取得

2021-10-18 / tau / コメントする

概要

ファイル選択要素を持つフォームでファイルを取得する手順を整理する。概要は以下のような流れ。

ファイル選択要素を持ったフォームを含むページを表示する
ユーザーがファイルを選択してPOSTリクエスト
リクエストを介して、サーバーにアップロード・一時保存されたファイルを取得する
バリデーションが必要な場合、フォームリクエストを作成して実装

基本例

機能

アップロードファイル取得の機能を、シンプルなコントローラーとビューで確認する。例として、画像ファイルの取得を目的として組み立てていく。

ファイル取得に限って言えば、要点は次の2点。

ビューでは、ファイル選択要素を持つフォームでファイルを選択、送信
コントローラーでは、アップロードされたファイルをフォームのリクエストから取得

ルーティング

例として以下のようにルーティングを設定する。

Route::resource('images', 'ImageController')
  ->only(['index', 'store']);

1 2	Route::resource('images', 'ImageController') ->only(['index', 'store']);

設定されるルーティングは以下のとおり。

$ php artisan route:list
+--------+----------+--------+----------------+--------------------------------------------+------------+
| Domain | Method   | URI    | Name           | Action                                     | Middleware |
+--------+----------+--------+----------------+--------------------------------------------+------------+
........
|        | GET|HEAD | images | images.index   | App\Http\Controllers\ImageController@index | web        |
|        | POST     | images | images.store   | App\Http\Controllers\ImageController@store | web        |
........
+--------+----------+--------+----------------+--------------------------------------------+------------+

$ php artisan route:list

+--------+----------+--------+----------------+--------------------------------------------+------------+

+--------+----------+--------+----------------+--------------------------------------------+------------+

........

........

+--------+----------+--------+----------------+--------------------------------------------+------------+

/imagesへのGETリクエストでコントローラーのindexアクションが呼ばれる
- このアクションでフォームページを表示する
フォームからのPOSTリクエストは/imagesに送られ、コントローラーのstoreアクションが呼ばれる
- 本来はファイル保存を想定したアクションだが、ここではファイルの内容確認のみ行う

コントローラー～フォーム表示

indexアクションではフォームを含むページを表示するだけ。

class ImageController extends Controller
{
    ........
    public function index() {
        return view('images.index');
    }
    ........
}

class ImageController extends Controller

{

........

public function index() {

return view('images.index');

}

........

}

ビュー～フォームとファイル選択要素の設定

表示するページのテンプレートは以下の通りで以下の2点が要点。

FORM要素でenctype="multipart/form-data"を指定している
INPUT要素でtype="file"としている

HTML-input-fileを参照

<!DOCTYPE html>
<html lang="ja">
  <head>
    <meta charset="utf-8">
    <title>画像ファイル選択</title>
  </head>
  <body>
    <h1>画像ファイル選択</h1>
    <form method="post" action="{{ route('images.store') }}" enctype="multipart/form-data">
      @csrf
      <input type="file" name="image">
      <input type="submit" value="送信">
    </form>
  </body>
</html>

<!DOCTYPE html>

<head>

<title>画像ファイル選択</title>

</head>

<body>

<h1>画像ファイル選択</h1>

@csrf

</form>

</body>

</html>

フォームで選択されたファイルの取得

アップロードされたファイルは、メソッド・インジェクションで得られたRequestオブジェクトのfile()メソッドで得られる。file()メソッドの引数にINPUT要素のname属性値を指定することでファイルのオブジェクトを得られる。

以下のアクションでは選択されたファイルの内容をdd()で表示させ、そこで実行を止めている。

class ImageController extends Controller
{
    ........
    public function store(Request $request) {
      $image = $request->file('image');
      dd($image);
    }
    ........
}

class ImageController extends Controller

{

........

public function store(Request $request) {

$image = $request->file('image');

dd($image);

}

........

}

ローカルのファイルを選択して送信ボタンを押した結果、上記のdd()で表示された内容を示したのが下記。この例ではJPEGファイルをアップロードしている。

アップロードされたファイルの実体が一時的に保存されるのは/tmpディレクトリーで、php.iniのupload_tmp_dirで設定されるようだが、コメントアウトされていた。この場合はルート直下の/tmpになると思われる。

Illuminate\Http\UploadedFile {#1244 ▼
  -test: false
  -originalName: "18420_smile1.jpg"
  -mimeType: "image/jpeg"
  -error: 0
  #hashName: null
  path: "/tmp"
  filename: "phpEyN1ug"
  basename: "phpEyN1ug"
  pathname: "/tmp/phpEyN1ug"
  extension: ""
  realPath: "/tmp/phpEyN1ug"
  aTime: 2021-10-17 19:22:08
  mTime: 2021-10-17 19:22:08
  cTime: 2021-10-17 19:22:08
  inode: 67201770
  size: 604673
  perms: 0100600
  owner: 1000
  group: 1000
  type: "file"
  writable: true
  readable: true
  executable: false
  file: true
  dir: false
  link: false
}

Illuminate\Http\UploadedFile {#1244 ▼

-test: false

-originalName: "18420_smile1.jpg"

-mimeType: "image/jpeg"

-error: 0

#hashName: null

path: "/tmp"

filename: "phpEyN1ug"

basename: "phpEyN1ug"

pathname: "/tmp/phpEyN1ug"

extension: ""

realPath: "/tmp/phpEyN1ug"

aTime: 2021-10-17 19:22:08

mTime: 2021-10-17 19:22:08

cTime: 2021-10-17 19:22:08

inode: 67201770

size: 604673

perms: 0100600

owner: 1000

group: 1000

type: "file"

writable: true

readable: true

executable: false

file: true

dir: false

link: false

}

バリデーション

フォームリクエスト

フォーム入力からファイルアップロード時にバリデーションをかける場合、フォームリクエストを使うとコントローラーで行うよりも明快になる。

フォームリクエストはartisanで作成する。

$ php artisan make:request ImageRequest
Request created successfully.

1 2	$ php artisan make:request ImageRequest Request created successfully.

フォームリクエストファイルはapp/Http/Requestsディレクトリーに作成され、このファイルにバリデーションの条件を記述する。条件は配列で書くか、文字列内で'|'で連結してもよい。

フォームリクエスト生成時にはauthorize()の戻り値はfalseになっているが、ここでは無条件にtrueとしている。

?php

namespace App\Http\Requests;

use Illuminate\Foundation\Http\FormRequest;

class ImageRequest extends FormRequest
{
    public function authorize()
    {
        return true;
    }

    public function rules()
    {
        return [
            'image' => [
                // ファイルがアップロードされている
                'file',
                // ファイル形式がJPEGかPNG
                'mimes:jpeg,jpg,png',
                // 画像のサイズ
                'dimensions:min_width=100,min_height=100,max_width=500,max_height=500',
            ],
        ];
    }
}

?php

namespace App\Http\Requests;

use Illuminate\Foundation\Http\FormRequest;

class ImageRequest extends FormRequest

{

public function authorize()

{

return true;

}

public function rules()

{

return [

'image' => [

// ファイルがアップロードされている

'file',

// ファイル形式がJPEGかPNG

'mimes:jpeg,jpg,png',

// 画像のサイズ

'dimensions:min_width=100,min_height=100,max_width=500,max_height=500',

];

}

ここでは画像ファイルを想定したバリデーションをかけているが、画像以外のファイルを扱う場合は、MIMEタイプをpdfやdocなど様々なファイル形式で指定。

また、ファイルサイズをmax:xxxのようにKB単位で制限することもできる。

なおここではファイルがアップロードされていないときは$imageはnullとなるが、ファイル指定を必須とする場合はrequiredを指定し、エラーメッセージでファイル指定を促すなどの対応をする。

エラー表示

フォームリクエストでのバリデーションの結果エラーがあると、検証結果が$errorsに記録され、もとのビューにリダイレクトされる。

ここでは、以下のようにフォーム入力のテンプレートで@foreachを使って$errorsの内容を全て表示させている。$errorsの使い方についてはこちらを参照。

<!DOCTYPE html>
<html lang="ja" dir="ltr">
  <head>
    <meta charset="utf-8">
    <title>画像選択</title>
  </head>
  <body>
    <h1>画像選択</h1>
    <form method="post" action="{{ route('images.store') }}" enctype="multipart/form-data">
      @csrf
      <input type="file" name="image">
      <input type="submit" value="登録">
    </form>

    {{-- バリデーションエラー表示 --}}
    @foreach ($errors->all() as $error)
      <p>{{ $error }}</p>
    @endforeach
  </body>
</html>

<!DOCTYPE html>

<head>

</head>

<body>

@csrf

</form>

@foreach ($errors->all() as $error)

<p>{{ $error }}</p>

@endforeach

</body>

</html>

概要

コントローラー～store

データ登録確認

概要

ルーティング

商品入力ページ～index.blade.php

フォームリクエスト

コントローラー～index/store

データ登録確認

概要

準備

仕様

モデルとコントローラーの作成

ルーティング

マイグレーション

マイグレーションファイルの編集

マイグレーション

アップロード画像処理の実装

実装の流れ

入力・アップロード

アップロード画像の保存・登録

アップロード画像の表示

アップロード画像の変更・削除

概要

view()

redirect()

概要

全てのエラー

$errors->all()

特定の項目のエラー

$errors->has('項目名')と$errors->first('項目名')

$errors->get('項目名')

ファイル削除の流れ

実装例

ビュー

ルーティング

コントローラー

概要

公開領域

storage下のファイルの公開

画像ファイルを表示する例

コントローラー

ビュー

$pathの内容

asset(), url()によるURL

\Storage::url()によるドキュメントルート下のパス

img要素のsrcの指定

概要

ファイル取得

ファイル保存の流れ

実装例

store()/storeAs()

UploadedFile::store()メソッド

標準形

引数が''の場合

引数にディレクトリーを指定

第2引数にディスクを指定

UploadedFile::storeAs()メソッド

ファイルのパスのデータベース登録

概要

基本例

機能

ルーティング

コントローラー～フォーム表示

ビュー～フォームとファイル選択要素の設定

フォームで選択されたファイルの取得

バリデーション

フォームリクエスト

エラー表示

`$errors->all()`

`$errors->has('項目名')`と`$errors->first('項目名')`

`$errors->get('項目名')`

引数が`''`の場合