このドライバは次の操作モードをサポートしています。
表 58-1このドライバがサポートする操作モード
| モード | サポートしている? |
|---|---|
| コンテナのサポート | no |
| 出力バッファリング | yes |
| ダイレクトレンダリング | yes |
| ストリーミング | yes |
このドライバは、以下のオプションを受け付けます。
表 58-2このドライバのオプション
| オプション | 型 | 説明 | デフォルト値 |
|---|---|---|---|
| buildFooter | bool | フッタを作成するかどうか。 | true |
| buildHeader | bool | ヘッダを作成するかどうか。 | true |
| defaultCellValue | string | 空のセルに表示するデフォルトの値。 | null |
| defaultColumnValues | array | カラムごとに指定するセルのデフォルト値。 array(fieldName => value, ...) 形式の配列となります。 | array() |
| delimiter | string | フィールドの区切り文字。 | ',' |
| enclosure | string | フィールドを囲む文字。 | '"' |
| encoding | string | 内容のエンコーディング。mbstring 拡張モジュールが使用可能な場合、 デフォルト値は mb_internal_encoding() から取得します。 それ以外の場合のデフォルト値は ISO-8859-1 となります。 | 'ISO-8859-1' |
| excludeVars | array | 作成される HTTP クエリから取り除く変数。 | array() |
| extraVars | array | 作成される HTTP クエリに追加される変数。 | array() |
| filename | string | 作成される CSV ファイルのファイル名。false を指定すると、 ファイル名は送信されません。 | false |
| fillWithEmptyRows | bool | すべてのページで行数が同じになるようにするかどうか。 | false |
| hideColumnLinks | array | デフォルトでは、すべてのカラムで並べ替えリンクが有効になります。 このオプションを使用すると、指定したカラムの並べ替えリンクを無効にできます。 array(fieldName, ...) 形式の配列で指定します。 このオプションは、並べ替えをサポートしているドライバでのみ有効です。 | array() |
| 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" 属性に渡されます。 クォートやスラッシュなどの処理は、自分で行ってください。 | '' |
| lineBreak | string | 改行に使用する文字。 | '\n' |
| numberAlign | bool | 数値を右詰めにするかどうか。 | true |
| saveToFile | boolean | 出力をローカルのファイルシステム上に保存するかどうか。 このオプションを true に設定する場合は、'filename' も必ず指定しなければならないことに注意しましょう。 | false |
| useQuotes | mixed | enclosure で指定した文字で値を囲むかどうか。 true: 常に囲む、false: 決して囲まない、'auto': 必要に応じて囲む | 'auto' |
| writeMode | string | 内部的に fopen() をコールする際に使用するモード。 たとえば既存のファイルに追記したい場合などに便利です。 使用可能なモードについては、fopen() のドキュメントを参照ください。 | 'wb' |