Structures_DataGrid

Structures_DataGrid は、テーブル構造のデータを 作成、操作、表示するためのクラスです。 データグリッドを HTML 形式で表示するだけでなく、XML ドキュメントや Excel スプレッドシート、そして XUL ドキュメントなどのさまざまな形式にすることができます。

ページ操作やソートの機能により、表示されるデータを絞り込むこともできます。 この考え方は、.NET Framework の DataGrid コントロール にヒントを得たもので、データベースの結果セットや XML 形式のデータセットと組み合わせると非常にうまく動作します。

導入および機能紹介

目次
導入 -- Structures_DataGrid で何ができるのか?
FAQ -- よくある質問への答え
インストール -- コアパッケージおよびドライバパッケージのインストール方法
データソース -- データソースドライバとは?
出力のレンダリング -- どのような書式で出力できるのか?
ストリーミング -- 大規模なレコードセットのストリーミング方法
カラムフォーマッタ -- カラムフォーマッタで何ができるのか?
サンプル - お手軽版 -- データベースのテーブルから、手っ取り早くデータを取得する
サンプル - 複雑版 -- さまざまな機能を使用してデータグリッドを作成する
独自のデータソース --  独自のデータソースドライバを作成する方法
独自のレンダラ --  独自のレンダリングドライバを作成する方法

Structures_DataGrid クラス

目次
constructor Structures_DataGrid::Structures_DataGrid() -- コンストラクタ
Structures_DataGrid::addColumn() -- カラムを追加する。オプションでその位置を指定する
Structures_DataGrid::attachRenderer() -- 初期化済みのレンダリングドライバをアタッチする
Structures_DataGrid::bind() -- シンプルな方法で、レコードセットをデータグリッドにバインドする
Structures_DataGrid::bindDataSource() -- データソースドライバのインスタンスをバインドする
Structures_DataGrid::build() -- データグリッドを組み立てる
Structures_DataGrid::dataSourceFactory() -- データソースドライバのファクトリ
Structures_DataGrid::dump() --  デバッグ用にのみ使用するメソッド。 データグリッドオブジェクトの内容をダンプする
Structures_DataGrid::enableStreaming() --  データソースからの読み込み、レンダラへの書き出しの際のストリーミング機能を有効にし、 バッファの大きさ (レコード数) を設定する
Structures_DataGrid::fill() -- レンダリングコンテナにデータを投入する
Structures_DataGrid::generateColumns() -- フィールドリストのカラムを生成する
Structures_DataGrid::getColumnByField() -- フィールド名からカラムを探す
Structures_DataGrid::getColumnByName() -- 名前 (ラベル) からカラムを探す
Structures_DataGrid::getColumnCount() -- カラムの数を返す
Structures_DataGrid::getColumns() -- 現在のカラムを返す
Structures_DataGrid::getCurrentPage() -- ページ処理が実装されている場合に、現在のページ番号を取得する
Structures_DataGrid::getCurrentRecordNumberEnd() -- 現在のページの最後のレコードの番号を返す
Structures_DataGrid::getCurrentRecordNumberStart() -- 現在のページの最初のレコードの番号を返す
Structures_DataGrid::getDataSource() -- 現在読み込まれているデータソースドライバを取得する
Structures_DataGrid::getOutput() -- データグリッドの出力を返す
Structures_DataGrid::getPageCount() -- 総ページ数を返す
Structures_DataGrid::getRecordCount() -- レコードの総数を返す
Structures_DataGrid::getRenderer() -- 現在使用中の、あるいはデフォルトのレンダリングドライバを取得する
Structures_DataGrid::removeColumn() -- カラムを削除する
Structures_DataGrid::render() -- データグリッドをレンダリングする
Structures_DataGrid::setCurrentPage() -- 現在のページ番号を定義する
Structures_DataGrid::setDataSourceOption() -- データソースのオプションを設定する
Structures_DataGrid::setDataSourceOptions() -- データソースの複数のオプションを設定する
Structures_DataGrid::setDefaultSort() -- デフォルトの並べ替え条件を設定する
Structures_DataGrid::setRenderer() -- レンダラを設定する
Structures_DataGrid::setRendererOption() -- レンダラのオプションを設定する
Structures_DataGrid::setRendererOptions() -- レンダラの複数のオプションを設定する
Structures_DataGrid::setRequestPrefix() -- グローバル変数 GET/POST のプレフィックスを設定する
Structures_DataGrid::setUrlFormat() -- URL のマッピングを有効にし、設定する
Structures_DataGrid::sortRecordSet() -- 定義したフィールドで、レコードを並べ替える

Structures_DataGrid_Column クラス

目次
Structures_DataGrid_Column クラス概要 -- Structures_DataGrid_Column クラス
constructor Structures_DataGrid_Column::Structures_DataGrid_Column() -- コンストラクタ
Structures_DataGrid_Column::format() -- 定義済みの書式を選択する
Structures_DataGrid_Column::formatter() -- フォーマッタ
Structures_DataGrid_Column::getAttributes() -- カラムの XML/HTML 属性を取得する
Structures_DataGrid_Column::getAutoFillValue() -- オートフィルの値を取得する
Structures_DataGrid_Column::getDefaultDirection() -- このカラムのデフォルトのソート方向を返す
Structures_DataGrid_Column::getField() -- カラムに対応させるフィールドの名前を取得する
Structures_DataGrid_Column::getLabel() -- カラムのラベルを取得する
Structures_DataGrid_Column::getOrderBy() -- データの並べ替えの基準となるフィールド名を取得する
Structures_DataGrid_Column::setAttributes() -- カラムの XML/HTML 属性を設定する
Structures_DataGrid_Column::setAutoFillValue() -- オートフィルの値を設定する
Structures_DataGrid_Column::setDefaultDirection() -- このカラムのデフォルトのソート方向を設定する
Structures_DataGrid_Column::setField() -- カラムに対応させるフィールドの名前を設定する
Structures_DataGrid_Column::setFormatter() -- フォーマッタのコールバックを設定する
Structures_DataGrid_Column::setLabel() -- カラムのラベルを設定する
Structures_DataGrid_Column::setOrderBy() -- データの並べ替えの基準となるフィールド名を設定する

データソースドライバ

目次
Structures_DataGrid_DataSource_Array -- Array データソースドライバ
Structures_DataGrid_DataSource_CSV -- カンマ区切り値 (CSV) データソースドライバ
Structures_DataGrid_DataSource_DataObject -- PEAR::DB_DataObject データソースドライバ
Structures_DataGrid_DataSource_DB -- PEAR::DB データソースドライバ
Structures_DataGrid_DataSource_DBQuery -- PEAR::DB SQL クエリ データソースドライバ
Structures_DataGrid_DataSource_DBTable -- PEAR::DB_Table データソースドライバ
Structures_DataGrid_DataSource_Excel -- Excel スプレッドシート データソースドライバ
Structures_DataGrid_DataSource_MDB2 -- PEAR::MDB2 SQL クエリ データソースドライバ
Structures_DataGrid_DataSource_PDO -- PDO SQL クエリデータソースドライバ
Structures_DataGrid_DataSource_RSS -- RSS データソースドライバ
Structures_DataGrid_DataSource_XML -- XML データソースドライバ

レンダラドライバ

目次
Structures_DataGrid_Renderer_CheckableHTMLTable -- グリッドの各行にチェックボックスをつけた HTML テーブルレンダリングドライバ
Structures_DataGrid_Renderer_Console -- コンソールテーブル レンダリングドライバ
Structures_DataGrid_Renderer_CSV -- CSV レンダリングドライバ
Structures_DataGrid_Renderer_Flexy -- Flexy レンダリングドライバ
Structures_DataGrid_Renderer_HTMLEditForm -- レコードを編集するための HTML フォーム
Structures_DataGrid_Renderer_HTMLSortForm -- 複数フィールドによる並べ替えを行うレンダリングドライバ
Structures_DataGrid_Renderer_HTMLTable -- HTML テーブル レンダリングドライバ
Structures_DataGrid_Renderer_Pager -- Pager レンダリングドライバ
Structures_DataGrid_Renderer_Smarty -- Smarty レンダリングドライバ
Structures_DataGrid_Renderer_XLS -- Excel スプレッドシート レンダリングドライバ
Structures_DataGrid_Renderer_XML -- XML レンダリングドライバ
Structures_DataGrid_Renderer_XUL -- XUL レンダリングドライバ