cakephp-1.3 > NumberHelper :: addFormat()
NumberHelper
A
AclBase
AclBehavior
AclComponent
AclNode
AclShell
Aco
AcoAction
AjaxHelper
ApcEngine
ApiShell
App
AppController
AppController
AppHelper
AppHelper
AppModel
AppModel
Aro
AuthComponent
B
BakeShell
BakeTask
BehaviorCollection
C
Cache
CacheEngine
CacheHelper
CakeErrorController
CakeLog
CakeRoute
CakeSchema
CakeSession
CakeSocket
ClassRegistry
Component
Configure
ConnectionManager
ConsoleShell
ContainableBehavior
Controller
ControllerTask
CookieComponent
D
DataSource
DbAcl
DbAclSchema
DbConfigTask
DboMssql
DboMysql
DboMysqlBase
DboMysqli
DboOracle
DboPostgres
DboSource
DboSqlite
Debugger
Dispatcher
E
EmailComponent
ErrorHandler
ErrorHandler
ExtractTask
F
File
FileEngine
FileLog
FixtureTask
Folder
FormHelper
H
Helper
HtmlHelper
HttpSocket
I
I18n
I18nModel
i18nSchema
I18nShell
Inflector
IniAcl
J
JavascriptHelper
JqueryEngineHelper
JsBaseEngineHelper
JsHelper
L
L10n
M
MagicDb
MagicFileResource
MediaView
MemcacheEngine
Model
ModelBehavior
ModelTask
MootoolsEngineHelper
Multibyte
N
NumberHelper
O
Object
Overloadable
Overloadable
Overloadable2
Overloadable2
P
PagesController
PagesController
PaginatorHelper
Permission
PluginShortRoute
PluginTask
ProjectTask
PrototypeEngineHelper
R
RequestHandlerComponent
Router
RssHelper
S
Sanitize
Scaffold
ScaffoldView
SchemaShell
Security
SecurityComponent
SessionComponent
SessionHelper
SessionsSchema
Set
Shell
ShellDispatcher
String
T
TemplateTask
TestSuiteShell
TestTask
TextHelper
ThemeView
TimeHelper
TranslateBehavior
TreeBehavior
V
Validation
View
ViewTask
X
XcacheEngine
Xml
XmlElement
XmlHelper
XmlManager
XmlNode
XmlTextNode
addFormat
Add a currency format to the Number helper. Makes reusing
currency formats easier.
Method
(void)
addFormat
($formatName, $options)
Parameters
Parameter | Type | Comment | Default |
---|---|---|---|
$formatName | string | required The format name to be used in the future. | |
$options | array | required The array of options for this format. |
Return
voidComment
Add a currency format to the Number helper. Makes reusing
currency formats easier.
{{{ $number->addFormat('NOK', array('before' => 'Kr. ')); }}}
You can now use `NOK` as a shortform when formatting currency amounts.
{{{ $number->currency($value, 'NOK'); }}}
Added formats are merged with the following defaults.
{{{
array(
'before' => '$', 'after' => 'c', 'zero' => 0, 'places' => 2, 'thousands' => ',',
'decimals' => '.', 'negative' => '()', 'escape' => true
)
}}}
@param string $formatName The format name to be used in the future.
@param array $options The array of options for this format.
@return void
@see NumberHelper::currency()
@access public
currency formats easier.
{{{ $number->addFormat('NOK', array('before' => 'Kr. ')); }}}
You can now use `NOK` as a shortform when formatting currency amounts.
{{{ $number->currency($value, 'NOK'); }}}
Added formats are merged with the following defaults.
{{{
array(
'before' => '$', 'after' => 'c', 'zero' => 0, 'places' => 2, 'thousands' => ',',
'decimals' => '.', 'negative' => '()', 'escape' => true
)
}}}
@param string $formatName The format name to be used in the future.
@param array $options The array of options for this format.
@return void
@see NumberHelper::currency()
@access public