Structures_DataGrid_Column::setFormatter()

Structures_DataGrid_Column::setFormatter()  -- フォーマッタのコールバックを設定する

概要

require_once 'Structures/DataGrid/Column.php';

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

説明

このカラムに適用する書式設定用のコールバックを、引数とともに定義します。

コールバック関数の最初の引数には、次のような配列が渡されます。
array(
   'record' => このレコードの全フィールドの値を含む連想配列,
   'fieldName' => このカラムのフィールド名,
   'columnName' => このカラムのラベル (ヘッダ),
   'orderBy' => このカラムをソートするフィールド名,
   'attribs' => このカラムの属性,
   'currRow' => ゼロから始まる行インデックス,
   'currCol' => ゼロから始まるカラムインデックス,
 );

オプションのパラメータ $arguments を setFormatter() に渡すと、 コールバック関数の 2 番目の引数としてそれが渡されます。

パラメータ

mixed $formatter

PHP の擬似型であるコールバック型 (配列あるいは文字列)。

array $arguments

コールバック関数の 2 番目の引数として渡すパラメータの連想配列。

返り値

失敗した場合に PEAR_Error を返します。

例外・エラー

例外はスローされません。

参照

http://www.php.net/manual/ja/language.pseudo-types.php も参照ください。

注意

この関数は、スタティックにコールする ことはできません。