著者アーカイブ 杉浦

著者:杉浦

php-cs-fixerの設定まとめページphp-cs-fixer-configuratorの紹介

　php-cs-fixer-configuratorはphp-cs-fixerの設定をまとめているページです。php-cs-fixerはphpのコードを設定に従って修正してくれるアプリケーションなのですが、大本の設定マニュアルは羅列という言葉が似あうもので読むのが億劫です。php-cs-fixer-configuratorはphp-cs-fixerの設定を読みやすい形でまとめているページです。
　使い方はいたって簡単、次の画像からぱっと見でわかる様に検索して目的のルールを探すだけです。

　各ルールの詳細な説明もあります。次の画像らはblank_line_after_namespaceの説明です。これは名前空間の宣言の後には一行だけ空白行が入る、というルールです。This fixer is not configurableは設定不能というよりも設定不要と読んだ方がいいでしょう。ルールの有効無効だけが選択できます。
　


　プリセットに何が含まれているかを確認することも容易です。

著者:杉浦

__callによる未定義メソッドの呼び出し

　PHPには予約関数マジックメソッドがあり、__call()はその一つです。
PHP: マジックメソッド – Manual

__call() は、 アクセス不能メソッドをオブジェクトのコンテキストで実行したときに起動します。

　要は、未定義のメソッドを呼び出した時は代わりに__call()が呼ばれますよ、ということです。__call()は次の様に定義されます。

public mixed __call ( string $name , array $arguments )

$nameには呼ばれた際に使われたメソッド名、$argumentsには呼ばれた際に使われた引数が入ってきます。__call()を利用する事でな様々なことが出来ます。例えばエラーメッセージです。あるクラスが存在しないメソッドに向かってアクセスされようとした時、エラーメッセージを返すには次の様なコードが使えます。

public function __call($method, $parameters)
{
    sprintf('Method %s::%s does not exist.', static::class, $method);
}

　また、よく行うであろう動作をあらかじめ定義し、その動作の省略に割り当てるという使い方もあります。次の例はあるモデルにクエリビルダを繋ぎ、新規クエリビルダ呼び出しを省略する手法です。この手法を用いることで、クエリビルダと同等の働きができ、なおかつDBから引き出されたphp上における振る舞いのメソッドも多様に持つ、という風に見えるモデルを簡単に記述できます。

class Model
{
    public function __call($method, $parameters)
    {
        return $this->newQuery()->$method(...$parameters);
    }
    //省略
}

　クエリビルダへつなげる手法では更にクエリビルダの持つメソッドへチェーンしていくことが出来ます。これにより一見存在しないメソッドが存在するかのように振る舞います。この存在しないように見えるが使用されるメソッドが無秩序に増えた場合、コードを追うことが非常に大変な作業になります。これはgrepや参照呼出しを一発で当てられなくなるためです。何が呼び出されているかをいちいち確認する必要があることが面倒なのです。
　PHPDocを書くことでこの問題を解決できます。PHPDocの@methodはどの様なメソッドがあるかを示す文言で、多くのIDEはこれを追ってくれます。次の様に記述した場合、IDEはselectメソッド、whereメソッドが存在するかの様にModelクラスを扱ってくれます。

/**
 * @method QueryBuilder select(QueryBuilder $query)
 * @method QueryBuilder where(QueryBuilder $query)
 */
class Model
{
    public function __call($method, $parameters)
    {
        return $this->newQuery()->$method(...$parameters);
    }
    //省略
}

著者:杉浦

万能クラスや数珠つなぎの継承を作らずにコードの共有を行うトレイト

PHP: トレイト – Manual

トレイトは、PHP のような単一継承言語でコードを再利用するための仕組みのひとつです。 トレイトは、単一継承の制約を減らすために作られたもので、 いくつかのメソッド群を異なるクラス階層にある独立したクラスで再利用できるようにします。 トレイトとクラスを組み合わせた構文は複雑さを軽減させてくれ、 多重継承や Mixin に関連するありがちな問題を回避することもできます。

　トレイトはtraitと書き、次の様にclassと同じ書き方をし、useで読み込みます。関数などの名前が衝突した際にはinsteadofでどちらを使うか決定する、asで別名として扱う対応を行います。

<?php
trait A {
    public function smallTalk() {
        echo 'a';
    }
    public function bigTalk() {
        echo 'A';
    }
    public function moreBigTalk() {
        echo 'X';
    }
}

trait B {
    public function smallTalk() {
        echo 'b';
    }
    public function bigTalk() {
        echo 'B';
    }
}

class Talker {
    use A, B {
        B::smallTalk insteadof A;
        A::bigTalk insteadof B;
    }
}

class Aliased_Talker {
    use A, B {
        B::smallTalk insteadof A;
        A::bigTalk insteadof B;
        B::bigTalk as talk;
    }
    $this->moreBigTalk();
}

　いまのところ使ったことはないですが可視性の変更も可能です。
　トレイトの特に強力で扱いやすい部分が名前の扱いです。トレイトなしでコードを再利用する場合、共通のクラスを継承する、ユーティリティクラスを作る、別ファイルにしてincludeかrequireしてグローバル領域に配置するといった手法が考えられます。それらの手法の複雑さの原因になりうるという危うい点を、継承を行わず、グローバルを汚染せず、区分をtraitの名前につけてコードの再利用を可能にすることでトレイトは回避しています。
　IDEは画像の様に内部に何が入っているのかアイコンで表示してくれるのでその点でもありがたいです。