PEAR マニュアル
前のページ次のページ

Structures_DataGrid_DataSource_DataObject

Structures_DataGrid_DataSource_DataObject -- PEAR::DB_DataObject データソースドライバ

Description

このクラスは、PEAR::DB::DB_DataObject オブジェクト用のデータソースドライバです。

サポートする操作モード

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

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

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

オプション

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

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

オプション型説明デフォルト値
fieldsarray データソースからどのフィールドを取得するか。空の配列を指定すると、 すべてのフィールドを取得します。 array(field1, field2, ...) 形式となります。 array()
fields_order_propertystring DataObject 内に設定するプロパティの名前。このプロパティを使用して、 フィールドの表示順を設定します。カラムを追加したり生成したりしない限りは、 この順で表示されます。同時に fields_property も設定する必要があります。 null
fields_propertystring DataObject 内に設定するプロパティの名前。このプロパティは、 'fields' オプションと同じような情報が含まれていることを想定しています。 'fields' オプションが設定されている場合は、これは使用されません。 'fb_fieldsToRender'
formbuilder_integrationbool 非推奨: 代わりに link_level と fields_order_property を使用してください。 これは、過去との互換性のために残されているものです。true を指定すると、link_level を 3、 fields_order_property を 'fb_preDefOrder' に設定したのと同じ動作となります。 false
generate_columnsbool ラベルつきの Structures_DataGrid_Column オブジェクトを作成します。 'labels' オプションを参照ください。 非推奨: 代わりに Structures_DataGrid::generateColumns() を使用してください。 false
labelsarray データフィールドとラベルの対応。 'generate_columns' が true の場合にのみ使用します。 array(field => label, ...) 形式となります。 非推奨: 代わりに Structures_DataGrid::generateColumns() を使用してください。 array()
labels_propertystring DataObject 内に設定するプロパティの名前。このプロパティは、 'labels' オプションと同じような情報を含めなければなりません。 'labels' オプションが設定されている場合は、これは使用されません。 'fb_fieldLabels'
link_keep_keybool これを true に設定すると、リンク先の値だけでなく元の値 (通常は外部キー) も保持します。 この値は、"__key" を付加した名前のキーで保持されます。 このオプションは、link_level が 0 より大きい場合にしか意味を持ちません。 例: country_code の値が 'FR' で、これがリンク先の country テーブルの値 "France" に置き換えられているとしましょう。 link_keep_key を true にすると、 country_code__key の値が "FR" となります。 false
link_levelint リンクの表示レベル。0 の場合はリンク先を追いません。0
link_propertystring リンク先の DataObject で設定するプロパティの名前。 このプロパティには、リンク先の DataObject から文字列を表示する際に使用するフィールド名の配列を指定します。 link_level が 0 のときには無意味です。 'fb_linkDisplayFields'
primaryKeyarray レコードを一意に決定する識別子を含むフィールドの名前、 あるいは数値インデックス (複数のフィールドを指定するのは、 複合主キーの場合のみです)。 null
raw_countbool true の場合は、レコード数を数える際に全レコードを問い合わせます。 レコードをグループ化 (GROUP BY や DISTINCT など……) している場合に必要となりますが、 処理は重くなります。false の場合は、 DB_DataObject::count() を使用してレコード数を取得します。 false
return_objectsbool true を指定すると、返り値は連想配列ではなくデータオブジェクトのクローンとなります。 これは、たとえば Smarty レンダラなどと組み合わせて使用する場合に便利です。 テンプレート内から直接データオブジェクトのプロパティやメソッドを使用できるようになります。 false
sort_propertystring DataObject 内に設定するプロパティの名前。このプロパティは、 array("field1", "field1 DESC", ...) 形式の配列でなければなりません。 データが既にソートされている場合は、 現在の設定にこのプロパティの中身が追加されます。 'fb_linkOrderFields'

例

例 62-1DB_DataObject の Structures_DataGrid へのバインド

<?php
$person = new DataObjects_Person;

$person->hair = 'red';
$person->has_glasses = 1; 

$datagrid->bind($person);
?>
前のページホーム次のページ
Structures_DataGrid_DataSource_CSV上に戻るStructures_DataGrid_DataSource_DB