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

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

WordPress – QuickLatexのエラー

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

QuickLatexにエラー発生

2021年11月のある日、WordPressで作業していてQuickLatexでエラーが出てしまった。

*** QuickLaTeX cannot compile formula:

\begin{equation*}
\frac{d\boldsymbol{f}(\boldsymbol{x})^T}{d\boldsymbol{x}} =
\left[ \begin{array}{ccc}
\dfrac{\partial f_1}{\partial x_1} & \ldots & \dfrac{\partial f_n}{\partial x_1} \\
\vdots & \dfrac{\partial f_j}{\partial x_i} & \vdots \\
\dfrac{\partial f_1}{\partial x_m} & \ldots & \dfrac{\partial f_n}{\partial x_m} \\
\end{array} \right]
\end{equation*}

*** Error message:
Cannot connect to QuickLaTeX server: cURL error 60: SSL certificate problem: unable to get local issuer certificate
Please make sure your server/PHP settings allow HTTP requests to external resources ("allow_url_fopen", etc.)
These links might help in finding solution:
http://wordpress.org/extend/plugins/core-control/
http://wordpress.org/support/topic/an-unexpected-http-error-occurred-during-the-api-request-on-wordpress-3?replies=37

*** QuickLaTeX cannot compile formula:

\begin{equation*}

\frac{d\boldsymbol{f}(\boldsymbol{x})^T}{d\boldsymbol{x}} =

\left[ \begin{array}{ccc}

\dfrac{\partial f_1}{\partial x_1} & \ldots & \dfrac{\partial f_n}{\partial x_1} \\

\vdots & \dfrac{\partial f_j}{\partial x_i} & \vdots \\

\dfrac{\partial f_1}{\partial x_m} & \ldots & \dfrac{\partial f_n}{\partial x_m} \\

\end{array} \right]

\end{equation*}

*** Error message:

Cannot connect to QuickLaTeX server: cURL error 60: SSL certificate problem: unable to get local issuer certificate

Please make sure your server/PHP settings allow HTTP requests to external resources ("allow_url_fopen", etc.)

These links might help in finding solution:

http://wordpress.org/extend/plugins/core-control/

http://wordpress.org/support/topic/an-unexpected-http-error-occurred-during-the-api-request-on-wordpress-3?replies=37

certificateに関するエラーらしいがよくわからない。

下記サイトに対処方法が整理されていて助かった。感謝したい。

参考サイト：数樂管理人のブログ～Cannot connect to QuickLaTeX server:…

手順

古い証明書の退避

さくらサーバーにssh接続して、証明書ファイルの確認。

% ls www/wp1/wp-includes/certificates
ca-bundle.crt

% ls www/wp1/wp-includes/certificates

ca-bundle.crt

このca-bundle.crtを別の名前にリネーム(.bakを付けるなど)。

新しい証明書の導入

このgithubサイトのWordPressページに証明書の内容が掲載されているので、その内容でca-bundle.crtファイルをローカルに作成し、先のディレクトリーにアップロード。

これで元の様にQuickLatexがコンパイルされるようになった。

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)と直接オブジェクトで指定しても結果は同じ。

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

Laravel – ルートパラメーター～インスタンスを渡す

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

概要

ルートパラメーターは、idなどの値を指定するほか、モデルのインスタンスを直接渡してコントローラーで受け取ることができる。

値を渡して値を受け取る

ルーティング

以下の様にルーティングを設定したとする。

Requeset::get('/users/{id}', 'UserController@show')
  ->name('users.show');

1 2	Requeset::get('/users/{id}', 'UserController@show') ->name('users.show');

ルーティングは以下のようになる。

$ php artisan route:list
+--------+----------+------------+------------+------------------------------------------+------------+
| Domain | Method   | URI        | Name       | Action                                   | Middleware |
+--------+----------+------------+------------+------------------------------------------+------------+
........
|        | GET|HEAD | users/{id} | users.show | App\Http\Controllers\UserController@show | web        |
........
+--------+----------+------------+------------+------------------------------------------+------------+

$ php artisan route:list

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

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

........

| | GET|HEAD | users/{id} | users.show | App\Http\Controllers\UserController@show | web |

........

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

ビューでの渡し方

ビューからのルーティングでidなどの値を渡すなら、以下のようにURLで展開させるかroute()ヘルパーの第2引数で指定する。

<!-- URLで値を展開させる -->
<a href="/users/{{ $id }}">プロフィール</a>

<!-- route()ヘルパーの第2引数に渡す -->
<a href="{{ route('users.show', $id) }}">プロフィール</a>

<a href="/users/{{ $id }}">プロフィール</a>

<a href="{{ route('users.show', $id) }}">プロフィール</a>

いずれの場合も、以下のようなURLでGETリクエストされる。

http://localhost/users/2 ←idの値

1	http://localhost/users/2 ←idの値

ログイン済みユーザーのidを渡す場合、以下のように書ける。

<!-- URLで値を展開させる -->
<a href="/user/{{ \Auth::user()->id }}">プロフィール</a>

<!-- route()ヘルパーの第2引数に渡す -->
<a href="{{ route('user.show', \Auth::user()->id) }}">プロフィール</a>

<a href="/user/{{ \Auth::user()->id }}">プロフィール</a>

<a href="{{ route('user.show', \Auth::user()->id) }}">プロフィール</a>

コントローラーでの受け取り方

コントローラー側でパラメーターを受け取る場合、アクションメソッドの引数にパラメーターが渡されるので、それをそのまま利用すればよい。

class UserController extends Controller
{
  public function getProfile($id) {
    return 'user name:" . \App\User::find($id)->name;
  }
}

// ブラウザー表示例
// user name:user2

class UserController extends Controller

{

public function getProfile($id) {

return 'user name:" . \App\User::find($id)->name;

}

// ブラウザー表示例

// user name:user2

モデルのインスタンスのまま渡して受け取る

ルーティング

以下の様にルーティングを設定する。

Requeset::get('/users/{user}', 'UserController@show')
  ->name('user.show');

1 2	Requeset::get('/users/{user}', 'UserController@show') ->name('user.show');

リソースルーティングで指定するなら以下のとおり。

Route::resource('users', 'UserController')
  ->only(['show']);

1 2	Route::resource('users', 'UserController') ->only(['show']);

何れの場合もルーティングは以下のようになる。

$ php artisan route:list
+--------+----------+--------------+------------+------------------------------------------+------------+
| Domain | Method   | URI          | Name       | Action                                   | Middleware |
+--------+----------+--------------+------------+------------------------------------------+------------+
........
|        | GET|HEAD | users/{user} | users.show | App\Http\Controllers\UserController@show | web        |
........
+--------+----------+--------------+------------+------------------------------------------+------------+

$ php artisan route:list

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

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

........

| | GET|HEAD | users/{user} | users.show | App\Http\Controllers\UserController@show | web |

........

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

ビューでの渡し方

ビューからからのルーティングでモデルのインスタンスを渡す場合も、URLで展開させるかroute()ヘルパーの第2引数で指定する。ここでは認証済みのユーザーインスタンスを渡している。

<!-- URLで値を展開させる -->
<a href="/users/{{ \Auth::user() }}">プロフィール</a>

<!-- route()ヘルパーの第2引数に渡す -->
<a href="{{ route('users.show', \Auth::user()) }}">プロフィール</a>

<a href="/users/{{ \Auth::user() }}">プロフィール</a>

<a href="{{ route('users.show', \Auth::user()) }}">プロフィール</a>

インスタンスを渡しても、ルートパラメーターはidの値になる。

http://localhost/users/2

1	http://localhost/users/2

コントローラーでの受け取り方

コントローラーのアクションでは、引数にモデルクラスのメソッドインジェクションを適用して、idに対応したインスタンスを受け取る。

class UserController extends Controller
{
  public function getProfile(\App\User $user) {
    return 'user name:" . $user->name;
  }
}

// ブラウザー表示例
// user name:user2

class UserController extends Controller

{

public function getProfile(\App\User $user) {

return 'user name:" . $user->name;

}

// ブラウザー表示例

// user name:user2

コントローラーの冒頭でモデルをuse指定してもよい。

use App\User;
// user \App\Userでもよい

class UserController extends Controller
{
  public function getProfile(User $user) {
    return 'user name:" . $user->name;
  }
}

// ブラウザー表示例
// user name:user2

use App\User;

// user \App\Userでもよい

class UserController extends Controller

{

public function getProfile(User $user) {

return 'user name:" . $user->name;

}

// ブラウザー表示例

// user name:user2

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

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

概要

公開領域のディスクに保存された画像ファイルを変更・削除する手順を整理する。

変更は現在のファイルを削除して新しいファイルを保存するので、画像ファイルの削除手順がキーになる。

一般的なアップロードファイルの削除はこちらを参照。

ファイルの削除手順

storageディレクトリーのディスクに保存された画像ファイルの削除は、以下で行う。

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

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

ここで'ディスク'と'ファイルパス'は、保存・登録でstore()メソッドの引数に指定したものと同じ。

データの変更

例題のアプリケーションを、画像ファイルのほか、商品名や価格も併せて変更できるように修正する。

ルーティング

画像データの編集は、GETメソッドでeditアクションにルーティングされる。
編集されたデータの更新登録は、PATCHメソッドでupdateアクションにルーティングされる。

$ php artisan route:list
+--------+-----------+-------------------+----------------+--------------------------------------------+------------+
| Domain | Method    | URI               | Name           | Action                                     | Middleware |
+--------+-----------+-------------------+----------------+--------------------------------------------+------------+
........
|        | 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

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

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

........

| | 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 |

........

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

ビューからのリンク～index.blade.php

indexページで一覧された各商品に、編集のリンクを配置する。要点としては、

a要素のhrefの遷移先でroute('items.edit', $item)をしている
第1引数はeditのルート名、第2引数は編集対象のデータインスタンス
GETのURLは以下の様に展開される
- アプリケーションルート/{$id}/edit

<!DOCTYPE html>
<html lang="ja" dir="ltr">
  <head>
    <meta charset="utf-8">
    <title>商品一覧・入力</title>
  </head>
  <body>
    <h1>商品一覧・入力</h1>
    ........
    {{-- 商品データ・画像表示 --}}
    @foreach ($items as $item)
      <p>{{ $item->name }} : {{ $item->price }}円</p>
      <div>
        @if ($item->image !=='')
          <img src="{{ \Storage::url($item->image) }}" width="25%">
        @else
          <img src="{{ \Storage::url('items/no_image.png') }}">
        @endif
      </div>
      <a href="{{ route('items.edit', $item) }}">内容編集</a>
    @endforeach
  </body>
</html>

<!DOCTYPE html>

<head>

</head>

<body>

........

@foreach ($items as $item)

<p>{{ $item->name }} : {{ $item->price }}円</p>

<div>

@if ($item->image !=='')

<img src="{{ \Storage::url($item->image) }}" width="25%">

@else

@endif

</div>

@endforeach

</body>

</html>

コントローラー～edit

GETメソッドでルーティングされたeditアクションでは、URLに含まれる$idに対応するインスタンス$itemがデータベースから引数として渡され、このインスタンスをそのままeditビューに渡している。

class ItemController extends Controller
{
    ........
    public function edit(Item $item)
    {
        return view('items.edit', ['item' => $item]);
    }
    ........
}

class ItemController extends Controller

{

........

public function edit(Item $item)

{

return view('items.edit', ['item' => $item]);

}

........

}

ビュー～edit.blade.php

editビューでは渡された$itemインスタンスの内容を各input要素に表示し、画像ファイルのパスから画像を表示している。

画像を扱うため、formのenctypeオプションを指定している
form要素で指定できるメソッドはGETかPOSTだけだが、updateルートはPATCHメソッドを期待しているので、@methodディレクティブで'patch'を指定している
新規入力時と同じく、フォームリクエストで編集時の入力バリデーションを行っている

<!DOCTYPE html>
<html lang="ja" dir="ltr">
  <head>
    <meta charset="utf-8">
    <title>商品データ編集</title>
  </head>
  <body>
    <h1>商品データ編集</h1>

    <p>商品ID: {{ $item->id }}</p>
    <form method="post" action="{{ route('items.update', $item) }}" enctype="multipart/form-data">
      @csrf
      @method('patch')
      <div>
        <label>商品名:
          <input type="text" name="name" value="{{ $item->name }}">
        </label>
      </div>
      <div>
        <label>価　格:
          <input type="text" name="price" value="{{ $item->price }}">円
        </label>
      </div>
      <div>
        @if ($item->image !=='')
          <img src="{{ \Storage::url($item->image) }}" width="25%">
        @else
          <img src="{{ \Storage::url('items/no_image.png') }}">
        @endif
      </div>
      <div>
        <input type="file" name="image">
      </div>
      <input type="submit" value="更新">
    </form>
    <a href="{{ route('items.index') }}">一覧に戻る</a>

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

<!DOCTYPE html>

<head>

<title>商品データ編集</title>

</head>

<body>

<h1>商品データ編集</h1>

@csrf

@method('patch')

<div>

<label>商品名:

</label>

</div>

<div>

<label>価　格:

<input type="text" name="price" value="{{ $item->price }}">円

</label>

</div>

<div>

@if ($item->image !=='')

<img src="{{ \Storage::url($item->image) }}" width="25%">

@else

@endif

</div>

<div>

</div>

</form>

<a href="{{ route('items.index') }}">一覧に戻る</a>

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

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

@endforeach

</body>

</html>

コントローラー～update

PATCHメソッドでルーティングされたupdateアクションでは、編集入力内容によって、商品データの内容と画像ファイルを更新している。

編集時に画像が選択されていれば、現在のファイルを削除して、選択されたファイルを保存
- このときにファイルのパスも取得
商品内容、画像ファイルへのパスでデータの内容を更新

class ItemController extends Controller
{
    ........
    public function update(ItemRequest $request, Item $item)
    {
        // 画像ファイルインスタンス取得
        $image = $request->file('image');
        // 現在の画像へのパスをセット
        $path = $item->image;
        if (isset($image)) {
            // 現在の画像ファイルの削除
            \Storage::disk('public')->delete($path);
            // 選択された画像ファイルを保存してパスをセット
            $path = $image->store('items', 'public');
        }
        // データベースを更新
        $item->update([
            'name' => $request->name,
            'price' => $request->price,
            'image' => $path,
        ]);

        return redirect()->route('items.edit', $item);
    }
    ........
}

class ItemController extends Controller

{

........

public function update(ItemRequest $request, Item $item)

{

// 画像ファイルインスタンス取得

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

// 現在の画像へのパスをセット

$path = $item->image;

if (isset($image)) {

// 現在の画像ファイルの削除

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

// 選択された画像ファイルを保存してパスをセット

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

}

// データベースを更新

$item->update([

'name' => $request->name,

'price' => $request->price,

'image' => $path,

]);

return redirect()->route('items.edit', $item);

}

........

}

データの削除

ルーティング

indexページで一覧表示された商品の削除ボタンを押すと、DELETEメソッドでdestroyにルーティングされる。

$ php artisan route:list
+--------+--------+--------------+---------------+---------------------------------------------+------------+
| Domain | Method | URI          | Name          | Action                                      | Middleware |
+--------+--------+--------------+---------------+---------------------------------------------+------------+
........
|        | DELETE | items/{item} | items.destroy | App\Http\Controllers\ItemController@destroy | web        |
........
+--------+--------+--------------+---------------+---------------------------------------------+------------+

$ php artisan route:list

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

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

........

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

........

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

ビューへの削除ボタン配置～index.blade.php

indexページの各商品表示にフォームと削除ボタンを加える。

form要素ではmethod="post"を指定し、@methodディレクティブで'delete'メソッドを指定している
削除する商品を指定してdestroyにルーティングするだけなので、フォームにはsubmitボタンだけが配置されている

    {{-- 商品データ・画像表示 --}}
    @foreach ($items as $item)
      <p>{{ $item->name }} : {{ $item->price }}円</p>
      <div>
        @if ($item->image !=='')
          <img src="{{ \Storage::url($item->image) }}" width="25%">
        @else
          <img src="{{ \Storage::url('items/no_image.png') }}">
        @endif
      </div>
      <a href="{{ route('items.edit', $item) }}">内容編集</a>
      <form method="post" action="{{ route('items.destroy', $item) }}">
        @csrf
        @method('delete')
        <input type="submit" value="データ削除">
      </form>
    @endforeach

@foreach ($items as $item)

<p>{{ $item->name }} : {{ $item->price }}円</p>

<div>

@if ($item->image !=='')

<img src="{{ \Storage::url($item->image) }}" width="25%">

@else

@endif

</div>

@csrf

@method('delete')

</form>

@endforeach

コントローラー～destroy

destroyアクションでは、ファイルが登録されていればpublicディスクから削除し、商品データをデータベースから削除している。

    public function destroy(Item $item)
    {
        // 商品画像ファイルへのパスを取得
        $path = $item->image;
        // ファイルが登録されていれば削除
        if ($path !== '') {
          \Storage::disk('public')->delete($path);
        }
        // データベースからデータを削除
        $item->delete();

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

public function destroy(Item $item)

{

// 商品画像ファイルへのパスを取得

$path = $item->image;

// ファイルが登録されていれば削除

if ($path !== '') {

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

}

// データベースからデータを削除

$item->delete();

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

}

Laravel – アップロード画像の読み込み・表示

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

概要

データベースに登録されたパスから画像ファイルを取得し、ビューで表示する手順を整理する。ここでは、indexページで画像のほかに商品名や商品価格も表示させる。

表示された画像ファイルの変更・削除についてはこちらを参照。

publicディスクへのリンク作成

アップロード画像を保存したpublicディスクはstrage/app/publicに割り当てられているが、このディレクトリーはWebサーバー上は公開されていない。

そこで、publicディスクをアプリケーション下のpublicディレクトリーで公開するため、以下のコマンドを実行しておく。

$ php artisan storage:link

1	$ php artisan storage:link

これにより、publicディレクトリーにシンボリックリンクstorageが作成されて、publicディスクに割り当てられたディレクトリーに公開領域からアクセスが可能になる。

$ ls -Al public
合計 16
-rw-rw-r--. 1 vagrant vagrant  593  9月  6 21:24 .htaccess
-rw-rw-r--. 1 vagrant vagrant    0  9月  6 21:24 favicon.ico
-rw-rw-r--. 1 vagrant vagrant 1823  9月  6 21:24 index.php
drwxrwxr-x. 4 vagrant vagrant  159  9月  6 21:24 object_sample
-rw-rw-r--. 1 vagrant vagrant   24  9月  6 21:24 robots.txt
lrwxrwxrwx. 1 vagrant vagrant   70 10月 21 21:06 storage -> /home/..../laravel_tutorial/storage/app/public

$ ls -Al public

合計 16

-rw-rw-r--. 1 vagrant vagrant 593 9月 6 21:24 .htaccess

-rw-rw-r--. 1 vagrant vagrant 0 9月 6 21:24 favicon.ico

-rw-rw-r--. 1 vagrant vagrant 1823 9月 6 21:24 index.php

drwxrwxr-x. 4 vagrant vagrant 159 9月 6 21:24 object_sample

-rw-rw-r--. 1 vagrant vagrant 24 9月 6 21:24 robots.txt

lrwxrwxrwx. 1 vagrant vagrant 70 10月 21 21:06 storage -> /home/..../laravel_tutorial/storage/app/public

コントローラー～index

indexアクションでitemsテーブルの全データを取得し、これをビューに渡して表示させる。

class ItemController extends Controller
{
    public function index()
    {
        $items = Item::all();

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

class ItemController extends Controller

{

public function index()

{

$items = Item::all();

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

}

........

}

ビュー～index.blade.php

コントローラーから$itemsを受け取り、@foreachディレクティブによって全データの内容と画像データを表示する。

ここでは\Storageファサードのurl()メソッドを使って画像ファイルのパスを得ていて、これによってpublicディレクトリー下のstorage/app/publicディレクトリー下にある画像ファイルにアクセスしている。

\Storage::url(publicディスク下のパス)

1	\Storage::url(publicディスク下のパス)

公開領域のファイルのURLについてはこちらを参照。

<!DOCTYPE html>
<html lang="ja" dir="ltr">
  <head>
    <meta charset="utf-8">
    <title>商品一覧・入力</title>
  </head>
  <body>
    <h1>商品一覧・入力</h1>
    ........
    {{-- 商品データ・画像表示 --}}
    @foreach ($items as $item)
      <p>{{ $item->name }} : {{ $item->price }}円</p>
      <div>
        @if ($item->image !=='')
          <img src="{{ \Storage::url($item->image) }}" width="25%">
        @else
          <img src="{{ \Storage::url('items/no_image.png') }}">
        @endif
      </div>
    @endforeach
  </body>
</html>

<!DOCTYPE html>

<head>

</head>

<body>

........

@foreach ($items as $item)

<p>{{ $item->name }} : {{ $item->price }}円</p>

<div>

@if ($item->image !=='')

<img src="{{ \Storage::url($item->image) }}" width="25%">

@else

@endif

</div>

@endforeach

</body>

</html>

なお、商品画像が登録されていない場合は、プレースホルダー画像を表示させている。

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

price: 100

image:

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

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

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

id: 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は、画像が登録されていない場合に表示するプレースホルダー画像。