Numbers_Words
[ class tree: Numbers_Words ] [ index: Numbers_Words ] [ all elements ]

Class: Numbers_Words_en_US

Source Location: /Numbers_Words-0.10.1/Words/lang.en_US.php

Class Overview

Numbers_Words
   |
   --Numbers_Words_en_US

Class for translating numbers into American English.


Author(s):

  • Piotr Klaban

Variables

Methods


Inherited Variables

Inherited Methods

Class: Numbers_Words

Numbers_Words::raiseError()
Trigger a PEAR error
Numbers_Words::toCurrency()
Converts a currency value to word representation (1.02 => one dollar two cents) If the number has not any fraction part, the "cents" number is omitted.
Numbers_Words::toWords()
Converts a number to its word representation

Class Details

[line 43]
Class for translating numbers into American English.
  • Author: Piotr Klaban


[ Top ]


Class Variables

$def_currency =  'USD'

[line 272]

The default currency name
  • Access: public

Type:   string


[ Top ]

$lang =  'American English'

[line 60]

Language name in English
  • Access: public

Type:   string


[ Top ]

$lang_native =  'American English'

[line 67]

Native language name
  • Access: public

Type:   string


[ Top ]

$locale =  'en_US'

[line 53]

Locale name
  • Access: public

Type:   string


[ Top ]



Method Detail

toCurrencyWords   [line 471]

string toCurrencyWords( integer $int_curr, integer $decimal, [integer $fraction = false])

Converts a currency value to its word representation (with monetary units) in English language
  • Return: The corresponding word representation for the currency
  • Author: Piotr Klaban <makler@man.torun.pl>
  • Since: Numbers_Words 0.4
  • Access: public

Parameters:

integer   $int_curr   —  An international currency symbol as defined by the ISO 4217 standard (three characters)
integer   $decimal   —  A money total amount without fraction part (e.g. amount of dollars)
integer   $fraction   —  Fractional part of the money amount (e.g. amount of cents) Optional. Defaults to false.

[ Top ]

toWords   [line 294]

string toWords( integer $num, [integer $power = 0], [integer $powsuffix = ''])

Converts a number to its word representation in American English language
  • Return: The corresponding word representation
  • Author: Piotr Klaban <makler@man.torun.pl>
  • Since: PHP 4.2.3
  • Access: public

Overrides Numbers_Words::toWords() (Converts a number to its word representation)

Parameters:

integer   $num   —  An integer between -infinity and infinity inclusive :) that need to be converted to words
integer   $power   —  The power of ten for the rest of the number to the right. Optional, defaults to 0.
integer   $powsuffix   —  The power name to be added to the end of the return string. Used internally. Optional, defaults to ''.

[ Top ]


Documentation generated on Mon, 11 Mar 2019 13:56:07 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.