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で確認できる。

PHP – 抽象クラス／ポリモーフィズム

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

抽象クラス

抽象クラスは

abstract classキーワードでクラスを定義する
abstract定義されたメソッドを含む

たとえば以下のクラスは、RPGのキャラクターをイメージしていて、

固有の名前を持つ
名前を返すpublicメソッドを持つ
attack()というabstract宣言されたpublicメソッドを持つ

<?php

abstract class CharacterClass {
  private $name;

  abstract public function attack();

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

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

<?php

abstract class CharacterClass {

private $name;

abstract public function attack();

public function __construct($name) {

$this->name = $name;

}

public function getName() {

return $this->name;

}

このクラスからインスタンスを生成しようとすると、Cannot instantiate abstract class CharacterClassとエラーになる。

抽象クラスの継承

先の抽象クラスCharacterClassを継承して、以下の2つのクラスを定義する。

class Swordfighter extends CharacterClass {
  public function attack() {
    echo $this->getName() . "は剣で切りかかった！\n";
  }
}

class Wizard extends CharacterClass {
  public function attack() {
    echo $this->getName() . "は攻撃呪文を唱えた！\n";
  }
}

class Swordfighter extends CharacterClass {

public function attack() {

echo $this->getName() . "は剣で切りかかった！\n";

}

class Wizard extends CharacterClass {

public function attack() {

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

}

こうすると、Swordfighterクラス、Wizardクラスのインスタンスを生成することができる。

$arthur = new Swordfighter('アーサー');
$harry = new Wizard('ハリー');

$arthur->attack();
$harry->attack();

// アーサーは剣で切りかかった！
// ハリーは攻撃呪文を唱えた！

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

$harry = new Wizard('ハリー');

$arthur->attack();

$harry->attack();

// アーサーは剣で切りかかった！

// ハリーは攻撃呪文を唱えた！

ポリモーフィズム

先の2つのクラス(Swordfighter、Wizard)のインスタンスを、以下のように配列にしてattack()メソッドを実行してみる。

$party_members = [];
$party_members[] = new Swordfighter('アーサー');
$party_members[] = new Wizard('ハリー');
$party_members[] = new Wizard('セイメイ');
$party_members[] = new Swordfighter('コジロー');

foreach ($party_members as $member) {
  $member->attack();
}

// アーサーは剣で切りかかった！
// ハリーは攻撃呪文を唱えた！
// セイメイは攻撃呪文を唱えた！
// コジローは剣で切りかかった！

$party_members = [];

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

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

$party_members[] = new Wizard('セイメイ');

$party_members[] = new Swordfighter('コジロー');

foreach ($party_members as $member) {

$member->attack();

}

// アーサーは剣で切りかかった！

// ハリーは攻撃呪文を唱えた！

// セイメイは攻撃呪文を唱えた！

// コジローは剣で切りかかった！

配列の各要素が具体にどのクラスかを指定しなくても、それぞれのクラスに応じたattack()メソッドが適切に呼ばれている(ポリモーフィズム)。

抽象クラスとポリモーフィズム

抽象クラスはabstractメソッドを含む
抽象クラスを継承したクラスのうち、インスタンスを生成するクラスでは、必ずabstractメソッドを実装しなければならない
実行時にabstractメソッドに対応したメソッドを呼び出すと、インスタンスのクラスを逐一確認しなくても、そのインスタンスのクラスに応じたメソッドが実行される
したがって、abstractメソッドの機能の実装は各継承クラスで責任を持ち、それを呼び出す側でケアする必要はない(例外処理などを除けば)

PHP – 継承

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

設定

以下のようなクラス構成を考える。

RPGに出てくるようなキャラクターとして、剣士と魔法使いを考える
共通点として、いずれも名前とエネルギーを持つ
剣士特有の能力として、剣で切りかかって戦う動作ができる
魔法使い特有の能力として、攻撃魔法を唱える動作ができる
それぞれの動作を行うと、それに応じたエネルギーが消費される

親クラス～汎化

キャラクターの種類によらず共通するものを、親クラスCharacterClassとしてまとめる。

privateなプロパティーとして、$name(名前)、$energy(エネルギー)を持つ
インスタンス生成時に名前を与えて生成し、エネルギーの初期値は職業によらず100
それぞれの値を得るpublicなゲッターを備えている
エネルギー値を変更するpublicメソッドを備えている
自身の攻撃の番であることを表示するpublicメソッドを備えている

<?php
// inheritance.php

class CharacterClass {
  private $name;
  private $energy;

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

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

  public function getEnergy() {
    return $this->energy;
  }

  public function changeEnergy($delta) {
    $this->energy += $delta;
  }

  public function showTurn() {
    echo $this->name . "の攻撃:\n";
  }
}

<?php

// inheritance.php

class CharacterClass {

private $name;

private $energy;

public function __construct($name) {

$this->name = $name;

$this->energy = 100;

}

public function getName() {

return $this->name;

}

public function getEnergy() {

return $this->energy;

}

public function changeEnergy($delta) {

$this->energy += $delta;

}

public function showTurn() {

echo $this->name . "の攻撃:\n";

}

継承

CharacterClassクラスを継承し、剣士(Swordfighter)と魔法使いのクラスを定義する。

戦士の動作メソッドattack()で剣で切りかかり、エネルギーを15消費する
魔法使いの動作メソッドspell()で攻撃魔法を唱え、エネルギーを10消費する

class Swordfighter extends CharacterClass {
  public function attack() {
    $this->showTurn();
    $this->changeEnergy(-15);
    echo $this->getName() . "は剣で切りかかった！(Energy:" .
         $this->getEnergy() . ")\n";
  }
}

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

class Swordfighter extends CharacterClass {

public function attack() {

$this->showTurn();

$this->changeEnergy(-15);

echo $this->getName() . "は剣で切りかかった！(Energy:" .

$this->getEnergy() . ")\n";

}

class Wizard extends CharacterClass {

public function spell() {

$this->showTurn();

$this->changeEnergy(-10);

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

$this->getEnergy() . ")\n";

}

剣士としてアーサー、魔法使いとしてハリーという名前でインスタンスを生成し、順番に2回ずつ攻撃させる。

$arthur = new Swordfighter('アーサー');
$harry = new Wizard('ハリー');

$arthur->attack();
$harry->spell();
$arthur->attack();
$harry->spell();

// アーサーの攻撃:
// アーサーは剣で切りかかった！(Energy:85)
// ハリーの攻撃:
// ハリーは攻撃魔法を唱えた！(Energy:90)
// アーサーの攻撃:
// アーサーは剣で切りかかった！(Energy:70)
// ハリーの攻撃:
// ハリーは攻撃魔法を唱えた！(Energy:80)

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

$harry = new Wizard('ハリー');

$arthur->attack();

$harry->spell();

$arthur->attack();

$harry->spell();

// アーサーの攻撃:

// アーサーは剣で切りかかった！(Energy:85)

// ハリーの攻撃:

// ハリーは攻撃魔法を唱えた！(Energy:90)

// アーサーの攻撃:

// アーサーは剣で切りかかった！(Energy:70)

// ハリーの攻撃:

// ハリーは攻撃魔法を唱えた！(Energy:80)

メソッドのオーバーライド

CharacterClassクラスにshowTurn()メソッドを定義したが、これと同じ名前のメソッドをSwordfighterクラスとWizardクラスに定義する。

class Swordfighter extends CharacterClass {
  public function showTurn() {
    echo '戦士';
    parent::showTurn();
  }

  .....
}

class Wizard extends CharacterClass {
  public function showTurn() {
    echo '魔法使い';
    parent::showTurn();
  }

  .....
}

class Swordfighter extends CharacterClass {

public function showTurn() {

echo '戦士';

parent::showTurn();

}

.....

}

class Wizard extends CharacterClass {

public function showTurn() {

echo '魔法使い';

parent::showTurn();

}

.....

}

そして同じように実行すると以下のようになり、それぞれの子クラスで定義したshowTurn()が呼ばれて剣士・魔法使いと表示され、その後に親クラスのメソッドの表示がされている。

// 剣士アーサーの攻撃:
// アーサーは剣で切りかかった！(Energy:85)
// 魔法使いハリーの攻撃:
// ハリーは攻撃魔法を唱えた！(Energy:90)
// 剣士アーサーの攻撃:
// アーサーは剣で切りかかった！(Energy:70)
// 魔法使いハリーの攻撃:
// ハリーは攻撃魔法を唱えた！(Energy:80)

// 剣士アーサーの攻撃:

// アーサーは剣で切りかかった！(Energy:85)

// 魔法使いハリーの攻撃:

// ハリーは攻撃魔法を唱えた！(Energy:90)

// 剣士アーサーの攻撃:

// アーサーは剣で切りかかった！(Energy:70)

// 魔法使いハリーの攻撃:

// ハリーは攻撃魔法を唱えた！(Energy:80)

ここで行ったのがメソッドのオーバーライド。

親クラスのメソッドと同じ名前のメソッドを子クラスで定義した場合、子クラスのメソッドが呼ばれる
子クラスのメソッドの中でparent::メソッド名とすると、親クラスのメソッドが呼ばれる。

実行時のメソッドの探索順は以下の通り。

現在のクラスで該当するメソッドを探す
無ければ親クラスのメソッドを順次遡って探す
parent::で呼ばれた場合、親クラスのメソッドを探す

コンストラクター

オーバーライド

上記のコードに更に変更を加えて、初期エネルギー値を戦士が100、魔法使いが80となるようにする。

まずCharacterClassのコンストラクターを変更して、$energyについても引数で値をあてるようにする。

class CharacterClass {
  private $name;
  private $energy;

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

  .....
}

class CharacterClass {

private $name;

private $energy;

public function __construct($name, $energy) {

$this->name = $name;

$this->energy = $energy;

}

.....

}

そしてSwordfighter、Wizardそれぞれのクラスにコンストラクターを追加。インスタンス生成時には名前のみを指定し、それぞれのクラスに応じた初期エネルギー値を親クラスのコンストラクターに渡して、名前とともにセットする。

class Swordfighter extends CharacterClass {
  public function __construct($name) {
    parent::__construct($name, 100);
  }

  .....
}

class Wizard extends CharacterClass {
  public function __construct($name) {
    parent::__construct($name, 80);
  }

  .....
}

class Swordfighter extends CharacterClass {

public function __construct($name) {

parent::__construct($name, 100);

}

.....

}

class Wizard extends CharacterClass {

public function __construct($name) {

parent::__construct($name, 80);

}

.....

}

実行結果は以下の通り。

$arthur = new Swordfighter('アーサー');
$harry = new Wizard('ハリー');

$arthur->attack();
$harry->spell();
$arthur->attack();
$harry->spell();

剣士アーサーの攻撃:
アーサーは剣で切りかかった！(Energy:85)
魔法使いハリーの攻撃:
ハリーは攻撃魔法を唱えた！(Energy:70)
剣士アーサーの攻撃:
アーサーは剣で切りかかった！(Energy:70)
魔法使いハリーの攻撃:
ハリーは攻撃魔法を唱えた！(Energy:60)

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

$harry = new Wizard('ハリー');

$arthur->attack();

$harry->spell();

$arthur->attack();

$harry->spell();

剣士アーサーの攻撃:

アーサーは剣で切りかかった！(Energy:85)

魔法使いハリーの攻撃:

ハリーは攻撃魔法を唱えた！(Energy:70)

剣士アーサーの攻撃:

アーサーは剣で切りかかった！(Energy:70)

魔法使いハリーの攻撃:

ハリーは攻撃魔法を唱えた！(Energy:60)

クラスの継承とコンストラクター／デストラクターについて

インスタンス生成時、子クラスのコンストラクターが見つからなければ、親クラスのコンストラクターが使われる
子クラスのコンストラクターを定義した場合、暗黙では親クラスのコンストラクターは呼ばれない
から親クラスのコンストラクター／デストラクターを呼び出すときは、parent::_construct/__destructで呼び出す
通常、子クラスのコンストラクターの中で
- parent::constructor()はコードの最初に書く
- parent::destructor()はコードの最後に書く

プロパティーの`private`宣言について

親クラスのプロパティー$nameと$energyをprivate宣言にしているので、継承した子クラスから直接はアクセスできない
- このため、publicなメソッドを準備して、アクセスさせている
プロパティーをpublic宣言すると子クラスから$this->nameのようにアクセスできる
- しかしpublic宣言すると、クラス外部で任意に名前やエネルギーの値を変更できてしまう
protected宣言にすれば、継承したクラスから$this->nameのようにアクセスできる
- ここではプロパティーの変更を厳格にし、アクセスメソッドを準備しているのでprivateにした

PHP – クラス

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

クラスの定義

classキーワードでクラスを定義
プロパティーはprivate/protected/publicで宣言
コンストラクターはpublic function __construct()で定義(アンダースコア2つ)
メソッドはpublic/protected/private functionで定義
インスタンスの生成はnew クラス名(...);

<?php
class MyClass {
  private $property;

  public function __construct() {
    .....
  }

  public function method() {
    .....
  }
}

$instance = new MyClass();

<?php

class MyClass {

private $property;

public function __construct() {

.....

}

public function method() {

.....

}

$instance = new MyClass();

プロパティー

宣言・定義

プロパティー宣言時に値の初期値を定義可能。

private/protected/public プロパティー = 初期値;

参照・代入

クラス内でのプロパティー参照・代入

$this->プロパティー名($除き)

publicプロパティーのインスタンスからの参照・代入

インスタンス変数->プロパティー名($除き)

<?php
class MyClass {
  public $public_property;
  private $private_property;

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

  public function method() {
    echo $this->private_property . '<br>';
  }
}

$instance = new MyClass('Private');
$instance->public_property = 'Public';

$instance->method();
echo $instance->public_property;

<?php

class MyClass {

public $public_property;

private $private_property;

public function __construct($private_property) {

$this->private_property = $private_property;

}

public function method() {

echo $this->private_property . '<br>';

}

$instance = new MyClass('Private');

$instance->public_property = 'Public';

$instance->method();

echo $instance->public_property;

メソッド

メソッドはオーバーロードできない

PHPでは、異なるシグネチャーでメソッドをオーバーロードすることはできない。コンストラクターについても同じくオーバーロードできない。

以下のクラスではメソッドをシグネチャーの違いによってオーバーロードしようとしている。

<?php

class MyClass {
  public function method($arg) {
    echo $arg . "\n";
  }

  public function method() {
    echo '0\n';
  }
}

<?php

class MyClass {

public function method($arg) {

echo $arg . "\n";

}

public function method() {

echo '0\n';

}

しかし複数宣言はできないというエラーになる。

PHP Fatal error:  Cannot redeclare MyClass::method() in /home/vagrant/test/test.php on line 8

1	PHP Fatal error: Cannot redeclare MyClass::method() in /home/vagrant/test/test.php on line 8

デフォルト引数は使える

異なるシグネチャーのメソッドは、デフォルト引数を使うことで実現できる。

<?php

class MyClass {
  public function method($arg1=0, $arg2=0) {
    echo $arg1 * 10 + $arg2 . "\n";
  }
}

$instance = new MyClass();
$instance->method(2, 1);  // 21
$instance->method(2);     // 20
$instance->method();      // 0

<?php

class MyClass {

public function method($arg1=0, $arg2=0) {

echo $arg1 * 10 + $arg2 . "\n";

}

$instance = new MyClass();

$instance->method(2, 1); // 21

$instance->method(2); // 20

$instance->method(); // 0

デフォルト引数が指定されている場合に引数を指定すると、先頭の引数から値が設定されていく。引数名を指定して任意の引数の実を指定することはできない。

$instance->method($arg1=4); // 40
$instance->method($arg2=4); // 40

1 2	$instance->method($arg1=4); // 40 $instance->method($arg2=4); // 40

コンストラクター／デストラクター

public function __construct(...) { ... }
public function __destruct(... { ... }

いずれも動詞形で、先頭にアンダースコアを2つつける

クラスを継承した場合、コンストラクター／デストラクターを定義しなければ、親クラスのそれらが呼ばれるが、定義した場合には明示的に親クラスのコンストラクター／デストラクターを呼び出す必要がある。

parent::__construct(...)
parent::__destruct(...)

staticプロパティー

プロパティーをstatic宣言することで、クラスとして保持されるようになる。

`private static`宣言

クラス外からアクセス不能なクラスレベル変数。

クラス内で(すなわち各インスタンスから)self::プロパティー名($付き)でアクセスできる
全インスタンスで1つの値を共有する

以下の例では全インスタンスに共通のカウンターをクラス変数として持ち、

<?php

class MyClass {
  private static $count = 0;

  public function __construct() {
    self::$count++;
    echo self::$count . "個目のインスタンスを生成\n";
  }
}

$instance1 = new MyClass();
$instance2 = new MyClass();
$instance3 = new MyClass();

// 1個目のインスタンスを生成
// 2個目のインスタンスを生成
// 3個目のインスタンスを生成

<?php

class MyClass {

private static $count = 0;

public function __construct() {

self::$count++;

echo self::$count . "個目のインスタンスを生成\n";

}

$instance1 = new MyClass();

$instance2 = new MyClass();

$instance3 = new MyClass();

// 1個目のインスタンスを生成

// 2個目のインスタンスを生成

// 3個目のインスタンスを生成

`public static`宣言

クラス外からもアクセス可能なクラスレベル変数。

クラス内外を問わず、クラス名::プロパティー名($付き)でアクセスできる

以下のコードではクラスレベルのカウンターをpublic宣言し、クラス外からもアクセス可能としている。

8行目はself::$countでもよいが、クラス外からもアクセス可能なことを強調してMyClass::$countとしている。

<?php

class MyClass {
  public static $count = 0;

  public function __construct() {
    self::$count++;
    echo MyClass::$count . "個目のインスタンスを生成\n";
  }
}

$instance1 = new MyClass();
echo MyClass::$count . "個のインスタンス\n";
$instance2 = new MyClass();
echo MyClass::$count . "個のインスタンス\n";
$instance3 = new MyClass();
echo MyClass::$count . "個のインスタンス\n";

// 1個目のインスタンスを生成
// 1個のインスタンス
// 2個目のインスタンスを生成
// 2個のインスタンス
// 3個目のインスタンスを生成
// 3個のインスタンス

<?php

class MyClass {

public static $count = 0;

public function __construct() {

self::$count++;

echo MyClass::$count . "個目のインスタンスを生成\n";

}

$instance1 = new MyClass();

echo MyClass::$count . "個のインスタンス\n";

$instance2 = new MyClass();

echo MyClass::$count . "個のインスタンス\n";

$instance3 = new MyClass();

echo MyClass::$count . "個のインスタンス\n";

// 1個目のインスタンスを生成

// 1個のインスタンス

// 2個目のインスタンスを生成

// 2個のインスタンス

// 3個目のインスタンスを生成

// 3個のインスタンス

staticメソッド

`public static`宣言

クラス外からもアクセス可能なクラスレベルメソッド。

以下のコードでは、private static宣言されたカウンターを、public static宣言されたメソッドで参照している。このようにすると、private宣言されたカウンターが外部で変更される恐れがなくなる。

<?php

class MyClass {
  private static $count = 0;

  public static function getInstanceCount() {
    return self::$count;
  }

  public function __construct() {
    MyClass::$count++;
  }
}

$instance1 = new MyClass();
echo MyClass::getInstanceCount() . "個のインスタンス\n";
$instance2 = new MyClass();
echo MyClass::getInstanceCount() . "個のインスタンス\n";
$instance3 = new MyClass();
echo MyClass::getInstanceCount() . "個のインスタンス\n";

// 1個のインスタンス
// 2個のインスタンス
// 3個のインスタンス

<?php

class MyClass {

private static $count = 0;

public static function getInstanceCount() {

return self::$count;

}

public function __construct() {

MyClass::$count++;

}

$instance1 = new MyClass();

echo MyClass::getInstanceCount() . "個のインスタンス\n";

$instance2 = new MyClass();

echo MyClass::getInstanceCount() . "個のインスタンス\n";

$instance3 = new MyClass();

echo MyClass::getInstanceCount() . "個のインスタンス\n";

// 1個のインスタンス

// 2個のインスタンス

// 3個のインスタンス

`private static`宣言

private宣言したメソッドはstatic宣言されたクラスメソッドでもインスタンスメソッドでもあまり変わりはないように思える。

こちらの記事で、staticメソッドからインスタンスのプロパティーにアクセスできないことを利用して、メソッドが余計な副作用を持たないことを明示できるとあって、なるほどと思った。

Laravel – バリデーションメッセージの日本語化

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

概要

バリデーションエラーはデフォルトで英語だが、これを日本語にしてみる。

方法の1つとして、ロケールjaに対するメッセージファイルを編集する方法を整理する。

ロケールファイルを一括して日本語化する方法はこちら。

元になるアプリケーション

ルーティング

GETリクエストに対してフォームを含むビューを表示し、POSTリクエストに対してバリデーション処理を実行する。

Route::get('/validation_message', 'SampleController@validationMessage');
Route::post('/validation_message', 'SampleController@validationMessageResult');

1 2	Route::get('/validation_message', 'SampleController@validationMessage'); Route::post('/validation_message', 'SampleController@validationMessageResult');

ビュー

フォームでユーザー名とメールアドレスを入力し、POST処理の結果バリデーションエラーがあれば表示する。

  <h1>{{ $title }}</h1>

  <form method="post">
    @csrf
    <p><input type="text" name="name" placeholder="ユーザー名:10文字以内"></p>
    <p><input type="text" name="email" placeholder="メールアドレス:**@**"></p>
    <input type="submit" value="送信">
  </form>

  <p>{!! implode('<br>', $errors->all()) !!}</p>

<h1>{{ $title }}</h1>

@csrf

</form>

<p>{!! implode('<br>', $errors->all()) !!}</p>

コントローラー

フォーム表示

GETリクエストに対してフォーム画面を表示する。

  public function validationMessage() {
    return view('samples.validation_message', [
      'title' => 'カスタムバリデーションメッセージ',
    ]);
  }

public function validationMessage() {

return view('samples.validation_message', [

'title' => 'カスタムバリデーションメッセージ',

]);

}

POST処理

POSTリクエストに対して、ユーザー名とメールアドレスのバリデーションを実行。

  public function validationMessageResult(Request $request) {
    $request->validate([
      'name' => ['required', 'max:10'],
      'email' => ['required', 'email'],
    ]);

    return redirect('/validation_message');
  }

public function validationMessageResult(Request $request) {

$request->validate([

'name' => ['required', 'max:10'],

'email' => ['required', 'email'],

]);

return redirect('/validation_message');

}

この場合のバリデーションエラーは以下の様に表示される。

The name field is required.
The email field is required.

1 2	The name field is required. The email field is required.

あるいは

The name may not be greater than 10 characters.
The email must be a valid email address.

1 2	The name may not be greater than 10 characters. The email must be a valid email address.

ロケール設定による日本語化

ReaDouble.comのバリデーションのドキュメントでエラーメッセージのカスタマイズについて説明されていて、ローカライゼーションについては多言語化ドキュメントを参照するよう示唆されている。

これに基づいて、バリデーションエラーメッセージの日本語化をローカライゼーション周りで実装する方法を整理する。

言語の選択

config/app.phpでロケール設定を変更する。

localeをデフォルトのenからjaに変更
localeがjaで見つからないときのfallback_localeがデフォルトでenになっていることを確認
これにより、日本語ロケールの設定がある場合は日本語が適用され、見つからない場合は英語の設定が適用される

    .....
    'locale' => 'ja',
    .....
    'fallback_locale' => 'en',
    .....

.....

'locale' => 'ja',

.....

'fallback_locale' => 'en',

.....

バリデーションエラーメッセージのコピー・編集

resources/en/validation.phpで英語のバリデーションメッセージが定義されている。

<?php

return [
    .....
    'email' => 'The :attribute must be a valid email address.',
    .....
    'max' => [
        'numeric' => 'The :attribute may not be greater than :max.',
        'file' => 'The :attribute may not be greater than :max kilobytes.',
        'string' => 'The :attribute may not be greater than :max characters.',
        'array' => 'The :attribute may not have more than :max items.',
    ],
    .....
    'required' => 'The :attribute field is required.',
    .....
];

<?php

return [

.....

'email' => 'The :attribute must be a valid email address.',

.....

'max' => [

'numeric' => 'The :attribute may not be greater than :max.',

'file' => 'The :attribute may not be greater than :max kilobytes.',

'string' => 'The :attribute may not be greater than :max characters.',

'array' => 'The :attribute may not have more than :max items.',

.....

'required' => 'The :attribute field is required.',

.....

];

日本語ロケール設定のため、jaディレクトリーを作成し、そこにコピーしたvalidation.phpを編集する。

resources/jaディレクトリーを作成
jaディレクトリー下にvalidation.phpをコピー
必要なバリデーションメッセージを日本語化

<?php

return [
    .....
    'email' => ':attributeが正しい形式ではありません。',
    .....
    'max' => [
        'numeric' => 'The :attribute may not be greater than :max.',
        'file' => 'The :attribute may not be greater than :max kilobytes.',
        'string' => ':attributeは:max文字を超えられません。',
        'array' => 'The :attribute may not have more than :max items.',
    ],
    .....
    'required' => ':attributeの入力が必要です。',
    .....
];

<?php

return [

.....

'email' => ':attributeが正しい形式ではありません。',

.....

'max' => [

'numeric' => 'The :attribute may not be greater than :max.',

'file' => 'The :attribute may not be greater than :max kilobytes.',

'string' => ':attributeは:max文字を超えられません。',

'array' => 'The :attribute may not have more than :max items.',

.....

'required' => ':attributeの入力が必要です。',

.....

];

:attributeはエラーが発生したフィールドのname属性の値で置き換えられる。また:maxはバリデーションで設定した値に置き換えられる。

これにより、バリデーションエラーが生じたときの表示は以下の様に日本語化される。

nameの入力が必要です。
emailの入力が必要です。

1 2	nameの入力が必要です。 emailの入力が必要です。

あるいは

nameは10文字を超えられません。
emailが正しい形式ではありません。

1 2	nameは10文字を超えられません。 emailが正しい形式ではありません。

属性の日本語化

上記のメッセージでは、:attributeが置き換えられるname属性のnameやemailがそのまま現れている。

これらは、validation.phpの最後にある'attributes'に連想配列を記述することで、日本語表現に置き換えることができる。

    'attributes' => [],

1	'attributes' => [],

今回の例の場合、name属性はname(ユーザー名)とemail(メールアドレス)なので、これらを日本語に置き換えるよう定義する。

    'attributes' => [
        'email' => 'メールアドレス',
        'name' => 'ユーザー名'
    ],

'attributes' => [

'email' => 'メールアドレス',

'name' => 'ユーザー名'

この結果、バリデーションエラーメッセージは以下の様になる。

ユーザー名の入力が必要です。
メールアドレスの入力が必要です。

1 2	ユーザー名の入力が必要です。メールアドレスの入力が必要です。

あるいは

ユーザー名は10文字を超えられません。
メールアドレスが正しい形式ではありません。

1 2	ユーザー名は10文字を超えられません。メールアドレスが正しい形式ではありません。

エラーメッセージを日本語化したもの以外のバリデーションに対しては、元のまま残っている英語の内容が使われる。

たとえばバリデーションを追加する。

'email' => ['required', 'email', 'regex:/^\w+@\w+$/'],

1	'email' => ['required', 'email', 'regex:/^\w+@\w+$/'],

そうするとバリデーションエラーは以下のようになる。

The メールアドレス format is invalid.

1	The メールアドレス format is invalid.

全体のセンテンスは英語だが、name属性emailがattributesで変更した内容に置き換えられている。

Laravel – 動的メッセージ表示

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

概要

バリデーションエラーや登録成功などのメッセージを一時的に表示する方法を整理する。

ダイアログによりブラウザー表示領域とは別に表示する方法と、表示領域にメッセージを出して動的に消去する方法の2つ。

エラー・成功メッセージの登録

以下のような例で考えていく。

GETリクエストから表示用コントローラー・アクションにルーティング
アクションからフォームを含むページを呼び出す
フォームにユーザー名とメールアドレスの入力テキストボックスを配置

    <form method="post">
      @csrf
      <p><input type="text" name="name" placeholder="ユーザー名10文字以内"></p>
      <p><input type="text" name="email" placeholder="***@***"></p>
      <input type="submit" value="送信">
    </form>

@csrf

</form>

送信ボタンが押された場合のPOSTに対して、バリデーション用コントローラー・アクションにルーティング
バリデーション用アクションでは、ユーザー名とメールアドレスのバリデーションを記述
- バリデーション結果が妥当な場合はflash()で成功メッセージを登録
- バリデーション結果が妥当でない場合は、それ以降は実行されず$errorsに結果が保存される
いずれの場合も元のGETルートにリダイレクトされる

  public function flashResult(Request $request) {
    $request->validate([
      'name' => ['required', 'max:10'],
      'email' => ['required', 'email'],
    ]);

    session()->flash('success', '正しく入力されました');

    return redirect('/flash_sample');
  }

public function flashResult(Request $request) {

$request->validate([

'name' => ['required', 'max:10'],

'email' => ['required', 'email'],

]);

session()->flash('success', '正しく入力されました');

return redirect('/flash_sample');

}

状況に応じて登録された／空のままの$errorsやflashに対して、ビュー側で表示する。

ダイアログ表示

$errorsやflashをダイアログで表示する方法。

ビューのhead要素内で、これらの状態に応じたメッセージを生成し、Javascriptのalertの引数に渡している。

複数のエラーメッセージを改行文字を挟んでつなげるのに、PHPのinplode()関数を使っている。

<!DOCTYPE html>
<html lang="ja">
  <head>
    <meta charset="utf-8">
    <title>{{ $title }}</title>
    <script>
    @if ($errors->any())
      alert("{{ implode('\n', $errors->all()) }}");
    @elseif (session()->has('success'))
      alert("{{ session()->get('success') }}");
    @endif
    </script>
  </head>
  <body>
  .....
  </body>
</html>

<!DOCTYPE html>

<head>

<title>{{ $title }}</title>

@if ($errors->any())

alert("{{ implode('\n', $errors->all()) }}");

@elseif (session()->has('success'))

alert("{{ session()->get('success') }}");

@endif

</script>

</head>

<body>

.....

</body>

</html>

スライドアップによる一時表示

エラーや成功メッセージをブラウザーの上部などに表示し、一定時間後にそれをスライドアップなどで消去する。

メッセージ表示領域の設定と、Javascriptによる動的な消去の2段階で整理する。

メッセージ表示エリアの設定

ビューのbody要素最上部で、ディレクティブによってメッセージ表示領域を動的に生成している。その際に、エラー／成功に応じたクラスを要素に設定している。

$errors->any()でエラーが登録されていれば、エラー表示領域を生成
session()->has()で成功メッセージが登録されていれば成功メッセージ表示領域を生成

ビューのhead要素内で、エラーメッセージ領域／成功メッセージ領域それぞれのクラスに応じたスタイルを設定している。

なお、エラーメッセージは複数のメッセージを改行で表示させたいので、PHPのImplode()関数で区切りを<br>としたうえで{!! ... !!}で囲んでエスケープを抑制している。

!DOCTYPE html>
<html lang="ja">
  <head>
    <meta charset="utf-8">
    <style>
      .error {
        padding: 0.5em 1em 0.5em 1em;
        background-color: #fcc;
      }
      .success {
        padding: 0.5em 1em 0.5em 1em;
        background-color: #9df;
      }
    </style>
    <title>{{ $title }}</title>
  </head>
  <body>
    @if ($errors->any())
      {{-- エラーメッセージ --}}
      <div class="error">
        {!! implode('<br>', $errors->all()) !!}
      </div>
    @elseif (session()->has('success'))
      {{-- 成功メッセージ --}}
      <div class="success">
        {{ session()->get('success') }}
      </div>
    @endif
    .....
  </body>
</html>

!DOCTYPE html>

<head>

<style>

.error {

padding: 0.5em 1em 0.5em 1em;

background-color: #fcc;

}

.success {

padding: 0.5em 1em 0.5em 1em;

background-color: #9df;

}

</style>

<title>{{ $title }}</title>

</head>

<body>

@if ($errors->any())

{!! implode('<br>', $errors->all()) !!}

</div>

@elseif (session()->has('success'))

</div>

@endif

.....

</body>

</html>

メッセージ表示エリアの消去

エラー／成功のクラスに対して、JQueryでこれらをスライドアップして消去するスクリプトを追加する。

5行目でJQueryをCDNで読み込み
script要素内でスライドアップの動作を定義

<!DOCTYPE html>
<html lang="ja">
  <head>
    <meta charset="utf-8">
    <script src="https://code.jquery.com/jquery-3.5.0.min.js"></script>
    <script>
      window.setTimeout(() => {
        $(".error").slideUp();
        $(".success").slideUp();
      }, 1500);
    </script>
    .....
  </head>
  <body>
  .....
  </body>
</html>

<!DOCTYPE html>

<head>

window.setTimeout(() => {

$(".error").slideUp();

$(".success").slideUp();

}, 1500);

</script>

.....

</head>

<body>

.....

</body>

</html>

概要

instanceof/is_a()

instanceof

is_a()

is_subclass_of()

class_uses()

method_exists()/property_exists()

概要

連想配列への適用例

配列への適用例

概要

配列の要素の確認

連想配列の値の確認

注意点

概要

トレイトの使い方

定義

トレイトの実装

実装例

ベースになるコード

要件

トレイトの追加

トレイトの導入

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

留意点

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

概要

基本形

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

インターフェイスの実装

実装例

親クラス

Swordfighterクラス

Spellcasterインターフェイス

Wizardクラス

Priestクラス

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

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

抽象クラス

抽象クラスの継承

ポリモーフィズム

抽象クラスとポリモーフィズム

設定

親クラス～汎化

継承

メソッドのオーバーライド

コンストラクター

オーバーライド

クラスの継承とコンストラクター／デストラクターについて

プロパティーのprivate宣言について

クラスの定義

プロパティー

宣言・定義

参照・代入

メソッド

メソッドはオーバーロードできない

デフォルト引数は使える

コンストラクター／デストラクター

staticプロパティー

private static宣言

public static宣言

staticメソッド

public static宣言

private static宣言

概要

元になるアプリケーション

ルーティング

ビュー

コントローラー

フォーム表示

POST処理

ロケール設定による日本語化

言語の選択

バリデーションエラーメッセージのコピー・編集

属性の日本語化

概要

エラー・成功メッセージの登録

ダイアログ表示

スライドアップによる一時表示

メッセージ表示エリアの設定

プロパティーの`private`宣言について

`private static`宣言

`public static`宣言

`public static`宣言

`private static`宣言