. * * ---------------------------------------------------------------------- * * Class Name: Spell numbers in the Arabic idiom * * Filename: ArNumbers.class.php * * Original Author(s): Khaled Al-Sham'aa * * Purpose: Spell numbers in the Arabic idiom * * ---------------------------------------------------------------------- * * Spell numbers in the Arabic idiom * * PHP class to spell numbers in the Arabic idiom. This function is very * useful for financial applications in Arabic for example. * * If you ever have to create an Arabic PHP application built around invoicing or * accounting, you might find this class useful. Its sole reason for existence is * to help you translate integers into their spoken-word equivalents in Arabic * language. * * How is this useful? Well, consider the typical invoice: In addition to a * description of the work done, the date, and the hourly or project cost, it always * includes a total cost at the end, the amount that the customer is expected * to pay. * * To avoid any misinterpretation of the total amount, many organizations (mine * included) put the amount in both words and figures; for example, $1,200 becomes * "one thousand and two hundred dollars." You probably do the same thing every time * you write a check. * * Now take this scenario to a Web-based invoicing system. The actual data used to * generate the invoice will be stored in a database as integers, both to save space * and to simplify calculations. So when a printable invoice is generated, your Web * application will need to convert those integers into words, this is more clarity * and more personality. * * This class will accept almost any numeric value and convert it into an equivalent * string of words in written Arabic language (using Windows-1256 character set). * The value can be any positive number up to 999,999,999 (users should not use * commas). It will take care of feminine and Arabic grammar rules. * * Example: *


 *     include('./Arabic.php');
 *     $obj = new Arabic('ArNumbers');
 *     
 *     $obj->setFeminine(1);
 *     $obj->setFormat(1);
 *     
 *     $integer = 2147483647;
 *     
 *     $text = $obj->int2str($integer);
 *     
 *     echo "$integer
$text";
 * 
 *     $obj->setFeminine(2);
 *     $obj->setFormat(2);
 *     
 *     $integer = 2147483647;
 *     
 *     $text = $obj->int2str($integer);
 *     
 *     echo "$integer
$text";   
 *

* * @category I18N * @package Arabic * @author Khaled Al-Shamaa * @copyright 2006-2010 Khaled Al-Shamaa * * @license LGPL * @link http://www.ar-php.org */ // New in PHP V5.3: Namespaces // namespace I18N/Arabic/ArNumbers; /** * This PHP class spell numbers in the Arabic idiom * * @category I18N * @package Arabic * @author Khaled Al-Shamaa * @copyright 2006-2010 Khaled Al-Shamaa * * @license LGPL * @link http://www.ar-php.org */ class ArNumbers { protected $individual = array(); protected $feminine = 1; protected $format = 1; /** * "int2str" method output charset * @var String */ public $int2strOutput = 'utf-8'; /** * Loads initialize values */ public function __construct() { $xml = simplexml_load_file(dirname(__FILE__).'/data/ArNumbers.xml'); foreach ($xml->xpath("//individual/number[@gender='male']") as $num) { if (isset($num['grammar'])) { $grammar = $num['grammar']; $this->individual["{$num['value']}"][1]["$grammar"] = (string)$num; } else { $this->individual["{$num['value']}"][1] = (string)$num; } } foreach ($xml->xpath("//individual/number[@gender='female']") as $num) { if (isset($num['grammar'])) { $grammar = $num['grammar']; $this->individual["{$num['value']}"][2]["$grammar"] = (string)$num; } else { $this->individual["{$num['value']}"][2] = (string)$num; } } foreach ($xml->xpath("//individual/number[@value>19]") as $num) { if (isset($num['grammar'])) { $grammar = $num['grammar']; $this->individual["{$num['value']}"]["$grammar"] = (string)$num; } else { $this->individual["{$num['value']}"] = (string)$num; } } foreach ($xml->complications->number as $num) { $scale = $num['scale']; $format = $num['format']; $this->complications["$scale"]["$format"] = (string)$num; } } /** * Set feminine flag of the counted object * * @param integer $value Counted object feminine * (1 for masculine & 2 for feminine) * * @return object $this to build a fluent interface * @author Khaled Al-Shamaa */ public function setFeminine($value) { if ($value == 1 || $value == 2) { $this->feminine = $value; } return $this; } /** * Set the grammar position flag of the counted object * * @param integer $value Grammar position of counted object * (1 if Marfoua & 2 if Mansoub or Majrour) * * @return object $this to build a fluent interface * @author Khaled Al-Shamaa */ public function setFormat($value) { if ($value == 1 || $value == 2) { $this->format = $value; } return $this; } /** * Get the feminine flag of counted object * * @return integer return current setting of counted object feminine flag * @author Khaled Al-Shamaa */ public function getFeminine() { return $this->feminine; } /** * Get the grammer position flag of counted object * * @return integer return current setting of counted object grammer * position flag * @author Khaled Al-Shamaa */ public function getFormat() { return $this->format; } /** * Spell integer number in Arabic idiom * * @param integer $number The number you want to spell in Arabic idiom * * @return string The Arabic idiom that spells inserted number * @author Khaled Al-Shamaa */ public function int2str($number) { if ($number < 0) { $string = 'سالب '; $number = (string) -1 * $number; } else { $string = ''; } $temp = explode('.', $number); $string .= $this->subInt2str($temp[0]); if (!empty($temp[1])) { $dec = $this->subInt2str($temp[1]); $string .= ' فاصلة ' . $dec; } return $string; } /** * Spell integer number in Arabic idiom * * @param integer $number The number you want to spell in Arabic idiom * * @return string The Arabic idiom that spells inserted number * @author Khaled Al-Shamaa */ protected function subInt2str($number) { $blocks = array(); $items = array(); $string = ''; $number = trim((float)$number); if ($number > 0) { while (strlen($number) > 3) { array_push($blocks, substr($number, -3)); $number = substr($number, 0, strlen($number) - 3); } array_push($blocks, $number); $blocks_num = count($blocks) - 1; for ($i = $blocks_num; $i >= 0; $i--) { $number = floor($blocks[$i]); $text = $this->writtenBlock($number); if ($text) { if ($number == 1 && $i != 0) { $text = $this->complications[$i][4]; } elseif ($number == 2 && $i != 0) { $text = $this->complications[$i][$this->format]; } elseif ($number > 2 && $number < 11 && $i != 0) { $text .= ' ' . $this->complications[$i][3]; } elseif ($i != 0) { $text .= ' ' . $this->complications[$i][4]; } array_push($items, $text); } } $string = implode(' و ', $items); } else { $string = 'صفر'; } return $string; } /** * Spell sub block number of three digits max in Arabic idiom * * @param integer $number Sub block number of three digits max you want to * spell in Arabic idiom * * @return string The Arabic idiom that spells inserted sub block * @author Khaled Al-Shamaa */ protected function writtenBlock($number) { $items = array(); $string = ''; if ($number > 99) { $hundred = floor($number / 100) * 100; $number = $number % 100; if ($hundred == 200) { array_push($items, $this->individual[$hundred][$this->format]); } else { array_push($items, $this->individual[$hundred]); } } if ($number != 0) { if ($number == 2 || $number == 12) { array_push($items, $this->individual[$number] [$this->feminine] [$this->format]); } elseif ($number < 20) { array_push($items, $this->individual[$number][$this->feminine]); } else { $ones = $number % 10; $tens = floor($number / 10) * 10; if ($ones == 2) { array_push($items, $this->individual[$ones] [$this->feminine] [$this->format]); } elseif ($ones > 0) { array_push($items, $this->individual[$ones][$this->feminine]); } array_push($items, $this->individual[$tens][$this->format]); } } $items = array_diff($items, array('')); $string = implode(' و ', $items); return $string; } }