0 follower

クラス yii\web\SessionIterator

全てのクラス | メソッド
継承yii\web\SessionIterator
実装Iterator
利用可能バージョン2.0
ソースコード https://github.com/yiisoft/yii2/blob/master/framework/web/SessionIterator.php

SessionIterator は、yii\web\Session によって管理されるセッション変数をトラバースするためのiteratorを実装します。

公開メソッド

継承されたメソッドを非表示

メソッド 説明 定義元
__construct() コンストラクタ。 yii\web\SessionIterator
current() 現在の配列要素を返します。 yii\web\SessionIterator
key() 現在の配列要素のキーを返します。 yii\web\SessionIterator
next() 内部ポインタを次の配列要素に移動します。 yii\web\SessionIterator
rewind() 内部配列ポインタを巻き戻します。 yii\web\SessionIterator
valid() 現在位置に要素が存在するかどうかを返します。 yii\web\SessionIterator

メソッドの詳細

継承されたメソッドを非表示

__construct() public メソッド

コンストラクタ。

public void __construct ( )

                public function __construct()
{
    $this->_keys = array_keys(isset($_SESSION) ? $_SESSION : []);
    $this->rewind();
}
current() public メソッド

現在の配列要素を返します。

このメソッドは、インターフェース Iterator によって要求されます。

public mixed current ( )
戻り値 mixed

現在の配列要素

 

                #[\ReturnTypeWillChange]
public function current()
{
    return $this->_key !== false && isset($_SESSION[$this->_key]) ? $_SESSION[$this->_key] : null;
}
key() public メソッド

現在の配列要素のキーを返します。

このメソッドは、インターフェース Iterator によって要求されます。

public string|integer|null key ( )
戻り値 string|integer|null

現在の配列要素のキー

 

                #[\ReturnTypeWillChange]
public function key()
{
    return $this->_key === false ? null : $this->_key;
}
next() public メソッド

内部ポインタを次の配列要素に移動します。

このメソッドは、インターフェース Iterator によって要求されます。

public void next ( )

                #[\ReturnTypeWillChange]
public function next()
{
    do {
        $this->_key = next($this->_keys);
    } while ($this->_key !== false && !isset($_SESSION[$this->_key]));
}
rewind() publicメソッド

内部配列ポインタを巻き戻します。

このメソッドは、インターフェース Iterator によって要求されます。

public void rewind ( )

                #[\ReturnTypeWillChange]
public function rewind()
{
    $this->_key = reset($this->_keys);
}
valid() publicメソッド

現在位置に要素が存在するかどうかを返します。

このメソッドは、インターフェース Iterator によって要求されます。

public boolean valid ( )

                #[\ReturnTypeWillChange]
public function valid()
{
    return $this->_key !== false;
}