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

Class: Numbers_Words

Source Location: /Numbers_Words-0.15.0/Words.php

Class Overview


The Numbers_Words class provides method to convert arabic numerals to words.


Author(s):

Methods


Child classes:

Numbers_Words_bg
Class for translating numbers into Bulgarian.
Numbers_Words_cs
Class for translating numbers into Czech.
Numbers_Words_de
Class for translating numbers into German.
Numbers_Words_dk
Class for translating numbers into Danish.
Numbers_Words_en_100
Class for translating numbers into Donald Knuth system, in English language.
Numbers_Words_en_GB
Class for translating numbers into British English.
Numbers_Words_en_US
Class for translating numbers into American English.
Numbers_Words_es
Class for translating numbers into Spanish (Castellano).
Numbers_Words_es_AR
Class for translating numbers into Argentinian Spanish.
Numbers_Words_et
Class for translating numbers into Estonian.
Numbers_Words_fr
Class for translating numbers into French.
Numbers_Words_fr_BE
Class for translating numbers into French (Belgium).
Numbers_Words_he
Class for translating numbers into Hebrew.
Numbers_Words_hu_HU
Class for translating numbers into Hungarian.
Numbers_Words_id
Class for translating numbers into Indonesian.
Numbers_Words_it_IT
Class for translating numbers into Italian.
Numbers_Words_lt
Class for translating numbers into Lithuanian.
Numbers_Words_nl
Class for translating numbers into Dutch.
Numbers_Words_pl
Class for translating numbers into Polish.
Numbers_Words_pt_BR
Class for translating numbers into Brazilian Portuguese.
Numbers_Words_ru
Class for translating numbers into Russian.
Numbers_Words_sv
Class for translating numbers into Swedish.

Inherited Variables

Inherited Methods


Class Details

[line 41]
The Numbers_Words class provides method to convert arabic numerals to words.


[ Top ]


Method Detail

getLocales   [line 149]

array getLocales( [mixed $locale = null], string $int_curr, mixed 1)

Lists available locales for Numbers_Words
  • Return: The available locales (optionaly only the requested ones)
  • Static: This method can be called statically
  • Access: public
  • Author: Bertrand Gugger, bertrand at toggg dot com
  • Author: Piotr Klaban <mailto:makler@man.torun.pl>

Parameters:

string   $int_curr     International currency symbol
mixed   1     string/array of strings $locale Optional searched language name abbreviation. Default: all available locales.

[ Top ]

raiseError   [line 179]

void raiseError( string $msg)

Trigger a PEAR error

To improve performances, the PEAR.php file is included dynamically.


Parameters:

string   $msg     error message

[ Top ]

toCurrency   [line 100]

string toCurrency( float $num, [string $locale = 'en_US'], [string $int_curr = ''])

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.

Parameters:

float   $num     A float/integer/string number representing currency value
string   $locale     Language name abbreviation. Optional. Defaults to en_US.
string   $int_curr     International currency symbol as defined by the ISO 4217 standard (three characters). E.g. 'EUR', 'USD', 'PLN'. Optional. Defaults to $def_currency defined in the language class.

[ Top ]

toWords   [line 59]

string toWords( integer $num, [string $locale = 'en_US'])

Converts a number to its word representation

Overridden in child classes as:

Numbers_Words_bg::toWords()
Converts a number to its word representation in Bulgarian language.
Numbers_Words_cs::toWords()
Converts a number to its word representation in Czech language
Numbers_Words_dk::toWords()
Converts a number to its word representation in Danish language
Numbers_Words_en_100::toWords()
Converts a number to its word representation in Donald Knuth system, in English language.
Numbers_Words_en_GB::toWords()
Converts a number to its word representation in British English language
Numbers_Words_en_US::toWords()
Converts a number to its word representation in American English language
Numbers_Words_et::toWords()
Converts a number to its word representation in Estonian language
Numbers_Words_fr::toWords()
Converts a number to its word representation in French language.
Numbers_Words_fr_BE::toWords()
Converts a number to its word representation in French language.
Numbers_Words_he::toWords()
Converts a number to its word representation
Numbers_Words_hu_HU::toWords()
Converts a number to its word representation in the Hungarian language
Numbers_Words_id::toWords()
Converts a number to its word representation in Indonesian language
Numbers_Words_lt::toWords()
Converts a number to its word representation in Lithuanian language
Numbers_Words_pl::toWords()
Converts a number to its word representation in Polish language
Numbers_Words_pt_BR::toWords()
Converts a number to its word representation in Brazilian Portuguese language

Parameters:

integer   $num     An integer between -infinity and infinity inclusive :) that should be converted to a words representation
string   $locale     Language name abbreviation. Optional. Defaults to en_US.

[ Top ]


Documentation generated on Tue, 13 Jun 2006 08:07:49 -0400 by phpDocumentor 1.2.3. PEAR Logo Copyright © PHP Group 2004.