I18n class - Documentation for SproutCMS

Info Page:

Page options:

class I18n

Formats data according to local conventions.
This is an easier-to-use helper version of the LocaleInfo set of classes.

To set the locale, set the config param:
   sprout.locale

The default is AUS - Australia

File: /sprout/Helpers/I18n.php
Namespace: Sprout\Helpers

Variables

Name	Visibility	Description
`$locale`	(static)

Functions

Name	Visibility	Description
addressFields	public (static)	Returns HTML for address fields
init	public (static)	Set the locale to the default as per the configuration
initJavaScript	public (static)	Return JavaScript code which initialises the I18n javascript library with the locale parameters
longdate	public (static)	Return a formatted date in a short format (e.g. Mon 3rd Jan 2003)
money	public (static)	Return a formatted currency value
number	public (static)	Return a formatted number
setLocale	public (static)	Set the locale to something other than the default
shortdate	public (static)	Return a formatted date in a short format (e.g. 3/1/2003)
time	public (static)	Return a formatted dtime (e.g. 5:30pm)

public addressFields

void I18n::addressFields ( bool $required );

Returns HTML for address fields

public init

void I18n::init ( );

Set the locale to the default as per the configuration

public initJavaScript

string I18n::initJavaScript ( );

Return JavaScript code which initialises the I18n javascript library with the locale parameters

public longdate

unknown I18n::longdate ( [ int $timestamp ] );

Return a formatted date in a short format (e.g. Mon 3rd Jan 2003)

public money

unknown I18n::money ( float $number [, mixed $precision ] );

Return a formatted currency value

public number

unknown I18n::number ( float $number , int $precision );

Return a formatted number

public setLocale

void I18n::setLocale ( string $country );

Set the locale to something other than the default
Useful for multi-currency shopping carts, for example.

public shortdate

unknown I18n::shortdate ( [ int $timestamp ] );

Return a formatted date in a short format (e.g. 3/1/2003)

public time

unknown I18n::time ( [ int $timestamp ] );

Return a formatted dtime (e.g. 5:30pm)

SproutCMS

Search documentation