API:cakephp-2.0 NumberHelper::currency

cakephp-2.0 > NumberHelper :: currency()

NumberHelper

Classes

A AbstractTransport AclBehavior AclComponent AclInterface AclNode AclShell Aco AcoAction ActionsAuthorize ApcEngine ApiShell App AppController AppController AppHelper AppHelper AppModel AppModel AppShell Aro AuthComponent B BadRequestException BakeShell BakeTask BaseAuthenticate BaseAuthorize BasicAuthenticate BasicAuthentication BehaviorCollection C Cache CacheEngine CacheException CacheHelper CacheSession CakeEmail CakeErrorController CakeException CakeLog CakeLogException CakeLogInterface CakePlugin CakeRequest CakeResponse CakeRoute CakeSchema CakeSession CakeSessionException CakeSessionHandlerInterface CakeSocket ClassRegistry CommandListShell Component ComponentCollection ConfigReaderInterface Configure ConfigureException ConnectionManager ConsoleErrorHandler ConsoleException ConsoleInput ConsoleInputArgument ConsoleInputOption ConsoleInputSubcommand ConsoleOptionParser ConsoleOutput ConsoleShell ContainableBehavior Controller ControllerAuthorize ControllerTask CookieComponent CrudAuthorize D DatabaseSession DataSource DbAcl DbAclSchema DbConfigTask DboSource Debugger DebugTransport DigestAuthenticate DigestAuthentication Dispatcher E EmailComponent ErrorHandler ExceptionRenderer ExtractTask F File FileEngine FileLog FixtureTask Folder ForbiddenException FormAuthenticate FormHelper H Helper HelperCollection HelpFormatter HtmlHelper HttpException HttpResponse HttpSocket I I18n I18nModel i18nSchema I18nShell Inflector IniReader InternalErrorException J JqueryEngineHelper JsBaseEngineHelper JsHelper L L10n M MailTransport MediaView MemcacheEngine MethodNotAllowedException MissingActionException MissingBehaviorException MissingComponentException MissingConnectionException MissingControllerException MissingDatabaseException MissingDatasourceConfigException MissingDatasourceException MissingHelperException MissingLayoutException MissingModelException MissingPluginException MissingShellException MissingShellMethodException MissingTableException MissingTaskException MissingTestLoaderException MissingViewException Model ModelBehavior ModelTask MootoolsEngineHelper Multibyte Mysql N NotFoundException NumberHelper O Object ObjectCollection P PagesController PagesController PaginatorComponent PaginatorHelper Permission PhpReader PluginShortRoute PluginTask Postgres PrivateActionException ProjectTask PrototypeEngineHelper R RedirectRoute RequestHandlerComponent Router RouterException RssHelper S Sanitize Scaffold ScaffoldView SchemaShell Security SecurityComponent SessionComponent SessionHelper SessionsSchema Set Shell ShellDispatcher SmtpTransport SocketException Sqlite Sqlserver String T TaskCollection TemplateTask TestsuiteShell TestTask TextHelper ThemeView TimeHelper TranslateBehavior TreeBehavior U UnauthorizedException UpgradeShell V Validation View ViewTask W WincacheEngine X XcacheEngine Xml XmlException

currency

line:177 at /lib/Cake/View/Helper/NumberHelper.php

Formats a number into a currency format.

Method

(string) public currency ($number, $currency = 'USD', $options = array())

Parameters

Parameter	Type	Comment	Default
$number	float	required
$currency	string	optional Shortcut to default options. Valid values are 'USD', 'EUR', 'GBP', otherwise set at least 'before' and 'after' options.	'USD'
$options	array	optional	array()

Return

string

Comment

Formats a number into a currency format.

### Options

- `before` - The currency symbol to place before whole numbers ie. '$'
- `after` - The currency symbol to place after decimal numbers ie. 'c'. Set to boolean false to
use no decimal symbol. eg. 0.35 => $0.35.
- `zero` - The text to use for zero values, can be a string or a number. ie. 0, 'Free!'
- `places` - Number of decimal places to use. ie. 2
- `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

@param float $number
@param string $currency Shortcut to default options. Valid values are 'USD', 'EUR', 'GBP', otherwise
set at least 'before' and 'after' options.
@param array $options
@return string Number formatted as a currency.
@link http://book.cakephp.org/2.0/en/core-libraries/helpers/number.html#NumberHelper::currency