\App\Library\GeneralFormatAmountForCountry

Summary

Methods

Properties

Constants

__construct()
setAmount()
setDecimalPlaces()
setCurrencyCode()
getCurrencyCode()
getCurrencySymbol()
getFormattedAmount()
getRoundedAmount()
displayFormatAmountForCountry()
getFormattedAmountWithCurrencySymbol()
parseFormattedAmountToFloat()
isWellFormedAmount()
getFormattedQuantity()

No public properties found

No constants found

No protected methods found

No protected properties found

N/A

getCountryCurrency()

$amount
$decSeparator
$thousandsSeparator
$currencyPosition
$decimalPlaces
$currencyCode
$currencySymbol

N/A

final

File: app/Library/General/FormatAmountForCountry.php
Package: Library\General
Class hierarchy: \App\Library\General\FormatAmountForCountry
Uses

Tags

author

Damian Pawlonka damian.pawlonka@unitedprint.com

date

2019-06-18 14:04

Class FormatAmountForCountry

Properties

$amount

$amount
Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
 : 
Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
float

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50

Type

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50 float

$decSeparator

$decSeparator
Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
 : 
Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
string

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50

Type

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50 string

$thousandsSeparator

$thousandsSeparator
Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
 : 
Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
string

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50

Type

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50 string

$currencyPosition

$currencyPosition
Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
 : 
Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
string

'ahead' means currency symbol must be places before amount

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50

Type

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50 string

$decimalPlaces

$decimalPlaces
Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
 : 
Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
int

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50

Type

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50 int

$currencyCode

$currencyCode
Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
 : 
Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
string

should be accessed through getCurrencyCode()

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50

Type

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50 string

$currencySymbol

$currencySymbol
Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
 : 
Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
string

should be accessed through getCurrencySymbol()

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50

Type

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50 string

Methods

__construct()

__construct(
Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
float  $amount = 0.0) 
Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
: mixed

FormatAmountForCountry constructor.

Parameters

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50 float

$amount

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50

Returns

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50 mixed —

setAmount()

setAmount(
Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
float  $amount) 
Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
: \App\Library\General\FormatAmountForCountry

Parameters

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50 float

$amount

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50

Returns

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50 \App\Library\General\FormatAmountForCountry —

Inherited from: \App\Library\General\FormatAmountForCountry
Uses

Tags

author	Damian Pawlonka damian.pawlonka@unitedprint.com
date	2019-06-19 10:45

setDecimalPlaces()

setDecimalPlaces(
Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
int  $decimalPlaces) 
Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
: $this

set decimal places

Parameters

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50 int

$decimalPlaces

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50

Returns

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50 $this —

Inherited from: \App\Library\General\FormatAmountForCountry
Uses

Tags

author	Damian Pawlonka damian.pawlonka@unitedprint.com
date	2020.08.11 15:52

setCurrencyCode()

setCurrencyCode(
Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
string  $currencyCode) 
Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
: $this

set currency code

Parameters

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50 string

$currencyCode

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50

Returns

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50 $this —

Inherited from: \App\Library\General\FormatAmountForCountry
Uses

Tags

author	Damian Pawlonka damian.pawlonka@unitedprint.com
date	2020.08.11 16:02

getCurrencyCode()

getCurrencyCode(
Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
string|null  $countryCode = null) 
Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
: string

Parameters

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50 string|null

$countryCode

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50

Returns

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50 string —

getCurrencySymbol()

getCurrencySymbol() 
Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
: string

return currently used currency symbol

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50

Returns

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50 string —

Inherited from: \App\Library\General\FormatAmountForCountry
Uses

Tags

author	Damian Pawlonka damian.pawlonka@unitedprint.com
date	2019-06-18 14:05

getFormattedAmount()

getFormattedAmount() 
Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
: string

return formatted amount for country

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50

Returns

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50 string —

Inherited from: \App\Library\General\FormatAmountForCountry
Uses

Tags

author	Damian Pawlonka damian.pawlonka@unitedprint.com
date	2019-06-18 14:18

getRoundedAmount()

getRoundedAmount() 
Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
: float

return amount rounded to country-specific decimal places

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50

Returns

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50 float —

displayFormatAmountForCountry()

displayFormatAmountForCountry() 
Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
: string

get display for format of amount respect for country-language settings ###,## || ###.## || ###

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50

Returns

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50 string —

Inherited from: \App\Library\General\FormatAmountForCountry
Uses

Tags

author	Oxana Dreßler oxana.dressler@unitedprint.com
date	2020-02-17

getFormattedAmountWithCurrencySymbol()

getFormattedAmountWithCurrencySymbol() 
Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
: string

return formatted amount with currency symbol for country

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50

Returns

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50 string —

Inherited from: \App\Library\General\FormatAmountForCountry
Uses

Tags

author	Damian Pawlonka damian.pawlonka@unitedprint.com
date	2019-06-18 14:19

parseFormattedAmountToFloat()

parseFormattedAmountToFloat(
Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
string  $formattedAmount) 
Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
: float|null

convert amount from country-specific formatted string to float returns null if given amount string is not well-formed

Parameters

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50 string

$formattedAmount

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50

Returns

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50 float|null —

Inherited from: \App\Library\General\FormatAmountForCountry
Uses

Tags

author	Oxana Dreßler oxana.dressler@unitedprint.com
date	2020-02-17

isWellFormedAmount()

isWellFormedAmount(
Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
string  $formattedAmount) 
Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
: bool

return true if given string is well-formed amount formatted according to current country-language rules

Parameters

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50 string

$formattedAmount

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50

Returns

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50 bool —

getFormattedQuantity()

getFormattedQuantity() 
Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
: string

return formatted number without decimal places for country

@return string

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50

Returns

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50 string —

Inherited from: \App\Library\General\FormatAmountForCountry
Uses

Tags

author	Chathuri Udeshika Imbulanage Dona chathuri.dona@unitedprint.com

getCountryCurrency()

getCountryCurrency(
Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
string|null  $countryCode = null) 
Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
: \App\Models\CountryCurrency

Parameters

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50 string|null

$countryCode

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50

Returns

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50 \App\Models\CountryCurrency —