Add Hebrew

README.md

@@ -112,6 +112,7 @@ Note: The Currency Transformer within this library processes integers; ensure yo
 | Ukrainian            | ua        | +      | +        |
 | Uzbek                | uz        | +      | +        |
 | Yoruba               | yo        | +      | +        |
+| Hebrew               | he        | +      | +        |
 
 ## Contributors
 

src/Concerns/ManagesCurrencyTransformers.php

@@ -32,6 +32,7 @@ trait ManagesCurrencyTransformers
         'ua' => Transformer\UkrainianCurrencyTransformer::class,
         'uz' => Transformer\UzbekCurrencyTransformer::class,
         'yo' => Transformer\YorubaCurrencyTransformer::class,
+        'he' => Transformer\HebrewCurrencyTransformer::class,
     ];
 
     /**

src/Concerns/ManagesNumberTransformers.php

@@ -44,6 +44,7 @@ trait ManagesNumberTransformers
         'ua' => Transformer\UkrainianNumberTransformer::class,
         'uz' => Transformer\UzbekNumberTransformer::class,
         'yo' => Transformer\YorubaNumberTransformer::class,
+        'he' => Transformer\HebrewNumberTransformer::class,
     ];
 
     /**

src/CurrencyTransformer/HebrewCurrencyTransformer.php

@@ -0,0 +1,80 @@
+<?php
+
+namespace NumberToWords\CurrencyTransformer;
+
+use NumberToWords\Exception\NumberToWordsException;
+use NumberToWords\Language\Hebrew\HebrewDictionary;
+use NumberToWords\Language\Hebrew\HebrewExponentInflector;
+use NumberToWords\Language\Hebrew\HebrewNounGenderInflector;
+use NumberToWords\Language\Hebrew\HebrewTripletTransformer;
+use NumberToWords\NumberTransformer\NumberTransformerBuilder;
+use NumberToWords\Service\NumberToTripletsConverter;
+use NumberToWords\TransformerOptions\CurrencyTransformerOptions;
+
+class HebrewCurrencyTransformer implements CurrencyTransformer
+{
+    public function toWords(int $amount, string $currency, ?CurrencyTransformerOptions $options = null): string
+    {
+        $dictionary = new HebrewDictionary();
+        $numberToTripletsConverter = new NumberToTripletsConverter();
+        $tripletTransformer = new HebrewTripletTransformer($dictionary);
+        $exponentInflector = new HebrewExponentInflector(new HebrewNounGenderInflector());
+
+        $numberTransformer = (new NumberTransformerBuilder())
+            ->withDictionary($dictionary)
+            ->withWordsSeparatedBy(' ')
+            ->transformNumbersBySplittingIntoPowerAwareTriplets($numberToTripletsConverter, $tripletTransformer)
+            ->inflectExponentByNumbers($exponentInflector)
+            ->build();
+
+        $decimal = (int) ($amount / 100);
+
+        $fraction = abs($amount % 100);
+
+        if ($fraction === 0) {
+            $fraction = null;
+        }
+
+        $currency = strtoupper($currency);
+
+        if (!array_key_exists($currency, HebrewDictionary::$currencyNames)) {
+            throw new NumberToWordsException(
+                sprintf('Currency "%s" is not available for "%s" language', $currency, get_class($this))
+            );
+        }
+
+        $currencyNames = HebrewDictionary::$currencyNames[$currency];
+
+        $return = trim($numberTransformer->toWords($decimal));
+
+        $level = ($decimal === 1) ? 0 : 1;
+
+        if ($level > 0) {
+            if (count($currencyNames[0]) > 1) {
+                $return .= ' ' . $currencyNames[0][$level];
+            } else {
+                $return .= ' ' . $currencyNames[0][0] . 's';
+            }
+        } else {
+            $return .= ' ' . $currencyNames[0][0];
+        }
+
+        if (null !== $fraction) {
+            $return .= ' ו' . trim($numberTransformer->toWords($fraction));
+
+            $level = $fraction === 1 ? 0 : 1;
+
+            if ($level > 0) {
+                if (count($currencyNames[1]) > 1) {
+                    $return .= ' ' . $currencyNames[1][$level];
+                } else {
+                    $return .= ' ' . $currencyNames[1][0] . 's';
+                }
+            } else {
+                $return .= ' ' . $currencyNames[1][0];
+            }
+        }
+
+        return $return;
+    }
+}

src/Language/Hebrew/HebrewDictionary.php

@@ -0,0 +1,138 @@
+<?php
+
+namespace NumberToWords\Language\Hebrew;
+
+use NumberToWords\Language\Dictionary;
+
+class HebrewDictionary implements Dictionary
+{
+    public const LOCALE = 'he_IL';
+    public const LANGUAGE_NAME = 'עברית';
+    public const LANGUAGE_NAME_NATIVE = 'עברית';
+
+    private static array $units = ['', 'אחד', 'שתיים', 'שלוש', 'ארבע', 'חמש', 'שש', 'שבע', 'שמונה', 'תשע'];
+
+    private static array $teens = [
+        'עשר',
+        'אחד עשרה',
+        'שתיים עשרה',
+        'שלוש עשרה',
+        'ארבע עשרה',
+        'חמש עשרה',
+        'שש עשרה',
+        'שבע עשרה',
+        'שמונה עשרה',
+        'תשע עשרה'
+    ];
+
+    private static array $tens = [
+        '',
+        'עשר',
+        'עשרים',
+        'שלושים',
+        'ארבעים',
+        'חמישים',
+        'שישים',
+        'שבעים',
+        'שמונים',
+        'תשעים'
+    ];
+
+    private static array $hundred = [
+        '',
+        'מאה',
+        'מאתיים',
+        'שלוש מאות',
+        'ארבע מאות',
+        'חמש מאות',
+        'שש מאות',
+        'שבע מאות',
+        'שמונה מאות',
+        'תשע מאות'
+    ];
+
+    public static array $currencyNames = [
+        'ALL' => [['lek'], ['qindarka']],
+        'AED' => [['Dirham'], ['Fils']],
+        'AUD' => [['Australian dollar'], ['cent']],
+        'BAM' => [['convertible marka'], ['fenig']],
+        'BGN' => [['lev'], ['stotinka']],
+        'BRL' => [['real'], ['centavos']],
+        'BYR' => [['Belarussian rouble'], ['kopiejka']],
+        'CAD' => [['Canadian dollar'], ['cent']],
+        'CHF' => [['Swiss franc'], ['rapp']],
+        'CYP' => [['Cypriot pound'], ['cent']],
+        'CZK' => [['Czech koruna'], ['halerz']],
+        'DKK' => [['Danish krone'], ['ore']],
+        'DZD' => [['dinar'], ['cent']],
+        'EEK' => [['kroon'], ['senti']],
+        'EGP' => [['Egyptian Pound'], ['piastre']],
+        'EUR' => [['אירו'], ['אירו סנט']],
+        'GBP' => [['pound', 'pounds'], ['pence', 'pence']],
+        'HKD' => [['Hong Kong dollar'], ['cent']],
+        'HRK' => [['Croatian kuna'], ['lipa']],
+        'HUF' => [['forint'], ['filler']],
+        'ILS' => [['ש"ח', 'ש"ח'], ['אגו\'', 'אגו\'']],
+        'ISK' => [['Icelandic króna'], ['aurar']],
+        'JPY' => [['yen'], ['sen']],
+        'LTL' => [['litas'], ['cent']],
+        'LVL' => [['lat'], ['sentim']],
+        'LYD' => [['dinar'], ['cent']],
+        'MAD' => [['dirham'], ['cent']],
+        'MKD' => [['Macedonian dinar'], ['deni']],
+        'MRO' => [['ouguiya'], ['khoums']],
+        'MTL' => [['Maltese lira'], ['centym']],
+        'NGN' => [['Naira'], ['kobo']],
+        'NOK' => [['Norwegian krone'], ['oere']],
+        'PHP' => [['peso'], ['centavo']],
+        'PLN' => [['zloty', 'zlotys'], ['grosz']],
+        'ROL' => [['Romanian leu'], ['bani']],
+        'RUB' => [['Russian Federation rouble'], ['kopiejka']],
+        'SAR' => [['Riyal'], ['Halalah']],
+        'SEK' => [['Swedish krona'], ['oere']],
+        'SIT' => [['Tolar'], ['stotinia']],
+        'SKK' => [['Slovak koruna'], []],
+        'TMT' => [['manat'], ['tenge']],
+        'TND' => [['dinar'], ['millime']],
+        'TRL' => [['lira'], ['kuruş']],
+        'TRY' => [['lira'], ['kuruş']],
+        'UAH' => [['hryvna'], ['cent']],
+        'USD' => [['דולר', 'דולר'], ['סנט', 'סנט']],
+        'XAF' => [['CFA franc'], ['cent']],
+        'XOF' => [['CFA franc'], ['cent']],
+        'XPF' => [['CFP franc'], ['centime']],
+        'YUM' => [['dinar'], ['para']],
+        'ZAR' => [['rand'], ['cent']],
+        'UZS' => [['sum'], ['tiyin']],
+    ];
+
+    public function getZero(): string
+    {
+        return 'אפס';
+    }
+
+    public function getMinus(): string
+    {
+        return 'מינוס';
+    }
+
+    public function getCorrespondingUnit(int $unit): string
+    {
+        return self::$units[$unit];
+    }
+
+    public function getCorrespondingTen(int $ten): string
+    {
+        return self::$tens[$ten];
+    }
+
+    public function getCorrespondingTeen(int $teen): string
+    {
+        return self::$teens[$teen];
+    }
+
+    public function getCorrespondingHundred(int $hundred): string
+    {
+        return self::$hundred[$hundred];
+    }
+}

src/Language/Hebrew/HebrewExponentGetter.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace NumberToWords\Language\Hebrew;
+
+use NumberToWords\Language\ExponentGetter;
+
+class HebrewExponentGetter implements ExponentGetter
+{
+    private static array $exponent = [
+        '',
+        'אלף',
+        'מיליון',
+        'מיליארד',
+        'טריליון',
+        'קוודריליון',
+        'קווינטיליון',
+        'סקסטיליון',
+        'ספטיליון',
+        'אוקטיליון',
+        'נוניליון',
+        'דציליון',
+        'אנדציליון',
+        'דודציליון',
+        'טרדציליון',
+        'קוואטורדציליון',
+        'קווינדציליון',
+        'סקסדציליון',
+        'ספטנדציליון',
+        'אוקטודציליון',
+        'נובמדציליון',
+        'ויגינטיליון',
+    ];
+
+    public function getExponent(int $power): string
+    {
+        return self::$exponent[$power];
+    }
+}

src/Language/Hebrew/HebrewExponentInflector.php

@@ -0,0 +1,73 @@
+<?php
+
+namespace NumberToWords\Language\Hebrew;
+
+use NumberToWords\Language\ExponentInflector;
+
+class HebrewExponentInflector implements ExponentInflector
+{
+    private static $exponent = [
+        ['', '', ''],
+        ['אלפים', 'אלף'], // 'אלף' is 'thousand
+        ['מיליון', 'מיליון'], // 'מיליון' is 'million'
+        ['מיליארד', 'מיליארד'], // 'מיליארד' is 'billion'
+        ['טריליון', 'טריליון'], // 'טריליון' is 'trillion'
+        ['קוודריליון', 'קוודריליון'], // 'קוודריליון' is 'quadrillion'
+        ['קווינטיליון', 'קווינטיליון'], // 'קווינטיליון' is 'quintillion'
+        ['סקסטיליון', 'סקסטיליון'], // 'סקסטיליון' is 'sextillion'
+        ['ספטיליון', 'ספטיליון'], // 'ספטיליון' is 'septillion'
+        ['אוקטיליון', 'אוקטיליון'], // 'אוקטיליון' is 'octillion'
+        ['נוניליון', 'נוניליון'], // 'נוניליון' is 'nonillion'
+        ['דציליון', 'דציליון'], // 'דציליון' is 'decillion'
+        ['אנדציליון', 'אנדציליון'], // 'אנדציליון' is 'undecillion'
+        ['דודציליון', 'דודציליון'], // 'דודציליון
+    ];
+
+    private static $exponentBetweenTenToTeweny = [
+        '',
+        'אלף',
+        'אלפיים',
+        'שלושת',
+        'ארבעת',
+        'חמשת',
+        'ששת',
+        'שבעת',
+        'שמונת',
+        'תשעת',
+        'עשרת',
+    ];
+
+    /**
+     * @var HebrewNounGenderInflector
+     */
+    private $inflector;
+
+    /**
+     * @param HebrewNounGenderInflector $inflector
+     */
+    public function __construct(HebrewNounGenderInflector $inflector)
+    {
+        $this->inflector = $inflector;
+    }
+
+
+    /**
+     * @param int $number
+     * @param int $power
+     *
+     * @return string
+     */
+    public function inflectExponent($number, $power): string
+    {
+        if ($power === 0) {
+            return '';
+        }
+
+        return $this->inflector->inflectNounByNumber(
+            $number,
+            self::$exponent[$power][0],
+            self::$exponent[$power][1],
+            $power === 1 ? self::$exponentBetweenTenToTeweny : []
+        );
+    }
+}

src/Language/Hebrew/HebrewNounGenderInflector.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace NumberToWords\Language\Hebrew;
+
+class HebrewNounGenderInflector
+{
+    /**
+     * @param int    $number
+     * @param string $singular
+     * @param string $plural
+     * @param string $genitivePlural
+     *
+     * @return string
+     */
+    public function inflectNounByNumber($number, $plural, $genitivePlural, array $exponentBetweenTenToTeweny)
+    {
+        $units = $number % 10;
+        $tens = ((int) ($number / 10)) % 10;
+
+        if ($number > 1 && $number <= 10) {
+            if($number === 2) {
+                return $exponentBetweenTenToTeweny[$number] ?? $plural;
+            }
+            return ($exponentBetweenTenToTeweny[$number] ?? false)
+                ?  $exponentBetweenTenToTeweny[$number] . ' ' . $plural
+                : $plural;
+        }
+
+        if (($units > 2 && $tens === 0) || ($units === 0 && $tens === 1)) {
+            return $genitivePlural;
+        }
+
+        return $genitivePlural;
+    }
+}