Constructor BrowserColumn (line 100)

BrowserColumn constructor. Only the first parameter is mandatory.

• string $hook:

  The name of a global function which will preprocess the column value

  The hook function should be defined as follows: function hookfunction( $column_value, $column_name, $database_row ) { ... return $value; }

• string $field: field The name of the column in the SQL result.
• string $header: header The text to appear in the column header on output (@see BrowserColumn::RenderHeader()). If this is not supplied then a default of the field name will be used.
• string $align: align left|center|right - text alignment. Defaults to 'left'.
• string $format: format A format (a-la-printf) to render data values within. (@see BrowserColumn::RenderValue()). If this is not supplied then the default will ensure the column value is displayed as-is.
• string $sql: sql Some SQL which will return the desired value to be presented as column 'field' of the result. If this is blank then the column is assumed to be a real data column.
• string $class: class Additional classes to apply to the column header and column value cells.
• string $datatype: datatype This will allow 'date' or 'timestamp' to preformat the field correctly before using it in replacements or display. Other types may be added in future.

RenderHeader (line 134)

RenderHeader

Renders the column header cell for this column. This will be rendered as a <th>...</th> with class and alignment applied to it. Browser column headers are clickable, and the ordering will also display an 'up' or 'down' triangle with the column header that the SQL is sorted on at the moment.

• string $order_field: order_field The name of the field currently being sorted on.
• string $order_direction: order_direction Whether the sort is Ascending or Descending.
• int $browser_array_key: browser_array_key Used this to help handle separate ordering of multiple browsers on the same page.