このドライバは次の操作モードをサポートしています。
表 62-1このドライバがサポートする操作モード
| モード | サポートしている? |
|---|---|
| コンテナのサポート | no |
| 出力バッファリング | yes |
| ダイレクトレンダリング | yes |
| ストリーミング | yes |
| オブジェクトの永続化 | no |
このドライバは、以下のオプションを受け付けます。
表 62-2このドライバのオプション
| オプション | 型 | 説明 | デフォルト値 |
|---|---|---|---|
| buildFooter | bool | フッタを作成するかどうか。 | true |
| buildHeader | bool | ヘッダを作成するかどうか。 | true |
| columnAttributes | array | カラムのセルの属性。 array(fieldName => array(attribute => value, ...) ...) 形式の配列となります。 このオプションは、XML/HTML ベースのドライバでのみ使用します。 | array() |
| defaultCellValue | string | 空のセルに表示するデフォルトの値。 | null |
| defaultColumnValues | array | カラムごとに指定するセルのデフォルト値。 array(fieldName => value, ...) 形式の配列となります。 | array() |
| encoding | string | 内容のエンコーディング。mbstring 拡張モジュールが使用可能な場合、 デフォルト値は mb_internal_encoding() から取得します。 それ以外の場合のデフォルト値は ISO-8859-1 となります。 | 'ISO-8859-1' |
| excludeVars | array | 作成される HTTP クエリから取り除く変数。 | array() |
| extraVars | array | 作成される HTTP クエリに追加される変数。 | array() |
| fieldAttribute | string | フィールド名に使用する属性の名前。null は属性がないことを表します。 | null |
| fieldTag | string | 行の中の各フィールドのタグの名前を括弧なしで指定します。 特別な値として '{field}' はフィールド名で置き換えられます。 | '{field}' |
| filename | string | 生成された XML ファイルのファイル名。 false を指定すると、ファイル名は送信されません。 | false |
| fillWithEmptyRows | bool | すべてのページで行数が同じになるようにするかどうか。 | false |
| hideColumnLinks | array | デフォルトでは、すべてのカラムで並べ替えリンクが有効になります。 このオプションを使用すると、指定したカラムの並べ替えリンクを無効にできます。 array(fieldName, ...) 形式の配列で指定します。 このオプションは、並べ替えをサポートしているドライバでのみ有効です。 | array() |
| labelAttribute | string | カラムのラベルに使用する属性の名前。null は属性がないことを表します。 | null |
| numberAlign | bool | 数値を右詰めにするかどうか。 | true |
| outerTag | string | データグリッドを表すタグの名前を括弧なしで指定します。 | 'DataGrid' |
| rowTag | string | 各行を表すタグの名前を括弧なしで指定します。 | 'Row' |
| saveToFile | boolean | 出力をローカルファイルシステムに保存するかどうか。 このオプションを true にする場合は、必ずオプション 'filename' を指定するようにしなければなりません。 | false |
| useXMLDecl | bool | XML 宣言を出力に追加するかどうか。encoding 属性の値は "encoding" オプションから取得して設定します。 XML 宣言をさらに変更したい (version など) 場合は "useXMLDecl" を false とし、独自の宣言文字列を追加します。 | true |
| writeMode | string | 内部的に fopen() をコールする際に使用するモード。 たとえば既存のファイルに追記したい場合などに便利です。 使用可能なモードについては、fopen() のドキュメントを参照ください。 | 'wb' |