LocaleInfoBOL class - Documentation for SproutCMS

Info Page:

Page options:

class LocaleInfoBOL

Locale info for Bolivia; see LocaleInfo

File: /sprout/Helpers/Locales/LocaleInfoBOL.php
Namespace: Sprout\Helpers\Locales
Extends: LocaleInfo

Variables

Name	Visibility	Description
`$auto`	(static)
`$currency_decimal`
`$currency_name`
`$currency_symbol`
`$decimal_seperator`
`$group_seperator`
`$line1`
`$line2`
`$longdate`
`$postcode_name`
`$shortdate`
`$state_list`
`$state_name`
`$time`
`$town_name`

Functions

Name	Visibility	Description
auto	public (static)	Automatically chooses a locale and returns it
get	public (static)	Returns the LocaleInfo class for the specified country code.
getCurrencyName	public	The name of the currency, e.g. 'Dollar' for $
getParameters	public	Return the raw parameters of this locale
getStateList	public	Gets a list of states
getStateName	public	Get the name of a given state by looking it up in the states list
longdate	public	Formats dates in a long format
moneyFormat	public	Formats currency values, similar to the interal number_format function
nonNumericStates	public	Organises the state list so that it doesn't have numeric keys.
numberFormat	public	Formats numbers, like the interal number_format function
outputAddressField	public	Generates a single address field for the current locale
outputAddressFields	public	Generates the address fields for the current locale
outputAddressText	public	Returns a string which is a formatted version of the address specified using the provided data.
shortdate	public	Formats dates in a short format
stateValues	public	Extracts only the enterable values from the state list
time	public	Formats times
validateAddress	public	Validate address fields

public auto (from LocaleInfo)

LocaleInfo LocaleInfo::auto ( );

Automatically chooses a locale and returns it

public get (from LocaleInfo)

LocaleInfo LocaleInfo::get ( [ string $code ] );

Returns the LocaleInfo class for the specified country code.
If no LocaleInfo can be found, a generic version is used.

public getCurrencyName (from LocaleInfo)

string $LocaleInfo->getCurrencyName ( );

The name of the currency, e.g. 'Dollar' for $

public getParameters (from LocaleInfo)

unknown $LocaleInfo->getParameters ( );

Return the raw parameters of this locale

public getStateList (from LocaleInfo)

array $LocaleInfo->getStateList ( );

Gets a list of states

public getStateName (from LocaleInfo)

null|string $LocaleInfo->getStateName ( string $val );

Get the name of a given state by looking it up in the states list

public longdate (from LocaleInfo)

string $LocaleInfo->longdate ( int $timestamp );

Formats dates in a long format

public moneyFormat (from LocaleInfo)

string $LocaleInfo->moneyFormat ( int|float $number [, int $precision ] );

Formats currency values, similar to the interal number_format function

public nonNumericStates (from LocaleInfo)

array $LocaleInfo->nonNumericStates ( );

Organises the state list so that it doesn't have numeric keys.

The state names become the form field values if state list is a numeric array.
This makes it easy to configure a new locate with states/provinces/etc which don't have standard abbreviations.

E.g. ['State 1', 'State 2'] would become: ['State 1' => 'State 1', 'State 2' => 'State 2']

public numberFormat (from LocaleInfo)

string $LocaleInfo->numberFormat ( int|float $number [, int $precision ] );

Formats numbers, like the interal number_format function

public outputAddressField (from LocaleInfo)

string $LocaleInfo->outputAddressField ( string $field [, string $prefix [, bool $required ]] );

Generates a single address field for the current locale

public outputAddressFields (from LocaleInfo)

string $LocaleInfo->outputAddressFields ( [ string $prefix [, bool $required ]] );

Generates the address fields for the current locale

public outputAddressText (from LocaleInfo)

string $LocaleInfo->outputAddressText ( array|object $data );

Returns a string which is a formatted version of the address specified using the provided data.
The string contains newlines which will need converting to BRs for HTML output

public shortdate (from LocaleInfo)

string $LocaleInfo->shortdate ( int $timestamp );

Formats dates in a short format

public stateValues (from LocaleInfo)

array $LocaleInfo->stateValues ( );

Extracts only the enterable values from the state list

This should be used for validation.

public time (from LocaleInfo)

string $LocaleInfo->time ( int $timestamp );

Formats times

public validateAddress (from LocaleInfo)

void $LocaleInfo->validateAddress ( Validator $valid [, bool $required ] );

Validate address fields

SproutCMS

Search documentation