Laravel – データが属しているユーザーを取り出す

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

概要

投稿記事を投稿したユーザーや商品カートの保有ユーザーなど、データが所属しているユーザーを取り出す場合。1対多のリレーションの多に属するデータから1のデータを取得する。

データモデルにリレーションを設定することで、そのデータが属するユーザーを属性として取り出すことができる。

手順

データモデルにuser()メソッドを定義し、そのデータがUserモデルのデータに属していることを記述する。メソッド名はUserの単数形となっていることに注意。

class モデル extends Model
{
    ....
    // リレーション設定
    public function user() {
      return $this->belongsTo('App\User');
    }
}

class モデル extends Model

{

....

// リレーション設定

public function user() {

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

}

これによってデータモデルにuser属性が追加され、それを介してUserの各属性を取得することができる。

モデルデータ->user->name

例

例えばユーザー認証は設定済みとして、ユーザーの投稿記事モデルPostsを定義済みとする。Postモデルは記事の投稿ユーザーのIDをuser_idとして持ち、外部キー制約を設定している。

mysql> DESCRIBE posts;
+------------+-----------------+------+-----+---------+----------------+
| Field      | Type            | Null | Key | Default | Extra          |
+------------+-----------------+------+-----+---------+----------------+
| id         | bigint unsigned | NO   | PRI | NULL    | auto_increment |
| user_id    | bigint unsigned | NO   | MUL | NULL    |                |
| comment    | varchar(200)    | NO   |     | NULL    |                |
| image_name | varchar(100)    | NO   |     | NULL    |                |
| created_at | datetime        | NO   |     | NULL    |                |
| updated_at | datetime        | NO   |     | NULL    |                |
+------------+-----------------+------+-----+---------+----------------+
6 rows in set (0.00 sec)

mysql> DESCRIBE posts;

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

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

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

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

6 rows in set (0.00 sec)

まずPostモデルにuser()メソッドを定義し、belongsTo(App\User)を戻り値とする。

belongsTo()はPostモデルがUserモデルに属することから、Postのインスタンスが属するUserのインスタンスを返す
このリレーション設定によって、Postモデルにuserプロパティーが加えられ、Postインスタンスが属するUserのインスタンスを取得できる

class Post extends Model
{
    ....
    // リレーション設定
    public function user() {
      return $this->belongsTo('App\User');
    }
}

class Post extends Model

{

....

// リレーション設定

public function user() {

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

}

これでPostインスタンスのuserプロパティーに、その記事を投稿したユーザーへの参照が格納される。

たとえば投稿記事が$postに格納されているとして、ビュー側でユーザーを取得して表示する場合、以下のようなディレクティブになる。

<p>{{ $post->user->name }}さんの記事 : {{ $post->comment }}</p>

1	<p>{{ $post->user->name }}さんの記事 : {{ $post->comment }}</p>

Laravel – ログインユーザーのデータのみ取り出す

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

概要

ユーザーが投稿した記事や購入予定のカート・商品など、ログインユーザーに関するもののみを利用したい場合。1対多のリレーションの1から多のデータ群を取得する。

以下のいずれかの方法がある。

モデルのwhere()->get()で抽出する
Userモデルにリレーションを定義し、Userのプロパティーとして取得する

where()メソッドを使う方法

手順

全ての記事を取得するならコントローラーのアクションでPost::all()として取り出すが、この場合はwhere()メソッドで全データのうちuser_idがログインユーザーのidと同じデータだけを抽出する。

SQLではWHERE user_id = ログインユーザーidとなるが、Laravelでは以下のように書く。

モデル::where('モデルのユーザーid', \Auth::user()->id)->get()

例

mysql> DESCRIBE posts;
+------------+-----------------+------+-----+---------+----------------+
| Field      | Type            | Null | Key | Default | Extra          |
+------------+-----------------+------+-----+---------+----------------+
| id         | bigint unsigned | NO   | PRI | NULL    | auto_increment |
| user_id    | bigint unsigned | NO   | MUL | NULL    |                |
| comment    | varchar(200)    | NO   |     | NULL    |                |
| image_name | varchar(100)    | NO   |     | NULL    |                |
| created_at | datetime        | NO   |     | NULL    |                |
| updated_at | datetime        | NO   |     | NULL    |                |
+------------+-----------------+------+-----+---------+----------------+
6 rows in set (0.00 sec)

mysql> DESCRIBE posts;

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

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

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

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

6 rows in set (0.00 sec)

以下はログインユーザーの全記事をPostControllerのindexアクションで取得し、indexビューで表示させる例。ビュー側で受け取った$postsにログインユーザーが投稿した記事だけが配列で格納される。

class PostController extends Controller
{
    ....
    public function index()
    {
        $posts = Post::where('user_id', \Auth::user()->id)->get();

        return view('posts.index', [
          'title' => '投稿一覧',
          'posts' => $posts,
        ]);
    }
}

class PostController extends Controller

{

....

public function index()

{

$posts = Post::where('user_id', \Auth::user()->id)->get();

return view('posts.index', [

'title' => '投稿一覧',

'posts' => $posts,

]);

}

モデルのリレーションを定義する方法

手順

Userモデルにモデル名の複数形(テーブル名に相当)でメソッドを定義し、リレーションを記述する。

class User extends Authenticatable
{
    ....
    // リレーション設定
    public function メソッド名() {
      return $this->hasMany('App\モデル名');
    }
}

class User extends Authenticatable

{

....

// リレーション設定

public function メソッド名() {

return $this->hasMany('App\モデル名');

}

これによってUserモデルの属性にメソッド名と同名のプロパティーが追加され、そのユーザーのidを外部キーに持つモデルのデータのみを取り出すことができる。

そしてコントローラーのアクションで、ログインユーザーのプロパティーでログインユーザーのidを持つデータのみを取得できる。

class コントローラー extends Controller
{
    ....
    public function アクション()
    {
        $login_users_data = \Auth::user()->メソッド名;
        ....
    }
}

class コントローラー extends Controller

{

....

public function アクション()

{

$login_users_data = \Auth::user()->メソッド名;

....

}

例

以下は先と同じPostモデルを扱う例。

まずUserモデルにPostの複数形(テーブル名)でposts()メソッドを定義し、hasMany(App\Post)を戻り値とする。

hasMany()は元のモデル(User)が複数の引数モデルを持つことから、Userのインスタンスに属する複数のデータの配列を返す
このリレーション設定によって、Userモデルにpostsプロパティーが加えられ、Userインスタンスに属するPostの配列を取得できる

class User extends Authenticatable
{
    ....
    // リレーション設定
    public function posts() {
      return $this->hasMany('App\Post');
    }
}

class User extends Authenticatable

{

....

// リレーション設定

public function posts() {

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

}

これでユーザーのインスタンスのpostsプロパティーに、そのユーザーが投稿した記事だけが格納される。

コントローラーではログインユーザー(\Auth::user())のpostsプロパティーを参照すればよいので、以下のようになる。

class PostController extends Controller
{
    ....
    public function index()
    {
        $posts = \Auth::user()->posts;

        return view('posts.index', [
          'title' => '投稿一覧',
          'posts' => $posts,
        ]);
    }
}

class PostController extends Controller

{

....

public function index()

{

$posts = \Auth::user()->posts;

return view('posts.index', [

'title' => '投稿一覧',

'posts' => $posts,

]);

}

Laravel – フォーム入力・データ登録

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

create, store～データの入力と登録

リソースルーティングでは、以下を意図している。

create: 登録するデータを作成する。フォーム入力の場合、フォームを持つビューを表示する。
store: データをデータベースに登録する。createがフォーム入力の場合、フォームのaction先をこのルートにする。

前提

モデルデータの操作で準備した枠組みを使う。ユーザー認証機能を持ち、ユーザーごとに入力されたシンプルな投稿記事Postを扱う。

流れ

ドメイン名/posts/createをGETリクエスト
posts.createルートでPostsControllerのcreateアクションを実行
createアクションで入力フォームを含むビューを表示
入力フォームのactionからposts.storeへルーティング
posts.storeルートでPostControllerのstoreアクションを実行
storeアクションでデータベースにデータを登録

createアクションの呼び出し

リソースルーティングで以下のように設定されていて、ドメイン/posts/createからPostControllerのcreateアクションにルーティングされる。ルーティング名はposts.create。

$ php artisan route:list
+--------+-----------+------------------------+------------------+------------------------------------------------------------------------+--------------+
| Domain | Method    | URI                    | Name             | Action                                                                 | Middleware   |
+--------+-----------+------------------------+------------------+------------------------------------------------------------------------+--------------+
........
|        | POST      | posts                  | posts.store      | App\Http\Controllers\PostController@store                              | web,auth     |
|        | GET|HEAD  | posts                  | posts.index      | App\Http\Controllers\PostController@index                              | web,auth     |
|        | GET|HEAD  | posts/create           | posts.create     | App\Http\Controllers\PostController@create                             | web,auth     |
|        | GET|HEAD  | posts/{post}           | posts.show       | App\Http\Controllers\PostController@show                               | web,auth     |
|        | DELETE    | posts/{post}           | posts.destroy    | App\Http\Controllers\PostController@destroy                            | web,auth     |
|        | PUT|PATCH | posts/{post}           | posts.update     | App\Http\Controllers\PostController@update                             | web,auth     |
|        | GET|HEAD  | posts/{post}/edit      | posts.edit       | App\Http\Controllers\PostController@edit                               | web,auth     |
........

$ php artisan route:list

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

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

........

| | GET|HEAD | posts/{post} | posts.show | App\Http\Controllers\PostController@show | web,auth |

| | DELETE | posts/{post} | posts.destroy | App\Http\Controllers\PostController@destroy | web,auth |

| | PUT|PATCH | posts/{post} | posts.update | App\Http\Controllers\PostController@update | web,auth |

| | GET|HEAD | posts/{post}/edit | posts.edit | App\Http\Controllers\PostController@edit | web,auth |

........

コントローラー～createアクション

コントローラーでは、ビューの$titleを設定してresources/views/posts/create.blade.phpを表示させるだけ。

class PostController extends Controller
{
    ........
    public function create()
    {
        return view('posts.create', [
            'title' => '新規投稿'
        ]);
    }
    ........
}

class PostController extends Controller

{

........

public function create()

{

return view('posts.create', [

'title' => '新規投稿'

]);

}

........

}

入力フォームビュー

bladeテンプレート

投稿を入力するフォームはposts/create.blade.phpに以下の要領で記述。

<form action="{{ route('posts.store') }}" method="post">
  @csrf
  <div>
    <input type="text" name="comment" placeholder="コメントを入力">
  </div>
  <input type="submit" value="投稿">
</form>

@csrf

<div>

</div>

</form>

actionで指定しているroute('posts.store')はデータベースへの登録アクションstoreへのルーティング。

$ php artisan route:list
+--------+-----------+------------------------+------------------+------------------------------------------------------------------------+--------------+
| Domain | Method    | URI                    | Name             | Action                                                                 | Middleware   |
+--------+-----------+------------------------+------------------+------------------------------------------------------------------------+--------------+
........
|        | POST      | posts                  | posts.store      | App\Http\Controllers\PostController@store                              | web,auth     |
|        | GET|HEAD  | posts                  | posts.index      | App\Http\Controllers\PostController@index                              | web,auth     |
|        | GET|HEAD  | posts/create           | posts.create     | App\Http\Controllers\PostController@create                             | web,auth     |
|        | GET|HEAD  | posts/{post}           | posts.show       | App\Http\Controllers\PostController@show                               | web,auth     |
|        | DELETE    | posts/{post}           | posts.destroy    | App\Http\Controllers\PostController@destroy                            | web,auth     |
|        | PUT|PATCH | posts/{post}           | posts.update     | App\Http\Controllers\PostController@update                             | web,auth     |
|        | GET|HEAD  | posts/{post}/edit      | posts.edit       | App\Http\Controllers\PostController@edit                               | web,auth     |
........

$ php artisan route:list

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

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

........

| | GET|HEAD | posts/{post} | posts.show | App\Http\Controllers\PostController@show | web,auth |

| | DELETE | posts/{post} | posts.destroy | App\Http\Controllers\PostController@destroy | web,auth |

| | PUT|PATCH | posts/{post} | posts.update | App\Http\Controllers\PostController@update | web,auth |

| | GET|HEAD | posts/{post}/edit | posts.edit | App\Http\Controllers\PostController@edit | web,auth |

........

フォームリクエスト～バリデーション

フォーム入力のバリデーションをフォームリクエストに記述する。

まず、以下のコマンドでフォームリクエストを作成。

$ php artisan make:request PostRequest

1	$ php artisan make:request PostRequest

app/Http/Requestsディレクトリーに作成されたPostRequest.phpを編集し、バリデーションルールを追加。ここでは唯一のフォーム入力commentに対して、入力必須(required)と最大200文字(max:200)を配列で設定している。

<?php

namespace App\Http\Requests;

use Illuminate\Foundation\Http\FormRequest;

class PostRequest extends FormRequest
{
    ........
    public function rules()
    {
        return [
            'comment' => ['required', 'max:200'],
        ];
    }
}

<?php

namespace App\Http\Requests;

use Illuminate\Foundation\Http\FormRequest;

class PostRequest extends FormRequest

{

........

public function rules()

{

return [

'comment' => ['required', 'max:200'],

];

}

コントローラー～storeアクション

use指定

PostControllerでPostモデルとPostのフォームリクエストを使うため、以下のようにファイル冒頭でuse指定する(個別の名前空間指定が不要になる)。

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;

use App\Post;
use App\Http\Requests\PostRequest;

class PostController extends Controller
{
    ........
}

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;

use App\Post;

use App\Http\Requests\PostRequest;

class PostController extends Controller

{

........

}

storeアクション

入力フォームのaction先で指定されたアクションメソッドで、フォームの入力をデータベースに書き込む。

class PostController extends Controller
{
    ........
    public function store(PostRequest $request)
    {
        Post::create([
          'comment' => $request->comment,
        ]);

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

class PostController extends Controller

{

........

public function store(PostRequest $request)

{

Post::create([

'comment' => $request->comment,

]);

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

}

........

}

ここではPostクラスが継承しているModelクラスのcreate()メソッドで、フォームリクエストのパラメーターをセットしてデータを書き込んでいる。

入力バリデーションはマスアサインメント実行時にフォームリクエストで実行され、エラーがあれば$errorsに格納される
Post::create()は最終的にEloquent/Builderのcreate()が実行されるらしい(参照：モデルのcreate()メソッドはどこに？)

データ書き込み後posts.indexにリダイレクトしているが、これは投稿記事一覧表示へのルーティング。

モデルでの$fillable設定

create()メソッドによる登録はマスアサインメントになるので、モデルに$fillableを定義しておく。

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class Post extends Model
{
    protected $fillable = ['user_id', 'comment', 'image_name'];
}

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class Post extends Model

{

protected $fillable = ['user_id', 'comment', 'image_name'];

}

確認

ユーザーログイン状態でドメイン名/posts/createをGETリクエストすると入力フォームのページが表示され、投稿ボタンを押すとデータが登録される。

たとえばuser1とuser2をユーザー登録しておいて・・・

mysql> SELECT * FROM users\G
*************************** 1. row ***************************
               id: 1
             name: user1
            email: user1@mail.com
email_verified_at: NULL
         password: $2y$10$45lbfGBk84uzZQLi3lahmulUVSQ75xeNSJC42FmS.ayCaW6WyZtfS
   remember_token: NULL
       created_at: 2021-10-09 10:24:22
       updated_at: 2021-10-09 10:24:22
*************************** 2. row ***************************
               id: 2
             name: user2
            email: user2@mail.com
email_verified_at: NULL
         password: $2y$10$dVAMHnafJLvx4HSyypRfwubvM8ARlAKGa6tqV647xxiBc4i34kixG
   remember_token: NULL
       created_at: 2021-10-09 10:25:59
       updated_at: 2021-10-09 10:25:59
2 rows in set (0.00 sec)

mysql> SELECT * FROM users\G

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

id: 1

name: user1

email: user1@mail.com

email_verified_at: NULL

password: $2y$10$45lbfGBk84uzZQLi3lahmulUVSQ75xeNSJC42FmS.ayCaW6WyZtfS

remember_token: NULL

created_at: 2021-10-09 10:24:22

updated_at: 2021-10-09 10:24:22

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

id: 2

name: user2

email: user2@mail.com

email_verified_at: NULL

password: $2y$10$dVAMHnafJLvx4HSyypRfwubvM8ARlAKGa6tqV647xxiBc4i34kixG

remember_token: NULL

created_at: 2021-10-09 10:25:59

updated_at: 2021-10-09 10:25:59

2 rows in set (0.00 sec)

それぞれの記事を投稿した結果は以下の通り。

mysql> SELECT * FROM posts;
+----+---------+--------------------------+---------------------+---------------------+
| id | user_id | comment                  | created_at          | updated_at          |
+----+---------+--------------------------+---------------------+---------------------+
|  1 |       1 | user1の1つ目の投稿       | 2021-10-09 10:34:47 | 2021-10-09 10:34:47 |
|  2 |       1 | user1の2つ目の投稿       | 2021-10-09 10:35:01 | 2021-10-09 10:35:01 |
|  3 |       2 | user2の1つ目の投稿       | 2021-10-09 10:35:32 | 2021-10-09 10:35:32 |
|  4 |       2 | user2の2つ目の投稿       | 2021-10-09 10:35:45 | 2021-10-09 10:35:45 |
+----+---------+--------------------------+------------+---------------------+---------------------+
4 rows in set (0.00 sec)

mysql> SELECT * FROM posts;

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

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

| 1 | 1 | user1の1つ目の投稿 | 2021-10-09 10:34:47 | 2021-10-09 10:34:47 |

| 2 | 1 | user1の2つ目の投稿 | 2021-10-09 10:35:01 | 2021-10-09 10:35:01 |

| 3 | 2 | user2の1つ目の投稿 | 2021-10-09 10:35:32 | 2021-10-09 10:35:32 |

| 4 | 2 | user2の2つ目の投稿 | 2021-10-09 10:35:45 | 2021-10-09 10:35:45 |

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

4 rows in set (0.00 sec)

Laravel – モデルのcreate()メソッドはどこに？

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

Modelにcreate()メソッドがない

LaravelのUserや作成したモデルで呼び出すcreate()メソッドについて調べた過程。

たとえばLaravelでモデルとコントローラーをPost、PostControllerのように生成し、store()アクション内でマスアサインメントによってデータを登録する場合に、以下のように書き、モデルクラスのスタティックメソッドcreate()を呼び出している。

class PostController extends Controller
{
    ........
    public function store(Request $request)
    {
        Post::create([
          'comment' => $request->comment,
        ]);

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

class PostController extends Controller

{

........

public function store(Request $request)

{

Post::create([

'comment' => $request->comment,

]);

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

}

........

}

ここでPostモデルのクラスを見てみると、EloquentのModelクラスを継承している。

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class Post extends Model
{
}

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class Post extends Model

{

}

ところがIlluminate\Database\Eloquent\Modelクラスなどをたどってみても、create()メソッドが見当たらなかった。

マジックメソッドで実装している

以下のように、Modelクラスではマジックメソッド__call()、__callstatic()が定義されている。

    public function __call($method, $parameters)
    {
        if (in_array($method, ['increment', 'decrement'])) {
            return $this->$method(...$parameters);
        }

        if ($resolver = (static::$relationResolvers[get_class($this)][$method] ?? null)) {
            return $resolver($this);
        }

        return $this->forwardCallTo($this->newQuery(), $method, $parameters);
    }

    public static function __callStatic($method, $parameters)
    {
        return (new static)->$method(...$parameters);
    }

public function __call($method, $parameters)

{

if (in_array($method, ['increment', 'decrement'])) {

return $this->$method(...$parameters);

}

if ($resolver = (static::$relationResolvers[get_class($this)][$method] ?? null)) {

return $resolver($this);

}

return $this->forwardCallTo($this->newQuery(), $method, $parameters);

}

public static function __callStatic($method, $parameters)

{

return (new static)->$method(...$parameters);

}

まず、Post::create()が実行されると、

Postクラスにはstatic create()がない
継承元のModelクラスにもstatic create()がない
Model::__callstatic()が呼ばれる
new staticがlate static bindingで実行されてnew Post()と解釈される
Postインスタンスにはcreate()がない
継承元のModelにもcreate()がない
Model::__call()が呼ばれる

この__call()メソッドの動作はよくわかっていないが、create()の場合は最終的に以下が実行されるようだ。

return $this->forwardCallTo($this->newQuery(), $method, $parameters);

1	return $this->forwardCallTo($this->newQuery(), $method, $parameters);

forwardCallTo()はModelでuseしているForwardsCallsトレイトのメソッドを呼んでいるが、要するにnewQuery()の戻り値のオブジェクトで定義されている$method(この場合はcreate())を呼んでいる。

trait ForwardsCalls
{
    protected function forwardCallTo($object, $method, $parameters)
    {
        try {
            return $object->{$method}(...$parameters);
        } catch (Error|BadMethodCallException $e) {
            ........
        }
    }
    ........
}

trait ForwardsCalls

{

protected function forwardCallTo($object, $method, $parameters)

{

try {

return $object->{$method}(...$parameters);

} catch (Error|BadMethodCallException $e) {

........

}

........

}

ここからどんどん複雑になっていくので手に負えなくなるが、参考サイトを拝見するとEloquent\Builderというクラスのインスタンスが戻り値になるようで、その中にcreate()が定義されていた。

参考サイト：【Laravel】第1回 Eloquent ソースコードリーディング – モデルの取得

尻切れトンボになってしまうが、ひとまずここまで。

PHP – new staticとnew self

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

概要

static、selfはnewと組み合わせることでクラス内でインスタンスを生成する際に使えるが、以下のような違いがある。

new staticはそれが実行されるときのクラスのインスタンスを生成する
new selfはそれが定義されたときのクラスのインスタンを生成する

参照：static::とself::

準備

以下のようにParentClassとそれを継承したChildClassを準備する。

いずれも同じ名前のインスタンスメソッドmethod()を持つ
それぞれのクラスはスタティックメソッドparent_method()、child_method()を持つ
何れの内容も同じで、以下を実行する
- (new static)->static_method()
- (new self)->static_method()

new staticやnew selfはクラスのインスタンスを生成する。この例では()->で生成されたインスタンスから直接メソッドを呼び出しているが、$instance = new staticのように一旦変数に参照させて$instance->method()としてもよい。

<?php

class ParentClass
{
  public static function parent_method()
  {
    (new static)->method();
    (new self)->method();
  }

  public function method()
  {
    echo 'in Parent', PHP_EOL;
  }
}

class ChildClass extends ParentClass
{
  public static function child_method()
  {
    (new static)->method();
    (new self)->method();
  }

  public function method()
  {
    echo 'in Child', PHP_EOL;
  }
}

<?php

class ParentClass

{

public static function parent_method()

{

(new static)->method();

(new self)->method();

}

public function method()

{

echo 'in Parent', PHP_EOL;

}

class ChildClass extends ParentClass

{

public static function child_method()

{

(new static)->method();

(new self)->method();

}

public function method()

{

echo 'in Child', PHP_EOL;

}

親クラスのメソッドで生成する場合

親クラスのメソッド内でstatic、selfで生成されるインスタンスは親クラスのインスタンス。

ParentClass::parent_method();

// in Parent
// in Parent

ParentClass::parent_method();

// in Parent

子クラスのメソッドで生成する場合

子クラスのメソッド内でstatic、selfで生成されるインスタンスは子クラスのインスタンス。

ChildClass::child_method();

// in Child
// in Child

ChildClass::child_method();

// in Child

継承元の親クラスのメソッドで生成する場合

子クラスから継承元の親クラスのメソッドを呼んで、その中でstatic、selfで生成されるインスタンスは以下の通り。

ChildClass::parent_method();

// in Child
// in Parent

ChildClass::parent_method();

// in Child

// in Parent

これらは以下のような動作による。

子クラスから呼ばれた親クラスのスタティックメソッドで以下が実行される。

  public static function parent_method()
  {
    (new static)->method();
    (new self)->method();
  }

public static function parent_method()

{

(new static)->method();

(new self)->method();

}

new staticで生成されるのは、この文が実行されるときにスタティックメソッドを呼び出したChildClassなので、ChildClassのインスタンスが生成されて、そのmethod()が呼ばれる。

new selfで生成されるのは、この文が定義されたParentClassなので、ParentClassのインスタンスが生成されて、そのmethod()が呼ばれる。

PHP – マジックメソッド – __call()

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

__call()はマジックメソッドの一つで、実行させようとしたインスタンスのメソッドが存在しない時に呼ばれる。

以下の例では、MyClassに__call()メソッドのみが定義されている。__call()の内容は、引数の$methodと$argsを表示させるようにしている。

<?php

class MyClass
{
  public function __call($method, $args) {
    echo '$method:';
    var_export($method);
    echo PHP_EOL;
    echo '$args:' . PHP_EOL;
    var_export($args);
    echo PHP_EOL;
  }
}

<?php

class MyClass

{

public function __call($method, $args) {

echo '$method:';

var_export($method);

echo PHP_EOL;

echo '$args:' . PHP_EOL;

var_export($args);

echo PHP_EOL;

}

このクラスに存在しないインスタンスメソッドを、引数なし、引数1個、2個で実行した場合の実行結果。引数は配列として$argsにセットされ、引数がない場合は空の配列、引数が1個の場合は要素数1(要素番号0)の配列となる。

$instance = new MyClass();

$instance->method1();
// $method:'method1'
// $args:
// array (
// )

$instance->myMethod(1);
// $method:'myMethod'
// $args:
// array (
//   0 => 1,
// )

$instance->myMethod(1, "two");
// $method:'myMethod'
// $args:
// array (
//   0 => 1,
//   1 => 'two',
// )

$instance = new MyClass();

$instance->method1();

// $method:'method1'

// $args:

// array (

// )

$instance->myMethod(1);

// $method:'myMethod'

// $args:

// array (

// 0 => 1,

// )

$instance->myMethod(1, "two");

// $method:'myMethod'

// $args:

// array (

// 0 => 1,

// 1 => 'two',

// )

Laravel – マイグレーションコマンド

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

表示

status

マイグレーションの状態表示

$ php artisan migrate:status

1	$ php artisan migrate:status

SQLの表示

migrateコマンドのオプションに--pretendを指定すると、マイグレーションにおけるテーブル生成のクエリーを表示する。

$ php artisan migrate --pretend

1	$ php artisan migrate --pretend

migrate:rollbackコマンドでも指定可能だが、rollbackの時と同じメッセージが出力される。他のコマンドでは、--pretendは指定できない。

マイグレーションの実行

マイグレートされていない全マイグレーションファイルのマイグレート

$ php artisan migrate

1	$ php artisan migrate

ロールバック

rollback

直前のマイグレーションのロールバック

$ php artisan migrate:rollback

1	$ php artisan migrate:rollback

指定したステップ分のロールバック(--step=1は指定なしと同じ)

$ php artisan migrate:rollback --setp=ステップ数

1	$ php artisan migrate:rollback --setp=ステップ数

マイグレーションの再実行

reset

実行済みの全マイグレーションのロールバック

$ php artisan migrate:reset

1	$ php artisan migrate:reset

refresh

実行済みの全マイグレーションファイルをロールバックし、マイグレーションを実行。

$ php artisan migrate:refresh

1	$ php artisan migrate:refresh

マイグレート済みの各マイグレーションファイルのdown()メソッドが実行された後、全マイグレーションファイルのup()メソッドが実行される。

デフォルトのdown()メソッドはテーブルをドロップするのみなので、後述のfreshと同じ効果。

fresh

全テーブルをドロップした後、全マイグレーションファイルをマイグレート。

$ php artisan migrate:fresh

1	$ php artisan migrate:fresh

ロールバックは行われずテーブルが再度新規に構築される。各マイグレーションファイルのdown()メソッドは実行されず、up()メソッドのみが実行される。

Laravel – モデル – 外部キー

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

外部キーの準備

通常、外部キーは相手方テーブルで自動連番として生成されたキーを対象とすることが多い。

例えば参照先のテーブルのプライマリーキーが'id'であるとして、これがAuto Incrementの場合にはマイグレーションファイルでは以下のように定義される。

$table->bigIncrements('id');

これにより生成されるカラムのデータ型はunsignedBigIntegerとなるので、参照元のテーブルで外部キーを設定するときは以下のように定義する。

$table->unsignedBigInteger('参照先テーブル名の単数形_id');

例えば参照先テーブルをcustomersとすると、マイグレーションファイルでは以下のように書かれる。

class CreateCustomersTable extends Migration
{
    public function up()
    {
        Schema::create('customers', function (Blueprint $table) {
            $table->bigIncrements('id');
            ........
        });
    }
    ........
}

class CreateCustomersTable extends Migration

{

public function up()

{

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

$table->bigIncrements('id');

........

});

}

........

}

ordersテーブルから上記のcustomersテーブルを参照する場合、ordersテーブルの外部キーは以下のように記述する。

class CreateOrdersTable extends Migration
{
    public function up()
    {
        Schema::create('orders', function (Blueprint $table) {
            $table->bigIncrements('id');
            $table->unsignedBigInteger('customer_id');
            ........
        });
    }
    ........
}

class CreateOrdersTable extends Migration

{

public function up()

{

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

$table->bigIncrements('id');

$table->unsignedBigInteger('customer_id');

........

});

}

........

}

外部キーの設定

Laravelのモデルに外部キーを設定する場合、マイグレーションファイルでforeign()メソッドを使う。

具体的には、テーブルを作成するクラスのup()メソッドで呼ばれるSchema::create()メソッド内に以下を記述。

$table->foreign('外部キー')->references('参照キー')->on('参照テーブル');

外部キー制約

マイグレーションファイルで外部キーを設定した場合、デフォルトの外部キー制約はRESTRICTになる。この制約をCASCADEやSET NULLに変更することができる。

削除、更新に対する制約はonDelete()、onUpdate()をメソッドチェーンに追加して設定する。

$table->foreign('外部キー')->references('参照キー')->on('参照テーブル')
->onDelete('CASCADE')->onUpdate('CASCADE');

1 2	$table->foreign('外部キー')->references('参照キー')->on('参照テーブル') ->onDelete('CASCADE')->onUpdate('CASCADE');

引数は大文字でも小文字でもよく、CASCADE、SET NULL、RESTRICTの何れかを指定する。

コード例

たとえば.投稿記事のPostモデルのテーブルがuser_idカラムを持ち、ここにUsersモデルのidを外部キーとする場合、PostのマイグレーションファイルのCreatePostsTableクラスのup()メソッドに、外部キー設定の行を記述する。

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

            // ユーザーIDの外部キー
            $table->unsignedBigInteger('user_id');
            ........

            $table->foreign('user_id')->references('id')->on('users')
            ->onUpdate('cascade')
            ->onDelete('cascade');
        });
    }
    ........
}

class CreatePostsTable extends Migration

{

public function up()

{

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

$table->bigIncrements('id');

// ユーザーIDの外部キー

$table->unsignedBigInteger('user_id');

........

$table->foreign('user_id')->references('id')->on('users')

->onUpdate('cascade')

->onDelete('cascade');

});

}

........

}

Laravel – ログアウト

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

概要

基本的な流れの一つ。

form要素のアクションでlogoutを指定して、submitボタンを配置
LoginControllerでloggedOut()メソッドをオーバーライドしてリダイレクト先を指定

ログアウトボタンの配置

フォームとボタンによる方法

ログアウト機能を実装するビューで以下のようなform要素を記述。

<form action="{{ route('logout') }}" method="post">
  @csrf
  <input type="submit" value="ログアウト">
</form>

@csrf

</form>

アンカー要素による方法

ログアウト機能を実装するビューで以下のようなアンカー要素を記述。

<a href="/logout">ログアウト</a>

1	<a href="/logout">ログアウト</a>

アンカー要素はGETメソッドを発行するので、以下のルーティングをroutes/web.phpに追加。

Route::get('/logout', 'Auth\LoginController@logout');

1	Route::get('/logout', 'Auth\LoginController@logout');

その他の方法

このほか、form要素にhiddenタイプのinput要素を配置して、アンカータグでログアウトさせる方法もあるらしい。

ログアウト後のリダイレクト先を変更

LoginControllerで以下の様にloggedOut()メソッドをオーバーライドし、リダイレクト先を指定。

class LoginController extends Controller
{
    ....
    protected function loggedOut(\Illuminate\Http\Request $request) {
      return redirect('login');
    }
}

class LoginController extends Controller

{

....

protected function loggedOut(\Illuminate\Http\Request $request) {

return redirect('login');

}

メソッドインジェクションのRequestは、ファイル冒頭でuseするならフルネームスペースでなくてもよい。

MySQL – 月単位の集計～残高もある場合

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

例題設定

例題として個人の銀行口座の入出金記録の以下の構造のテーブルを考える。

mysql> DESCRIBE account;
+-------------+--------------+------+-----+---------+-------+
| Field       | Type         | Null | Key | Default | Extra |
+-------------+--------------+------+-----+---------+-------+
| id          | int          | YES  |     | NULL    |       |
| date        | date         | YES  |     | NULL    |       |
| branch      | varchar(3)   | YES  |     | NULL    |       |
| transaction | varchar(20)  | YES  |     | NULL    |       |
| category    | varchar(10)  | YES  |     | NULL    |       |
| withdrawal  | int          | YES  |     | NULL    |       |
| deposit     | int          | YES  |     | NULL    |       |
| balance     | int          | YES  |     | NULL    |       |
| partner     | varchar(100) | YES  |     | NULL    |       |
+-------------+--------------+------+-----+---------+-------+
9 rows in set (0.00 sec)

mysql> DESCRIBE account;

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

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

| id | int | YES | | NULL | |

| withdrawal | int | YES | | NULL | |

| deposit | int | YES | | NULL | |

| balance | int | YES | | NULL | |

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

9 rows in set (0.00 sec)

ここでidは入出金記録の順番に付されていて、変更されないものとする。すなわち、日・月・年などの単位でグルーピングしたとき、idが最も大きいレコードのbalanceがその期の残高となっている。

合計計算のみの場合

月ごとの合計を計算するだけの場合、年月でグルーピングしてSUM関数を使う。

SELECT
  MAX(DATE_FORMAT(date, '%Y年%m月')) AS 年月,
  SUM(withdrawal) AS 月別出金,
  SUM(deposit) AS 月別入金
FROM account
GROUP BY DATE_FORMAT(date, '%Y%m')
;

SELECT

MAX(DATE_FORMAT(date, '%Y年%m月')) AS 年月,

SUM(withdrawal) AS 月別出金,

SUM(deposit) AS 月別入金

FROM account

GROUP BY DATE_FORMAT(date, '%Y%m')

;

要点は以下の通り。

GROUP BY句で、yyyymm形式でフォーマットされた年月単位でグルーピング
グループごとにSUM関数で出金額と入金額を合計
年月表示はGROUP BY句のフォーマットと異なってもよい
ただしグルーピングされた複数レコード中のどのレコードのdateを使うかを明示するため、MAX関数を使っている。
- こうしないと(オプション指定なしでは)エラーが発生する

各月の残高も含める場合

月ごとの最終取引の抽出

各月の残高がデータに含まれていて、取引がidの昇順であることがわかっている場合、月ごとにグルーピングされたレコードのうちidが最大のレコードがその月の最後の取引になり、そのbalanceが月の残高になる。

そこで、まず各月の最終取引のidを取得する。

SELECT
  MAX(id) AS max_id
FROM account
GROUP BY DATE_FORMAT(date, '%Y%m')
;

SELECT

MAX(id) AS max_id

FROM account

GROUP BY DATE_FORMAT(date, '%Y%m')

;

各月最終取引のレコード取得と残高表示

最終取引のidに一致するレコードのみ元のテーブルから取り出すため、INNER JOINを使う。

SELECT
  id,
  DATE_FORMAT(date, '%Y年%m月') AS 年月,
  balance AS 月末残高
FROM mufj
INNER JOIN (
  SELECT
    MAX(id) AS max_id
  FROM mufj
  GROUP BY DATE_FORMAT(date, '%Y%m')
) AS monthly_final_transaction
ON id = max_id
;

SELECT

id,

DATE_FORMAT(date, '%Y年%m月') AS 年月,

balance AS 月末残高

FROM mufj

INNER JOIN (

SELECT

MAX(id) AS max_id

FROM mufj

GROUP BY DATE_FORMAT(date, '%Y%m')

) AS monthly_final_transaction

ON id = max_id

;

要点は以下の通り。

最終取引を抽出したクエリーをサブクエリ―として、そのidと等しいレコードのみを元のテーブルから抽出している
サブクエリ―にはエイリアスが必須
抽出された最終取引のbalanceを月末残高として表示
SELECT句のidは確認用で、表示目的としては不要

月ごとの入出金額を追加

上記のクエリーに、グルーピングされた月ごとの入出金額を追加する。

SELECT
  DATE_FORMAT(date, '%Y年%m月') AS 年月,
  monthly_withdrawal AS 出金額,
  monthly_deposit AS 入金額,
  balance AS 月末残高
FROM mufj
INNER JOIN (
  SELECT
    MAX(id) AS max_id,
    SUM(withdrawal) AS monthly_withdrawal,
    SUM(deposit) AS monthly_deposit
  FROM mufj
  GROUP BY DATE_FORMAT(date, '%Y%m')
) AS monthly_final_transaction
ON id = max_id
;

SELECT

DATE_FORMAT(date, '%Y年%m月') AS 年月,

monthly_withdrawal AS 出金額,

monthly_deposit AS 入金額,

balance AS 月末残高

FROM mufj

INNER JOIN (

SELECT

MAX(id) AS max_id,

SUM(withdrawal) AS monthly_withdrawal,

SUM(deposit) AS monthly_deposit

FROM mufj

GROUP BY DATE_FORMAT(date, '%Y%m')

) AS monthly_final_transaction

ON id = max_id

;

要点は以下の通り。

月ごとにグルーピングしているサブクエリ―で、SUM関数によって月単位の出金・入金額を計算
それらの値をエイリアスを使って元のテーブルで表示

このクエリーのチェックは、前月残高に当月の入出金額を加減して当月残高となることで確認できる。