Structures_DataGrid_Renderer_HTMLSortForm
Structures_DataGrid_Renderer_HTMLSortForm – 複数フィールドによる並べ替えを行うレンダリングドライバ
説明
このドライバは、(HTML_QuickForm を使用して) フォームを作成します。 これにより、複数のフィールドや並べ替え方向を指定して データグリッドを並べ替えることができるようになります。
サポートする操作モード
このドライバは次の操作モードをサポートしています。
| モード | サポートしている? |
|---|---|
| コンテナのサポート | yes |
| 出力バッファリング | yes |
| ダイレクトレンダリング | no |
| ストリーミング | no |
| オブジェクトの永続化 | no |
オプション
このドライバは、以下のオプションを受け付けます。
| オプション | 型 | 説明 | デフォルト値 |
|---|---|---|---|
| buildFooter | bool | フッタを作成するかどうか。 | true |
| buildHeader | bool | ヘッダを作成するかどうか。 | true |
| defaultCellValue | string | 空のセルに表示するデフォルトの値。 | null |
| defaultColumnValues | array | カラムごとに指定するセルのデフォルト値。 array(fieldName => value, ...) 形式の配列となります。 | array() |
| directionStyle | string | 並べ替え方法を指定を 'select' 要素あるいは 'radio' 要素のどちらで行うか。 | 'select' |
| encoding | string | 内容のエンコーディング。mbstring 拡張モジュールが使用可能な場合、 デフォルト値は mb_internal_encoding() から取得します。 それ以外の場合のデフォルト値は ISO-8859-1 となります。 | 'ISO-8859-1' |
| excludeVars | array | 作成される HTTP クエリから取り除く変数。 | array() |
| extraVars | array | 作成される HTTP クエリに追加される変数。 | array() |
| fillWithEmptyRows | bool | すべてのページで行数が同じになるようにするかどうか。 | false |
| hideColumnLinks | array | デフォルトでは、すべてのカラムで並べ替えリンクが有効になります。 このオプションを使用すると、指定したカラムの並べ替えリンクを無効にできます。 array(fieldName, ...) 形式の配列で指定します。 このオプションは、並べ替えをサポートしているドライバでのみ有効です。 | array() |
| numberAlign | bool | 数値を右詰めにするかどうか。 | true |
| onMove | string | ユーザがページを移動したりデータをソートしたりしたときの onclick/onsubmit イベント発生時にコールする Javascript 関数の名前。 この関数は、オブジェクトを引数として受け取ります。 このオブジェクトの形式は { page: <page>, sort: [{field: <field>, direction: <direction>}, ...], data: <user_data> } のようになります。このオプションを指定しても、 href 属性は削除されないことに注意しましょう。 href を無効にしたい場合 (AJAX など……) は、ハンドラ関数内で false を返すようにしなければなりません。 | null |
| onMoveData | string | onMove に渡す引数のオブジェクトの、"data" に渡すデータ。JSON 形式のシリアル化は行わず、 そのままの形で "data" 属性に渡されます。 クォートやスラッシュなどを追加する処理は、自分で行ってください。 | '' |
| sortFieldsNum | int | 並べ替えに指定できるフィールドの数。 バックエンドが複数フィールドによる並べ替えに対応していない場合、 これは何の意味ももちません。 | 3 |
| textAscending | string | 昇順を表すラベル。 | 'Ascending' |
| textChoose | string | select ボックスで何も選択されていない場合に表示する文字列。 | 'Choose...' |
| textDescending | string | 降順を表すラベル。 | 'Descending' |
| textSortBy | string | 最初のフィールドのラベル。 | 'Sort by:' |
| textSubmit | string | 送信ボタンのラベル。 | 'Submit' |
| textThenBy | string | 2 番目以降のフィールドのラベル。 | 'Then by:' |
例
並べ替えフィールドつきのフォームの作成
<?php
require_once 'HTML/QuickForm.php';
// 空のフォームを作成します
$form = new HTML_QuickForm('myForm', 'POST');
// カスタマイズし、ヘッダやテキストフィールド等を追加します
$form->addElement('header', null, 'Search & Sort Form Example');
$form->addElement('text', 'my_search', 'Search for:');
// データグリッドにラジオボタン形式の並べ替え用フィールドを追加します
$options = array('directionStyle' => 'radio');
$datagrid->fill($form, $options, 'HTMLSortForm');
// submit ボタンは fill() では作成されないので、自分で追加する必要があります
$form->addElement('submit', null, 'Submit');
// HTML_QuickForm::display() でフォームを表示します
$form->display();
?>
忘却曲線を使ってこの知識を確実に記憶に残す
