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

1 概要
2 準備
3 手順
4 例1：引数なし
5 例2：引数を渡す場合
6 例3：子モデルが絡む場合

概要

ローカルクエリースコープを使うと、特定モデルに必要なクエリービルダーに名前を付けて、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",

]

TauStation

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

概要

準備

手順

例1：引数なし

例2：引数を渡す場合

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

コメントを残すコメントをキャンセル

概要

準備

手順

例1：引数なし

例2：引数を渡す場合

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

コメントを残す コメントをキャンセル

コメントを残すコメントをキャンセル