引数を名前で渡す

引数が多い時に困るのはみんな一緒ですね。

C++とかJavaで良く見るプログラミングスタイルだが、こうやってひたすら数字だけが並んでいるとやたらと読みにくい。三日後に見たらどのパラメーターが何なのかが思い出せなくて、コンストラクターのソースコードを参照せねばならない。

Life is beautiful: 「パラメーターのプロパティ渡し」でプログラムを読みやすくする、というアイデアはどうだろう

PHPのコンストラクタを名前付き引数で呼ぶアイデアはid:shimookaさんが書かれているので、ここでは通常のメソッドについて考えてみました。

いまいちなコードですが、引数省略時のデフォルト値、存在しない引数名が来た時・必須引数が無い場合に例外を投げるようにしてます。

<?php
class IllegalArgumentException extends Exception {}

class Hoge {
  protected function getParam(array &$params, $key, $isMust = false, $default = null) {
    if (array_key_exists($key, $params)) {
      $v = $params&#91;$key&#93;;
      unset($params&#91;$key&#93;);
      return $v;
    } else {
      if ($isMust) {
        throw new IllegalArgumentException();
      } else {
        return $default;
      }
    }
  }
}

class Foo extends Hoge {
  public function func1(array $params = array()) {
    $id = $this->getParam($params, 'id', true);
    $name = $this->getParam($params, 'name', false, 'NO NAME');
    if (count($params) > 0) {
      throw new IllegalArgumentException();
    }
                      
    printf("id=%s name=%s\n", $id, $name); 
  }
}
                
$obj = new Foo();
// id=1 name=hoge     
$obj->func1(array('name' => 'hoge', 'id' => 1));
// id=1 name=NO NAME
$obj->func1(array('id' => 1));
//  Uncaught exception 'IllegalArgumentException'
$obj->func1(); 
//  Uncaught exception 'IllegalArgumentException'
$obj->func1(array('name' => 'hoge', 'id' => 1, 'email' => 'hoge@example.com'));

引数定義をメソッド宣言とは別に持つのはいまいちですね、はい。

ちなみにPythonは言語としてこの機能をサポートしているようです（via: odz buffer）。あとVBも同じような機能があります（via: 位置と名前による引数渡し）。

Tweet

Pocket