Structures_DataGrid_Renderer_XML

Structures_DataGrid_Renderer_XML -- XML 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()
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()
fieldAttributestringThe name of the attribute for the field name. null stands for no attributenull
fieldTagstringThe name of the tag for each field inside a row, without brackets. The special value '{field}' is replaced by the field name.'{field}'
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()
labelAttributestringThe name of the attribute for the column label. null stands for no attributenull
numberAlignboolWhether to right-align numeric values.true
outerTagstringThe name of the tag for the datagrid, without brackets'DataGrid'
rowTagstringThe name of the tag for each row, without brackets'Row'
useXMLDeclboolWhether the XML declaration string should be added to the output. The encoding attribute value will get set from the common "encoding" option. If you need to further customize the XML declaration (version, etc..), then please set "useXMLDecl" to false, and add your own declaration string.true