Structures_DataGrid_Column::format()

説明

試行版: このメソッドの挙動は、将来のバージョンで変更される可能性があります。

このメソッドにより、定義済みのフォーマッタを "自動的に" カラムと関連付けることができます。日付や数値などのフォーマットの必要があるカラムに使用します。

現在サポートしている定義済みフォーマッタは次のとおりです。

• dateFromTimestamp: UNIX タイムスタンプを、第二引数で指定した date() 風の書式設定文字列でフォーマットします。

• dateFromMysql : MySQL の DATE、DATETIME あるいは TIMESTAMP 型を、第二引数で指定した date() 風の書式設定文字列でフォーマットします。

• number: 数値をフォーマットします。オプションの第二、第三、第四引数で、 PHP の number_format() 関数と同様の書式指定を行います。

• printf: 第二引数で指定した printf の書式指定文字でフォーマットします。

• printfURL: URL エンコードを行い、 第二引数で指定した printf の書式指定文字でフォーマットします。

パラメータ

例外・エラー

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

例

<?php

// UNIX タイムスタンプをイギリスでの日付に変換します
$column->format('dateFromTimestamp', 'm/d/y');

// MySQL の DATE、DATETIME あるいは TIMESTAMP をフランスの日付に変換します。
$column->format('dateFromMysql', 'd/m/y');

// 数値を、小数点以下 3 桁のカンマなし形式でフォーマットします
$column->format('number', 3, '.', '');

// 数値を小数点以下 3 桁でフォーマットします
$column->format('number', 2);

// printf 風のフォーマットを行います
$column->format('printf', 'ポテトの数: %d');

// HTML のリンクについて、URL エンコードしたうえで printf 風のフォーマットを行います
$column->format('printfURL', '<a href="edit.php?key=%s">Edit</a>'); 

?>

注意

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