Laravel – Userモデル

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

概要

Laravelプロジェクト作成時にUserモデルのapp/User.phpファイルが自動作成される。この中で、認証関係について調べてみた。

User.phpファイルの内容

app/User.phpの内容は以下のとおり。

<?php

namespace App;

use Illuminate\Contracts\Auth\MustVerifyEmail;
use Illuminate\Foundation\Auth\User as Authenticatable;
use Illuminate\Notifications\Notifiable;

class User extends Authenticatable
{
    use Notifiable;

    /**
     * The attributes that are mass assignable.
     *
     * @var array
     */
    protected $fillable = [
        'name', 'email', 'password',
    ];

    /**
     * The attributes that should be hidden for arrays.
     *
     * @var array
     */
    protected $hidden = [
        'password', 'remember_token',
    ];

    /**
     * The attributes that should be cast to native types.
     *
     * @var array
     */
    protected $casts = [
        'email_verified_at' => 'datetime',
    ];
}

<?php

namespace App;

use Illuminate\Contracts\Auth\MustVerifyEmail;

use Illuminate\Foundation\Auth\User as Authenticatable;

use Illuminate\Notifications\Notifiable;

class User extends Authenticatable

{

use Notifiable;

/**

* The attributes that are mass assignable.

* @var array

protected $fillable = [

'name', 'email', 'password',

];

/**

* The attributes that should be hidden for arrays.

* @var array

protected $hidden = [

'password', 'remember_token',

];

/**

* The attributes that should be cast to native types.

* @var array

protected $casts = [

'email_verified_at' => 'datetime',

];

}

認証関係

UserクラスはModelクラスを(直接には)継承していない
UserクラスはAuthenticatableクラスを継承している
AuthenticatableクラスはIlluminate\Foundation\Auth\Userのエイリアスとして定義されている。

Illuminate\Foundation\Auth\Userクラス

UserモデルクラスがAuthenticatbleクラスとして継承しているIlluminate\Foundation\Auth\Userクラスの要点は以下のとおり。

Modelクラスを継承している(L14)
AuthenticatableContractインターフェイスを適用している(L15)
- AuthenticatableContractはIlluminate\Contracts\Auth\Authenticatableインターフェイスのエイリアス(L15)
AuthenticatableContractインターフェイスのメソッドは、Illuminate\Auth\Authenticatableトレイトで実装(L19, L5)

同じAuthenticatableという名前でインターフェイスとトレイトがあるのがややこしい。

<?php

namespace Illuminate\Foundation\Auth;

use Illuminate\Auth\Authenticatable;
use Illuminate\Auth\MustVerifyEmail;
use Illuminate\Auth\Passwords\CanResetPassword;
use Illuminate\Contracts\Auth\Access\Authorizable as AuthorizableContract;
use Illuminate\Contracts\Auth\Authenticatable as AuthenticatableContract;
use Illuminate\Contracts\Auth\CanResetPassword as CanResetPasswordContract;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Foundation\Auth\Access\Authorizable;

class User extends Model implements
    AuthenticatableContract,
    AuthorizableContract,
    CanResetPasswordContract
{
    use Authenticatable, Authorizable, CanResetPassword, MustVerifyEmail;
}

<?php

namespace Illuminate\Foundation\Auth;

use Illuminate\Auth\Authenticatable;

use Illuminate\Auth\MustVerifyEmail;

use Illuminate\Auth\Passwords\CanResetPassword;

use Illuminate\Contracts\Auth\Access\Authorizable as AuthorizableContract;

use Illuminate\Contracts\Auth\Authenticatable as AuthenticatableContract;

use Illuminate\Contracts\Auth\CanResetPassword as CanResetPasswordContract;

use Illuminate\Database\Eloquent\Model;

use Illuminate\Foundation\Auth\Access\Authorizable;

class User extends Model implements

AuthenticatableContract,

AuthorizableContract,

CanResetPasswordContract

{

use Authenticatable, Authorizable, CanResetPassword, MustVerifyEmail;

}

Authenticatableインターフェース

Illuminate\Contracts\Auth\Authenticatableインターフェイスは、識別子やパスワード、セッションに関する6つのメソッドの実装を要請する。

Userクラスでこのインターフェイスを適用する際には、エイリアスでAuthenticatbleContractという別名で扱っている。

<?php

namespace Illuminate\Contracts\Auth;

interface Authenticatable
{
    // userの一意な識別子名をstringで返す
    public function getAuthIdentifierName();

    // userの一意な識別子を返す(mixed型)
    public function getAuthIdentifier();

    // userのパスワードをstringで返す
    public function getAuthPassword();

    // "remember me"セッションのトークンをstringで返す
    public function getRememberToken();

    // "remember me"セッションのトークンをstringで与えて設定する
    public function setRememberToken($value);

    // "remember me"トークンのカラム名をstringで返す
    public function getRememberTokenName();
}

<?php

namespace Illuminate\Contracts\Auth;

interface Authenticatable

{

// userの一意な識別子名をstringで返す

public function getAuthIdentifierName();

// userの一意な識別子を返す(mixed型)

public function getAuthIdentifier();

// userのパスワードをstringで返す

public function getAuthPassword();

// "remember me"セッションのトークンをstringで返す

public function getRememberToken();

// "remember me"セッションのトークンをstringで与えて設定する

public function setRememberToken($value);

// "remember me"トークンのカラム名をstringで返す

public function getRememberTokenName();

}

Authenticatableトレイト

Illuminate\Auth\Authenticatableトレイトは、Authenticatableインターフェイスで要請された6つのメソッドを実装する。

<?php

namespace Illuminate\Auth;

trait Authenticatable
{
    // "remember me"トークンのカラム名
    protected $rememberTokenName = 'remember_token';

    // userの一意な識別子名をstringで返す
    public function getAuthIdentifierName()
    {
        return $this->getKeyName();
    }

    // userの一意な識別子を返す(mixed型)
    public function getAuthIdentifier()
    {
        return $this->{$this->getAuthIdentifierName()};
    }

    // userのパスワードをstringで返す
    public function getAuthPassword()
    {
        return $this->password;
    }

    // "remember me"セッションのトークンをstringで返す
    public function getRememberToken()
    {
        if (! empty($this->getRememberTokenName())) {
            return (string) $this->{$this->getRememberTokenName()};
        }
    }

    // "remember me"セッションのトークンをstringで与えて設定する
    public function setRememberToken($value)
    {
        if (! empty($this->getRememberTokenName())) {
            $this->{$this->getRememberTokenName()} = $value;
        }
    }

    // "remember me"トークンのカラム名をstringで返す
    public function getRememberTokenName()
    {
        return $this->rememberTokenName;
    }
}

<?php

namespace Illuminate\Auth;

trait Authenticatable

{

// "remember me"トークンのカラム名

protected $rememberTokenName = 'remember_token';

// userの一意な識別子名をstringで返す

public function getAuthIdentifierName()

{

return $this->getKeyName();

}

// userの一意な識別子を返す(mixed型)

public function getAuthIdentifier()

{

return $this->{$this->getAuthIdentifierName()};

}

// userのパスワードをstringで返す

public function getAuthPassword()

{

return $this->password;

}

// "remember me"セッションのトークンをstringで返す

public function getRememberToken()

{

if (! empty($this->getRememberTokenName())) {

return (string) $this->{$this->getRememberTokenName()};

}

// "remember me"セッションのトークンをstringで与えて設定する

public function setRememberToken($value)

{

if (! empty($this->getRememberTokenName())) {

$this->{$this->getRememberTokenName()} = $value;

}

// "remember me"トークンのカラム名をstringで返す

public function getRememberTokenName()

{

return $this->rememberTokenName;

}

要約

要約すると、プロジェクトで生成されるUserクラスはIlluminate\Foundation\Auth\Userクラスを継承することによって、

Illuminate\Database\Eloquent\Modelクラスを継承している
Authenticatableインターフェイスの6つのメソッドを実装している
- これにより、ユーザー認証と継続セッションの機能が実装される。

通知関係

UserモデルクラスはIlluminate\Notifications\Notifiableトレイトを実装している。

.....
use Illuminate\Notifications\Notifiable;

class User extends Authenticatable
{
    use Notifiable;
    ....
}

.....

use Illuminate\Notifications\Notifiable;

class User extends Authenticatable

{

use Notifiable;

....

}

属性関係

$fillable

フォームのデータをマスアサインメントで取り込むための設定。

    protected $fillable = [
        'name', 'email', 'password',
    ];

protected $fillable = [

'name', 'email', 'password',

];

$hidden

モデルを変換する際に、指定した属性を含めないための指定。

    protected $hidden = [
        'password', 'remember_token',
    ];

protected $hidden = [

'password', 'remember_token',

];

$cast

データベースの読み込み時にstringから特定のデータ型にキャストするための指定。

    protected $casts = [
        'email_verified_at' => 'datetime',
    ];

protected $casts = [

'email_verified_at' => 'datetime',

];

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

Userモデルクラスファイルとともに、以下のマイグレーションファイルもLaravelにより生成される。

<?php

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

class CreateUsersTable extends Migration
{
    /**
     * Run the migrations.
     *
     * @return void
     */
    public function up()
    {
        Schema::create('users', function (Blueprint $table) {
            $table->bigIncrements('id');
            $table->string('name');
            $table->string('email')->unique();
            $table->datetime('email_verified_at')->nullable();
            $table->string('password');
            $table->rememberToken();
            $table->datetime('created_at');
            $table->datetime('updated_at');
        });
    }

    /**
     * Reverse the migrations.
     *
     * @return void
     */
    public function down()
    {
        Schema::dropIfExists('users');
    }
}

<?php

use Illuminate\Database\Migrations\Migration;

use Illuminate\Database\Schema\Blueprint;

use Illuminate\Support\Facades\Schema;

class CreateUsersTable extends Migration

{

/**

* Run the migrations.

* @return void

public function up()

{

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

$table->bigIncrements('id');

$table->string('name');

$table->string('email')->unique();

$table->datetime('email_verified_at')->nullable();

$table->string('password');

$table->rememberToken();

$table->datetime('created_at');

$table->datetime('updated_at');

});

}

/**

* Reverse the migrations.

* @return void

public function down()

{

Schema::dropIfExists('users');

}

artisan migrateコマンドで生成されたテーブルの構造は以下のとおり。

mysql> DESCRIBE users;
+-------------------+-----------------+------+-----+---------+----------------+
| Field             | Type            | Null | Key | Default | Extra          |
+-------------------+-----------------+------+-----+---------+----------------+
| id                | bigint unsigned | NO   | PRI | NULL    | auto_increment |
| name              | varchar(255)    | NO   |     | NULL    |                |
| email             | varchar(255)    | NO   | UNI | NULL    |                |
| email_verified_at | datetime        | YES  |     | NULL    |                |
| password          | varchar(255)    | NO   |     | NULL    |                |
| remember_token    | varchar(100)    | YES  |     | NULL    |                |
| created_at        | datetime        | NO   |     | NULL    |                |
| updated_at        | datetime        | NO   |     | NULL    |                |
+-------------------+-----------------+------+-----+---------+----------------+
8 rows in set (0.02 sec)

mysql> DESCRIBE users;

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

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

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

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

8 rows in set (0.02 sec)

ユーザー認証

基本的なユーザー認証の設定はこちらを参照。

また、ユーザー登録処理の内容、ログイン処理の内容についてはそれぞれのリンクを参照。

Laravel6 – ユーザー認証

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

プロジェクト開始時に作成されるファイル

Userモデル

プロジェクトを作成すると、appディレクトリー下にUser.phpが作成される。

Userモデルの内容についてはこちらを参照。

<?php

namespace App;

use Illuminate\Contracts\Auth\MustVerifyEmail;
use Illuminate\Foundation\Auth\User as Authenticatable;
use Illuminate\Notifications\Notifiable;

class User extends Authenticatable
{
    use Notifiable;

    // マスアサインメントの対象となる属性
    protected $fillable = [
        'name', 'email', 'password',
    ];

    // 秘匿する属性
    protected $hidden = [
        'password', 'remember_token',
    ];

    // データベース読み込み時にキャストする属性
    protected $casts = [
        'email_verified_at' => 'datetime',
    ];
}

<?php

namespace App;

use Illuminate\Contracts\Auth\MustVerifyEmail;

use Illuminate\Foundation\Auth\User as Authenticatable;

use Illuminate\Notifications\Notifiable;

class User extends Authenticatable

{

use Notifiable;

// マスアサインメントの対象となる属性

protected $fillable = [

'name', 'email', 'password',

];

// 秘匿する属性

protected $hidden = [

'password', 'remember_token',

];

// データベース読み込み時にキャストする属性

protected $casts = [

'email_verified_at' => 'datetime',

];

}

コントローラー

プロジェクトを作成すると、Controllers/Authディレクトリー下に以下の認証用コントローラー群が自動的に作成される。

[vagrant@localhost laravel_photo]$ ls app/Http/Controllers/Auth/ -Al
合計 24
-rw-rw-r--. 1 vagrant vagrant 1024  5月 12 05:47 ConfirmPasswordController.php
-rw-rw-r--. 1 vagrant vagrant  667  5月 12 05:47 ForgotPasswordController.php
-rw-rw-r--. 1 vagrant vagrant 1002  5月 12 05:47 LoginController.php
-rw-rw-r--. 1 vagrant vagrant 1950  5月 12 05:47 RegisterController.php
-rw-rw-r--. 1 vagrant vagrant  844  5月 12 05:47 ResetPasswordController.php
-rw-rw-r--. 1 vagrant vagrant 1130  5月 12 05:47 VerificationController.php

[vagrant@localhost laravel_photo]$ ls app/Http/Controllers/Auth/ -Al

合計 24

-rw-rw-r--. 1 vagrant vagrant 1024 5月 12 05:47 ConfirmPasswordController.php

-rw-rw-r--. 1 vagrant vagrant 667 5月 12 05:47 ForgotPasswordController.php

-rw-rw-r--. 1 vagrant vagrant 1002 5月 12 05:47 LoginController.php

-rw-rw-r--. 1 vagrant vagrant 1950 5月 12 05:47 RegisterController.php

-rw-rw-r--. 1 vagrant vagrant 844 5月 12 05:47 ResetPasswordController.php

-rw-rw-r--. 1 vagrant vagrant 1130 5月 12 05:47 VerificationController.php

ルーティング設定

ユーザー認証のためのルーティング

プロジェクト作成後にUserモデルと必要なコントローラーはLaravelにより作成されるが、ルーティングは設定が必要になる。

ルーティングファイルに以下の1行を記載すると、ユーザー認証用の各種ルーティングがまとめて定義される。

Auth::routes();

1	Auth::routes();

ルーティングリスト

関係するルーティングは以下の通りで、ログイン関係とユーザー登録関係が定義されている。

[vagrant@localhost laravel_photo]$ php artisan route:list
+--------+-----------+------------------------+------------------+------------------------------------------------------------------------+--------------+
| Domain | Method    | URI                    | Name             | Action                                                                 | Middleware   |
+--------+-----------+------------------------+------------------+------------------------------------------------------------------------+--------------+
|        | GET|HEAD  | /                      |                  | Closure                                                                | web          |
|        | GET|HEAD  | api/user               |                  | Closure                                                                | api,auth:api |
.....
|        | GET|HEAD  | login                  | login            | App\Http\Controllers\Auth\LoginController@showLoginForm                | web,guest    |
|        | POST      | login                  |                  | App\Http\Controllers\Auth\LoginController@login                        | web,guest    |
|        | POST      | logout                 | logout           | App\Http\Controllers\Auth\LoginController@logout                       | web          |
|        | GET|HEAD  | password/confirm       | password.confirm | App\Http\Controllers\Auth\ConfirmPasswordController@showConfirmForm    | web,auth     |
|        | POST      | password/confirm       |                  | App\Http\Controllers\Auth\ConfirmPasswordController@confirm            | web,auth     |
|        | POST      | password/email         | password.email   | App\Http\Controllers\Auth\ForgotPasswordController@sendResetLinkEmail  | web          |
|        | GET|HEAD  | password/reset         | password.request | App\Http\Controllers\Auth\ForgotPasswordController@showLinkRequestForm | web          |
|        | POST      | password/reset         | password.update  | App\Http\Controllers\Auth\ResetPasswordController@reset                | web          |
|        | GET|HEAD  | password/reset/{token} | password.reset   | App\Http\Controllers\Auth\ResetPasswordController@showResetForm        | web          |
.....
|        | GET|HEAD  | register               | register         | App\Http\Controllers\Auth\RegisterController@showRegistrationForm      | web,guest    |
|        | POST      | register               |                  | App\Http\Controllers\Auth\RegisterController@register                  | web,guest    |
+--------+-----------+------------------------+------------------+------------------------------------------------------------------------+--------------+

[vagrant@localhost laravel_photo]$ php artisan route:list

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

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

| | GET|HEAD | / | | Closure | web |

.....

| | GET|HEAD | password/reset/{token} | password.reset | App\Http\Controllers\Auth\ResetPasswordController@showResetForm | web |

.....

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

ビューの作成

自動作成の場合

php artisan ui vue --authコマンドでユーザー認証に必要なビューを作成
作成されるビューはresources/views/authディレクトリー下に配置

カスタムビュー作成の場合

authディレクトリーの作成

resources/viewsディレクトリー下にauthディレクトリーを作成
作成したauthディレクトリー下に必要なビューを定められたファイル名と内容で作成

登録用フォームビューの作成～register.blade.php

authディレクトリー下に、以下フォームを含む内容でregister.blade.phpを作成。ビュー名はLaravelが生成するコントローラーで想定されているされるため、これに合わせる必要がある。

たとえばユーザー登録フォームのビュー名はRegisterControllerでuseされているRegistersUsersトレイトのshowRegistrationForm()メソッドにおいて、'auth.register'として呼ばれる。

  <form method="post" action="{{ route('register') }}">
    @csrf
    <div>
      <label>ユーザー名: <input type="text" name="name"></label>
    </div>
    <div>
      <label>メールアドレス: <input type="email" name="email"></label>
    </div>
    <div>
      <label>パスワード: <input type="password" name="password"></label>
    </div>
    <div>
      <label>パスワード: <input type="password" name="password_confirmation"></label>
    </div>

    <div>
      <input type="submit" value="登録">
    </div>
  </form>

@csrf

<div>

<label>ユーザー名: <input type="text" name="name"></label>

</div>

<div>

<label>メールアドレス: <input type="email" name="email"></label>

</div>

<div>

<label>パスワード: <input type="password" name="password"></label>

</div>

<div>

<label>パスワード: <input type="password" name="password_confirmation"></label>

</div>

<div>

</div>

</form>

ブラウザーからURL:ドメイン名/registerでアクセスすると以下のようなフォームが表示される。

カスタマイズしていない状態で登録ボタンを押すと、URL:ドメイン名/homeにリダイレクトされる(後述のように、そのままでは404エラーになる)。

ログインフォームビューの作成～login.blade.php

authディレクトリー下に、以下のフォームを含む内容でlogin.blade.phpを作成。

  <form method="post" action="{{ route('login') }}">
    <div>
      <label>メールアドレス: <input type="email" name="email"></label>
    </div>
    <div>
      <label>パスワード: <input type="password" name="password"></label>
    </div>
    <div>
      <input type="submit" value="ログイン">
    </div>
  </form>

<div>

<label>メールアドレス: <input type="email" name="email"></label>

</div>

<div>

<label>パスワード: <input type="password" name="password"></label>

</div>

<div>

</div>

</form>

ブラウザーからURL:ドメイン名/loginでアクセスすると以下のようなフォームが表示される。

カスタマイズしていない状態で登録ボタンを押すと、URL:ドメイン名/homeにリダイレクトされる。

コントローラー設定

ログイン後の画面遷移

たとえばユーザーログイン後のトップページを'posts/index'とする。

デフォルト設定～404エラー

カスタマイズしていない状態では以下の様になっているが、このままログインすると404エラーとなる。

ルーティングファイル→特に設定なし
コントローラー

Controllers/Auth/LogiinController.php
PHP

protected $redirectTo = RouteServiceProvider::HOME;

1

protected $redirectTo = RouteServiceProvider::HOME;

このときブラウザーのURL表示はhttp://localhost:3000/homeとなっている。

方法1～コントロールファイルを変更

以下の様に$redirectToの定義を編集すると、意図したページに遷移する。

protected $redirectTo = 'posts/index';

または

protected $redirectTo = 'posts';

protected $redirectTo = 'posts/index';

または

protected $redirectTo = 'posts';

方法2～ルーティングファイルに追加

コントローラーが以下の様に生成直後の状態で・・・

protected $redirectTo = RouteServiceProvider::HOME;

1	protected $redirectTo = RouteServiceProvider::HOME;

ルーティングファイルに以下の1行を追加する。

Route::get('home', 'PostController@index');

1	Route::get('home', 'PostController@index');

なお、上記をルーティングファイルに追加すれば、コントローラーの定義は以下でもよい。

protected $redirectTo = 'home';

1	protected $redirectTo = 'home';

ルート名は使えない

ルート名が設定されていても、以下の表現はエラーになる(Constant expression contains invalid operations)。

protected $redirectTo = route('posts.index');

1	protected $redirectTo = route('posts.index');

ユーザー登録後の画面遷移

RegisterControllerでもデフォルトで以下の様に定義されている。

protected $redirectTo = RouteServiceProvider::HOME;

1	protected $redirectTo = RouteServiceProvider::HOME;

LoginControllerと同じようにルーティング設定をすることで、ユーザー登録後の遷移先を設定することができる。

ユーザー認証処理の詳細

ユーザー登録処理の内容、ログイン処理の内容についてはそれぞれのリンクを参照。

2038年問題対応

Laravelでモデルの雛形を生成する場合、MySQLだと作成日時と更新日時のtimestamp型の2038年問題が内包される。

database/migrationsディレクトリー下のマイグレーションファイル、...create_users_table.phpのtimestampsをdatetime型に修正しておくべき。

ログアウト処理

ログアウト処理についてはこちら。

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

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

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

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

<?php

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

<?php

class MyClass

{

public static function __callStatic($method, $args) {

echo '$method:';

var_export($method);

echo PHP_EOL;

echo '$args:' . PHP_EOL;

var_export($args);

echo PHP_EOL;

}

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

MyClass::method1();
// $method:'method1'
// $args:
// array (
// )

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

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

MyClass::method1();

// $method:'method1'

// $args:

// array (

// )

MyClass::myMethod(1);

// $method:'myMethod'

// $args:

// array (

// 0 => 1,

// )

MyClass::myMethod(1, "two");

// $method:'myMethod'

// $args:

// array (

// 0 => 1,

// 1 => 'two',

// )

インスタンスに対して存在しないstaticメソッドを呼んで__callStatic()が実行される場合、通常のstaticメソッドと違って'->'はエラーになる。

<?php

class MyClass
{
  public static function static_method() {
    echo "static method\n";
  }

  public static function __callStatic($method, $args) {
    echo "__callStatic called.\n";
  }
}

$instance = new MyClass();

$instance->static_method();
// static method

$instance::static_method();
// static method

$instance::method1('undefined static method');
//__callStatic called.

$instance->method1('undefined static method');
// Uncaught Error: Call to undefined method MyClass::method1()

<?php

class MyClass

{

public static function static_method() {

echo "static method\n";

}

public static function __callStatic($method, $args) {

echo "__callStatic called.\n";

}

$instance = new MyClass();

$instance->static_method();

// static method

$instance::static_method();

// static method

$instance::method1('undefined static method');

//__callStatic called.

$instance->method1('undefined static method');

// Uncaught Error: Call to undefined method MyClass::method1()

PHP – static::とself::

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

概要

static::とself::はクラスのスタティックメソッドを指すときに使えるが、それぞれ以下のような違いがある。

staticはそれが実行されるときのクラスを指す
selfはそれが定義されたときのクラスを指す

参照：new staticとnew self

準備

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

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

<?php

class ParentClass
{
  public static function static_method() {
    echo 'in ParentClass', PHP_EOL;
  }

  public function parent_method() {
    static::static_method();
    self::static_method();
  }
}

class ChildClass extends ParentClass
{
  public static function static_method() {
    echo 'in ChildClass', PHP_EOL;
  }

  public function child_method() {
    static::static_method();
    self::static_method();
  }
}

<?php

class ParentClass

{

public static function static_method() {

echo 'in ParentClass', PHP_EOL;

}

public function parent_method() {

static::static_method();

self::static_method();

}

class ChildClass extends ParentClass

{

public static function static_method() {

echo 'in ChildClass', PHP_EOL;

}

public function child_method() {

static::static_method();

self::static_method();

}

クラスからstaticメソッドを呼ぶ

クラスからstaticメソッドを呼ぶと、当然それぞれに対応したstatic_method()が実行される。

ParentClass::static_method();
ChildClass::static_method();

// static method of Parent
// static method of Child

ParentClass::static_method();

ChildClass::static_method();

// static method of Parent

// static method of Child

親クラスのメソッドから呼ぶ

親クラスのインスタンスを作って、インスタンスメソッドparent_method()内でstatic、selfでstatic_method()を呼び出す場合。

親クラスのstaticメソッドしか対象がないので、いずれの場合も親クラスのstatic_method()が実行される。

$parent = new ParentClass();
$parent->parent_method();

// in ParentClass
// in ParentClass

$parent = new ParentClass();

$parent->parent_method();

// in ParentClass

子クラスのメソッドから呼ぶ

子クラスのインスタンスを作って、インスタンスメソッドchild_method()内でstatic、selfでstatic_method()を呼び出す場合。

static、selfとも子クラスを指し、子クラスのインスタンスメソッドが実行される。

$child = new ChildClass();
$child->child_method();

// in ChildClass
// in ChildClass

$child = new ChildClass();

$child->child_method();

// in ChildClass

子クラスで親クラスのメソッドから呼ぶ

子クラスのインスタンスを作って、継承元の親クラスのインスタンスメソッドparent_method()からstatic、selfでstatic_method()を呼び出す場合。

$child = new ChildClass();
$child->parent_method();

// in ChildClass
// in ParentClass

$child = new ChildClass();

$child->parent_method();

// in ChildClass

// in ParentClass

staticは実行時のクラスを指すため、Childクラスのstatic_method()が実行される。

一方selfは定義時のクラスを指すため、parent_method()が定義されたParentClassのstatic_method()が実行される。