\CodeLapse\DatabaseResultSet

データベースの結果セットラッパー。 ドライバーはこのクラスの"_fetch"メソッドのみを実装する必要があります。

Summary

Methods
Properties
Constants
__construct()
rewind()
valid()
current()
key()
next()
getResultSet()
fetch()
fetchAll()
free()
No public properties found
FETCH_BOTH
FETCH_NUM
FETCH_ASSOC
_fetch()
$_result
$_itr_index
$_cursor
$_fetched_rows
N/A
_deformRow()
No private properties found
N/A

Constants

FETCH_BOTH

FETCH_BOTH

FETCH_NUM

FETCH_NUM

FETCH_ASSOC

FETCH_ASSOC

Properties

$_result

$_result : mixed

Type

mixed — データベースから取得したリザルトセット

$_itr_index

$_itr_index : integer

Type

integer — イテレータ用ポインタ

$_cursor

$_cursor : integer

Type

integer — fetchメソッド用カウンタ

$_fetched_rows

$_fetched_rows : array

Type

array — データベースから読み込まれた行データ

Methods

__construct()

__construct(mixed $result)

Parameters

mixed $result

リザルトセット

rewind()

rewind()

Iterator実装メソッド ポインタを巻き戻します。

valid()

valid() : boolean

Iterator実装メソッド 現在位置が有効か調べます。

Returns

boolean

current()

current() : mixed

Iterator実装メソッド 現在の要素を返します。

Returns

mixed

key()

key() : scalar

Iterator実装メソッド 現在のインデックスを返します。

Returns

scalar —

| null

next()

next()

Iterator実装メソッド カーソルをひとつ進めます。

getResultSet()

getResultSet() : mixed

プレーンなResultSetオブジェクトを取得します。

Returns

mixed

fetch()

fetch(integer $type) : mixed

現在のカーソル位置の次のレコードを取得します。

Parameters

integer $type

(optional) 返されるデータの形式を指定します。

 DB_Resultset::FETCH_*のいずれかを指定します。

Returns

mixed —

指定された形式の配列もしくはオブジェクトを返します。

 カーソルが最後の行まで到達した時に falseが返されます。

fetchAll()

fetchAll(integer $type) : array

結果を全件取得します。

Parameters

integer $type

返されるデータの種類を指定します。

 DB_Resultset::FETCH_*のいずれかを指定します。

Returns

array

free()

free()

ResultSetオブジェクトを解放します。

ドライバに結果セット開放機能がない場合など、 このメソッドは必ずしも実装する必要はありません。

_fetch()

_fetch( $resultset) : array|boolean

次の行データを読み込みます。

このメソッドは次の行の内容をBOTH形式で返す必要があります。 fetch, fetchAll, currentメソッドのいずれかがコールされ、次の行のデータが必要になったとき DB_Resultsetクラスからコールされます。

このメソッドは一律にBOTH形式のデータを返すことで, 他のメソッドが要求されたフェッチ形式(ASSOC, NUM, etc...)にデータを整形することができます。

Parameters

$resultset

Returns

array|boolean —

1行文のBOTH形式の行データ。

 次の行がない場合は falseを返してください。

_deformRow()

_deformRow( $row, integer $type) : array

一行分のデータを指定形式へ変換します。

Parameters

$row
integer $type

DBResultset::FETCH* のいずれか

Returns

array —

指定形式へ変換された行データ