Laravel – view()とredirect()

概要

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

view()

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

 

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

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

resources/views/products/index.blade.php

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

redirect()

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

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

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

 

 

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

概要

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

全てのエラー

$errors->all()

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

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

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

特定の項目のエラー

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

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

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

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

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

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

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

 

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

ファイル削除の流れ

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

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

実装例

ビュー

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

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

ルーティング

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

コントローラー

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

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

 

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

概要

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

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

公開領域

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

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

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

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

storage下のファイルの公開

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

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

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

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

コントローラー

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

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

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

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

ビュー

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

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

$pathの内容

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

asset(), url()によるURL

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

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

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

img要素のsrcの指定

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

 

 

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

概要

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

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

ファイル取得

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

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

ファイル保存の流れ

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

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

実装例

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

store()/storeAs()

UploadedFile::store()メソッド

標準形

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

引数が''の場合

ファイルパスの内容。

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

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

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

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

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

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

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

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

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

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

UploadedFile::storeAs()メソッド

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

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

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

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

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

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

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

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

 

Laravel – diskの場所

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

これらの第2引数や第3引数でdiskを指定することができるが、それがどの場所を指しているかは、アプリケーションディレクトリー下のconfig/filesystems.phpに書かれている。

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

 

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

概要

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

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

基本例

機能

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

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

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

ルーティング

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

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

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

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

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

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

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

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

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

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

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

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

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

バリデーション

フォームリクエスト

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

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

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

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

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

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

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

エラー表示

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

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

 

Laravel – リレーション

 

概要

Laravelでは、テーブル間のリレーションを設定することで、外部キーで関連付けられた複数のモデルを(外部キーを意識することなく)一貫して扱うことができる。

リレーションの種類と定義方法

リレーションはモデル定義で設定し、以下の3種類の何れかを設定する。

hasOne
1対1のリレーションの親のモデルで設定し、親データに属する子データのモデルとidを指定する。これにより親データから子データやそのプロパティーの参照が可能になる。
hasMany
1対nの親のモデルで設定し、親データに属する子データのモデルとidを指定する。これにより親データから子データのコレクション、要素インスタンスやそのプロパティーの参照が可能になる。
belongsTo
1対1、1対nとも子のモデルで設定し、子データが属する親データを指す外部キーと親のモデルを指定する。これにより子データから親データやそのプロパティーが参照可能になる。

いずれについてもモデルでの記述方法は同じで、たとえばhasManyを例にとると以下の様に書く。

子の参照名はモデル名のスモールケースで、hasOneの場合は単数形、hasManyの場合は複数形。

例えば親テーブルcustomersのデータが子テーブルemailsのデータを1つだけ持つ場合は以下の様に書く。

また、親テーブルcustomersのデータが子テーブルordersの複数のデータを持つ場合は以下の様に書く。

子テーブルのデータが親テーブルのデータに属することを設定するbelongsToでは、メソッド名は単数形。

リレーション設定後の参照方法

リレーションを設定すると、そのメソッド名と同じ名前のプロパティーによって親から子、子から親のモデルインスタンスを参照できるようになる。

先のCustomerEmailOrderの場合、以下の様に参照する。

子データが得られれば、以下の例の様にそのプロパティーも得ることができる。

挙動確認

準備

設定

挙動確認のため、3つのモデルとテーブルを作成する。

  • Customer
    • Auto Increment(AI)のid、顧客名、作成・更新日時を持つ
    • e-mailアドレスを1つだけ持つ
    • 複数の注文を持つ
  • Email
    • AIのid、e-mailアドレスを持つ顧客のid、アドレス、作成・更新日時を持つ
  • Order
    • AIのid、注文した顧客のid、注文品、作成・更新日時を持つ

モデル作成

artisanでCustomerEmailOrderの3つのモデルを、マイグレーションファイルとともに作成する。

timestampsの生成の抑制

本筋ではないが、ここではテーブル構造をシンプルにするため、デフォルトのtimestampsの生成を抑制している。

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

マイグレーションファイルを編集し、各テーブルの要素を追加する。なおタイムスタンプを省略するため、各マイグレーションファイルに自動で記述される$table->timestamps()は削除している。

customersテーブルには顧客名を追加記述する。

emailsテーブルには以下を追加記述する。

  • 親のcustomersテーブルのidを参照する外部キーcustomer_idと、メールアドレスemail
  • customer_id外部キー設定

ordersには以下を追加記述する。

  • 親のcustomersテーブルのidを参照する外部キーcustomer_idと、注文品名item
  • customer_id外部キー設定

マイグレーション

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

テーブル構造

生成された3つのテーブルは以下のとおり。

customersテーブル

emailsテーブル。

ordersテーブル。

リレーション設定

リレーションを各モデルで設定する。なおタイムスタンプを省略するため、各モデルで$timestampsfalseにセットする行を追加している。

Customerモデルでは、1対1でEmailを子に持つこと、1対nでOrderを子に持つことを設定。

EmailモデルではCustomerを親に持つことを設定。

OrderモデルではCustomerを親に持つことを設定。

テストデータ作成

tinkerでテストデータを作成し、データベースに登録する。

Customer

まずCustomerのデータを登録する。

3人の顧客データを登録。

Email

Emailのデータを、Customerの各データに関連付けながら登録する。ここではcustomer1customer2に紐づくデータを登録し、customer3のアドレスは未登録とする。

登録後のテーブルは以下のとおり。

Order

Orderのデータを、Customerの各データに関連付けながら登録する。ここではcustomer1に1つの、customer2に2つの注文があり、customer3からの注文はない状態とする。

登録後のテーブルは以下のとおりで、customer1はネジのオーダー1つ、customer2はゴムシートとプラスチック板で2つのオーダー。

リレーションを使った操作

親データを取得

まず3人の顧客のデータを取得する。

親からhasOneを取得

それぞれの顧客データから、hasOneで関連付けられたemailのインスタンスを取得する。$customer3emailは未登録なのでnullとなる。

親からhasManyを取得

それぞれの顧客データから、hasManyで関連付けられたorderのデータを取得する。

  • hasManyリレーションのデータは配列で得られる
  • データが1つの場合は要素数1の配列
  • 子データがない場合は空の配列

hasManyの場合、子データは配列で得られるので、要素指定やforeachなどで個々のデータを取り出す。

子データのプロパティーの取得

hasOnehasManyの子データが親データから得られれば、そのプロパティーを得ることもできる。

hasOneの子から親を取得

hasOneEmailが属するCustomerを取得する例。ここでは変数を介さず、生成したインスタンスから直接プロパティーを参照している。

hasManyの子から親を取得

hasManyで関連付けられた子のOrderから親のCustomerを取得する例。

親データのプロパティーの取得

子データから親データが得られれば、そのプロパティーも得ることができる。

 

Laravel – timestampsを抑制する

概要

Laraveのデフォルトでモデルとマイグレーションファイルを作成すると、マイグレーションファイルには$table->timestampsが自動的に記述され、マイグレートするとcreated_atupdated_atの2つのカラムがtimestamp型で定義される。

ここでは、これらのタイムスタンプを生成させない方法をまとめる。

  • マイグレーションファイルの該当文を削除orコメントアウト
  • モデルでタイムスタンプを生成させないよう記述を追加

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

マイグレーションファイル生成時に自動で記述される$table->timestamps()を削除するかコメントアウトする。

モデルへのタイムスタンプ抑制の記述

マイグレーションファイルからタイムスタンプの行を消しても、モデルをデータベースに登録しようとするとモデル側でタイムスタンプを生成し、データベースに対応するカラムがないとしてエラーになる。

そこで、モデルにタイムスタンプの生成を抑制する記述を追加する。

 

Laravel – timestampsの2038年問題

マイグレーションファイルでのtimestamp

Laravelでマイグレーションファイルを生成させると、timestampが自動的に設定されている。たとえばuserテーブルを生成するマイグレーションファイルは以下のとおり。

生成されるテーブルの構造は以下のとおりで、引数を与えないtimestamps()メソッドはcreated_atupdated_atの2つのカラムを生成する。

ところがMySQLのtimestampは2038年問題を回避できないので、安易にこのまま使うののではなく、これらをdatetime型に変更しておいた方が安全。

timestamp datetime
UTC内部表現で保持 タイムゾーン文字列で保持
1970-01-01 00:00:01UTC~2038-01-19 03:14:07UTC 1000-01-01 00:00:00~9999-12-31 23:59:59

マイグレーションファイルの修正

timestamps()を削除して、必要なら以下の2行に入れ替えるのが一方法。

このように設定すると、Laravelの方で作成日時と更新日時を自動的に更新してくれる(tinkerでのモデル操作を参照)。