Structures_DataGrid_Column::setFormatter

Structures_DataGrid_Column::setFormatter() – Set Formatter Callback

Synopsis

require_once 'Structures/DataGrid/Column.php';

mixed Structures_DataGrid_Column::setFormatter ( mixed $formatter , array $arguments = array() )

Description

Define a formatting callback function with optional arguments for this column.

The callback function receives the following array as its first argument:

<?php
array(
   
'record' => associative array of all fields values for this record,
   
'fieldName' => the field name of this column,
   
'columnName' => the label (headerof this column,
   
'orderBy' => the field name to sort this column by,
   
'attribs' => this column's attributes,
   '
currRow' => zero-based row index,
   '
currCol' => zero-based column index,
 );
?>

If you pass the optional $arguments parameter to setFormatter(), the callback function will receive it as its second argument.

Parameter

mixed $formatter

Callback PHP pseudo-type (Array or String)

array $arguments

Associative array of parameters passed to as second argument to the callback function

Return value

returns PEAR_Error on failure

Throws

throws no exceptions thrown

Note

This function can not be called statically.

Set name of the field for the column to be mapped to (Previous) Set column label (Next)
Last updated: Fri, 29 Aug 2014 — Download Documentation
Do you think that something on this page is wrong? Please file a bug report or add a note.
View this page in:

User Notes:

There are no user contributed notes for this page.