PHPの戻り値型宣言でselfを使ってみよう

1. @DQNEO(どきゅねお) at Mercari
2018.06 #phpstudy
self in
Return Type Declaration

2. Git本の監修しました

3. Return type declaration
(戻り値の型宣言)
使ってますか？

4. function foo(): int
{
}
戻り値の型宣言とは？
こんなやつ

5. 例：自分を返すメソッド
class A
{
public function getMe(): A
{
return $this;
}
}

6. 実はselfと書ける
class A
{
public function getMe(): self
{
return $this;
}
}

7. べんり！！

8. 意外と知らない人
多い印象

9. 公式ドキュメントには
なぜかselfについて
言及なし
http://php.net/manual/en/functions.returning-
values.php#functions.returning-values.type-declaration

10. RFCの下の方に小さ∼く
書いてある
https://wiki.php.net/rfc/return_types

11. 継承するとどうなる？
class A
{
public function getMe(): self
{
return $this;
}
}
class B extends A {}
$b = new B();
$b->getMe(); // ?

12. 正解 : Bのインスタンスが返る
class A
{
public function getMe(): self
{
return $this;
}
}
class B extends A {}
$b = new B();
$b->getMe(); // instance of B

13. $thisは、Bのコンテキス
トから呼ばれるとBのイ
ンスタンスを指すので。

14. 左のコードは右のコードと等価
class A
{
public function getMe(): A
{
return $this;
}
}
class B extends A {}
$b = new B();
$b->getMe(); // B
class A
{
public function getMe(): self
{
return $this;
}
}
class B extends A {}
$b = new B();
$b->getMe(); // B

15. 戻り値の型は、
実行時にreturnされた際に
instanceof(的なもので)
でチェックされる

16. この場合どうなる？
class A
{
public function getMe(): self
{
return $this;
}
}
class B extends A
{
public function getMe(): self
{
return $this;
}
}

17. Fatal error
(実行時コンパイルエラー)
PHP Fatal error:
Declaration of B::getMe(): B must be compatible with
A::getMe(): A

18. これがダメなのと同じ
(シグネチャの不一致)
class A
{
public function getMe(): A
…
}
class B extends A
{
public function getMe(): B
…
}

19. こうすればおｋ
class A
{
public function getMe(): self
{
return $this;
}
}
class B extends A
{
public function getMe(): parent
{
return $this;
}
}

20. これがOKなのと同じ
class A
{
public function getMe(): A
…
}
class B extends A
{
public function getMe(): A
…
}

21. 余談：これは将来のPHPでは
可能になるかもしれない。(戻り値の共変)
class A
{
public function getMe(): A
}
class B extends A
{
public function getMe(): B
…
}
https://wiki.php.net/rfc/covariant-returns-and-
contravariant-parameters

22. ちなみに型名のところに
staticは不可。
class A
{
public function getMe(): static
…
}

23. まとめ
• 戻り値型宣言でself, parent
が使える
• 乱用するとわかりにくくなる
ので適材適所で
• 「instanceofチェック」だと
思えばおｋ

24. 余談：メソッドの引数でも使える
class A
{
public function setMe(self $self)
{
$this->self = $self;
}
}
class B extends A
{
public function setMe(parent $self)
{
$this->self = $self;
}
}

25. ご清聴ありがとう
ございました
mm