Skip to content

Commit ec3e85e

Browse files
committed
Update docs for the escape option in CakeNumber::currency()
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
1 parent 3de72ba commit ec3e85e

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

lib/Cake/Utility/CakeNumber.php

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -211,7 +211,10 @@ protected static function _numberFormat($number, $places = 0, $decimals = '.', $
211211
* - `decimals` - Decimal separator symbol ie. '.'
212212
* - `negative` - Symbol for negative numbers. If equal to '()',
213213
* the number will be wrapped with ( and )
214-
* - `escape` - Should the output be htmlentity escaped? Defaults to true
214+
* - `escape` - Should the output be escaped for html special characters.
215+
* The default value for this option is controlled by the currency settings.
216+
* By default the EUR, and GBP contain HTML encoded symbols. If you require non HTML
217+
* encoded symbols you will need to update the settings with the correct bytes.
215218
*
216219
* @param float $number
217220
* @param string $currency Shortcut to default options. Valid values are

0 commit comments

Comments
 (0)