PHPでメソッドチェーンを実現する方法をわかりやすく解説

PHPでは「メソッドチェーン」という手法を使うことで、複数のメソッドを連続して呼び出すことができます。この仕組みを実現する鍵となるのがミューテータ（mutator）メソッドです。ミューテータメソッドは、処理の最後に自分自身のオブジェクト（$this）を返します。そのため、戻り値となったオブジェクトに対してさらに別のメソッドを続けて呼び出すことが可能になります。

実装例

以下は、メソッドチェーンを利用したシンプルなサンプルコードです。

<?php
class sample_class {
   private $str;
   function __construct() {
      $this->str = "";
   }
   function addA() {
      $this->str .= "am";
      return $this;
   }
   function addB() {
      $this->str .= "_bn";
      return $this;
   }
   function getStr() {
      return $this->str;
   }
}
$new_object = new sample_class();
echo $new_object->addA()->addB()->getStr();

実行結果

このコードを実行すると、次のような出力が得られます。

am_bn

ポイント解説

• 各メソッド内で return $this; を記述し、自分自身のインスタンスを返すことが重要です。
• これにより、$new_object->addA()->addB()->getStr() のように、矢印演算子（->）でつなげてメソッドを順番に実行できます。
• 最後の getStr() は文字列を返すため、チェーンの終端として機能します。

メソッドチェーンを活用すると、コードを簡潔かつ読みやすくまとめられるため、クエリビルダーや文字列操作ライブラリなどでも広く使われています。