Laravel – ローカルスコープクエリー

2021-12-03 / tau / コメントする

概要

ローカルクエリースコープを使うと、特定モデルに必要なクエリービルダーに名前を付けて、1つのメソッドとして呼び出すことができる。

準備

クエリービルダーで使ったOrderとCustomerのモデルとテーブルを使う。

mysql> SELECT * FROM customers;
+----+-----------+
| id | name      |
+----+-----------+
|  1 | customer1 |
|  2 | customer2 |
|  3 | customer3 |
+----+-----------+
3 rows in set (0.00 sec)

mysql> SELECT * FROM orders;
+----+-------------+---------------------+---------------+
| id | customer_id | ordered_at          | item          |
+----+-------------+---------------------+---------------+
|  1 |           1 | 2020-06-05 00:00:00 | screw         |
|  2 |           2 | 2020-06-05 00:00:00 | rubber sheet  |
|  3 |           2 | 2020-06-06 00:00:00 | plastic plate |
|  4 |           1 | 2020-06-07 00:00:00 | rubber sheet  |
|  5 |           3 | 2020-06-08 00:00:00 | wire          |
+----+-------------+---------------------+---------------+
5 rows in set (0.00 sec)

mysql> SELECT * FROM customers;

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

| id | name |

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

| 1 | customer1 |

| 2 | customer2 |

| 3 | customer3 |

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

3 rows in set (0.00 sec)

mysql> SELECT * FROM orders;

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

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

| 1 | 1 | 2020-06-05 00:00:00 | screw |

| 2 | 2 | 2020-06-05 00:00:00 | rubber sheet |

| 3 | 2 | 2020-06-06 00:00:00 | plastic plate |

| 4 | 1 | 2020-06-07 00:00:00 | rubber sheet |

| 5 | 3 | 2020-06-08 00:00:00 | wire |

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

5 rows in set (0.00 sec)

それぞれのモデルでリレーションを定義している。

# Customerモデル

class Customer extends Model
{
    public $timestamps = false;

    public function email() {
        return $this->hasOne('App\Email');
    }

    public function orders() {
        return $this->hasMany('App\Order');
    }
}

# Orderモデル

class Order extends Model
{
    public $timestamps = false;

    public function customer() {
        return $this->belongsTo('App\Customer');
    }
}

# Customerモデル

class Customer extends Model

{

public $timestamps = false;

public function email() {

return $this->hasOne('App\Email');

}

public function orders() {

return $this->hasMany('App\Order');

}

# Orderモデル

class Order extends Model

{

public $timestamps = false;

public function customer() {

return $this->belongsTo('App\Customer');

}

手順

ローカルスコープのクエリービルダーは、次の手順で定義する。

対象のモデルでメソッド定義
- 'scope'に続いてキャメルケースでメソッド名を定義
- 第1引数にクエリー($queryなど)
- ビルダーに引数を渡したいときは第2引数以降に加える
- メソッド内の戻り値は、第1引数のクエリーに対してビルダーを組んだ結果を渡す
定義したメソッドをビルダーの様に呼び出す
- 呼び出す際は'scope'を除いたメソッド名で呼び出す

例1：引数なし

たとえばordersの最新3データのみ取り出す定形操作があるとする。このとき、Orderモデルで以下の様にメソッドを定義する。

メソッド名は頭に'scope'を付けてscopeLatest3()として、クエリーを受け取る引数に$queryを設定。

class Order extends Model
{
    public $timestamps = false;

    public function customer() {
        return $this->belongsTo('App\Customer');
    }

    public function scopeLatest3($query) {
        return $query->latest('ordered_at')->limit(3);
    }
}

class Order extends Model

{

public $timestamps = false;

public function customer() {

return $this->belongsTo('App\Customer');

}

public function scopeLatest3($query) {

return $query->latest('ordered_at')->limit(3);

}

tinkerでこれを利用してみる。呼び出す際は’scope’を付けずにlatest3()とし、$queryに対応する引数は渡す必要はない。

>>> Order::latest3()->get()
=> Illuminate\Database\Eloquent\Collection {#4315
     all: [
       App\Order {#4311
         id: 5,
         customer_id: 3,
         ordered_at: "2020-06-08 00:00:00",
         item: "wire",
       },
       App\Order {#4321
         id: 4,
         customer_id: 1,
         ordered_at: "2020-06-07 00:00:00",
         item: "rubber sheet",
       },
       App\Order {#4328
         id: 3,
         customer_id: 2,
         ordered_at: "2020-06-06 00:00:00",
         item: "plastic plate",
       },
     ],
   }

>>> Order::latest3()->get()

=> Illuminate\Database\Eloquent\Collection {#4315

all: [

App\Order {#4311

id: 5,

customer_id: 3,

ordered_at: "2020-06-08 00:00:00",

item: "wire",

App\Order {#4321

id: 4,

customer_id: 1,

ordered_at: "2020-06-07 00:00:00",

item: "rubber sheet",

App\Order {#4328

id: 3,

customer_id: 2,

ordered_at: "2020-06-06 00:00:00",

item: "plastic plate",

}

生成されるSQLは以下のとおり。

>>> Order::latest3()->toSql()
=> "select * from `orders` order by `ordered_at` desc limit 3"

1 2	>>> Order::latest3()->toSql() => "select * from `orders` order by `ordered_at` desc limit 3"

例2：引数を渡す場合

モデルでのメソッド定義の第2引数以下に、渡したい引数を列挙する。以下の例ではcustomer_idを渡し、これに合致するordersのデータを抽出している。

実行時に渡したい引数は、第2引数custome_idで定義している。

    public function scopeOfCustomer($query, $customer_id) {
        return $query->where('customer_id', '=', $customer_id);
    }

public function scopeOfCustomer($query, $customer_id) {

return $query->where('customer_id', '=', $customer_id);

}

tinkerで引数にcustoer_id=1を渡して実行してみる。

>>> Order::ofCustomer(1)->get()
=> Illuminate\Database\Eloquent\Collection {#4323
     all: [
       App\Order {#4324
         id: 1,
         customer_id: 1,
         ordered_at: "2020-06-05 00:00:00",
         item: "screw",
       },
       App\Order {#4326
         id: 4,
         customer_id: 1,
         ordered_at: "2020-06-07 00:00:00",
         item: "rubber sheet",
       },
     ],
   }

>>> Order::ofCustomer(1)->get()

=> Illuminate\Database\Eloquent\Collection {#4323

all: [

App\Order {#4324

id: 1,

customer_id: 1,

ordered_at: "2020-06-05 00:00:00",

item: "screw",

App\Order {#4326

id: 4,

customer_id: 1,

ordered_at: "2020-06-07 00:00:00",

item: "rubber sheet",

}

生成されるSQLとバインドされる値は以下のとおり。

>>> Order::ofCustomer(1)->toSql()
=> "select * from `orders` where `customer_id` = ?"
>>> Order::ofCustomer(1)->getBindings()
=> [
     1,
   ]

>>> Order::ofCustomer(1)->toSql()

=> "select * from `orders` where `customer_id` = ?"

>>> Order::ofCustomer(1)->getBindings()

=> [

]

例3：子モデルが絡む場合

ビルダーに引数を渡して、子モデルの条件で抽出したい場合。whereHas()を使うが、引数に渡すクロージャ―の変数はローカルスコープのため、useで引数の変数を受け取って渡す。

    public function scopeOfCustomerName($query, $name) {
        return $query->whereHas('customer',
            function($query) use($name) {
                $query->where('name', '=', $name);
            }
        );
    }

public function scopeOfCustomerName($query, $name) {

return $query->whereHas('customer',

function($query) use($name) {

$query->where('name', '=', $name);

}

);

}

tinkerでcustomer_name='customer2'を渡して確認。

>>> Order::ofCustomerName('customer2')->get()
=> Illuminate\Database\Eloquent\Collection {#4317
     all: [
       App\Order {#4329
         id: 2,
         customer_id: 2,
         ordered_at: "2020-06-05 00:00:00",
         item: "rubber sheet",
       },
       App\Order {#4313
         id: 3,
         customer_id: 2,
         ordered_at: "2020-06-06 00:00:00",
         item: "plastic plate",
       },
     ],
   }

>>> Order::ofCustomerName('customer2')->get()

=> Illuminate\Database\Eloquent\Collection {#4317

all: [

App\Order {#4329

id: 2,

customer_id: 2,

ordered_at: "2020-06-05 00:00:00",

item: "rubber sheet",

App\Order {#4313

id: 3,

customer_id: 2,

ordered_at: "2020-06-06 00:00:00",

item: "plastic plate",

}

生成されるSQLとバインドされる値は以下のとおり。

>>> Order::ofCustomerName('customer2')->toSql()
=> "select * from `orders` where exists (select * from `customers` where `orders`.`customer_id` = `customers`.`id` and `name` = ?)"
>>> Order::ofCustomerName('customer2')->getBindings()
=> [
     "customer2",
   ]

>>> Order::ofCustomerName('customer2')->toSql()

=> "select * from `orders` where exists (select * from `customers` where `orders`.`customer_id` = `customers`.`id` and `name` = ?)"

>>> Order::ofCustomerName('customer2')->getBindings()

=> [

"customer2",

]

Laravel – ANDとORの優先順位

2021-12-02 / tau / コメントする

概要

where()とorWhere()組み合わせることで、WHERE句のANDやORを表現できる。ここではこれらのメソッドの書き方と生成されるSQL、条件の組み合わせの優先順位を整理する。

以下のようなメソッドの書き方が可能になる。

条件1 OR 条件2 AND 条件3でANDが優先される書き方
(条件1 OR 条件2) AND 条件3で括弧内のORが優先される書き方

where()やorWhere()については、クエリービルダーのメソッドを参照。

準備

クエリービルダーで使った以下の3つのテーブルで各メソッドを確認する。

mysql> SELECT * FROM customers;
+----+-----------+
| id | name      |
+----+-----------+
|  1 | customer1 |
|  2 | customer2 |
|  3 | customer3 |
+----+-----------+
3 rows in set (0.00 sec)

mysql> SELECT * FROM emails;
+----+-------------+--------------------+
| id | customer_id | email              |
+----+-------------+--------------------+
|  1 |           1 | customer1@mail.com |
|  2 |           2 | customer2@mail.com |
+----+-------------+--------------------+
2 rows in set (0.00 sec)

mysql> SELECT * FROM orders;
+----+-------------+---------------------+---------------+
| id | customer_id | ordered_at          | item          |
+----+-------------+---------------------+---------------+
|  1 |           1 | 2020-06-05 00:00:00 | screw         |
|  2 |           2 | 2020-06-05 00:00:00 | rubber sheet  |
|  3 |           2 | 2020-06-06 00:00:00 | plastic plate |
|  4 |           1 | 2020-06-07 00:00:00 | rubber sheet  |
|  5 |           3 | 2020-06-08 00:00:00 | wire          |
+----+-------------+---------------------+---------------+
5 rows in set (0.00 sec)

mysql> SELECT * FROM customers;

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

| id | name |

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

| 1 | customer1 |

| 2 | customer2 |

| 3 | customer3 |

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

3 rows in set (0.00 sec)

mysql> SELECT * FROM emails;

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

| id | customer_id | email |

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

| 1 | 1 | customer1@mail.com |

| 2 | 2 | customer2@mail.com |

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

2 rows in set (0.00 sec)

mysql> SELECT * FROM orders;

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

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

| 1 | 1 | 2020-06-05 00:00:00 | screw |

| 2 | 2 | 2020-06-05 00:00:00 | rubber sheet |

| 3 | 2 | 2020-06-06 00:00:00 | plastic plate |

| 4 | 1 | 2020-06-07 00:00:00 | rubber sheet |

| 5 | 3 | 2020-06-08 00:00:00 | wire |

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

5 rows in set (0.00 sec)

これをordersに対してcustomersとemailsを左結合で関連付けて並べると以下のとおり。

mysql> SELECT
    ->   o.id, o.ordered_at, o.item, c.id, c.name, e.address
    -> FROM orders AS o
    -> LEFT JOIN customers AS c ON o.customer_id = c.id
    -> LEFT JOIN emails AS e ON c.id = e.customer_id;
+----+---------------------+---------------+------+-----------+--------------------+
| id | ordered_at          | item          | id   | name      | address            |
+----+---------------------+---------------+------+-----------+--------------------+
|  1 | 2020-06-05 00:00:00 | screw         |    1 | customer1 | customer1@mail.com |
|  2 | 2020-06-05 00:00:00 | rubber sheet  |    2 | customer2 | customer2@mail.com |
|  3 | 2020-06-06 00:00:00 | plastic plate |    2 | customer2 | customer2@mail.com |
|  4 | 2020-06-07 00:00:00 | rubber sheet  |    1 | customer1 | customer1@mail.com |
|  5 | 2020-06-08 00:00:00 | wire          |    3 | customer3 | NULL               |
+----+---------------------+---------------+------+-----------+--------------------+
5 rows in set (0.00 sec)

mysql> SELECT

-> o.id, o.ordered_at, o.item, c.id, c.name, e.address

-> FROM orders AS o

-> LEFT JOIN customers AS c ON o.customer_id = c.id

-> LEFT JOIN emails AS e ON c.id = e.customer_id;

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

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

| 1 | 2020-06-05 00:00:00 | screw | 1 | customer1 | customer1@mail.com |

| 2 | 2020-06-05 00:00:00 | rubber sheet | 2 | customer2 | customer2@mail.com |

| 3 | 2020-06-06 00:00:00 | plastic plate | 2 | customer2 | customer2@mail.com |

| 4 | 2020-06-07 00:00:00 | rubber sheet | 1 | customer1 | customer1@mail.com |

| 5 | 2020-06-08 00:00:00 | wire | 3 | customer3 | NULL |

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

5 rows in set (0.00 sec)

チェーンの展開とANDの優先

where()やorWhere()をチェーンで連ねた場合、それぞれの条件が単純にANDあるいはORで連ねられる。その結果ANDが処理された後ORが処理される。

...->where(条件)は'... AND 条件'
...->orWhere(条件)は'... OR 条件'

以下の例では、where()->orWhere()->where()とメソッドチェーンを組んでいる。

        $orders = Order::where('item', '=', 'wire')
            ->orWhere('item', '=', 'rubber sheet')
            ->where('customer_id', '=', 1)->get();

$orders = Order::where('item', '=', 'wire')

->orWhere('item', '=', 'rubber sheet')

->where('customer_id', '=', 1)->get();

上記のクエリービルダーで生成されるSQLは以下のとおり。

>>> Order::where('item', '=', 'wire')->
... orWhere('item', '=', 'rubber sheet')->
... where('customer_id', '=', 1)->toSql()
=> "select * from `orders` where `item` = ? or `item` = ? and `customer_id` = ?"

>>> Order::where('item', '=', 'wire')->

... orWhere('item', '=', 'rubber sheet')->

... where('customer_id', '=', 1)->toSql()

=> "select * from `orders` where `item` = ? or `item` = ? and `customer_id` = ?"

この結果AND演算が優先され、「item='wire'または、item='rubber sheet'かつid=1」という条件で2つのデータが抽出される。

4: 2020-06-07 00:00:00
- customer name: customer1
- email address: customer1@mail.com
- ordered item : rubber sheet
5: 2020-06-08 00:00:00
- customer name: customer3
- email address:
- ordered item : wire

クロージャによる（）の表現

ANDに対してORの条件を優先させたい場合、SQLでは括弧で括る。クエリービルダーでは、括弧で括りたい処理をクロージャ―でまとめる。

where(function($query) { 括弧でまとめたい処理群; })

以下の例では、上の例と順番は同じだが、最初のwhere()とorWhere()をクロージャ―でまとめている。

        $orders = Order::where(function($q) {
            $q->where('item', '=', 'wire')
            ->orWhere('item', '=', 'rubber sheet');
        })->Where('customer_id', '=', 1)->get();

$orders = Order::where(function($q) {

$q->where('item', '=', 'wire')

->orWhere('item', '=', 'rubber sheet');

})->Where('customer_id', '=', 1)->get();

この結果、まず最初の2項のOR演算が処理され、その結果と残りの条件のAND演算で抽出処理される。生成されるSQLは以下のとおりでOR演算が括弧で括られている。

>>> Order::where(function($q) {
...   $q->where('item', '=', 'wire')
...     ->orWhere('item', '=', 'rubber sheet');
... })->Where('customer_id', '=', 1)->toSql();
=> "select * from `orders` where (`item` = ? or `item` = ?) and `customer_id` =

>>> Order::where(function($q) {

... $q->where('item', '=', 'wire')

... ->orWhere('item', '=', 'rubber sheet');

... })->Where('customer_id', '=', 1)->toSql();

=> "select * from `orders` where (`item` = ? or `item` = ?) and `customer_id` =

実行結果は以下のとおりで、「item='wire'またはitem='rubber sheet'」で3つのデータが抽出され、その結果とid=1のANDで結果が一つに絞り込まれる。

4: 2020-06-07 00:00:00
- customer name: customer1
- email address: customer1@mail.com
- ordered item : rubber sheet

Laravel – リレーション／クエリー

2021-12-01 / tau / コメントする

リレーション

複数テーブルで構成されるデータを、モデルベースで扱う方法
モデルでhasOne()、hasMany()、belongsTo()メソッドによってリレーションを定義
親モデルに属する子モデルを、親モデルの属性のように扱えるようになる

クエリービルダー
 クエリービルダーのメソッド

SQLによりフレームワークではなくRDBMS側でテーブルの連結や絞り込みなどの操作を行う
クエリービルダーメソッドを組み合わせてSQLを生成する

ANDとORの優先順位

WHERE条件でANDとORを組み合わせる場合の書き方
where()とorWhere()の優先順位とクロージャ―による括弧の実装

クエリービルダーとリレーション

クエリービルダーの効率性と、リレーションによる直感的な操作を組み合わせる手順

子モデルの属性による絞り込み

子モデルの属性の条件による絞り込みを、クエリービルダーで行う方法
whereHas()メソッドを使う

ローカルスコープクエリー

特定モデルで利用するクエリービルダーを、モデルのメソッドとして定義する

Laravel – 子テーブルの条件で絞り込み

2021-12-01 / tau / 1件のコメント

概要

複数テーブルが関連付けられているデータを子テーブルの条件で絞り込みたい場合。クエリービルダーのJOIN句によってテーブルを結合すると結果は配列となるが、配列ではなくオブジェクトのままリレーションで操作したいとき。

whereHas()メソッドを使うと、親のモデルでhasMany()で定義された子モデルの操作が可能になる。

親モデル::whereHas('子モデル', function($query) {
    $query->where('子モデルの属性', '演算子', '値');
])->get();

親モデル::whereHas('子モデル', function($query) {

$query->where('子モデルの属性', '演算子', '値');

])->get();

whereHas()の使い方は以下のとおり。

第1引数で子モデル名を指定
第2引数にクエリーを引数としたコールバックを定義
- コールバックで引数のクエリーに対してクエリービルダーメソッドを適用
最後のget()を忘れがちなので注意

準備

クエリービルダーの確認で使ったテーブルで確認する。

mysql> SELECT * FROM customers;
+----+-----------+
| id | name      |
+----+-----------+
|  1 | customer1 |
|  2 | customer2 |
|  3 | customer3 |
+----+-----------+
3 rows in set (0.00 sec)

mysql> SELECT * FROM emails;
+----+-------------+--------------------+
| id | customer_id | email              |
+----+-------------+--------------------+
|  1 |           1 | customer1@mail.com |
|  2 |           2 | customer2@mail.com |
+----+-------------+--------------------+
2 rows in set (0.00 sec)

mysql> SELECT * FROM orders;
+----+-------------+---------------------+---------------+
| id | customer_id | ordered_at          | item          |
+----+-------------+---------------------+---------------+
|  1 |           1 | 2020-06-05 00:00:00 | screw         |
|  2 |           2 | 2020-06-05 00:00:00 | rubber sheet  |
|  3 |           2 | 2020-06-06 00:00:00 | plastic plate |
|  4 |           1 | 2020-06-07 00:00:00 | rubber sheet  |
|  5 |           3 | 2020-06-08 00:00:00 | wire          |
+----+-------------+---------------------+---------------+
5 rows in set (0.00 sec)

mysql> SELECT * FROM customers;

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

| id | name |

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

| 1 | customer1 |

| 2 | customer2 |

| 3 | customer3 |

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

3 rows in set (0.00 sec)

mysql> SELECT * FROM emails;

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

| id | customer_id | email |

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

| 1 | 1 | customer1@mail.com |

| 2 | 2 | customer2@mail.com |

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

2 rows in set (0.00 sec)

mysql> SELECT * FROM orders;

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

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

| 1 | 1 | 2020-06-05 00:00:00 | screw |

| 2 | 2 | 2020-06-05 00:00:00 | rubber sheet |

| 3 | 2 | 2020-06-06 00:00:00 | plastic plate |

| 4 | 1 | 2020-06-07 00:00:00 | rubber sheet |

| 5 | 3 | 2020-06-08 00:00:00 | wire |

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

5 rows in set (0.00 sec)

1つ先のリレーション

親が直接持つ子モデルの場合、以下の様に記述する。ここでは子モデルのcustomerの名前が'customer2'のデータを抽出している。

抽出結果は親モデルのコレクションとしてビューに渡している。

    public function relation() {
        $orders = Order::whereHas('customer', function($query){
            $query->where('name', '=', 'customer2');
        })->get();

        return view('queries.relation', [
            'title' => 'Query Test',
            'orders' => $orders,
        ]);
    }

public function relation() {

$orders = Order::whereHas('customer', function($query){

$query->where('name', '=', 'customer2');

})->get();

return view('queries.relation', [

'title' => 'Query Test',

'orders' => $orders,

]);

}

モデルのコレクションを受け取ったビューでは、親モデルとしてこれらを扱い、必要に応じてリレーションによって子モデルの属性を取り出す。

emailを持たないcustomerに対応するため、optional()メソッドを使っている。

    <ol>
      @foreach ($orders as $order)
        <li>{{ $order->ordered_at }}: {{ $order->customer->name }}</li>
        <ul>
          <li>e-mail: {{ optional($order->customer->email)->address }}</li>
          <li>item: {{ $order->item }}</li>
        </ul>
      @endforeach
    </ol>

<ol>

@foreach ($orders as $order)

<li>{{ $order->ordered_at }}: {{ $order->customer->name }}</li>

<ul>

<li>e-mail: {{ optional($order->customer->email)->address }}</li>

<li>item: {{ $order->item }}</li>

</ul>

@endforeach

</ol>

結果は以下のとおりで、customer.id=2に相当するcustomer2のデータが抽出されている。

2020-06-05 00:00:00: customer2
- e-mail: customer2@mail.com
- item: rubber sheet
2020-06-06 00:00:00: customer2
- e-mail: customer2@mail.com
- item: plastic plate

whereHas()で生成されるSQLを確認しておく。where句の対象としてサブクエリーが構成されている(見やすいように結果を改行している)。

>>> Order::whereHas('customer', function($query){
...     $query->where('name', '=', 'customer2');
... })->toSql();
=> "select * from `orders` where exists (
      select * from `customers` where `orders`.`customer_id` = `customers`.`id` and `name` = ?)"

>>> Order::whereHas('customer', function($query){

... $query->where('name', '=', 'customer2');

... })->toSql();

=> "select * from `orders` where exists (

select * from `customers` where `orders`.`customer_id` = `customers`.`id` and `name` = ?)"

バインドされる値も確認。

>>> Order::whereHas('customer', function($query){
...     $query->where('name', '=', 'customer2');
... })->getBindings();
=> [
     "customer2",
   ]

>>> Order::whereHas('customer', function($query){

... $query->where('name', '=', 'customer2');

... })->getBindings();

=> [

"customer2",

]

2つ先のリレーション

子モデルの子モデルの属性で絞り込む場合は、whereHas()のコールバック内でwhereHas()を入れ子で呼び出す。呼び出し部分だけを取り出すと以下のとおり。

コールバックの引数は、コールバック内ローカルスコープなので同じ名前でも構わない。

        $orders = Order::whereHas('customer', function($q) {
            $q->whereHas('email', function($q) {
                $q->where('address', 'LIKE', 'customer2%');
            });
        })->get();

$orders = Order::whereHas('customer', function($q) {

$q->whereHas('email', function($q) {

$q->where('address', 'LIKE', 'customer2%');

});

})->get();

結果は以下のとおりで、メールアドレスが'customer2'で始まるcustomer2のみ取り出されている。

2020-06-05 00:00:00: customer2
- e-mail: customer2@mail.com
- item: rubber sheet
2020-06-06 00:00:00: customer2
- e-mail: customer2@mail.com
- item: plastic plate

生成されるSQLを確認。サブクエリーが入れ子で構成されている。

>>> $orders = Order::whereHas('customer', function($q) {
...     $q->whereHas('email', function($q) {
...         $q->where('address', 'LIKE', 'customer2%');
...     });
... })->toSql();
=> "select * from `orders` where exists (
      select * from `customers` where `orders`.`customer_id` = `customers`.`id` and exists (
        select * from `emails` where `customers`.`id` = `emails`.`customer_id` and `address` LIKE ?))"

>>> $orders = Order::whereHas('customer', function($q) {

... $q->whereHas('email', function($q) {

... $q->where('address', 'LIKE', 'customer2%');

... });

... })->toSql();

=> "select * from `orders` where exists (

select * from `customers` where `orders`.`customer_id` = `customers`.`id` and exists (

select * from `emails` where `customers`.`id` = `emails`.`customer_id` and `address` LIKE ?))"

バインドされる値も確認。

>>> $orders = Order::whereHas('customer', function($q) {
...     $q->whereHas('email', function($q) {
...         $q->where('address', 'LIKE', 'customer2%');
...     });
... })->getBindings();
=> [
     "customer2%",
   ]

>>> $orders = Order::whereHas('customer', function($q) {

... $q->whereHas('email', function($q) {

... $q->where('address', 'LIKE', 'customer2%');

... });

... })->getBindings();

=> [

"customer2%",

]

Laravel – クエリービルダーとリレーション

2021-11-29 / tau / コメントする

概要

Laravelでデータベースの大量のデータを扱う場合、クエリービルダーでSQLを発行してDBMS側でデータを絞り込んだ方がフレームワークの負担が少なくなる。

一方でリレーションに基づいた記述は、可読性やメンテナンスの面で有利な面を持つ。

そこで、クエリービルダーとリレーションの組み合わせについて試してみた。

モデルクラスのall()メソッドとwhere()のチェーンによる絞り込みは、DBMSの機能を使っておらず非効率ではないか
モデルクラスで記述するクエリービルダーは、DBMS側でデータを絞り込んだ結果をフレームワークで扱うので効率的なようだ
DBファサードで記述するクエリービルダーは、得られるデータがモデルのインスタンスではなく連想配列になるため、モデルで定義したリレーションが使えない

準備

クエリービルダーで使ったものと同じデータを準備する。

mysql> SELECT * FROM customers;
+----+-----------+
| id | name      |
+----+-----------+
|  1 | customer1 |
|  2 | customer2 |
|  3 | customer3 |
+----+-----------+
3 rows in set (0.00 sec)

mysql> SELECT * FROM emails;
+----+-------------+--------------------+
| id | customer_id | email              |
+----+-------------+--------------------+
|  1 |           1 | customer1@mail.com |
|  2 |           2 | customer2@mail.com |
+----+-------------+--------------------+
2 rows in set (0.00 sec)

mysql> SELECT * FROM orders;
+----+-------------+---------------------+---------------+
| id | customer_id | ordered_at          | item          |
+----+-------------+---------------------+---------------+
|  1 |           1 | 2020-06-05 00:00:00 | screw         |
|  2 |           2 | 2020-06-05 00:00:00 | rubber sheet  |
|  3 |           2 | 2020-06-06 00:00:00 | plastic plate |
|  4 |           1 | 2020-06-07 00:00:00 | rubber sheet  |
|  5 |           3 | 2020-06-08 00:00:00 | wire          |
+----+-------------+---------------------+---------------+
5 rows in set (0.00 sec)

mysql> SELECT * FROM customers;

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

| id | name |

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

| 1 | customer1 |

| 2 | customer2 |

| 3 | customer3 |

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

3 rows in set (0.00 sec)

mysql> SELECT * FROM emails;

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

| id | customer_id | email |

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

| 1 | 1 | customer1@mail.com |

| 2 | 2 | customer2@mail.com |

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

2 rows in set (0.00 sec)

mysql> SELECT * FROM orders;

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

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

| 1 | 1 | 2020-06-05 00:00:00 | screw |

| 2 | 2 | 2020-06-05 00:00:00 | rubber sheet |

| 3 | 2 | 2020-06-06 00:00:00 | plastic plate |

| 4 | 1 | 2020-06-07 00:00:00 | rubber sheet |

| 5 | 3 | 2020-06-08 00:00:00 | wire |

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

5 rows in set (0.00 sec)

all()とwhere()の組み合わせ

以下の様なコントローラーのアクションでデータを絞り込んでビューに渡す。

    public function query_relation() {
        $orders = Order::all()->where('customer_id', '=', 2);

        return view('queries.query_relation', [
            'title' => 'Query Test',
            'orders' => $orders,
        ]);
    }

public function query_relation() {

$orders = Order::all()->where('customer_id', '=', 2);

return view('queries.query_relation', [

'title' => 'Query Test',

'orders' => $orders,

]);

}

ビュー側では$ordersを受け取って、リレーションに基づいて表示する。

    <ol>
      @foreach ($orders as $order)
        <li>{{ $order->ordered_at }}: {{ $order->customer->name }}</li>
        <ul>
          <li>e-mail: {{ optional($order->customer->email)->address }}</li>
          <li>item: {{ $order->item }}</li>
        </ul>
      @endforeach
    </ol>

<ol>

@foreach ($orders as $order)

<li>{{ $order->ordered_at }}: {{ $order->customer->name }}</li>

<ul>

<li>e-mail: {{ optional($order->customer->email)->address }}</li>

<li>item: {{ $order->item }}</li>

</ul>

@endforeach

</ol>

ブラウザーでの表示は以下のとおり。

2020-06-05 00:00:00: customer2
- e-mail: customer2@mail.com
- item: rubber sheet
2020-06-06 00:00:00: customer2
- e-mail: customer2@mail.com
- item: plastic plate

ただしこの場合の動作は、DBMSから全データをall()で取得した後にcustomer_idで絞り込んでいる。以下の様にtinkerで確認してみると、where句を含むSQLは発行されていないようだ。

>>> Order::all()->where('customer_id', '=', 2)->toSql()
BadMethodCallException with message 'Method Illuminate\Database\Eloquent\Collection::toSql does not exist.'

1 2	>>> Order::all()->where('customer_id', '=', 2)->toSql() BadMethodCallException with message 'Method Illuminate\Database\Eloquent\Collection::toSql does not exist.'

実際、get()なしで直接モデルのインスタンスが得られている。tinkerで確認してみると、$ordersはOrderクラスのインスタンスを要素とするコレクションとなっている。

>>> Order::all()->where('customer_id', '=', 2)
=> Illuminate\Database\Eloquent\Collection {#4341
     all: [
       1 => App\Order {#4332
         id: 2,
         customer_id: 2,
         ordered_at: "2020-06-05 00:00:00",
         item: "rubber sheet",
       },
       2 => App\Order {#4344
         id: 3,
         customer_id: 2,
         ordered_at: "2020-06-06 00:00:00",
         item: "plastic plate",
       },
     ],
   }

>>> Order::all()->where('customer_id', '=', 2)

=> Illuminate\Database\Eloquent\Collection {#4341

all: [

1 => App\Order {#4332

id: 2,

customer_id: 2,

ordered_at: "2020-06-05 00:00:00",

item: "rubber sheet",

2 => App\Order {#4344

id: 3,

customer_id: 2,

ordered_at: "2020-06-06 00:00:00",

item: "plastic plate",

}

モデルのメソッドによるクエリービルダー

コントローラーのアクションで、以下の様にOrderモデルからクエリービルダーを構成する。

    public function query_relation() {
        $orders = Order::where('customer_id', '=', 2)->get();

        return view('queries.query_relation', [
            'title' => 'Query Test',
            'orders' => $orders,
        ]);
    }

public function query_relation() {

$orders = Order::where('customer_id', '=', 2)->get();

return view('queries.query_relation', [

'title' => 'Query Test',

'orders' => $orders,

]);

}

ビューは上と同じ内容で、結果も同じように表示される。

tinkerで確認するとSQLが構成されて値もバインドされているので、DBMS側でデータが絞り込まれているようだ。

>>> Order::where('customer_id', '=', 2)->toSql()
=> "select * from `orders` where `customer_id` = ?"
>>> Order::where('customer_id', '=', 2)->getBindings()
=> [
     2,
   ]

>>> Order::where('customer_id', '=', 2)->toSql()

=> "select * from `orders` where `customer_id` = ?"

>>> Order::where('customer_id', '=', 2)->getBindings()

=> [

]

get()の結果得られるデータは上記のall()～where()と同じで、Orderクラスのインスタンスを要素とするコレクション。

>>> Order::where('customer_id', '=', 2)->get()
=> Illuminate\Database\Eloquent\Collection {#4343
     all: [
       App\Order {#4327
         id: 2,
         customer_id: 2,
         ordered_at: "2020-06-05 00:00:00",
         item: "rubber sheet",
       },
       App\Order {#4312
         id: 3,
         customer_id: 2,
         ordered_at: "2020-06-06 00:00:00",
         item: "plastic plate",
       },
     ],
   }

>>> Order::where('customer_id', '=', 2)->get()

=> Illuminate\Database\Eloquent\Collection {#4343

all: [

App\Order {#4327

id: 2,

customer_id: 2,

ordered_at: "2020-06-05 00:00:00",

item: "rubber sheet",

App\Order {#4312

id: 3,

customer_id: 2,

ordered_at: "2020-06-06 00:00:00",

item: "plastic plate",

}

DBファサードによるクエリービルダー

クエリビルダ―をモデルクラスからではなくDBファサードから記述した場合。

    public function query_relation() {
        $orders = DB::table('orders')->where('customer_id', '=', 2)->get();

        return view('queries.query_relation', [
            'title' => 'Query Test',
            'orders' => $orders,
        ]);
    }

public function query_relation() {

$orders = DB::table('orders')->where('customer_id', '=', 2)->get();

return view('queries.query_relation', [

'title' => 'Query Test',

'orders' => $orders,

]);

}

同じビューを使った場合、以下のようなエラーがブラウザーに表示される。

ErrorException
Undefined property: stdClass::$customer (View:
/home/vagrant/git/codecamp/laravel/laravel_tutorial/resources/views/queries/query_relation.blade.php)

ErrorException

Undefined property: stdClass::$customer (View:

/home/vagrant/git/codecamp/laravel/laravel_tutorial/resources/views/queries/query_relation.blade.php)

tinkerで確認すると、SQLは同じように発行されバインディングも同じ。

>>> DB::table('orders')->where('customer_id', '=', 2)->toSql()
=> "select * from `orders` where `customer_id` = ?"
>>> DB::table('orders')->where('customer_id', '=', 2)->getBindings()
=> [
     2,
   ]

>>> DB::table('orders')->where('customer_id', '=', 2)->toSql()

=> "select * from `orders` where `customer_id` = ?"

>>> DB::table('orders')->where('customer_id', '=', 2)->getBindings()

=> [

]

ただし、get()で得られるデータが上と異なる。全体は配列だが、要素がOrderクラスのインスタンスではなく、Orderの属性をキーとする連想配列となっている。

>>> DB::table('orders')->where('customer_id', '=', 2)->get()
=> Illuminate\Support\Collection {#4337
     all: [
       {#4351
         +"id": 2,
         +"customer_id": 2,
         +"ordered_at": "2020-06-05 00:00:00",
         +"item": "rubber sheet",
       },
       {#4324
         +"id": 3,
         +"customer_id": 2,
         +"ordered_at": "2020-06-06 00:00:00",
         +"item": "plastic plate",
       },
     ],
   }

>>> DB::table('orders')->where('customer_id', '=', 2)->get()

=> Illuminate\Support\Collection {#4337

all: [

{#4351

+"id": 2,

+"customer_id": 2,

+"ordered_at": "2020-06-05 00:00:00",

+"item": "rubber sheet",

{#4324

+"id": 3,

+"customer_id": 2,

+"ordered_at": "2020-06-06 00:00:00",

+"item": "plastic plate",

}

このため、$ordersの要素からリレーションを定義したはずのcustomerを呼び出そうとしても、「定義されていない属性」としてエラーが発生する。

そこでビュー側でリレーションを用いず各要素を連想配列として取り出してみる。

    @foreach ($orders as $order)
      <ol>
      @foreach ($order as $key => $value)
        <li>{{ $key }}: {{ $value }}</li>
      @endforeach
      </ol>
    @endforeach

@foreach ($orders as $order)

<ol>

@foreach ($order as $key => $value)

<li>{{ $key }}: {{ $value }}</li>

@endforeach

</ol>

@endforeach

こうすると以下の様に$ordersの抽出結果が表示される。

id: 2
customer_id: 2
ordered_at: 2020-06-05 00:00:00
item: rubber sheet

id: 3
customer_id: 2
ordered_at: 2020-06-06 00:00:00
item: plastic plate

ただし各要素のorderに関係づけられたcustomerはこのままでは得られないため、クエリーレベルで2次元配列として関連する全モデルの属性をカラムとして取り出す必要がありそうだ。

Laravel – クエリービルダー

2021-11-29 / tau / コメントする

準備

以下の3つのテーブルを使ってクエリービルダーの動作を確認する。

mysql> SELECT * FROM customers;
+----+-----------+
| id | name      |
+----+-----------+
|  1 | customer1 |
|  2 | customer2 |
|  3 | customer3 |
+----+-----------+
3 rows in set (0.00 sec)

mysql> SELECT * FROM emails;
+----+-------------+--------------------+
| id | customer_id | email              |
+----+-------------+--------------------+
|  1 |           1 | customer1@mail.com |
|  2 |           2 | customer2@mail.com |
+----+-------------+--------------------+
2 rows in set (0.00 sec)

mysql> SELECT * FROM orders;
+----+-------------+---------------------+---------------+
| id | customer_id | ordered_at          | item          |
+----+-------------+---------------------+---------------+
|  1 |           1 | 2020-06-05 00:00:00 | screw         |
|  2 |           2 | 2020-06-05 00:00:00 | rubber sheet  |
|  3 |           2 | 2020-06-06 00:00:00 | plastic plate |
|  4 |           1 | 2020-06-07 00:00:00 | rubber sheet  |
|  5 |           3 | 2020-06-08 00:00:00 | wire          |
+----+-------------+---------------------+---------------+
5 rows in set (0.00 sec)

mysql> SELECT * FROM customers;

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

| id | name |

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

| 1 | customer1 |

| 2 | customer2 |

| 3 | customer3 |

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

3 rows in set (0.00 sec)

mysql> SELECT * FROM emails;

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

| id | customer_id | email |

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

| 1 | 1 | customer1@mail.com |

| 2 | 2 | customer2@mail.com |

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

2 rows in set (0.00 sec)

mysql> SELECT * FROM orders;

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

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

| 1 | 1 | 2020-06-05 00:00:00 | screw |

| 2 | 2 | 2020-06-05 00:00:00 | rubber sheet |

| 3 | 2 | 2020-06-06 00:00:00 | plastic plate |

| 4 | 1 | 2020-06-07 00:00:00 | rubber sheet |

| 5 | 3 | 2020-06-08 00:00:00 | wire |

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

5 rows in set (0.00 sec)

3つのテーブルを結合させるSQLの例。

SELECT
  orders.id,
  orders.ordered_at,
  orders.customer_id,
  customers.name,
  emails.email
FROM orders
LEFT JOIN customers
  ON orders.customer_id = customers.id
LEFT JOIN emails
  ON customers.id = emails.customer_id;

SELECT

orders.id,

orders.ordered_at,

orders.customer_id,

customers.name,

emails.email

FROM orders

LEFT JOIN customers

ON orders.customer_id = customers.id

LEFT JOIN emails

ON customers.id = emails.customer_id;

SQLの実行結果。

+----+---------------------+-------------+-----------+--------------------+
| id | ordered_at          | customer_id | name      | email              |
+----+---------------------+-------------+-----------+--------------------+
|  1 | 2020-06-05 00:00:00 |           1 | customer1 | customer1@mail.com |
|  2 | 2020-06-05 00:00:00 |           2 | customer2 | customer2@mail.com |
|  3 | 2020-06-06 00:00:00 |           2 | customer2 | customer2@mail.com |
|  4 | 2020-06-07 00:00:00 |           1 | customer1 | customer1@mail.com |
|  5 | 2020-06-08 00:00:00 |           3 | customer3 | NULL               |
+----+---------------------+-------------+-----------+--------------------+
5 rows in set (0.00 sec)

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

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

| 1 | 2020-06-05 00:00:00 | 1 | customer1 | customer1@mail.com |

| 2 | 2020-06-05 00:00:00 | 2 | customer2 | customer2@mail.com |

| 3 | 2020-06-06 00:00:00 | 2 | customer2 | customer2@mail.com |

| 4 | 2020-06-07 00:00:00 | 1 | customer1 | customer1@mail.com |

| 5 | 2020-06-08 00:00:00 | 3 | customer3 | NULL |

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

5 rows in set (0.00 sec)

基本操作

tinkerで確認する。

$ php artisan tinker
Psy Shell v0.10.8 (PHP 7.3.29 — cli) by Justin Hileman
>>>

$ php artisan tinker

Psy Shell v0.10.8 (PHP 7.3.29 — cli) by Justin Hileman

>>>

ビルダーの書き方

DBファサードのtableメソッド

DBファサードのtable()メソッドを使う場合。

>>> DB::table('customers')->select('*')->toSql()
=> "select * from `customers`"

1 2	>>> DB::table('customers')->select('')->toSql() => "select from `customers`"

モデルのビルダーメソッド

モデルのビルダーメソッドを直接実行する場合。

>>> Customer::select('*')->toSql()
[!] Aliasing 'Customer' to 'App\Customer' for this Tinker session.
=> "select * from `customers`"

>>> Customer::select('*')->toSql()

[!] Aliasing 'Customer' to 'App\Customer' for this Tinker session.

=> "select * from `customers`"

ビルダーのインスタンスを保存して使う

DBファサードのtable()メソッドの場合、tinkerだと以下のように詳細な内容が表示される。toSql()メソッドで構築されるSQLが確認できる。

>>> $builder = DB::table('customers')->select('*')
=> Illuminate\Database\Query\Builder {#4332
     +connection: Illuminate\Database\MySqlConnection {#4316},
     +grammar: Illuminate\Database\Query\Grammars\MySqlGrammar {#4317},
     +processor: Illuminate\Database\Query\Processors\MySqlProcessor {#4319},
     +bindings: [
       "select" => [],
       "from" => [],
       "join" => [],
     ........
     +useWritePdo: false,
   }
>>> $builder->toSql()
=> "select * from `customers`"

>>> $builder = DB::table('customers')->select('*')

=> Illuminate\Database\Query\Builder {#4332

+connection: Illuminate\Database\MySqlConnection {#4316},

+grammar: Illuminate\Database\Query\Grammars\MySqlGrammar {#4317},

+processor: Illuminate\Database\Query\Processors\MySqlProcessor {#4319},

+bindings: [

"select" => [],

"from" => [],

"join" => [],

........

+useWritePdo: false,

}

>>> $builder->toSql()

=> "select * from `customers`"

モデルからビルダーメソッドを直接呼び出す場合、tinkerでのインスタンスは表示はシンプルになる。

>>> $builder = Customer::select('*')
=> Illuminate\Database\Eloquent\Builder {#4324}
>>> $builder->toSql()
=> "select * from `customers`"

>>> $builder = Customer::select('*')

=> Illuminate\Database\Eloquent\Builder {#4324}

>>> $builder->toSql()

=> "select * from `customers`"

SQLや実行結果などの取得・確認方法

ビルダーのインスタンス取得

クエリービルダーを実行すると、ビルダーのインスタンスが得られる。

>>> $builder = Customer::whereIn('id', [1, 2])
=> Illuminate\Database\Eloquent\Builder {#4350}

1 2	>>> $builder = Customer::whereIn('id', [1, 2]) => Illuminate\Database\Eloquent\Builder {#4350}

get()～実行結果の取得

クエリービルダーの実行結果はget()メソッドで得る。

>>> $builder->get()
=> Illuminate\Database\Eloquent\Collection {#4329
     all: [
       App\Customer {#4333
         id: 1,
         name: "customer1",
       },
       App\Customer {#4348
         id: 2,
         name: "customer2",
       },
     ],
   }

>>> $builder->get()

=> Illuminate\Database\Eloquent\Collection {#4329

all: [

App\Customer {#4333

id: 1,

App\Customer {#4348

id: 2,

}

toSql()～SQLの確認

toSql()メソッドでビルダーで生成されるSQLを確認できる。

>>> $builder->toSql()
=> "select * from `customers` where `id` in (?, ?)"

1 2	>>> $builder->toSql() => "select * from `customers` where `id` in (?, ?)"

getBindings()～バインドされる値の確認

バインドされる値はgetBindings()メソッドで確認できる。

>>> $builder->getBindings()
=> [
     1,
     2,
   ]

>>> $builder->getBindings()

=> [

]

クエリービルダーメソッドのチェーン

複数のコマンドを含むSQLの場合は、コマンドに対応するクエリービルダーメソッドをチェーンで繋げる。

>>> Customer::select('name')->whereIn('id', [1, 2])->orderBy('id', 'desc')->get()
=> Illuminate\Database\Eloquent\Collection {#4335
     all: [
       App\Customer {#4347
         name: "customer2",
       },
       App\Customer {#4299
         name: "customer1",
       },
     ],
   }

>>> Customer::select('name')->whereIn('id', [1, 2])->orderBy('id', 'desc')->get()

=> Illuminate\Database\Eloquent\Collection {#4335

all: [

App\Customer {#4347

App\Customer {#4299

}

メソッドチェーンの順番は問わない。以下のようにメソッドの順番を変えても、生成されるSQLは同じ。

>>> Customer::select('name')->whereIn('id', [1, 2])->orderBy('id', 'desc')->toSql()
=> "select `name` from `customers` where `id` in (?, ?) order by `id` desc"
>>> Customer::orderBy('id', 'desc')->whereIn('id', [1, 2])->select('name')->toSql()
=> "select `name` from `customers` where `id` in (?, ?) order by `id` desc"

>>> Customer::select('name')->whereIn('id', [1, 2])->orderBy('id', 'desc')->toSql()

=> "select `name` from `customers` where `id` in (?, ?) order by `id` desc"

>>> Customer::orderBy('id', 'desc')->whereIn('id', [1, 2])->select('name')->toSql()

=> "select `name` from `customers` where `id` in (?, ?) order by `id` desc"

コントローラーでの記述

基本の書き方

以下のルーティングで基本の書き方を確認。

Route::get('/query_simple', 'QueryController@query_simple');

1	Route::get('/query_simple', 'QueryController@query_simple');

コントローラーでの書き方。DBファサードを使う例。

customersテーブルのnameカラムの値を取得している
結果は配列customersで各要素は2つの要素id、nameを持つ連想配列となる
$customersをビューに渡している

?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;

use Illuminate\Support\Facades\DB;
use App\Customer;

class QueryController extends Controller
{
    public function query_simple() {
        $customers = DB::table('customers')->select('id', 'name')->get();
        
        return view('queries.query_simple', [
            'title' => 'Query Test',
            'customers' => $customers,
        ]);
    }
}

?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;

use Illuminate\Support\Facades\DB;

use App\Customer;

class QueryController extends Controller

{

public function query_simple() {

$customers = DB::table('customers')->select('id', 'name')->get();

return view('queries.query_simple', [

'title' => 'Query Test',

'customers' => $customers,

]);

}

ビューでは受け取った$customersの各要素を取り出し、idとnameを表示。

<!DOCTYPE html>
<html lang="ja" dir="ltr">
  <head>
    <meta charset="utf-8">
    <title>{{ $title }}</title>
  </head>
  <body>
    <h1>{{ $title }}</h1>
    @foreach ($customers as $customer)
      <p>{{ $customer->id }}: {{ $customer->name }}</p>
    @endforeach
  </body>
</html>

<!DOCTYPE html>

<head>

<title>{{ $title }}</title>

</head>

<body>

<h1>{{ $title }}</h1>

@foreach ($customers as $customer)

<p>{{ $customer->id }}: {{ $customer->name }}</p>

@endforeach

</body>

</html>

なおdd()で表示させた$customersの内容は以下のとおり。

Illuminate\Support\Collection {#1274 ▼
  #items: array:3 [▼
    0 => {#1275 ▼
      +"id": 1
      +"name": "customer1"
    }
    1 => {#1278 ▼
      +"id": 2
      +"name": "customer2"
    }
    2 => {#1279 ▼
      +"id": 3
      +"name": "customer3"
    }
  ]
}

Illuminate\Support\Collection {#1274 ▼

#items: array:3 [▼

0 => {#1275 ▼

+"id": 1

+"name": "customer1"

}

1 => {#1278 ▼

+"id": 2

+"name": "customer2"

}

2 => {#1279 ▼

+"id": 3

+"name": "customer3"

}

]

}

メソッドチェーン

SQLの行が増えてきた場合、メソッドチェーンでビルダーメソッドを繋げる。

まず以下のようなルーティングを定義。

Route::get('/query_joined', 'QueryController@query_joined');

1	Route::get('/query_joined', 'QueryController@query_joined');

コントローラーのアクション内でメソッドチェーンを記述。以下の例では、冒頭のLEFT JOINを使ったSQLを意図している。

なお本筋ではないが、select()メソッドの要素内でASによるエイリアスを定義できる。

class QueryController extends Controller
{
    ........
    public function query_joined() {
        $orders = DB::table('orders')
            ->select(
                'orders.ordered_at',
                'customers.name AS customer_name',
                'emails.email',
                'orders.item')
            ->leftjoin('customers', 'orders.customer_id', '=', 'customers.id')
            ->leftJoin('emails', 'customers.id', '=', 'emails.customer_id')
            ->get();

        return view('queries.query_joined', [
            'title' => 'Query Test',
            'orders' => $orders,
        ]);
    }
    ........
}

class QueryController extends Controller

{

........

public function query_joined() {

$orders = DB::table('orders')

->select(

'orders.ordered_at',

'customers.name AS customer_name',

'emails.email',

'orders.item')

->leftjoin('customers', 'orders.customer_id', '=', 'customers.id')

->leftJoin('emails', 'customers.id', '=', 'emails.customer_id')

->get();

return view('queries.query_joined', [

'title' => 'Query Test',

'orders' => $orders,

]);

}

........

}

メソッドチェーンでSQLをビルドした場合、結果は指定したカラムを持つ複数レコードが2次元配列で返される。

以下はビューで受け取った$ordersを表示させる例。foreachで1レコードに相当する連想配列を取り出し、ネストしたforeachで各レコードの属性・内容の対を取り出して表示させている。

    @foreach ($orders as $order)
      <ol>
      @foreach ($order as $key => $value)
        <li>{{ $key }}: {{ $value }}</li>
      @endforeach
      </ol>
    @endforeach

@foreach ($orders as $order)

<ol>

@foreach ($order as $key => $value)

<li>{{ $key }}: {{ $value }}</li>

@endforeach

</ol>

@endforeach

ブラウザーには以下の様に表示される。

ordered_at: 2020-06-05 00:00:00
customer_name: customer1
address: customer1@mail.com
item: screw

ordered_at: 2020-06-05 00:00:00
customer_name: customer2
address: customer2@mail.com
item: rubber sheet

ordered_at: 2020-06-06 00:00:00
customer_name: customer2
address: customer2@mail.com
item: plastic plate

ordered_at: 2020-06-07 00:00:00
customer_name: customer1
address: customer1@mail.com
item: rubber sheet

ordered_at: 2020-06-08 00:00:00
customer_name: customer3
address:
item: wire

モデルのリレーション設定に基づく場合

クエリービルダーのメソッドチェーンへの対比として、同じデータをモデル間のリレーション定義に基づいて操作する例を示す。

Customer、Email、Orderの各モデルにリレーションに関する記述を追加する。

# Customerモデル

class Customer extends Model
{
    public $timestamps = false;

    public function email() {
        return $this->hasOne('App\Email');
    }

    public function orders() {
        return $this->hasMany('App\Order');
    }
}

# Emailモデル

class Email extends Model
{
    public $timestamps = false;

    public function customer() {
        return $this->belongsTo('App\Customer');
    }
}
# Orderモデル

class Order extends Model
{
    public $timestamps = false;

    public function customer() {
        return $this->belongsTo('App\Customer');
    }
}

# Customerモデル

class Customer extends Model

{

public $timestamps = false;

public function email() {

return $this->hasOne('App\Email');

}

public function orders() {

return $this->hasMany('App\Order');

}

# Emailモデル

class Email extends Model

{

public $timestamps = false;

public function customer() {

return $this->belongsTo('App\Customer');

}

# Orderモデル

class Order extends Model

{

public $timestamps = false;

public function customer() {

return $this->belongsTo('App\Customer');

}

コントローラーではOrderモデルの全データを取り込み、ビューに渡す。

class QueryController extends Controller
{
    ........
    public function query_relation() {
        $orders = Order::all();

        return view('queries.query_relation', [
            'title' => 'Query Test',
            'orders' => $orders,
        ]);
    }
}

class QueryController extends Controller

{

........

public function query_relation() {

$orders = Order::all();

return view('queries.query_relation', [

'title' => 'Query Test',

'orders' => $orders,

]);

}

ビューでは受け取った$ordersから要素を順に取り出して、関連付けられたデータを表示させる。関連付けられたデータがない場合のエラーを防ぐため、optional()ヘルパーを使っている。

  <body>
    <h1>{{ $title }}</h1>
    <ol>
      @foreach ($orders as $order)
        <li>{{ $order->ordered_at }}: {{ $order->customer->name }}</li>
        <ul>
          <li>e-mail: {{ optional($order->customer->email)->address }}</li>
          <li>item: {{ $order->item }}</li>
        </ul>
      @endforeach
    </ol>
  </body>

<body>

<h1>{{ $title }}</h1>

<ol>

@foreach ($orders as $order)

<li>{{ $order->ordered_at }}: {{ $order->customer->name }}</li>

<ul>

<li>e-mail: {{ optional($order->customer->email)->address }}</li>

<li>item: {{ $order->item }}</li>

</ul>

@endforeach

</ol>

</body>

ブラウザーには以下の様に出力される。emailが存在しない場合は無表示となっている。

2020-06-05 00:00:00: customer1
- e-mail: customer1@mail.com
- item: screw
2020-06-05 00:00:00: customer2
- e-mail: customer2@mail.com
- item: rubber sheet
2020-06-06 00:00:00: customer2
- e-mail: customer2@mail.com
- item: plastic plate
2020-06-07 00:00:00: customer1
- e-mail: customer1@mail.com
- item: rubber sheet
2020-06-08 00:00:00: customer3
- e-mail:
- item: wire

なおdd()で表示させた$ordersの内容は以下のとおり。1つ目の要素のみ展開している。

Illuminate\Database\Eloquent\Collection {#1288 ▼
  #items: array:5 [▼
    0 => App\Order {#1289 ▼
      +timestamps: false
      #connection: "mysql"
      #table: "orders"
      #primaryKey: "id"
      #keyType: "int"
      +incrementing: true
      #with: []
      #withCount: []
      #perPage: 15
      +exists: true
      +wasRecentlyCreated: false
      #attributes: array:4 [▼
        "id" => 1
        "customer_id" => 1
        "ordered_at" => "2020-06-05 00:00:00"
        "item" => "screw"
      ]
      #original: array:4 [▶]
      #changes: []
      #casts: []
      #dates: []
      #dateFormat: null
      #appends: []
      #dispatchesEvents: []
      #observables: []
      #relations: []
      #touches: []
      #hidden: []
      #visible: []
      #fillable: []
      #guarded: array:1 [▶]
    }
    1 => App\Order {#1290 ▶}
    2 => App\Order {#1291 ▶}
    3 => App\Order {#1292 ▶}
    4 => App\Order {#1293 ▶}
  ]
}

Illuminate\Database\Eloquent\Collection {#1288 ▼

#items: array:5 [▼

0 => App\Order {#1289 ▼

+timestamps: false

#connection: "mysql"

#table: "orders"

#primaryKey: "id"

#keyType: "int"

+incrementing: true

#with: []

#withCount: []

#perPage: 15

+exists: true

+wasRecentlyCreated: false

#attributes: array:4 [▼

"id" => 1

"customer_id" => 1

"ordered_at" => "2020-06-05 00:00:00"

"item" => "screw"

]

#original: array:4 [▶]

#changes: []

#casts: []

#dates: []

#dateFormat: null

#appends: []

#dispatchesEvents: []

#observables: []

#relations: []

#touches: []

#hidden: []

#visible: []

#fillable: []

#guarded: array:1 [▶]

}

1 => App\Order {#1290 ▶}

2 => App\Order {#1291 ▶}

3 => App\Order {#1292 ▶}

4 => App\Order {#1293 ▶}

]

}

クエリービルダーとリレーション

クエリービルダーでSQLを発行すると、フレームワークに負担をかけずにDBMS側でデータを絞り込めるが、その方法によっては意図した動作にならなかったり、リレーションを使えない場合がある。

結論としてはモデルクラスでクエリービルダーを記述するのがよさそうだが、その詳細についてはこちらにまとめた。

クエリービルダーでのエイリアス

クエリービルダーでSQLと同様にエイリアスを定義できる。クエリービルダーでのエイリアスを参照。

Laravel – Trying to get property ‘…’ of non-object

2021-11-29 / tau / コメントする

Trying to get property ‘address’ of non-object

Laravelで複数のモデル／テーブルを関連付けて表示させようとしたところ、「オブジェクトでもないものから属性を得ようとした」というエラーが表示された。

エラー発生の流れ

以下のような構造の顧客とメールアドレスのテーブルを(マイグレーションで)準備して、

mysql> DESCRIBE customers;
+-------+-----------------+------+-----+---------+----------------+
| Field | Type            | Null | Key | Default | Extra          |
+-------+-----------------+------+-----+---------+----------------+
| id    | bigint unsigned | NO   | PRI | NULL    | auto_increment |
| name  | varchar(255)    | NO   |     | NULL    |                |
+-------+-----------------+------+-----+---------+----------------+
2 rows in set (0.01 sec)

mysql> DESCRIBE emails;
+-------------+-----------------+------+-----+---------+----------------+
| Field       | Type            | Null | Key | Default | Extra          |
+-------------+-----------------+------+-----+---------+----------------+
| id          | bigint unsigned | NO   | PRI | NULL    | auto_increment |
| customer_id | bigint unsigned | NO   | MUL | NULL    |                |
| address     | varchar(255)    | YES  |     | NULL    |                |
+-------------+-----------------+------+-----+---------+----------------+
3 rows in set (0.01 sec)

mysql> DESCRIBE customers;

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

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

| id | bigint unsigned | NO | PRI | NULL | auto_increment |

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

2 rows in set (0.01 sec)

mysql> DESCRIBE emails;

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

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

| id | bigint unsigned | NO | PRI | NULL | auto_increment |

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

3 rows in set (0.01 sec)

以下の様にデータを準備して、

mysql> SELECT * FROM customers;
+----+-----------+
| id | name      |
+----+-----------+
|  1 | customer1 |
|  2 | customer2 |
|  3 | customer3 |
+----+-----------+
3 rows in set (0.00 sec)

mysql> SELECT * FROM emails;
+----+-------------+--------------------+
| id | customer_id | address            |
+----+-------------+--------------------+
|  1 |           1 | customer1@mail.com |
|  2 |           2 | customer2@mail.com |
+----+-------------+--------------------+
2 rows in set (0.00 sec)

mysql> SELECT * FROM customers;

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

| id | name |

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

| 1 | customer1 |

| 2 | customer2 |

| 3 | customer3 |

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

3 rows in set (0.00 sec)

mysql> SELECT * FROM emails;

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

| id | customer_id | address |

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

| 1 | 1 | customer1@mail.com |

| 2 | 2 | customer2@mail.com |

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

2 rows in set (0.00 sec)

モデルでリレーションを定義して、

# Customerモデルの内容

class Customer extends Model
{
    public $timestamps = false;

    public function email() {
        return $this->hasOne('App\Email');
    }
}

# Emailモデルの内容

class Email extends Model
{
    public $timestamps = false;

    public function customer() {
        return $this->belongsTo('App\Customer');
    }
}

# Customerモデルの内容

class Customer extends Model

{

public $timestamps = false;

public function email() {

return $this->hasOne('App\Email');

}

# Emailモデルの内容

class Email extends Model

{

public $timestamps = false;

public function customer() {

return $this->belongsTo('App\Customer');

}

コントローラーでCustomerの全データをビューに渡して、

    public function query_relation() {
        $customers = Customer::all();

        return view('queries.query_relation', [
            'title' => 'Query Test',
            'customers' => $customers,
        ]);
    }

public function query_relation() {

$customers = Customer::all();

return view('queries.query_relation', [

'title' => 'Query Test',

'customers' => $customers,

]);

}

ビューで各customersに関連付けられたemailsのaddressを読もうとすると、

@foreach ($customers as $customer)
  <p>{{ $customer->email->address }}</p>
@endforeach

@foreach ($customers as $customer)

<p>{{ $customer->email->address }}</p>

@endforeach

ブラウザーにエラーが表示された。

ErrorException
Trying to get property 'address' of non-object (View: ....resources/views/queries/query_relation.blade.php)
http://localhost:3000/query_relation

ErrorException

Trying to get property 'address' of non-object (View: ....resources/views/queries/query_relation.blade.php)

http://localhost:3000/query_relation

原因

以下の様に、customer3に対してはemailsのレコードがなく、戻り値がnullとなるので、そこからaddressを得ることができないため。

mysql> SELECT * FROM customers LEFT JOIN emails ON customers.id = customer_id;
+----+-----------+------+-------------+--------------------+
| id | name      | id   | customer_id | address            |
+----+-----------+------+-------------+--------------------+
|  1 | customer1 |    1 |           1 | customer1@mail.com |
|  2 | customer2 |    2 |           2 | customer2@mail.com |
|  3 | customer3 | NULL |        NULL | NULL               |
+----+-----------+------+-------------+--------------------+
3 rows in set (0.00 sec)

mysql> SELECT * FROM customers LEFT JOIN emails ON customers.id = customer_id;

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

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

| 1 | customer1 | 1 | 1 | customer1@mail.com |

| 2 | customer2 | 2 | 2 | customer2@mail.com |

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

3 rows in set (0.00 sec)

対処法

@issetディレクティブ

@issetで参照結果がnullかどうかを判定。

      @foreach ($customers as $customer)
        @isset($customer->email)
        <p>
          {{ $customer->name}}:
          {{ $customer->email['address'] }}
        </p>
        @endisset
      @endforeach

@foreach ($customers as $customer)

@isset($customer->email)

<p>

{{ $customer->name}}:

</p>

@endisset

@endforeach

emailsのレコードを持たないcusutomersのレコードは、@issetによってnullが無視されるため表示されないが、emailに関する2行目だけを@issetで囲めばnameだけは表示される。

customer1: customer1@mail.com

customer2: customer2@mail.com

customer1: customer1@mail.com

customer2: customer2@mail.com

連想配列の要素として指定

オブジェクトの属性ではなく、連想配列の要素として読み出す。

      @foreach ($customers as $customer)
        <p>
          {{ $customer->name}}:
          {{ $customer->email['address'] }}
        </p>
      @endforeach

@foreach ($customers as $customer)

<p>

{{ $customer->name}}:

</p>

@endforeach

参照しようとする配列がnullの場合、要素指定して読みだした結果はnullとなる。customersのレコードは全て表示され、emailsのレコードがnullの場合はemailsの情報だけ表示されない。

customer1: customer1@mail.com

customer2: customer2@mail.com

customer3:

customer1: customer1@mail.com

customer2: customer2@mail.com

customer3:

optional()ヘルパー

optional()の引数の内容がnullの場合、その属性参照はエラーとならずに属性の参照結果がnullとなる。

      @foreach ($customers as $customer)
        <p>
          {{ $customer->name}}:
          {{ optional($customer->email)->address }}
        </p>
      @endforeach

@foreach ($customers as $customer)

<p>

{{ $customer->name}}:

</p>

@endforeach

ブラウザーの表示結果は上と同じ。

customer1: customer1@mail.com

customer2: customer2@mail.com

customer3:

customer1: customer1@mail.com

customer2: customer2@mail.com

customer3:

なお、optional()は1段先の参照結果までは保証できるが、3段目以降には作用しない。必要ならoptional()を入れ子にしなければならない。

null合体演算子との組み合わせ

PHPのnull合体演算子を使って、結果がnullの場合の内容を定義できる。

      @foreach ($customers as $customer)
        <p>
          {{ $customer->name}}:
          {{ optional($customer->email)->address ?? '未定義です' }}
        </p>
      @endforeach

@foreach ($customers as $customer)

<p>

{{ $customer->name}}:

</p>

@endforeach

以下の様に、ブラウザー上で適切な表現が可能になる。

customer1: customer1@mail.com

customer2: customer2@mail.com

customer3: 未定義です

customer1: customer1@mail.com

customer2: customer2@mail.com

customer3: 未定義です

PHP – null合体演算子

2021-11-29 / tau / コメントする

null合体演算子(null coalesce operator)は、opr1 ?? opr2の形をとり、以下の様に結果を返す。

左辺opr1の評価結果がnullでない場合は評価結果をそのまま返す
左辺opr1の評価結果がnullの場合は右辺opr2を返す

>>> 1 + 2 ?? 'Resula is null'
=> 3
>>> null ?? 'Result is NULL'
=> "Result is NULL"

>>> 1 + 2 ?? 'Resula is null'

=> 3

>>> null ?? 'Result is NULL'

=> "Result is NULL"

変数の場合。未定義だとnullで第2オペランドが、定義済みだとその内容が返る。

>>> $var ?? 'Resula is null'
=> "Resula is null"
>>> $var = 3
=> 3
>>> $var ?? 'Resula is null'
=> 3

>>> $var ?? 'Resula is null'

=> "Resula is null"

>>> $var = 3

=> 3

>>> $var ?? 'Resula is null'

=> 3

??単独の演算子ではなく、左辺の評価対象と右辺の戻り値を含めて戻り値を持つ式に相当し、三項演算子と似ている。

Laravel – マイグレーション – カラムの追加

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

概要

マイグレーションによって生成されたテーブルに、新たにカラムを追加する。

テーブルを生成するマイグレーションファイルの前までロールバックしてファイル修正、再マイグレートという方法もあるが、ここでは新たにマイグレーションファイルを作成して追加カラムのみ処理する方法を整理する。

追加前

以下のマイグレーションファイルを準備する。

<?php

use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;

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

            // 商品名
            $table->string('name');
            // 価格
            $table->integer('price');

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

    public function down()
    {
        Schema::dropIfExists('items');
    }
}

<?php

use Illuminate\Database\Migrations\Migration;

use Illuminate\Database\Schema\Blueprint;

use Illuminate\Support\Facades\Schema;

class CreateItemsTable extends Migration

{

public function up()

{

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

$table->bigIncrements('id');

// 商品名

$table->string('name');

// 価格

$table->integer('price');

//$table->timestamps();

$table->datetime('created_at');

$table->datetime('updated_at');

});

}

public function down()

{

Schema::dropIfExists('items');

}

マイグレーション実行後に生成されたテーブルの構造は以下のとおり。

mysql> DESCRIBE items;
+------------+-----------------+------+-----+---------+----------------+
| Field      | Type            | Null | Key | Default | Extra          |
+------------+-----------------+------+-----+---------+----------------+
| id         | bigint unsigned | NO   | PRI | NULL    | auto_increment |
| name       | varchar(255)    | NO   |     | NULL    |                |
| price      | int             | NO   |     | NULL    |                |
| created_at | datetime        | NO   |     | NULL    |                |
| updated_at | datetime        | NO   |     | NULL    |                |
+------------+-----------------+------+-----+---------+----------------+
5 rows in set (0.00 sec)

mysql> DESCRIBE items;

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

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

| id | bigint unsigned | NO | PRI | NULL | auto_increment |

| price | int | NO | | NULL | |

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

5 rows in set (0.00 sec)

追加マイグレーションファイル

以下のコマンドでカラムを追加するためのマイグレーションファイルを新たに作成。

$ php artisan make:migration add_columnd_to_items --table=items
Created Migration: 2021_11_10_230552_add_columnd_to_items

1 2	$ php artisan make:migration add_columnd_to_items --table=items Created Migration: 2021_11_10_230552_add_columnd_to_items

以下の様にファイルを編集。

up()メソッドで追加するカラムを定義
down()メソッドで追加したカラムを削除する処理を記述

<?php

use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;

class AddColumndToItems extends Migration
{
    /**
     * Run the migrations.
     *
     * @return void
     */
    public function up()
    {
        Schema::table('items', function (Blueprint $table) {
            // 追加するカラムを定義
            $table->string('comment')->default('');
            $table->string('image')->default('');
        });
    }

    /**
     * Reverse the migrations.
     *
     * @return void
     */
    public function down()
    {
        Schema::table('items', function (Blueprint $table) {
            // 追加したカラムを削除
            $table->dropColumn('comment');
            $table->dropColumn('image');
        });
    }
}

<?php

use Illuminate\Database\Migrations\Migration;

use Illuminate\Database\Schema\Blueprint;

use Illuminate\Support\Facades\Schema;

class AddColumndToItems extends Migration

{

/**

* Run the migrations.

* @return void

public function up()

{

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

// 追加するカラムを定義

$table->string('comment')->default('');

$table->string('image')->default('');

});

}

/**

* Reverse the migrations.

* @return void

public function down()

{

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

// 追加したカラムを削除

$table->dropColumn('comment');

$table->dropColumn('image');

});

}

追加マイグレーションの確認

新たに作成したマイグレーションファイルに基づいてマイグレーションを実行。

$ php artisan migrate
Migrating: 2021_11_10_230552_add_columnd_to_items
Migrated:  2021_11_10_230552_add_columnd_to_items (0.03 seconds)

$ php artisan migrate

Migrating: 2021_11_10_230552_add_columnd_to_items

Migrated: 2021_11_10_230552_add_columnd_to_items (0.03 seconds)

以下の様に、2つのカラムが追加されている。

mysql> DESCRIBE items;
+------------+-----------------+------+-----+---------+----------------+
| Field      | Type            | Null | Key | Default | Extra          |
+------------+-----------------+------+-----+---------+----------------+
| id         | bigint unsigned | NO   | PRI | NULL    | auto_increment |
| name       | varchar(255)    | NO   |     | NULL    |                |
| price      | int             | NO   |     | NULL    |                |
| created_at | datetime        | NO   |     | NULL    |                |
| updated_at | datetime        | NO   |     | NULL    |                |
| comment    | varchar(255)    | NO   |     |         |                |
| image      | varchar(255)    | NO   |     |         |                |
+------------+-----------------+------+-----+---------+----------------+
7 rows in set (0.00 sec)

mysql> DESCRIBE items;

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

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

| id | bigint unsigned | NO | PRI | NULL | auto_increment |

| price | int | NO | | NULL | |

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

7 rows in set (0.00 sec)

ロールバックの確認

カラムを追加したマイグレーションの1ステップのみロールバック。

$ php artisan migrate:rollback --step=1
Rolling back: 2021_11_10_230552_add_columnd_to_items
Rolled back:  2021_11_10_230552_add_columnd_to_items (0.08 seconds)

$ php artisan migrate:rollback --step=1

Rolling back: 2021_11_10_230552_add_columnd_to_items

Rolled back: 2021_11_10_230552_add_columnd_to_items (0.08 seconds)

down()メソッドにより、追加されたカラムが削除されている。

mysql> DESCRIBE items;
+------------+-----------------+------+-----+---------+----------------+
| Field      | Type            | Null | Key | Default | Extra          |
+------------+-----------------+------+-----+---------+----------------+
| id         | bigint unsigned | NO   | PRI | NULL    | auto_increment |
| name       | varchar(255)    | NO   |     | NULL    |                |
| price      | int             | NO   |     | NULL    |                |
| created_at | datetime        | NO   |     | NULL    |                |
| updated_at | datetime        | NO   |     | NULL    |                |
+------------+-----------------+------+-----+---------+----------------+
5 rows in set (0.00 sec)

mysql> DESCRIBE items;

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

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

| id | bigint unsigned | NO | PRI | NULL | auto_increment |

| price | int | NO | | NULL | |

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

5 rows in set (0.00 sec)

Laravel – バリデーション – uniqueの除外

2021-11-09 / tau / コメントする

概要

たとえば登録済みユーザーの情報(ユーザー名、メールアドレスなど)を編集・更新することを考える。

メールアドレスをログインIDとしている場合、登録時にはアドレスにuniqueのバリデーションルールを適用している。

ユーザー情報を編集する場合もメールアドレスには同様の制約をかけるが、アドレスを変更せずに他の項目を変更しようとしたとき、「既にデータベース上にアドレスが存在している」のでuniqueに対するバリデーションエラーとなる。

ここでは、その回避方法を整理する。

フォームリクエストの準備

作成

編集用のビューは別に作成済みで、ルーティングも設定されているとして、以下の様にフォームリクエストを作成したとする。

$ php artisan make:request UserProfileRequest
Request created successfully.

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

編集

フォームリクエストの実装の際、単にunique制約とする場合は以下の様になる。

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

    public function rules()
    {
        return [
            'name' => ['required', 'string', 'max:255'],
            'email' => [
                'required',
                'string',
                'email',
                'max:255', 
                'unique:users',
            ],
        ];
    }
}

class UserProfileRequest extends FormRequest

{

public function authorize()

{

return true;

}

public function rules()

{

return [

'name' => ['required', 'string', 'max:255'],

'email' => [

'required',

'string',

'email',

'max:255',

'unique:users',

];

}

バリデーションの適用

アクションの引数において、メソッドインジェクションでフォームリクエストを指定。

<?php

....
use \App\Http\Requests\UserProfileRequest;

class UserController extends Controller
{
    ....
    public function update(UserProfileRequest $request, User $user) {
        return 'update ' . $user->name;
    }
}

<?php

....

use \App\Http\Requests\UserProfileRequest;

class UserController extends Controller

{

....

public function update(UserProfileRequest $request, User $user) {

return 'update ' . $user->name;

}

ここでユーザー名を空白、メールアドレスは登録済みの元の値でバリデーションが行われると、エラーは以下の様になる。

The name field is required.

The email has already been taken.

The name field is required.

The email has already been taken.

uniqueルールの除外

uniqueのルールを課しながら、特定のデータについてこれを除外するために、以下の構文が使える。

Rule::unique('テーブル名')->ignore($this->モデル->id)

class UserProfileRequest extends FormRequest
{
    ....
    public function rules()
    {
        return [
            'name' => ['required', 'string', 'max:255'],
            'email' => [
                'required',
                'string',
                'email',
                'max:255', 
                Rule::unique('users')->ignore($this->user->id),
            ],
        ];
    }
}

class UserProfileRequest extends FormRequest

{

....

public function rules()

{

return [

'name' => ['required', 'string', 'max:255'],

'email' => [

'required',

'string',

'email',

'max:255',

Rule::unique('users')->ignore($this->user->id),

];

}

以下、バリエーション。

Request::unique('users')だけだと、'unique:users'と同じ
これにメソッドチェーンでignore($this->user->id)を付けると、ルートパラメーターの値をとってくる。
ignore($this->user)と直接オブジェクトで指定しても結果は同じ。

このようにすることで、自身のメールアドレスに関しては同じ内容が許容される。