Structures_DataGrid_Renderer_CSV

Structures_DataGrid_Renderer_CSV -- CSV Rendering Driver

Options

This driver accepts the following options:

Table 55-1. Options for this driver

OptionTypeDescriptionDefault Value
buildFooterboolWhether to build the footer.true
buildHeaderboolWhether to build the header.true
defaultCellValuestringWhat value to put by default into empty cells.null
defaultColumnValuesarrayPer-column default cell value. This is an array of the form: array(fieldName => value, ...).array()
delimiterstringField delimiter','
enclosurestringField enclosurea double quotation mark: "
encodingstringThe content encoding. If the mbstring extension is present the default value is set from mb_internal_encoding(), otherwise it is ISO-8859-1. 
excludeVarsarrayVariables to be removed from the generated HTTP queries.array()
extraVarsarrayVariables to be added to the generated HTTP queries.array()
filenamestringFilename of the generated CSV file; boolean false means that no filename will be sentfalse
fillWithEmptyRowsboolEnsures that all pages have the same number of rows.false
hideColumnLinksarrayBy default sorting links are enabled on all columns. With this option it is possible to disable sorting links on specific columns. This is an array of the form: array(fieldName, ...). This option only affects drivers that support sorting.array()
lineBreakstringThe character(s) to use for line breaks'\n'
numberAlignboolWhether to right-align numeric values.true
useQuotesmixedWhether or not to encapuslate the values with the enclosure value. true: always, false: never, "auto": when needed"auto"