PHP 5では、タイプヒンティング(Type Hinting)が導入されました。 これにより、関数は、 (クラスの名前を関数プロトタイプの中に指定することにより) パラメータをオブジェクトもしくはインターフェイス、配列 (PHP 5.1 以降)、callable (PHP 5.4 以降) を必ず指定させることができるようになりました。 しかし、デフォルトのパラメータの値として NULL を使用した場合は、後から任意の値を引数に指定できるようになります。
タイプヒントでクラスやインターフェイスを指定した場合、 その子クラスや実装クラスも利用できます。
タイプヒントは int や string といったスカラー型には使えません。 また、リソース や トレイト も使えません。
例1 タイプヒンティングの例
<?php
// とあるクラス
class MyClass
{
/**
* テスト関数
*
* 第 1 引数は OtherClass 型のオブジェクトでなければならない
*/
public function test(OtherClass $otherclass) {
echo $otherclass->var;
}
/**
* もう一つのテスト関数
*
* 第 1 引数は配列でなければならない
*/
public function test_array(array $input_array) {
print_r($input_array);
}
/**
* 第 1 引数はイテレータでなければならない
*/
public function test_interface(Traversable $iterator) {
echo get_class($iterator);
}
/**
* 第 1 引数は callable でなければならない
*/
public function test_callable(callable $callback, $data) {
call_user_func($callback, $data);
}
}
// もう一つのサンプルクラス
class OtherClass {
public $var = 'Hello World';
}
?>
タイプヒントの指定を満たさないとキャッチ可能な致命的エラーとなります。
<?php
// それぞれのクラスのインスタンス
$myclass = new MyClass;
$otherclass = new OtherClass;
// Fatal Error: Argument 1 must be an object of class OtherClass
$myclass->test('hello');
// Fatal Error: Argument 1 must be an instance of OtherClass
$foo = new stdClass;
$myclass->test($foo);
// Fatal Error: Argument 1 must not be null
$myclass->test(null);
// Works: Prints Hello World
$myclass->test($otherclass);
// Fatal Error: Argument 1 must be an array
$myclass->test_array('a string');
// 動作する: 配列の内容を表示する
$myclass->test_array(array('a', 'b', 'c'));
// 動作する: ArrayObject を表示する
$myclass->test_interface(new ArrayObject(array()));
// 動作する: int(1) を表示する
$myclass->test_callable('var_dump', 1);
?>
タイプヒンティングは、関数でも使用できます。
<?php
// とあるクラス
class MyClass {
public $var = 'Hello World';
}
/**
* テスト関数
*
* 第 1 引数は MyClass 型のオブジェクトでなければならない
*/
function myFunction(MyClass $foo) {
echo $foo->var;
}
// 動作する
$myclass = new MyClass;
myFunction($myclass);
?>
タイプヒントには NULL 値を使用することもできます。
<?php
/* NULL 値も使えます */
function test(stdClass $obj = NULL) {
}
test(NULL);
test(new stdClass);
?>