Structures_DataGrid_DataSource_Array

Structures_DataGrid_DataSource_Array -- Array データソースドライバ

説明

このクラスは、二次元配列用のデータソースドライバです。

サポートする操作モード

このドライバは次の操作モードをサポートしています。

表 62-1このドライバがサポートする操作モード

モードサポートしている?
複数フィールドによる並べ替えno
レコードの追加、更新および削除no

オプション

このドライバは、以下のオプションを受け付けます。

表 62-2このドライバのオプション

オプション説明デフォルト値
fieldsarray データソースからどのフィールドを取得するか。空の配列を指定すると、 すべてのフィールドを取得します。 array(field1, field2, ...) 形式となります。 array()
generate_columnsbool ラベルつきの Structures_DataGrid_Column オブジェクトを作成します。 'labels' オプションを参照ください。 非推奨: 代わりに Structures_DataGrid::generateColumns() を使用してください。 false
labelsarray データフィールドとラベルの対応。 'generate_columns' が true の場合にのみ使用します。 array(field => label, ...) 形式となります。 非推奨: 代わりに Structures_DataGrid::generateColumns() を使用してください。 array()
natsortboolean 配列のソートを自然順 (example1、Example2、test1、Test2) で行うか否 (Example2、Test2、example1、test1; つまり大文字が最初にくる) か。 false
primaryKeyarray レコードを一意に決定する識別子を含むフィールドの名前、 あるいは数値インデックス (複数のフィールドを指定するのは、 複合主キーの場合のみです)。 null

全般的な注意

このドライバが受け付ける配列の形式は、次のとおりです。
$data = array(0 => array('col0' => 'val00', 'col1' => 'val01', ...),
              1 => array('col0' => 'val10', 'col1' => 'val11', ...),
              ...
             );

この配列の最初にレベルが、各行のひとつのエントリを表します。 そのエントリに対応する配列が、行に受け付けるデータとなります。 この配列のキーはフィールド名となります。たとえば 'val01' は、 最初の行のフィールド名 'col1' に対応する値となります。 行番号は、1 からではなく 0 から始まることに注意しましょう。