ジェネレータとは?
状態:確認中
閲覧数:1,557
投稿日:2016-12-03
更新日:2016-12-03
「数列の各要素の値」などを次々と生成(ジェネレート)し他の手続きへ渡す機能
PHPにおけるGeneratorsとは?
・A.Generatorクラス
・B.generator関数
PHPにおけるGeneratorsとは?
・A.Generatorクラス
・B.generator関数
A.Generatorクラス
概要
Cで実装されている
擬似コード
Generator implements Iterator {
/* メソッド */
public mixed current ( void )
public mixed getReturn ( void )
public mixed key ( void )
public void next ( void )
public void rewind ( void )
public mixed send ( mixed $value )
public mixed throw ( Exception $exception )
public bool valid ( void )
public void __wakeup ( void )
}
/* メソッド */
public mixed current ( void )
public mixed getReturn ( void )
public mixed key ( void )
public void next ( void )
public void rewind ( void )
public mixed send ( mixed $value )
public mixed throw ( Exception $exception )
public bool valid ( void )
public void __wakeup ( void )
}
「Iteratorインターフェース」を実装している
「Generator クラス」は、 Iterator インターフェイスを実装している
・current(), key(), next(), rewind(), valid()を実装する必要がない
・Iterator インターフェイスを実装するクラスを用意しなくても、イテレータのメソッドを利用可
PHP-7.1
zend_class_implements(zend_ce_generator, 1, zend_ce_iterator);
PHP-5.5.4
zend_class_implements(zend_ce_generator TSRMLS_CC, 1, zend_ce_iterator);
ユーザーがnewすることはできない
「Generatorクラスのコンストラクタにエラーが仕込んである」から
PHP-7.1
static ZEND_COLD zend_function *zend_generator_get_constructor(zend_object *object) /* {{{ */
{
zend_throw_error(NULL, "The \"Generator\" class is reserved for internal use and cannot be manually instantiated");
return NULL;
}
{
zend_throw_error(NULL, "The \"Generator\" class is reserved for internal use and cannot be manually instantiated");
return NULL;
}
PHP-5.5.4
static zend_function *zend_generator_get_constructor(zval *object TSRMLS_DC) /* {{{ */
{
zend_error(E_RECOVERABLE_ERROR, "The \"Generator\" class is reserved for internal use and cannot be manually instantiated");
return NULL;
}
{
zend_error(E_RECOVERABLE_ERROR, "The \"Generator\" class is reserved for internal use and cannot be manually instantiated");
return NULL;
}
「finalクラス」なので「継承」不可
PHP-7.1
zend_ce_generator->ce_flags |= ZEND_ACC_FINAL;
PHP-5.5.4
zend_ce_generator->ce_flags |= ZEND_ACC_FINAL_CLASS;
「クローン」不可
PHP-7.1
PHP-5.5.4
zend_generator_handlers.clone_obj = NULL;
「serialize」不可
PHP-7.1
PHP-5.5.4
zend_ce_generator->serialize = zend_class_serialize_deny;
「unserialize」不可
PHP-7.1
PHP-5.5.4
zend_ce_generator->unserialize = zend_class_unserialize_deny;
B.generator関数
generator関数とは?
yield文を含む関数
・普通の関数と異なる
特徴
呼ばれたタイミングで関数の実行を行わない
・代わりに、「ジェネレータ関数に紐付いたGeneratorクラスのインスタンス」を返す
動きを一時停止して再度再開することが出来る
→ 関数やメソッド定義のなかの yield 文で指定した式は foreach ループで展開される
一度だけ return するのではない
・必要に応じて何度でも yield することが可能
→ 「値」を繰り返し返せる
ジェネレータ関数の実行順序
前回の終了位置から再開される
・通常の関数のように、毎回先頭から実行されない
PHPのparse時にyield文が見つかると、「その関数がジェネレータ関数であるというフラグが立てられる」
PHP-7.1
PHP-5.5.4
CG(active_op_array)->fn_flags |= ZEND_ACC_GENERATOR;
yield キーワード
比較
通常の関数
・return で関数実行を終了
・値を返す
// not generator
function func($n)
{
return $n;
}
echo func(10);// 10
yield キーワード
・「ジェネレータ関数」の実行を一時停止
・「ジェネレータを呼び出しているループ」に値を戻す
・「Generatorオブジェクト」を返す
// generator
function func($n)
{
yield $n;
}
$generator = func(10);
foreach ($generator as $val) {
echo "$val<br>"; //10
}
var_dump($generator); //object(Generator)#1 (0) { }
var_export($generator); //Generator::__set_state(array( ))
echo get_class($generator); //Generator