Skip to content
Permalink
Browse files

Add missing options to NumberHelper docblocks

  • Loading branch information...
shama committed Feb 11, 2012
1 parent 83e8d43 commit 730ac10ae4d54b7dfb1af211ee804df7d2910eba
Showing with 10 additions and 4 deletions.
  1. +10 −4 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,
* )
* }}}
*

0 comments on commit 730ac10

Please sign in to comment.
You can’t perform that action at this time.