Class: Structures_DataGrid_Renderer_XLS

Structures_DataGrid_Renderer
   |
   --Structures_DataGrid_Renderer_XLS

[line 151]
Excel Spreadsheet Rendering Driver

SUPPORTED OPTIONS:

• headerFormat: (mixed) The format for header cells (either 0 [= "no format"] or a Spreadsheet_Excel_Writer_Format object) Please see the NOTE ABOUT FORMATTING below.
• bodyFormat: (mixed) The format for body cells (either 0 [= "no format"] or a Spreadsheet_Excel_Writer_Format object) Please see the NOTE ABOUT FORMATTING below.
• filename: (string) The filename of the spreadsheet
• sendToBrowser: (bool) Should the spreadsheet be send to the browser? (true = send to browser, false = write to a file)
• tempDir: (string) A temporary directory to be used by Spreadsheet_Excel_Writer (cp. "General Notes" section).
• version: (int) If you don't pass a worksheet object to this renderer, you can set the BIFF version with this option. The only accepted value by Spreadsheet_Excel_Writer is 8 (for usage of the BIFF8 format). All other values will lead to the older format (which is needed if you get errors in Excel, e.g. about a broken file).
• worksheet: (object) Optional reference to a Spreadsheet_Excel_Writer_Worksheet object. You can leave this to null except if your workbook contains several worksheets and you want to fill a specific one.
• startCol: (int) The Worksheet column number to start rendering at
• startRow: (int) The Worksheet row number to start rendering at
• border: (int) Border drawn around the whole datagrid: 0 => none, 1 => thin, 2 => thick (NOT IMPLEMENTED YET)
• headerBorder: (int) Border between the header and body: 0 => none, 1 => thin, 2 => thick (NOT IMPLEMENTED YET)
• columnAttributes: (-) IGNORED
• onMove: (-) IGNORED
• onMoveData: (-) IGNORED

SUPPORTED OPERATION MODES:

• Container Support: yes
• Output Buffering: no
• Direct Rendering: not really, see below
• Streaming: no
• Object Preserving: no

GENERAL NOTES:

This driver does not support the flatten() method. You can not retrieve its output with DataGrid::getOutput(). You can either render it directly to the browser or save it to a file. See the "sendToBrowser" and "filename" options.

This driver has container support. You can use Structures_DataGrid::fill() with it; that's even recommended.

If PHP's safe_mode is enabled, Spreadsheet_Excel_Writer sometimes fails to generate the Excel file. You can avoid this problem by setting the 'tempDir' option to a (temporary) directory that is writable by PHP.

NOTE ABOUT FORMATTING:

You can specify some formatting with the 'headerFormat' and 'bodyFormat' options, or with setBodyFormat() and setHeaderFormat().

But beware of the following from the Spreadsheet_Excel_Writer manual: "Formats can't be created directly by a new call. You have to create a format using the addFormat() method from a Workbook, which associates your Format with this Workbook (you can't use the Format with another Workbook)."

What this means is that if you want to pass a format to this driver you have to "derive" the Format object out of the workbook used in the driver.

The easiest way to do this is:

 // Create a workbook

 $workbook = new Spreadsheet_Excel_Writer();
 
 // Specify that spreadsheet must be sent the browser
 $workbook->send('test.xls');
 
 // Create your format
 $format_bold =& $workbook->addFormat();
 $format_bold->setBold();
 
 // Fill the workbook, passing the format as an option
 $options = array('headerFormat' => &$format_bold);
 $datagrid->fill($workbook, $options);

Structures_DataGrid_Renderer_XLS (Constructor)   [line 181]

---

buildHeader   [line 348]

---

buildRow   [line 366]

---

getContainer   [line 220]

---

getSpreadsheet   [line 337]

---

init   [line 231]

---

render   [line 382]

---

setBodyFormat   [line 327]

---

setContainer   [line 208]

---

setCustomWriter   [line 300]

---

setFilename   [line 278]

---

setHeaderFormat   [line 314]

---