Skip to content

Commit

Permalink
Update docs for the escape option in CakeNumber::currency()
Browse files Browse the repository at this point in the history
Unfortunately, using actual bytes creates a host of problems for sites
not using UTF-8. Update the documentation to reflect reality, as
changing reality could cause more problems than it solves.

Closes #3351
  • Loading branch information
markstory committed Nov 9, 2012
1 parent 3de72ba commit ec3e85e
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion lib/Cake/Utility/CakeNumber.php
Expand Up @@ -211,7 +211,10 @@ protected static function _numberFormat($number, $places = 0, $decimals = '.', $
* - `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 escaped for html special characters.
* The default value for this option is controlled by the currency settings.
* By default the EUR, and GBP contain HTML encoded symbols. If you require non HTML
* encoded symbols you will need to update the settings with the correct bytes.
*
* @param float $number
* @param string $currency Shortcut to default options. Valid values are
Expand Down

0 comments on commit ec3e85e

Please sign in to comment.