このドライバは次の操作モードをサポートしています。
表 58-1このドライバがサポートする操作モード
| モード | サポートしている? |
|---|---|
| コンテナのサポート | yes |
| 出力バッファリング | yes |
| ダイレクトレンダリング | no |
| ストリーミング | no |
このドライバは、以下のオプションを受け付けます。
表 58-2このドライバのオプション
| オプション | 型 | 説明 | デフォルト値 |
|---|---|---|---|
| buildFooter | bool | フッタを作成するかどうか。 | true |
| buildHeader | bool | ヘッダを作成するかどうか。 | true |
| columnAttributes | array | カラムのセルの属性。 array(fieldName => array(attribute => value, ...) ...) 形式の配列となります。 このオプションは、XML/HTML ベースのドライバでのみ使用します。 | array() |
| convertEntities | bool | html エンティティを変換するかどうか。 htmlspecialchars() をコールします。 | true |
| defaultCellValue | string | 空のセルに表示するデフォルトの値。 | null |
| defaultColumnValues | array | カラムごとに指定するセルのデフォルト値。 array(fieldName => value, ...) 形式の配列となります。 | array() |
| emptyRowAttributes | array | 空の行についての属性を含む連想配列。 | array() |
| encoding | string | 内容のエンコーディング。mbstring 拡張モジュールが使用可能な場合、 デフォルト値は mb_internal_encoding() から取得します。 それ以外の場合のデフォルト値は ISO-8859-1 となります。 | 'ISO-8859-1' |
| evenRowAttributes | array | 偶数行の属性を含む連想配列。 | array() |
| excludeVars | array | 作成される HTTP クエリから取り除く変数。 | array() |
| extraVars | array | 作成される HTTP クエリに追加される変数。 | array() |
| fillWithEmptyRows | bool | すべてのページで行数が同じになるようにするかどうか。 | false |
| form | object | HTML_QuickForm オブジェクトのインスタンス。 | null |
| formRenderer | object | HTML_QuickForm_Renderer_QuickHtml オブジェクトのインスタンス。 | null |
| headerAttributes | array | 見出し行の属性。array(attribute => value, ...) 形式の配列となります。 | array() |
| hideColumnLinks | array | デフォルトでは、すべてのカラムで並べ替えリンクが有効になります。 このオプションを使用すると、指定したカラムの並べ替えリンクを無効にできます。 array(fieldName, ...) 形式の配列で指定します。 このオプションは、並べ替えをサポートしているドライバでのみ有効です。 | array() |
| inputName | string | チェックボックスの HTML_QuickForm 要素名。 | 'checkedItems' |
| jsHandler | string | onClick/onSubmit イベント発生時にコールする Javascript 関数の名前。 この関数は、オブジェクトを引数として受け取ります。 このオブジェクトの形式は { page: <page>, sort: [{field: <field>, direction: <direction>}, ...], data: <user_data> } のようになります。このオプションを指定しても、 href 属性は削除されないことに注意しましょう。 href を無効にしたい場合 (AJAX など……) は、ハンドラ関数内で false を返すようにしなければなりません。 | null |
| jsHandlerData | string | jsHandler に渡す引数のオブジェクトの、"data" に渡すデータ。JSON 形式のシリアル化は行わず、 そのままの形で "data" 属性に渡されます。 クォートやスラッシュなどの処理は、自分で行ってください。 | '' |
| numberAlign | bool | 数値を右詰めにするかどうか。 | true |
| oddRowAttributes | array | 奇数行の属性を含む連想配列。 | array() |
| primaryKey | string | 主キーの名前。この値をチェックボックスで使用します。 | 'id' |
| selfPath | string | 並べ替えおよびページ処理に使用するパス。 | $_SERVER['PHP_SELF'] |
| sortIconASC | string | 現在の並び順が昇順であることを示すアイコン。テキストか、 あるいは画像を表す HTML となります。 | '' |
| sortIconDESC | string | 現在の並び順が降順であることを示すアイコン。テキストか、 あるいは画像を表す HTML となります。 | '' |
| sortingResetsPaging | bool | 並べ替えの HTTP クエリで、ページをリセットするかどうか。 | true |
このドライバは、テーブルの各行の最初のカラムにチェックボックスを配置します。 デフォルトでは、オプション 'inputName' で指定した名前の新しいカラムがチェックボックス用に作成されます。 このカラムをカスタマイズしたい場合は、次の例で示すようにカラムを自分で作成します。
例 58-1基本的な使用例
|