From 730ac10ae4d54b7dfb1af211ee804df7d2910eba Mon Sep 17 00:00:00 2001 From: Kyle Robinson Young Date: Fri, 10 Feb 2012 22:17:58 -0800 Subject: [PATCH] Add missing options to NumberHelper docblocks --- lib/Cake/View/Helper/NumberHelper.php | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/lib/Cake/View/Helper/NumberHelper.php b/lib/Cake/View/Helper/NumberHelper.php index 8457133f6fa..3019a6a929c 100644 --- a/lib/Cake/View/Helper/NumberHelper.php +++ b/lib/Cake/View/Helper/NumberHelper.php @@ -59,7 +59,7 @@ class NumberHelper extends AppHelper { */ protected $_currencyDefaults = array( 'wholeSymbol' => '', 'wholePosition' => 'before', 'fractionSymbol' => '', 'fractionPosition' => 'after', - 'zero' => '0', 'places' => 2, 'thousands' => ',', 'decimals' => '.','negative' => '()', 'escape' => true, + 'zero' => '0', 'places' => 2, 'thousands' => ',', 'decimals' => '.', 'negative' => '()', 'escape' => true, ); /** @@ -165,7 +165,11 @@ public function format($number, $options = false) { * - `thousands` - Thousands separator ie. ',' * - `decimals` - Decimal separator symbol ie. '.' * - `negative` - Symbol for negative numbers. If equal to '()', the number will be wrapped with ( and ) - * - `escape` - Should the output be htmlentity escaped? Defaults to true + * - `escape` - Should the output be htmlentity escaped? Defaults to true. + * - `wholeSymbol` String to use for whole numbers ie. ' dollars'. + * - `wholePosition` Either 'before' or 'after' to place the whole symbol. + * - `fractionSymbol` String to use for fraction numbers ie. ' cents'. + * - `fractionPosition` Either 'before' or 'after' to place the fraction symbol. * * @param float $number * @param string $currency Shortcut to default options. Valid values are 'USD', 'EUR', 'GBP', otherwise @@ -238,8 +242,10 @@ public function currency($number, $currency = 'USD', $options = array()) { * * {{{ * array( - * 'before' => '$', 'after' => 'c', 'zero' => 0, 'places' => 2, 'thousands' => ',', - * 'decimals' => '.', 'negative' => '()', 'escape' => true + * 'wholeSymbol' => '', 'wholePosition' => 'before', + * 'fractionSymbol' => '', 'fractionPosition' => 'after', + * 'zero' => '0', 'places' => 2, 'thousands' => ',', + * 'decimals' => '.', 'negative' => '()', 'escape' => true, * ) * }}} *