Laravel – モデル作成とマイグレーション

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

データベース設定の確認

アプリケーションディレクトリー直下の.envファイルでデータベースの設定を確認する。DB_DATABASEに設定されたデータベースが作成済みでRDBMSでアクセス可能であることを確認する。

[vagrant@localhost laravel_tutorial]$ cat .env
.....

DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=laravel_test←データベース名
DB_USERNAME=root
DB_PASSWORD=パスワード

.....

[vagrant@localhost laravel_tutorial]$ cat .env

.....

DB_CONNECTION=mysql

DB_HOST=127.0.0.1

DB_PORT=3306

DB_DATABASE=laravel_test←データベース名

DB_USERNAME=root

DB_PASSWORD=パスワード

.....

モデルの作成

モデル作成コマンド

モデルの作成には、artisanのmake:modelコマンドを使う。同時にデータベースを定義するマイグレーションファイルも作成するときは--migrationオプションを付ける。

php artisan make:model モデル名 --migration

モデル名の考え方は以下の通り。

データベースのレコードに保存する対象として、単数の名詞とする
モデル名はアッパー・キャメルケース(パスカルケース)で定義する

以下はTestModelというモデルを作成したケース。

[vagrant@localhost laravel_tutorial]$ php artisan make:model TestModel --migration
Model created successfully.
Created Migration: 2021_08_23_093211_create_test_models_table

[vagrant@localhost laravel_tutorial]$ php artisan make:model TestModel --migration

Model created successfully.

Created Migration: 2021_08_23_093211_create_test_models_table

モデルの作成に成功したことと、2021_08_23…という名前でマイグレーションファイルが作成されたことが表示されている。

マイグレーションファイルの作成は--migrationオプションを付けたためで、これをつけないとモデルのだけが作成される。

モデルクラスファイル

モデルのクラスファイルはappディレクトリー下に作成される。コマンドで指定したモデル名に拡張子.phpが付けられている。

[vagrant@localhost laravel_tutorial]$ ls -Al app
合計 8
drwxrwxr-x. 2 vagrant vagrant  24  8月 15 23:38 Console
drwxrwxr-x. 2 vagrant vagrant  25  8月 15 23:38 Exceptions
drwxrwxr-x. 4 vagrant vagrant  61  8月 15 23:38 Http
drwxrwxr-x. 2 vagrant vagrant 167  8月 15 23:38 Providers
-rw-rw-r--. 1 vagrant vagrant 105  8月 23 09:32 TestModel.php
-rw-rw-r--. 1 vagrant vagrant 734  8月 15 23:38 User.php

[vagrant@localhost laravel_tutorial]$ ls -Al app

合計 8

drwxrwxr-x. 2 vagrant vagrant 24 8月 15 23:38 Console

drwxrwxr-x. 2 vagrant vagrant 25 8月 15 23:38 Exceptions

drwxrwxr-x. 4 vagrant vagrant 61 8月 15 23:38 Http

drwxrwxr-x. 2 vagrant vagrant 167 8月 15 23:38 Providers

-rw-rw-r--. 1 vagrant vagrant 105 8月 23 09:32 TestModel.php

-rw-rw-r--. 1 vagrant vagrant 734 8月 15 23:38 User.php

以下がモデルクラスファイルの内容。

名前空間をAppとしている
名前空間Illuminate\Database\EloquentのModelファイルを利用する
ModelファイルはModelクラスのファイル
今回作成したTestModelクラスはModelクラスを継承している
モデル作成で定義した名前がそのままクラス名になっている
作成したクラスの中身は空

[vagrant@localhost laravel_tutorial]$ cat app/TestModel.php
<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class TestModel extends Model
{
    //
}

[vagrant@localhost laravel_tutorial]$ cat app/TestModel.php

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class TestModel extends Model

{

}

オプション指定

モデル作成コマンドのオプションは-h/--helpオプションで指定できる。

php artisan make:model --help

1	php artisan make:model --help

主なオプションは以下の通り。

-c/--controller: コントローラーを作成する。
-m/--migration: マイグレーションファイルを作成する。
-r/--resource: リソースベースのアクションが含まれたコントローラーが生成される。ルーティングでのonly、exceptと関係なく、すべてのアクションが含まれる。
-s/--seed: シーダーファイルを作成する。

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

ファイル名

モデルクラスファイルと同時に作成されたマイグレーションファイルは、database/migrations下にある。新たに作成された2021_08_23...のマイグレーションファイルが確認できる。

マイグレーションファイルのファイル名構成は以下の通り。

日付_時刻_create_テーブル名_table.php

テーブル名はモデル名をスネークケースに変更し、複数形となっている。

[vagrant@localhost laravel_tutorial]$ ls -Al database/migrations/
合計 16
-rw-rw-r--. 1 vagrant vagrant 813  8月 15 23:38 2014_10_12_000000_create_users_table.php
-rw-rw-r--. 1 vagrant vagrant 683  8月 15 23:38 2014_10_12_100000_create_password_resets_table.php
-rw-rw-r--. 1 vagrant vagrant 789  8月 15 23:38 2019_08_19_000000_create_failed_jobs_table.php
-rw-rw-r--. 1 vagrant vagrant 606  8月 23 09:32 2021_08_23_093211_create_test_models_table.php

[vagrant@localhost laravel_tutorial]$ ls -Al database/migrations/

合計 16

-rw-rw-r--. 1 vagrant vagrant 813 8月 15 23:38 2014_10_12_000000_create_users_table.php

-rw-rw-r--. 1 vagrant vagrant 683 8月 15 23:38 2014_10_12_100000_create_password_resets_table.php

-rw-rw-r--. 1 vagrant vagrant 789 8月 15 23:38 2019_08_19_000000_create_failed_jobs_table.php

-rw-rw-r--. 1 vagrant vagrant 606 8月 23 09:32 2021_08_23_093211_create_test_models_table.php

マイグレーションファイルの内容は以下の通り。

up()メソッド

up()メソッドではテーブルを作成するときのカラム定義が記述されている。

bigincrements()はbigint unsigned型、AUTO_INCREMENT設定のカラムidを定義
timestamps()はtimestamp型でcreated_atとupdated_atの2つのカラムを定義

bigIncrements()によるIDを外部キーで参照する場合

bigIncrements()で生成されるカラムはbigint(unsigned)となる。他テーブルでこれを外部キーとして参照する場合のカラム型はbigint unsignedとする。マイグレーションファイルで指定する場合はunsignedBigInteger()とする。

down()メソッド

down()メソッドは、test_modelsテーブルが存在する場合にこれを削除(DROP)。

[vagrant@localhost laravel_tutorial]$ cat database/migrations/2021_08_23_093211_create_test_models_table.php
<?php

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

class CreateTestModelsTable extends Migration
{
    /**
     * Run the migrations.
     *
     * @return void
     */
    public function up()
    {
        Schema::create('test_models', function (Blueprint $table) {
            $table->bigIncrements('id');
            $table->timestamps();
        });
    }

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

[vagrant@localhost laravel_tutorial]$ cat database/migrations/2021_08_23_093211_create_test_models_table.php

<?php

use Illuminate\Database\Migrations\Migration;

use Illuminate\Database\Schema\Blueprint;

use Illuminate\Support\Facades\Schema;

class CreateTestModelsTable extends Migration

{

/**

* Run the migrations.

* @return void

public function up()

{

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

$table->bigIncrements('id');

$table->timestamps();

});

}

/**

* Reverse the migrations.

* @return void

public function down()

{

Schema::dropIfExists('test_models');

}

マイグレーション実行

マイグレーションコマンドについてはこちらを参照。

状態確認

マイグレーション実行前のテーブルの状態。準備の時に作成したままになっている。

mysql> SHOW TABLES;
+------------------------+
| Tables_in_laravel_test |
+------------------------+
| failed_jobs            |
| migrations             |
| password_resets        |
| users                  |
+------------------------+
5 rows in set (0.00 sec)

mysql> SHOW TABLES;

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

| Tables_in_laravel_test |

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

| failed_jobs |

| migrations |

| password_resets |

| users |

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

5 rows in set (0.00 sec)

マイグレーションの実行状態は以下のコマンドで確認。

php artisan migrate:status

今回作成されたマイグレーションファイルだけが未実行となっている。

[vagrant@localhost laravel_tutorial]$ php artisan migrate:status
+------+------------------------------------------------+-------+
| Ran? | Migration                                      | Batch |
+------+------------------------------------------------+-------+
| Yes  | 2014_10_12_000000_create_users_table           | 1     |
| Yes  | 2014_10_12_100000_create_password_resets_table | 1     |
| Yes  | 2019_08_19_000000_create_failed_jobs_table     | 1     |
| No   | 2021_08_23_093211_create_test_models_table     |       |
+------+------------------------------------------------+-------+

[vagrant@localhost laravel_tutorial]$ php artisan migrate:status

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

| Ran? | Migration | Batch |

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

| Yes | 2014_10_12_000000_create_users_table | 1 |

| Yes | 2014_10_12_100000_create_password_resets_table | 1 |

| Yes | 2019_08_19_000000_create_failed_jobs_table | 1 |

| No | 2021_08_23_093211_create_test_models_table | |

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

マイグレート

以下のコマンドで、マイグレーションファイルの設定に従ってテーブルを作成する。

php artisan migrate

[vagrant@localhost laravel_tutorial]$ php artisan migrate
Migrating: 2021_08_23_093211_create_test_models_table
Migrated:  2021_08_23_093211_create_test_models_table (0.02 seconds)

[vagrant@localhost laravel_tutorial]$ php artisan migrate

Migrating: 2021_08_23_093211_create_test_models_table

Migrated: 2021_08_23_093211_create_test_models_table (0.02 seconds)

マイグレーションの結果、データベースにテーブルが作成される。テーブル名はマイグレーションファイル名にもあるとおりで、以下のように付けられる。

モデル名のキャメルケースをスネークケースに変更
複数形にする

[vagrant@localhost laravel_tutorial]$ php artisan migrate:status
+------+------------------------------------------------+-------+
| Ran? | Migration                                      | Batch |
+------+------------------------------------------------+-------+
| Yes  | 2014_10_12_000000_create_users_table           | 1     |
| Yes  | 2014_10_12_100000_create_password_resets_table | 1     |
| Yes  | 2019_08_19_000000_create_failed_jobs_table     | 1     |
| Yes  | 2021_08_23_093211_create_test_models_table     | 2     |
+------+------------------------------------------------+-------+

[vagrant@localhost laravel_tutorial]$ php artisan migrate:status

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

| Ran? | Migration | Batch |

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

| Yes | 2014_10_12_000000_create_users_table | 1 |

| Yes | 2014_10_12_100000_create_password_resets_table | 1 |

| Yes | 2019_08_19_000000_create_failed_jobs_table | 1 |

| Yes | 2021_08_23_093211_create_test_models_table | 2 |

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

データベースでテーブルが作成されていることを確認。

mysql> SHOW TABLES;
+------------------------+
| Tables_in_laravel_test |
+------------------------+
| failed_jobs            |
| migrations             |
| password_resets        |
| test_models            |
| users                  |
+------------------------+
5 rows in set (0.00 sec)

mysql> SHOW TABLES;

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

| Tables_in_laravel_test |

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

| failed_jobs |

| migrations |

| password_resets |

| test_models |

| users |

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

5 rows in set (0.00 sec)

テーブル構造を確認。timestamp()によって、created_atとupdated_atの2つのカラムが作られている。

ただしtimestamp型は2038年問題が発生するため、datetime型に変更する方がよい。

mysql> DESCRIBE test_models;
+------------+-----------------+------+-----+---------+----------------+
| Field      | Type            | Null | Key | Default | Extra          |
+------------+-----------------+------+-----+---------+----------------+
| id         | bigint unsigned | NO   | PRI | NULL    | auto_increment |
| created_at | timestamp       | YES  |     | NULL    |                |
| updated_at | timestamp       | YES  |     | NULL    |                |
+------------+-----------------+------+-----+---------+----------------+
3 rows in set (0.00 sec)

mysql> DESCRIBE test_models;

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

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

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

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

3 rows in set (0.00 sec)

ロールバック

ロールバックにより、作成したテーブルを削除してマイグレーション前の状態に戻すことができる。

php artisan migrate:rollback

[vagrant@localhost laravel_tutorial]$ php artisan migrate:rollback
Rolling back: 2021_08_23_093211_create_test_models_table
Rolled back:  2021_08_23_093211_create_test_models_table (0.01 seconds)

[vagrant@localhost laravel_tutorial]$ php artisan migrate:rollback

Rolling back: 2021_08_23_093211_create_test_models_table

Rolled back: 2021_08_23_093211_create_test_models_table (0.01 seconds)

ロールバックを実行することで、ここまでで作成したtest_modelsテーブルが削除される。

mysql> SHOW TABLES;
+------------------------+
| Tables_in_laravel_test |
+------------------------+
| failed_jobs            |
| migrations             |
| password_resets        |
| users                  |
+------------------------+
4 rows in set (0.00 sec)

mysql> SHOW TABLES;

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

| Tables_in_laravel_test |

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

| failed_jobs |

| migrations |

| password_resets |

| users |

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

4 rows in set (0.00 sec)

ただしマイグレーションファイルは残っていて、編集などを行った後に再度マイグレーションできる。

[vagrant@localhost laravel_tutorial]$ ls -Al database/migrations/
合計 16
-rw-rw-r--. 1 vagrant vagrant 813  8月 15 23:38 2014_10_12_000000_create_users_table.php
-rw-rw-r--. 1 vagrant vagrant 683  8月 15 23:38 2014_10_12_100000_create_password_resets_table.php
-rw-rw-r--. 1 vagrant vagrant 789  8月 15 23:38 2019_08_19_000000_create_failed_jobs_table.php
-rw-rw-r--. 1 vagrant vagrant 606  8月 23 09:32 2021_08_23_093211_create_test_models_table.php

[vagrant@localhost laravel_tutorial]$ ls -Al database/migrations/

合計 16

-rw-rw-r--. 1 vagrant vagrant 813 8月 15 23:38 2014_10_12_000000_create_users_table.php

-rw-rw-r--. 1 vagrant vagrant 683 8月 15 23:38 2014_10_12_100000_create_password_resets_table.php

-rw-rw-r--. 1 vagrant vagrant 789 8月 15 23:38 2019_08_19_000000_create_failed_jobs_table.php

-rw-rw-r--. 1 vagrant vagrant 606 8月 23 09:32 2021_08_23_093211_create_test_models_table.php

マイグレーションファイルの実行状態も未実行に戻る。

[vagrant@localhost laravel_tutorial]$ php artisan migrate:status
+------+------------------------------------------------+-------+
| Ran? | Migration                                      | Batch |
+------+------------------------------------------------+-------+
| Yes  | 2014_10_12_000000_create_users_table           | 1     |
| Yes  | 2014_10_12_100000_create_password_resets_table | 1     |
| Yes  | 2019_08_19_000000_create_failed_jobs_table     | 1     |
| No   | 2021_08_23_093211_create_test_models_table     |       |
+------+------------------------------------------------+-------+

[vagrant@localhost laravel_tutorial]$ php artisan migrate:status

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

| Ran? | Migration | Batch |

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

| Yes | 2014_10_12_000000_create_users_table | 1 |

| Yes | 2014_10_12_100000_create_password_resets_table | 1 |

| Yes | 2019_08_19_000000_create_failed_jobs_table | 1 |

| No | 2021_08_23_093211_create_test_models_table | |

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

マイグレーションファイルの編集とマイグレーション

test_modelsテーブルのカラムを以下のように編集する。

idカラムはそのまま
VARCHAR(20)でproduct_nameカラムを追加
int型でamountカラムを追加
created_atとupdated_atをtimestamp型からdatetime型に変更

参考：利用可能なカラムタイプ

マイグレーション前のファイルを以下のように編集してマイグレート。

[vagrant@localhost laravel_tutorial]$ cat database/migrations/2021_08_23_093211_create_test_models_table.php
<?php

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

class CreateTestModelsTable extends Migration
{
    /**
     * Run the migrations.
     *
     * @return void
     */
    public function up()
    {
        Schema::create('test_models', function (Blueprint $table) {
            $table->bigIncrements('id');
            $table->string('product_name', 20);
            $table->integer('amount');
            $table->datetime('created_at');
            $table->datetime('updated_at');
        });
    }

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

[vagrant@localhost laravel_tutorial]$ cat database/migrations/2021_08_23_093211_create_test_models_table.php

<?php

use Illuminate\Database\Migrations\Migration;

use Illuminate\Database\Schema\Blueprint;

use Illuminate\Support\Facades\Schema;

class CreateTestModelsTable extends Migration

{

/**

* Run the migrations.

* @return void

public function up()

{

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

$table->bigIncrements('id');

$table->string('product_name', 20);

$table->integer('amount');

$table->datetime('created_at');

$table->datetime('updated_at');

});

}

/**

* Reverse the migrations.

* @return void

public function down()

{

Schema::dropIfExists('test_models');

}

以下の構造のテーブルが作成される。

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

mysql> DESCRIBE test_models;

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

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

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

| amount | int | NO | | NULL | |

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

5 rows in set (0.00 sec)

モデルの削除

モデルとテーブルを削除する手順は以下の通り。

該当テーブルのマイグレーションの前までロールバック
マイグレーションファイル削除
モデルファイル削除

timestampの2038年問題について

モデルとマイグレーションファイルを生成させると、自動的にtimestampsが設定されるが、MySQLとの組み合わせの場合に2038年問題が発生する。datetime型で書きなおすなどの対応をしておくべき。

モデル名とテーブル名について

モデルとテーブルを生成するときの命名の流れは以下のようになっている。

モデル名は単数形でアッパーキャメルケース
モデルクラスファイル名はモデル名に.phpの拡張子
モデルクラス名はモデル名と同じ
テーブル名はキャメルケースからスネークケースに変換され、複数形になる

複数形への変更はLaravelがエレガントにやってくれて、不規則な複数形にも対応している。ただし不可算名詞にはそのままsが付くようだ。

TestModel→test_models
TestDiary→test_diaries
CompanyPerson→CompanyPeople
WildGoos→WildGees
StockWater→StockWaters

なお、敢えてモデル名をスネークケースにすると、クラスファイル名、モデルクラス名もキャメルケースのままで、テーブル名は複数形になる。

test_model→test_models

Laravel – 現在のURLの取得

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

url()ヘルパー

ヘルパーやLaravel - url()を参照。現在のドメインやURLに関する情報が得られる。

Route::current()

以下のメソッドでドメイン名を除いた現在のフルパスが得られる。

\Route::current()->uri()
→localhost:3000/current/path

1 2	\Route::current()->uri() →localhost:3000/current/path

これとurl()ヘルパーを組み合わせて、以下でもカレントパスを得られる。

url(\Route::current()->uri())
→http://localhost:3000/current/path

1 2	url(\Route::current()->uri()) →http://localhost:3000/current/path

PHP – 名前空間～namespace

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

概要

PHPの名前空間(namespace)は、Javaのパッケージのようにコード群をカプセル化し、異なる名前空間の間での名前の衝突を避ける役割を持つ。

namespace 名前空間名;

namespaceが記述された以降のコードはその名前空間に属する
同じ名前空間内では、クラス名などはそのまま記述
異なる名前空間のクラスなどを用いるときは、絶対パスを使うかuse文で名前空間を指定する(このuse文はトレイトのuseとは異なる)

クラスの例

以下の例は、異なる名前空間のクラスを利用する場合。

名前空間Bでクラス名MyClassだけを記述すると、名前空間BのMyClassが使われる
絶対パス\A\MyClassと記述すると、名前空間AのMyClassが使われる
use \A\MyClassを記述すると、MyClassと記述したときに名前空間AのMyClassが使われる(as ...でエイリアスも指定できる)

namespace A;

class MyClass {
  public function show() {
    echo "名前空間Aのクラス\n";
  }
}


namespace B;

class MyClass {
  public function show() {
    echo "名前空間Bのクラス\n";
  }
}

$obj = new MyClass();
$obj->show();

$obj = new \A\MyClass();
$obj->show();


namespace C;

use \A\MyClass; // use A\MyClassでもよい
$obj = new MyClass();
$obj->show();


// 名前空間Bのクラス
// 名前空間Aのクラス
// 名前空間Aのクラス

namespace A;

class MyClass {

public function show() {

echo "名前空間Aのクラス\n";

}

namespace B;

class MyClass {

public function show() {

echo "名前空間Bのクラス\n";

}

$obj = new MyClass();

$obj->show();

$obj = new \A\MyClass();

$obj->show();

namespace C;

use \A\MyClass; // use A\MyClassでもよい

$obj = new MyClass();

$obj->show();

// 名前空間Bのクラス

// 名前空間Aのクラス

関数の場合

以下の例は、異なる名前空間の関数を利用する場合。

名前空間Bで関数名funcだけを記述すると、名前空間Bのfuncが使われる
絶対パス\A\funcと記述すると、名前空間Aのfuncが使われる
use function \A\funcを記述すると、funcと記述したときに名前空間Aのfuncが使われる(as ...でエイリアスも指定できる)

namespace A;

function func() {
  echo "名前空間Aの関数\n";
}


namespace B;

function func() {
  echo "名前空間Bの関数\n";
}

func();
\A\func();


namespace C;

use function \A\func;
func();


// 名前空間Bの関数
// 名前空間Aの関数
// 名前空間Aの関数

namespace A;

function func() {

echo "名前空間Aの関数\n";

}

namespace B;

function func() {

echo "名前空間Bの関数\n";

}

func();

\A\func();

namespace C;

use function \A\func;

func();

// 名前空間Bの関数

// 名前空間Aの関数

定数の場合

以下の例は、異なる名前空間の定数を利用する場合。

名前空間Bで関数名CONSTANTだけを記述すると、名前空間BのCONSTANTが使われる
絶対パス\A\CONSTANTと記述すると、名前空間AのCONSTANTが使われる
use const \A\CONSTANTを記述すると、CONSTANTと記述したときに名前空間AのCONSTANTが使われる(as ...でエイリアスも指定できる)

namespace A;

const CONSTANT = '名前空間Aの定数';


namespace B;

const CONSTANT = '名前空間Bの定数';

echo CONSTANT . "\n";
echo \A\CONSTANT . "\n";


namespace C;

use const \A\CONSTANT;
echo CONSTANT . "\n";


// 名前空間Bの定数
// 名前空間Aの定数
// 名前空間Aの定数

namespace A;

const CONSTANT = '名前空間Aの定数';

namespace B;

const CONSTANT = '名前空間Bの定数';

echo CONSTANT . "\n";

echo \A\CONSTANT . "\n";

namespace C;

use const \A\CONSTANT;

echo CONSTANT . "\n";

// 名前空間Bの定数

// 名前空間Aの定数

変数は名前空間によらずグローバル

変数は、それが定義された名前空間によらずグローバルスコープになる。

namespace A;

$var = '変数は名前空間によらずグローバル';
echo $var . "\n";


namespace B;

echo $var . "\n";


namespace C;

echo $var . "\n";


// 変数はグローバル
// 変数はグローバル
// 変数はグローバル

namespace A;

$var = '変数は名前空間によらずグローバル';

echo $var . "\n";

namespace B;

echo $var . "\n";

namespace C;

echo $var . "\n";

// 変数はグローバル

外部ファイルに分ける場合

外部ファイルで名前空間を設定している場合、インクルードしたコードで明示的に名前空間を指定する。

以下の例では2つのPHPファイルを準備し、それぞれの名前空間を設定している。

namespace_a.php

<?php

namespace A;

class MyClass {
  public function show() {
    echo "名前空間AのMyClass\n";
  }
}

<?php

namespace A;

class MyClass {

public function show() {

echo "名前空間AのMyClass\n";

}

namespace_b.php

<?php

namespace B;

class MyClass {
  public function show() {
    echo "名前空間BのMyClass\n";
  }
}

<?php

namespace B;

class MyClass {

public function show() {

echo "名前空間BのMyClass\n";

}

そして別のファイルでこれらのファイルを読み込んで実行する。

インクルード後に名前空間なしでクラス名のみ指定すると、クラスが見つからずエラーになる。

<?php

require 'namespace_a.php';
require 'namespace_b.php';

$obj = MyClass();

// Error: Class 'MyClass' not found in ...

<?php

require 'namespace_a.php';

require 'namespace_b.php';

$obj = MyClass();

// Error: Class 'MyClass' not found in ...

絶対パスかuseを使えば名前空間に応じたクラスを指定できる。

<?php

require 'namespace_a.php';
require 'namespace_b.php';

$obj = new \A\MyClass();
$obj->show();

// 名前空間AのMyClass

use \B\MyClass;
$obj = new MyClass();
$obj->show();

// 名前空間BのMyClass

<?php

require 'namespace_a.php';

require 'namespace_b.php';

$obj = new \A\MyClass();

$obj->show();

// 名前空間AのMyClass

use \B\MyClass;

$obj = new MyClass();

$obj->show();

// 名前空間BのMyClass

名前空間の部分指定

名前空間をパスで設定した場合、useでその一部を指定することができる。

以下の例では、

名前空間japan\aichiの中でMyClassAとMyClassBを定義
名前空間japan\osakaの中でMyClassを定義
use japan\aichiとすることで、japan\aichi→aichiとして使えるようになる
- japan\aichi\MyClassA→aichi\MyClassA
- japan\aichi\MyClassB→aichi\MyClassB
use japan\osakaとすることで、japan\osaka→osakaとして使えるようになる
- japan\osaka\MyClass→osaka\MyClass

<?php

namespace japan\aichi;

class MyClassA {
  public function show() {
    echo "名前空間\japan\aichiのMyClassA\n";
  }
}

class MyClassB {
  public function show() {
    echo "名前空間\japan\aichiのMyClassB\n";
  }
}


namespace japan\osaka;

class MyClass {
  public function show() {
    echo "名前空間\japan\osakaのMyClass\n";
  }
}

// 名前空間の一部をuseし、japan\aichiをaichiとして使えるようにする
use japan\aichi;

$obj = new aichi\MyClassA();
$obj->show();
$obj = new aichi\MyClassB();
$obj->show();

// 名前空間\japan\aichiのMyClassA
// 名前空間\japan\aichiのMyClassB

// 名前空間の一部をuseし、japan\osakaをosakaとして使えるようにする
use japan\osaka;
$obj =new osaka\MyClass();
$obj->show();

// 名前空間\japan\osakaのMyClass

<?php

namespace japan\aichi;

class MyClassA {

public function show() {

echo "名前空間\japan\aichiのMyClassA\n";

}

class MyClassB {

public function show() {

echo "名前空間\japan\aichiのMyClassB\n";

}

namespace japan\osaka;

class MyClass {

public function show() {

echo "名前空間\japan\osakaのMyClass\n";

}

// 名前空間の一部をuseし、japan\aichiをaichiとして使えるようにする

use japan\aichi;

$obj = new aichi\MyClassA();

$obj->show();

$obj = new aichi\MyClassB();

$obj->show();

// 名前空間\japan\aichiのMyClassA

// 名前空間\japan\aichiのMyClassB

// 名前空間の一部をuseし、japan\osakaをosakaとして使えるようにする

use japan\osaka;

$obj =new osaka\MyClass();

$obj->show();

// 名前空間\japan\osakaのMyClass

PHP – クラス定数

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

クラスの中で、constキーワードで定数を定義できる。

クラス内でアクセスする場合はself::でアクセス
クラス外でアクセスする場合はクラス名::でアクセス(変数::でも可能)

<?php

class MyClass {
  const MY_CONSTANT = 'my constant value';

  public function show() {
    echo self::MY_CONSTANT . "\n";
  }
}

$obj = new MyClass();

echo MyClass::MY_CONSTANT . "\n";
echo $obj::MY_CONSTANT . "\n";
echo $obj->show();

// my constant value
// my constant value
// my constant value

<?php

class MyClass {

const MY_CONSTANT = 'my constant value';

public function show() {

echo self::MY_CONSTANT . "\n";

}

$obj = new MyClass();

echo MyClass::MY_CONSTANT . "\n";

echo $obj::MY_CONSTANT . "\n";

echo $obj->show();

// my constant value

self::、クラス名::などをつけないと、警告が出たうえで定数名自体が文字列として解釈される。

class MyClass {
  const MY_CONSTANT = 'my constant value';

  public function show() {
    MY_CONSTANT . "\n";
  }
}

$obj = new MyClass();

echo MY_CONSTANT . "\n";
echo $obj->show();

// PHP Warning:  Use of undefined constant MY_CONSTANT - assumed 'MY_CONSTANT' (this will throw an Error in a future version of PHP)
// PHP Warning:  Use of undefined constant MY_CONSTANT - assumed 'MY_CONSTANT' (this will throw an Error in a future version of PHP)

class MyClass {

const MY_CONSTANT = 'my constant value';

public function show() {

MY_CONSTANT . "\n";

}

$obj = new MyClass();

echo MY_CONSTANT . "\n";

echo $obj->show();

// PHP Warning: Use of undefined constant MY_CONSTANT - assumed 'MY_CONSTANT' (this will throw an Error in a future version of PHP)

定数なので値を再代入することはできない。

<?php

class MyClass {
  const CONSTANT = 'constatnt value';

  public function show() {
    // self::CONSTANT = 'another constant valuse';
    // エラー：PHP Parse error:  syntax error, unexpected '='
  }
}

$obj = new MyClass();
$obj->show();

// MyClass::CONSTANT = 'another constant value';
// エラー：PHP Parse error:  syntax error, unexpected '='

<?php

class MyClass {

const CONSTANT = 'constatnt value';

public function show() {

// self::CONSTANT = 'another constant valuse';

// エラー：PHP Parse error: syntax error, unexpected '='

}

$obj = new MyClass();

$obj->show();

// MyClass::CONSTANT = 'another constant value';

// エラー：PHP Parse error: syntax error, unexpected '='

const定義の右辺に定義済みの定数、算術式を使うことができる。しかし関数は使用できない。

<?php

class MyClass {
  const CONST1 = 2;
  const CONST2 = 3;
  const CONST3 = self::CONST1 + self::CONST2;
//  const CONST4 = sqrt(CONST1);
//  関数は使えない：Constant expression contains invalid operations
}

echo MyClass::CONST3 . "\n";

// 5

<?php

class MyClass {

const CONST1 = 2;

const CONST2 = 3;

const CONST3 = self::CONST1 + self::CONST2;

// const CONST4 = sqrt(CONST1);

// 関数は使えない：Constant expression contains invalid operations

}

echo MyClass::CONST3 . "\n";

// 5

定数定義の際にアクセス修飾子を使えて、アクセス制限ができる。省略した場合はpublic。

<?php

class MyClass {
  public const PUBLIC_CONST = 'public constant';
  private const PRIVATE_CONST = 'private constant';

  public function show() {
    echo self::PUBLIC_CONST . "\n";
    echo self::PRIVATE_CONST . "\n";
  }
}

$obj = new MyClass();
$obj->show();

echo MyClass::PUBLIC_CONST . "\n";
// echo MyClass::PRIVATE_CONST . "\n";
// エラー：PHP Fatal error:  Uncaught Error: Cannot access private const MyClass::PRIVATE_CONST

// public constant
// private constant
// public constant
// PHP Fatal error:  Uncaught Error: Cannot access private const MyClass::PRIVATE_CONST in ...

<?php

class MyClass {

public const PUBLIC_CONST = 'public constant';

private const PRIVATE_CONST = 'private constant';

public function show() {

echo self::PUBLIC_CONST . "\n";

echo self::PRIVATE_CONST . "\n";

}

$obj = new MyClass();

$obj->show();

echo MyClass::PUBLIC_CONST . "\n";

// echo MyClass::PRIVATE_CONST . "\n";

// エラー：PHP Fatal error: Uncaught Error: Cannot access private const MyClass::PRIVATE_CONST

// public constant

// private constant

// public constant

// PHP Fatal error: Uncaught Error: Cannot access private const MyClass::PRIVATE_CONST in ...

PHP – gettype()/is_* – 型の確認

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

概要

値が特定のプリミティブ型かどうか、何かのクラスのインスタンスかどうかを確認する方法。

gettype()は型の名前の文字列を返す
is_*はそれぞれの型に合致しているかどうかをチェック

クラス関係の確認についてはこちらを参照、

gettype()

gettype()は、引数で与えられた値の型を文字列として返す。以下の例のほか、resource、unknown typeが準備されている。

vars = [true, 1, 3.14, 'abcd', ['acd', 1], new Exception(), null];

foreach ($vars as $var) {
  echo gettype($var) . "\n";
}

// boolean
// integer
// double
// string
// array
// object
// NULL

vars = [true, 1, 3.14, 'abcd', ['acd', 1], new Exception(), null];

foreach ($vars as $var) {

echo gettype($var) . "\n";

}

// boolean

// integer

// double

// string

// array

// object

// NULL

is_*() – 型の確認

is_*(値)で値の型が合致しているかをチェック。

is_bool
is_numeric, is_finite, is_infinite, is_nan
is_int/is_integer, is_long, is_float/is_double/is_real
is_string
is_array
is_object, is_subclass_of

echo is_bool(true) ? "true\n" : "false\n";        // true
echo is_bool(1) ? "true\n" : "false\n";           // false
echo is_finite(3.14) ? "true\n" : "false\n";      // true
echo is_infinite(1.0 / 0) ? "true\n" : "false\n"; // true
echo is_nan(0 / 0) ? "true\n" : "false\n";        // true
// 0除算はwarningが出る

echo is_bool(true) ? "true\n" : "false\n"; // true

echo is_bool(1) ? "true\n" : "false\n"; // false

echo is_finite(3.14) ? "true\n" : "false\n"; // true

echo is_infinite(1.0 / 0) ? "true\n" : "false\n"; // true

echo is_nan(0 / 0) ? "true\n" : "false\n"; // true

// 0除算はwarningが出る

PHP – クラスの確認

2021-07-21 / tau / 1件のコメント

概要

instanceof：値のクラスをチェック
is_a()：値のクラスをチェック
is_subclass_of()：値の親クラスをチェック
class_uses()：トレイトを使っているかどうかチェック

instanceof/is_a()

instanceof

インスタンス instanceof クラス等名

instanceofは、第1オペランドが第2オペランドのクラスに合致しているかどうかをチェックする演算子。第2オペランドにはクラス名などをそのまま記述する。is_a()関数と同じ機能。

以下の例の様に、instanceofは、

そのインスタンスのクラス、継承した親クラス、インプリメントしたインターフェイスに対して真となる
トレイトについてはuseしていても真とはならない

trait MyTrait {
  public function traitMethod() {}
}

interface MyInterface {}

class MyParent {
  public function parentMethod() {}
}

class MyChild extends MyParent implements MyInterface {
  use MyTrait;

  public function childMethod() {}
}

class GrandChild extends MyChild {}

$child = new MyChild();

$child = new MyChild();

echo $child instanceof MyChild ? "true\n" : "false\n";
echo $child instanceof MyParent ? "true\n" : "false\n";
echo $child instanceof MyInterface ? "true\n" : "false\n";
echo $child instanceof MyTrait ? "true\n" : "false\n";

// true
// true
// true
// false

trait MyTrait {

public function traitMethod() {}

}

interface MyInterface {}

class MyParent {

public function parentMethod() {}

}

class MyChild extends MyParent implements MyInterface {

use MyTrait;

public function childMethod() {}

}

class GrandChild extends MyChild {}

$child = new MyChild();

echo $child instanceof MyChild ? "true\n" : "false\n";

echo $child instanceof MyParent ? "true\n" : "false\n";

echo $child instanceof MyInterface ? "true\n" : "false\n";

echo $child instanceof MyTrait ? "true\n" : "false\n";

// true

// false

is_a()

is_a(インスタンス, 'クラス等名');

is_a()は第1引数のインスタンスが第2引数のクラスに合致しているかどうかチェックする。第2引数のクラス名は文字列として与える。

以下の例のように、親クラス、インターフェイス、トレイトに対する判定はinstanceofと同じ。

echo is_a($child, 'MyChild') ? "true\n" : "false\n";
echo is_a($child, 'MyParent') ? "true\n" : "false\n";
echo is_a($child, 'MyInterface') ? "true\n" : "false\n";
echo is_a($child, 'MyTrait') ? "true\n" : "false\n";

// true
// true
// true
// false

echo is_a($child, 'MyChild') ? "true\n" : "false\n";

echo is_a($child, 'MyParent') ? "true\n" : "false\n";

echo is_a($child, 'MyInterface') ? "true\n" : "false\n";

echo is_a($child, 'MyTrait') ? "true\n" : "false\n";

// true

// false

is_subclass_of()

is_subclass_of(インスタンス, 'クラス等名');

is_subclass_of()は、第1引数のインスタンスのクラスが第2引数のクラスを継承しているかどうかをチェックする。引数の渡し方はis_a()と同じ。

以下の例のように、

引数のインスタンスのクラスそのものは偽
継承した親クラスとインターフェースに対しては真
トレイトは偽

echo is_subclass_of($child, 'MyChild') ? "true\n" : "false\n";
echo is_subclass_of($child, 'MyParent') ? "true\n" : "false\n";
echo is_subclass_of($child, 'MyInterface') ? "true\n" : "false\n";
echo is_subclass_of($child, 'MyTrait') ? "true\n" : "false\n";

// false
// true
// true
// false

echo is_subclass_of($child, 'MyChild') ? "true\n" : "false\n";

echo is_subclass_of($child, 'MyParent') ? "true\n" : "false\n";

echo is_subclass_of($child, 'MyInterface') ? "true\n" : "false\n";

echo is_subclass_of($child, 'MyTrait') ? "true\n" : "false\n";

// false

// true

// false

class_uses()

class_uses(インスタンス);

class_uses()は、引数インスタンスのクラスがuseしているトレイト連想配列として返す。連想配列のキー・値とも、トレイト名の文字列。

var_dump(class_uses($child));

// array(1) {
//   ["MyTrait"]=>
//   string(7) "MyTrait"
// }

var_dump(class_uses($child));

// array(1) {

// ["MyTrait"]=>

// string(7) "MyTrait"

// }

トレイトをuseしているかどうかをチェックするには、class_uses()の結果の連想配列に対して、in_array()かarray_key_exists()でトレイト名が含まれるかどうかをチェック。

echo in_array('MyTrait', class_uses($child)) ? "true\n" : "false\n";

// true

echo in_array('MyTrait', class_uses($child)) ? "true\n" : "false\n";

// true

親クラスでトレイトをuseしていても、子クラスのclass_uses()では捕捉されない。

$grandchild = new GrandChild();
var_dump(class_uses($grandchild));

// array(0) {
// }

$grandchild = new GrandChild();

var_dump(class_uses($grandchild));

// array(0) {

// }

method_exists()/property_exists()

method_exists(インスタンス, ’クラス等名’)
property_exists(インスタンス, ’クラス等名’)

method_exists()は、第1引数で指定したインスタンスのクラスに第2引数で指定したメソッドが定義されているかどうかをチェックする。同様に、property_exists()はプロパティーが定義されているかどうかをチェックする。

以下の例で、method_exists()について確認する。

指定したメソッドが定義されていればtrue、定義されていなければfalse
親クラスのメソッドでも存在する(true)と判定(public～privateに関わらない)
トレイトのメソッドも存在すると判定
親クラスでuseされたトレイトのメソッドは、子クラスでも存在すると判定

echo method_exists($child, 'childMethod') ? "true\n" : "false\n";
echo method_exists($child, 'anotherMethod') ? "true\n" : "false\n";
echo method_exists($child, 'parentMethod') ? "true\n" : "false\n";
echo method_exists($child, 'traitMethod') ? "true\n" : "false\n";
echo method_exists($grandchild, 'traitMethod') ? "true\n" : "false\n";

// true
// false
// true
// true

echo method_exists($child, 'childMethod') ? "true\n" : "false\n";

echo method_exists($child, 'anotherMethod') ? "true\n" : "false\n";

echo method_exists($child, 'parentMethod') ? "true\n" : "false\n";

echo method_exists($child, 'traitMethod') ? "true\n" : "false\n";

echo method_exists($grandchild, 'traitMethod') ? "true\n" : "false\n";

// true

// false

// true

PHP – array_key_exists() – 配列のキーの存在確認

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

概要

array_key_exists()は$keyが配列のキーとして存在するかどうかをチェックする。比較にあたって、常に型変換が自動で行われる(‘==’と等価)。型までのチェックはされない。

array_key_exists($key, 配列)

連想配列への適用例

以下は連想配列に対する実行例。文字列と数値が自動で変換されている。

$assoc_array = [
  'one' => 'two',
  '3' => '6',
  5 => 10,
];

echo array_key_exists('one', $assoc_array) ? "true\n" : "false\n";  // true
echo array_key_exists('two', $assoc_array) ? "true\n" : "false\n";  // false
echo array_key_exists('3', $assoc_array) ? "true\n" : "false\n";    // true
echo array_key_exists(3, $assoc_array) ? "true\n" : "false\n";      // true
echo array_key_exists('5', $assoc_array) ? "true\n" : "false\n";    // true
echo array_key_exists(5, $assoc_array) ? "true\n" : "false\n";      // true

$assoc_array = [

'one' => 'two',

'3' => '6',

5 => 10,

];

echo array_key_exists('one', $assoc_array) ? "true\n" : "false\n"; // true

echo array_key_exists('two', $assoc_array) ? "true\n" : "false\n"; // false

echo array_key_exists('3', $assoc_array) ? "true\n" : "false\n"; // true

echo array_key_exists(3, $assoc_array) ? "true\n" : "false\n"; // true

echo array_key_exists('5', $assoc_array) ? "true\n" : "false\n"; // true

echo array_key_exists(5, $assoc_array) ? "true\n" : "false\n"; // true

配列への適用例

配列に対しても適用可能で、この場合はインデックスが存在するかどうかがチェックされる。このときも自動的に型が変換される。

$array = ['zero', 'one', 'two'];

echo array_key_exists(0, $array) ? "true\n" : "false\n";    // true
echo array_key_exists('0', $array) ? "true\n" : "false\n";  // true
echo array_key_exists(3, $array) ? "true\n" : "false\n";    // false
echo array_key_exists('3', $array) ? "true\n" : "false\n";  // false

$array = ['zero', 'one', 'two'];

echo array_key_exists(0, $array) ? "true\n" : "false\n"; // true

echo array_key_exists('0', $array) ? "true\n" : "false\n"; // true

echo array_key_exists(3, $array) ? "true\n" : "false\n"; // false

echo array_key_exists('3', $array) ? "true\n" : "false\n"; // false

PHP – in_array() – 配列の値の存在確認

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

概要

in_array()は、指定した$needleが配列($heystack)の要素として含まれるかどうかをチェックする。

in_array($needle, 配列, $strict=false)

デフォルトでは$strict=falseで、型変換を行って内容比較する
$strict=trueを指定すると、型の一致まで確認する

配列の要素の確認

以下の例ではデフォルトの$strict=falseとなっていて、文字列・数値の変換が自動的に行われている('=='と同じ効果)。

$array = ['ten', '11', 12];

echo in_array('ten', $array) ? "true\n" : "false\n";    // true
echo in_array('eleven', $array) ? "true\n" : "false\n"; // false
echo in_array('11', $array) ? "true\n" : "false\n";     // true
echo in_array(11, $array) ? "true\n" : "false\n";       // true
echo in_array('12', $array) ? "true\n" : "false\n";     // true
echo in_array(12, $array) ? "true\n" : "false\n";       // true

$array = ['ten', '11', 12];

echo in_array('ten', $array) ? "true\n" : "false\n"; // true

echo in_array('eleven', $array) ? "true\n" : "false\n"; // false

echo in_array('11', $array) ? "true\n" : "false\n"; // true

echo in_array(11, $array) ? "true\n" : "false\n"; // true

echo in_array('12', $array) ? "true\n" : "false\n"; // true

echo in_array(12, $array) ? "true\n" : "false\n"; // true

$strict=trueを指定すると、文字列と数値の違いも判定される('==='と同じ効果)。

echo in_array('11', $array, true) ? "true\n" : "false\n"; // true 
echo in_array(11, $array, true) ? "true\n" : "false\n";   // false
echo in_array('12', $array, true) ? "true\n" : "false\n"; // false
echo in_array(12, $array, true) ? "true\n" : "false\n";   // true

echo in_array('11', $array, true) ? "true\n" : "false\n"; // true

echo in_array(11, $array, true) ? "true\n" : "false\n"; // false

echo in_array('12', $array, true) ? "true\n" : "false\n"; // false

echo in_array(12, $array, true) ? "true\n" : "false\n"; // true

連想配列の値の確認

in_array()で連想配列を指定すると、キー・値のうち指定した$needleが「値として含まれるか」チェックする。キーとして含まれていてもfalseになる。

$assoc_array = [
  'one' => 'two',
  '3' => '6',
  5 => 10,
];

echo in_array('one', $assoc_array) ? "true\n" : "false\n";  // false
echo in_array('two', $assoc_array) ? "true\n" : "false\n";  // true
echo in_array('3', $assoc_array) ? "true\n" : "false\n";    // false
echo in_array('6', $assoc_array) ? "true\n" : "false\n";    // true
echo in_array(5, $assoc_array) ? "true\n" : "false\n";      // false
echo in_array(10, $assoc_array) ? "true\n" : "false\n";     // true

$assoc_array = [

'one' => 'two',

'3' => '6',

5 => 10,

];

echo in_array('one', $assoc_array) ? "true\n" : "false\n"; // false

echo in_array('two', $assoc_array) ? "true\n" : "false\n"; // true

echo in_array('3', $assoc_array) ? "true\n" : "false\n"; // false

echo in_array('6', $assoc_array) ? "true\n" : "false\n"; // true

echo in_array(5, $assoc_array) ? "true\n" : "false\n"; // false

echo in_array(10, $assoc_array) ? "true\n" : "false\n"; // true

デフォルトの$strict=falseでは型変換が自動的に行われる。

echo in_array('6', $assoc_array) ? "true\n" : "false\n";  // true
echo in_array(6, $assoc_array) ? "true\n" : "false\n";    // true
echo in_array('10', $assoc_array) ? "true\n" : "false\n"; // true
echo in_array(10, $assoc_array) ? "true\n" : "false\n";   // true

echo in_array('6', $assoc_array) ? "true\n" : "false\n"; // true

echo in_array(6, $assoc_array) ? "true\n" : "false\n"; // true

echo in_array('10', $assoc_array) ? "true\n" : "false\n"; // true

echo in_array(10, $assoc_array) ? "true\n" : "false\n"; // true

$strict=trueに指定すると、型の一致までチェックする。

echo in_array('6', $assoc_array, true) ? "true\n" : "false\n";  // true
echo in_array(6, $assoc_array, true) ? "true\n" : "false\n";    // false
echo in_array('10', $assoc_array, true) ? "true\n" : "false\n"; // false
echo in_array(10, $assoc_array, true) ? "true\n" : "false\n";   // true

echo in_array('6', $assoc_array, true) ? "true\n" : "false\n"; // true

echo in_array(6, $assoc_array, true) ? "true\n" : "false\n"; // false

echo in_array('10', $assoc_array, true) ? "true\n" : "false\n"; // false

echo in_array(10, $assoc_array, true) ? "true\n" : "false\n"; // true

注意点

in_array()は空の配列やnullに対してfalseを返す
nullに対しては警告が出される

echo in_array('one', []) ? "true\n" : "false\n";    // false
echo in_array('one', null) ? "true\n" : "false\n";  // false
// PHP Warning:  in_array() expects parameter 2 to be array, null given in ...

echo in_array('one', []) ? "true\n" : "false\n"; // false

echo in_array('one', null) ? "true\n" : "false\n"; // false

// PHP Warning: in_array() expects parameter 2 to be array, null given in ...

PHP – トレイト – メソッドの汎化

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

概要

インターフェイスはクラスがメソッドを実装することを明示・保証するが、その実装はインプリメントしたクラスに託されている。

一方トレイトは、予めメソッドを具体に実装しておき、これを用いるクラス中でuse文によって導入される。

トレイトの使い方

定義

traitキーワードでトレイトを定義し、その中で具体のメソッドを定義する。

trait トレイト名 {
  public function メソッド名1 {
  }

  public function メソッド名2 {
  }
  .....
}

trait トレイト名 {

public function メソッド名1 {

}

public function メソッド名2 {

}

.....

}

トレイトの実装

トレイトを導入するクラスで、useキーワードで導入するトレイトを宣言し、メソッドを呼び出す。

class クラス名 {
  use トレイト名;
  .....
｝

クラス名->メソッド名(...);

class クラス名 {

use トレイト名;

.....

｝

クラス名->メソッド名(...);

実装例

ベースになるコード

インターフェイスで例示したRPGキャラクターのコードを使う。

基底クラスCharacterClass：名前を持ち武器攻撃のみできる
インターフェイスSpellcaster：呪文を唱えるメソッドspell()を宣言
Swordfighterクラス：CharacterClassを継承
Wizardクラス：CharacterClassを継承し、Spellcasterをインプリメント
Priestクラス：CharacterClassを継承し、Spellcasterをインプリメント

要件

SwordfighterとPriestに、クリティカルアタックの機能を持たせる
クリティカルアタックはどのクラスにおいても共通の技

トレイトの追加

以下のトレイトを追加する。

trait AttackTrait {
  public function criticalAttack() {
    echo $this->getName() . "はクリティカルアタックを決めた！！\n";
  }
}

trait AttackTrait {

public function criticalAttack() {

echo $this->getName() . "はクリティカルアタックを決めた！！\n";

}

トレイトの導入

SwardfighterクラスとPriestクラスでトレイトを導入する。

class Swordfighter extends CharacterClass {
  use AttackTrait;
}

class Priest extends CharacterClass implements Spellcaster {
  use AttackTrait;

  public function spell() {
    echo $this->getName() . "は味方の傷を癒した！\n";
  }
}

class Swordfighter extends CharacterClass {

use AttackTrait;

}

class Priest extends CharacterClass implements Spellcaster {

use AttackTrait;

public function spell() {

echo $this->getName() . "は味方の傷を癒した！\n";

}

トレイトのメソッドの利用

クラスのインスタンスでトレイトのメソッドを呼び出す。

$arthur = new Swordfighter('アーサー');
$sanzo = new Priest('サンゾウ');

$arthur->criticalAttack();
$sanzo->criticalAttack();

// アーサーはクリティカルアタックを決めた！！
// サンゾウはクリティカルアタックを決めた！！

$arthur = new Swordfighter('アーサー');

$sanzo = new Priest('サンゾウ');

$arthur->criticalAttack();

$sanzo->criticalAttack();

// アーサーはクリティカルアタックを決めた！！

// サンゾウはクリティカルアタックを決めた！！

留意点

プロパティーも宣言・定義できる
トレイトを導入するクラスを意図した$thisを使える
インスタンスのクラスがトレイトを導入している場合、class_uses()メソッドで導入しているトレイト名を得られる

class_uses～実装しているトレイトの確認

たとえば上の実装例で、別のトレイトも加えてclass_uses()で内容を確認してみる。トレイト名をキー・値とする連想配列となっていることがわかる。

trait AnotherTrait {
}

class Swordfighter extends CharacterClass {
  use AttackTrait;
  use AnotherTrait;
}

$arthur = new Swordfighter('アーサー');
var_dump(class_uses($arthur));

// array(2) {
//   ["AttackTrait"]=>
//   string(11) "AttackTrait"
//   ["AnotherTrait"]=>
//   string(12) "AnotherTrait"
// }

trait AnotherTrait {

}

class Swordfighter extends CharacterClass {

use AttackTrait;

use AnotherTrait;

}

$arthur = new Swordfighter('アーサー');

var_dump(class_uses($arthur));

// array(2) {

// ["AttackTrait"]=>

// string(11) "AttackTrait"

// ["AnotherTrait"]=>

// string(12) "AnotherTrait"

// }

これまでの例で、各クラスのインスタンスを配列に入れて、クラスに応じた動作をさせる。

トレイトを実装しているかどうかのチェックは、class_uses()で導入しているトレイトの連想配列を得て、そのキーに対象となるトレイト名があるかどうかをarray_key_exists()でチェック。

$party_members = [];
$party_members[] = new Swordfighter('アーサー');
$party_members[] = new Wizard('ハリー');
$party_members[] = new Priest('サンゾウ');

echo "武器攻撃ターン\n";
foreach ($party_members as $member) {
  $member->attack();
}

echo "呪文使用ターン\n";
foreach ($party_members as $member) {
  if ($member instanceof Spellcaster) {
    $member->spell();
  }
}

echo "クリティカルアタック！\n";
foreach ($party_members as $member) {
  if (array_key_exists('AttackTrait', class_uses($member))) {
    $member->criticalAttack();
  }
}

// 武器攻撃ターン
// アーサーは武器で攻撃した！
// ハリーは武器で攻撃した！
// サンゾウは武器で攻撃した！
// 呪文使用ターン
// ハリーは攻撃魔法を唱えた！
// サンゾウは味方の傷を癒した！
// クリティカルアタック！
// アーサーはクリティカルアタックを決めた！！
// サンゾウはクリティカルアタックを決めた！！

$party_members = [];

$party_members[] = new Swordfighter('アーサー');

$party_members[] = new Wizard('ハリー');

$party_members[] = new Priest('サンゾウ');

echo "武器攻撃ターン\n";

foreach ($party_members as $member) {

$member->attack();

}

echo "呪文使用ターン\n";

foreach ($party_members as $member) {

if ($member instanceof Spellcaster) {

$member->spell();

}

echo "クリティカルアタック！\n";

foreach ($party_members as $member) {

if (array_key_exists('AttackTrait', class_uses($member))) {

$member->criticalAttack();

}

// 武器攻撃ターン

// アーサーは武器で攻撃した！

// ハリーは武器で攻撃した！

// サンゾウは武器で攻撃した！

// 呪文使用ターン

// ハリーは攻撃魔法を唱えた！

// サンゾウは味方の傷を癒した！

// クリティカルアタック！

// アーサーはクリティカルアタックを決めた！！

// サンゾウはクリティカルアタックを決めた！！

PHP – インターフェイス

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

概要

PHPではクラスの多重継承はできないが、複数のインターフェイスをインプリメントできる
インターフェイスでは実装すべき関数の宣言のみ行い、実装はこれをインプリメントした関数で行う
これにより、インターフェイスを実装するクラスが持つべきメソッドが明示・保証される

基本形

インターフェイスの宣言・定義

interface インターフェイス名 {
  public function メソッド名1;
  public function メソッド名2;
  .....
}

interface インターフェイス名 {

public function メソッド名1;

public function メソッド名2;

.....

}

インターフェイスの実装

class クラス名 implements インターフェイス名 {
  .....
  public function メソッド名1(...) {
    メソッド1の実装
  }

  public function メソッド名2(...) {
    メソッド2の実装
  }
  .....
}

class クラス名 implements インターフェイス名 {

.....

public function メソッド名1(...) {

メソッド1の実装

}

public function メソッド名2(...) {

メソッド2の実装

}

.....

}

実装例

RPGのキャラクターをイメージしたキャラクターを実装していく。

親クラス

全てのキャラクターはCharacterClassクラスを継承し、

名前を持つ
武器で攻撃するattack()メソッドを持つ

class CharacterClass {
  private $name;

  public function __construct($name) {
    $this->name = $name;
  }

  public function getName() {
    return $this->name;
  }

  public function attack() {
    echo $this->name . "は武器で攻撃した！\n";
  }
}

class CharacterClass {

private $name;

public function __construct($name) {

$this->name = $name;

}

public function getName() {

return $this->name;

}

public function attack() {

echo $this->name . "は武器で攻撃した！\n";

}

Swordfighterクラス

SwordfighterクラスとWizardクラスはCharacterClassを継承し、武器による攻撃ができる。

class Swordfighter extends CharacterClass {
}

1 2	class Swordfighter extends CharacterClass { }

Spellcasterインターフェイス

Spellcasterインターフェイスは呪文を使える種族を表し、呪文を唱えるspell()メソッドを持つ。spell()メソッドの実装は、インプリメントするクラスで定義する必要がある。

interface Spellcaster {
  public function spell();
}

interface Spellcaster {

public function spell();

}

Wizardクラス

WizardクラスはCharacterClassクラスを継承するとともに、Spellcasterインターフェイスをインプリメントする。Wizardは武器による攻撃ができるほか、spell()メソッドで攻撃魔法を実装している。

class Wizard extends CharacterClass implements Spellcaster {
  public function spell() {
    echo $this->getName() . "は攻撃魔法を唱えた！\n";
  }
}

class Wizard extends CharacterClass implements Spellcaster {

public function spell() {

echo $this->getName() . "は攻撃魔法を唱えた！\n";

}

Priestクラス

PriestクラスはCharacterClassクラスを継承するとともに、Spellcasterインターフェイスをインプリメントする。Priestは武器による攻撃ができるほか、spell()メソッドで味方の治療を実装している。

class Priest extends CharacterClass implements Spellcaster {
  public function spell() {
    echo $this->getName() . "は味方の傷を癒した！\n";
  }
}

class Priest extends CharacterClass implements Spellcaster {

public function spell() {

echo $this->getName() . "は味方の傷を癒した！\n";

}

ポリモーフィズムによる実行

Swordfighter、Wizard、Priestのインスタンスを生成し、$party_members配列に保存する。

全てのメンバーに武器で攻撃させる
その後、Spellcasterのメンバーに呪文使用させる

$party_members = [];
$party_members[] = new Swordfighter('アーサー');
$party_members[] = new Wizard('ハリー');
$party_members[] = new Priest('サンゾウ');

echo "武器攻撃ターン\n";
foreach ($party_members as $member) {
  $member->attack();
}

echo "呪文使用ターン\n";
foreach ($party_members as $member) {
  if ($member instanceof Spellcaster) {
    $member->spell();
  }
}

// 武器攻撃ターン
// アーサーは武器で攻撃した！
// ハリーは武器で攻撃した！
// サンゾウは武器で攻撃した！
// 魔法攻撃ターン
// ハリーは攻撃魔法を唱えた！
// サンゾウは味方の傷を癒した！

$party_members = [];

$party_members[] = new Swordfighter('アーサー');

$party_members[] = new Wizard('ハリー');

$party_members[] = new Priest('サンゾウ');

echo "武器攻撃ターン\n";

foreach ($party_members as $member) {

$member->attack();

}

echo "呪文使用ターン\n";

foreach ($party_members as $member) {

if ($member instanceof Spellcaster) {

$member->spell();

}

// 武器攻撃ターン

// アーサーは武器で攻撃した！

// ハリーは武器で攻撃した！

// サンゾウは武器で攻撃した！

// 魔法攻撃ターン

// ハリーは攻撃魔法を唱えた！

// サンゾウは味方の傷を癒した！

インターフェイス実装の確認

あるクラスが指定したインターフェイスをインプリメントしているかどうかは、クラスのチェックと同じ型演算子instanceofで確認できる。