I18N_Arabic

# Class: I18N_Arabic_Numbers

Source Location: /Arabic/Numbers.php

### Class Overview

This PHP class spell numbers in the Arabic idiom

#### Author(s):

- Khaled Al-Sham'aa <khaled@ar-php.org>

#### Copyright:

- 2006-2016 Khaled Al-Sham'aa

### Methods

- getFeminine
- getFormat
- getOrder
- int2indic
- int2str
- money2str
- setFeminine
- setFormat
- setOrder
- str2int
- subInt2str
- writtenBlock

### Class Details

[line 115]
This PHP class spell numbers in the Arabic idiom

#### Tags:

author: | Khaled Al-Sham'aa <khaled@ar-php.org>
copyright: | 2006-2016 Khaled Al-Sham'aa
link: | http://www.ar-php.org
license: | LGPL

[ Top ]

### Class Methods

### method getFeminine [line 268]

`integer getFeminine( )`

Get the feminine flag of counted object

#### Tags:

return: | return current setting of counted object feminine flag
author: | Khaled Al-Sham'aa <khaled@ar-php.org>
access: | public

[ Top ]

### method getFormat [line 280]

`integer getFormat( )`

Get the grammer position flag of counted object

#### Tags:

return: | return current setting of counted object grammer position flag
author: | Khaled Al-Sham'aa <khaled@ar-php.org>
access: | public

[ Top ]

### method getOrder [line 291]

`integer getOrder( )`

Get the ordering flag value

#### Tags:

return: | return current setting of ordering flag value
author: | Khaled Al-Sham'aa <khaled@ar-php.org>
access: | public

[ Top ]

### method int2indic [line 659]

`string int2indic( integer $number)`

Represent integer number in Arabic-Indic digits using HTML entities

#### Tags:

return: | The Arabic-Indic digits represent inserted integer number using HTML entities
author: | Khaled Al-Sham'aa <khaled@ar-php.org>
access: | public

#### Parameters:

integer | $number | The number you want to present in Arabic-Indic digits using HTML entities

[ Top ]

### method int2str [line 304]

`string int2str( integer $number)`

Spell integer number in Arabic idiom

#### Tags:

return: | The Arabic idiom that spells inserted number
author: | Khaled Al-Sham'aa <khaled@ar-php.org>
access: | public

#### Parameters:

integer | $number | The number you want to spell in Arabic idiom

[ Top ]

### method money2str [line 345]

`string money2str( integer $number, [string $iso = 'SYP'], [string $lang = 'ar'])`

Spell number in Arabic idiom as money

#### Tags:

return: | The Arabic idiom that spells inserted number as money
author: | Khaled Al-Sham'aa <khaled@ar-php.org>
access: | public

#### Parameters:

integer | $number | The number you want to spell in Arabic idiom as money
string | $iso | The three-letter Arabic country code defined in ISO 3166 standard
string | $lang | The two-letter language code in ISO 639-1 standard [ar|en]

[ Top ]

### method setFeminine [line 217]

`object setFeminine( integer $value)`

Set feminine flag of the counted object

#### Tags:

return: | to build a fluent interface
author: | Khaled Al-Sham'aa <khaled@ar-php.org>
access: | public

#### Parameters:

integer | $value | Counted object feminine (1 for masculine & 2 for feminine)

[ Top ]

### method setFormat [line 235]

`object setFormat( integer $value)`

Set the grammar position flag of the counted object

#### Tags:

return: | to build a fluent interface
author: | Khaled Al-Sham'aa <khaled@ar-php.org>
access: | public

#### Parameters:

integer | $value | Grammar position of counted object (1 if Marfoua & 2 if Mansoub or Majrour)

[ Top ]

### method setOrder [line 253]

`object setOrder( integer $value)`

Set the ordering flag, is it normal number or ordering number

#### Tags:

return: | to build a fluent interface
author: | Khaled Al-Sham'aa <khaled@ar-php.org>
access: | public

#### Parameters:

integer | $value | Is it an ordering number? default is 1 (use 1 if no and 2 if yes)

[ Top ]

### method str2int [line 383]

`integer str2int( string $str)`

Convert Arabic idiom number string into Integer

#### Tags:

return: | The number you spell it in the Arabic idiom
author: | Khaled Al-Sham'aa <khaled@ar-php.org>
access: | public

#### Parameters:

string | $str | The Arabic idiom that spells input number

[ Top ]

### method subInt2str [line 473]

`string subInt2str( integer $number, [logical $zero = true])`

Spell integer number in Arabic idiom

#### Tags:

return: | The Arabic idiom that spells inserted number
author: | Khaled Al-Sham'aa <khaled@ar-php.org>
access: | protected

#### Parameters:

integer | $number | The number you want to spell in Arabic idiom
logical | $zero | Present leading zero if true [default is true]

[ Top ]

### method writtenBlock [line 557]

`string writtenBlock( integer $number)`

Spell sub block number of three digits max in Arabic idiom

#### Tags:

return: | The Arabic idiom that spells inserted sub block
author: | Khaled Al-Sham'aa <khaled@ar-php.org>
access: | protected

#### Parameters:

integer | $number | Sub block number of three digits max you want to spell in Arabic idiom

[ Top ]

Documentation generated on Fri, 01 Jan 2016 10:26:16 +0200 by phpDocumentor 1.4.0