Main class to convert the plural rules of a language from CLDR to gettext. More...

Collaboration diagram for Gettext\Languages\Language:

Public Member Functions
	getUSAsciiClone ()
	Returns a clone of this instance with all the strings to US-ASCII. More...

Static Public Member Functions
static	getAll ()
	Return a list of all languages available. More...

static	getById ($id)
	Return a Language instance given the language id. More...

Data Fields
	$id

	$name

	$supersededBy

	$script

	$territory

	$baseLanguage

	$categories

	$formula

Private Member Functions
	__construct ($info)
	Initialize the instance and parse the language code. More...

	checkAlwaysTrueCategories ()
	Let's look for categories that will always occur. More...

	checkAlwaysFalseCategories ()
	Let's look for categories that will never occur. More...

	checkAllCategoriesWithExamples ()
	Let's look for categories that don't have examples. More...

	buildFormula ()
	Build the formula starting from the currently defined categories. More...

Static Private Member Functions
static	reverseFormula ($formula)
	Reverse a formula. More...

static	reduceFormula ($formula)
	Reduce some excessively complex formulas. More...

static	asciifier (&$value)
	Take one variable and, if it's a string, we transliterate it to US-ASCII. More...

Detailed Description

Main class to convert the plural rules of a language from CLDR to gettext.

Definition at line 9 of file Language.php.

Constructor & Destructor Documentation

◆ __construct()

Gettext\Languages\Language::__construct ( $info )

private

Initialize the instance and parse the language code.

Parameters

array $info The result of CldrData::getLanguageInfo()

Exceptions

Exception Throws an Exception if $fullId is not valid.

Definition at line 56 of file Language.php.

References Gettext\Languages\CldrData\$categories, $info, array, Gettext\Languages\Language\buildFormula(), Gettext\Languages\Language\checkAllCategoriesWithExamples(), Gettext\Languages\Language\checkAlwaysFalseCategories(), Gettext\Languages\Language\checkAlwaysTrueCategories(), and Gettext\Languages\CldrData\OTHER_CATEGORY.

     {
         $this->id = $info['id'];
         $this->name = $info['name'];
         $this->supersededBy = isset($info['supersededBy']) ? $info['supersededBy'] : null;
         $this->script = isset($info['script']) ? $info['script'] : null;
         $this->territory = isset($info['territory']) ? $info['territory'] : null;
         $this->baseLanguage = isset($info['baseLanguage']) ? $info['baseLanguage'] : null;
         // Let's build the category list
         $this->categories = array();
         foreach ($info['categories'] as $cldrCategoryId => $cldrFormulaAndExamples) {
             $category = new Category($cldrCategoryId, $cldrFormulaAndExamples);
             foreach ($this->categories as $c) {
                 if ($category->id === $c->id) {
                     throw new Exception("The category '{$category->id}' is specified more than once");
                 }
             }
             $this->categories[] = $category;
         }
         if (empty($this->categories)) {
             throw new Exception("The language '{$info['id']}' does not have any plural category");
         }
         // Let's sort the categories from 'zero' to 'other'
         usort($this->categories, function (Category $category1, Category $category2) {
             return array_search($category1->id, CldrData::$categories) - array_search($category2->id, CldrData::$categories);
         });
         // The 'other' category should always be there
         if ($this->categories[count($this->categories) - 1]->id !== CldrData::OTHER_CATEGORY) {
             throw new Exception("The language '{$info['id']}' does not have the '".CldrData::OTHER_CATEGORY."' plural category");
         }
         $this->checkAlwaysTrueCategories();
         $this->checkAlwaysFalseCategories();
         $this->checkAllCategoriesWithExamples();
         $this->formula = $this->buildFormula();
     }

Here is the call graph for this function:

Member Function Documentation

◆ asciifier()

static Gettext\Languages\Language::asciifier ( & $value )

staticprivate

Take one variable and, if it's a string, we transliterate it to US-ASCII.

Parameters

mixed $value The variable to work on.

Exceptions

Exception

Definition at line 322 of file Language.php.

References array.

     {
         if (is_string($value) && ($value !== '')) {
             // Avoid converting from 'Ÿ' to '"Y', let's prefer 'Y'
             $transliterated = strtr($value, array(
                 'À' => 'A', 'Á' => 'A', 'Â' => 'A', 'Ã' => 'A', 'Ä' => 'A',
                 'È' => 'E', 'É' => 'E', 'Ê' => 'E', 'Ë' => 'E',
                 'Ì' => 'I', 'Í' => 'I', 'Î' => 'I', 'Ï' => 'I',
                 'Ñ' => 'N',
                 'Ò' => 'O', 'Ó' => 'O', 'Ô' => 'O', 'Õ' => 'O', 'Ö' => 'O',
                 'Ù' => 'U', 'Ú' => 'U', 'Û' => 'U', 'Ü' => 'U',
                 'Ÿ' => 'Y', 'Ý' => 'Y',
                 'à' => 'a', 'á' => 'a', 'â' => 'a', 'ã' => 'a', 'ä' => 'a',
                 'è' => 'e', 'é' => 'e', 'ê' => 'e', 'ë' => 'e',
                 'ì' => 'i', 'í' => 'i', 'î' => 'i', 'ï' => 'i',
                 'ñ' => 'n', 'ò' => 'o', 'ó' => 'o', 'ô' => 'o', 'õ' => 'o', 'ö' => 'o',
                 'ù' => 'u', 'ú' => 'u', 'û' => 'u', 'ü' => 'u',
                 'ý' => 'y', 'ÿ' => 'y',
             ));
             $transliterated = @iconv('UTF-8', 'US-ASCII//IGNORE//TRANSLIT', $transliterated);
             if (($transliterated === false) || ($transliterated === '')) {
                 throw new Exception("Unable to transliterate '$value'");
             }
             $value = $transliterated;
         }
     }

◆ buildFormula()

Gettext\Languages\Language::buildFormula ( )

private

Build the formula starting from the currently defined categories.

Returns: string

Definition at line 249 of file Language.php.

References Gettext\Languages\Language\$formula, and $i.

Referenced by Gettext\Languages\Language\__construct(), and Gettext\Languages\Language\checkAllCategoriesWithExamples().

     {
         $numCategories = count($this->categories);
         switch ($numCategories) {
             case 1:
                 // Just one category
                 return '0';
             case 2:
                 return self::reduceFormula(self::reverseFormula($this->categories[0]->formula));
             default:
                 $formula = strval($numCategories - 1);
                 for ($i = $numCategories - 2; $i >= 0; $i--) {
                     $f = self::reduceFormula($this->categories[$i]->formula);
                     if (!preg_match('/^\([^()]+\)$/', $f)) {
                         $f = "($f)";
                     }
                     $formula = "$f ? $i : $formula";
                     if ($i > 0) {
                         $formula = "($formula)";
                     }
                 }
 
                 return $formula;
         }
     }

Here is the caller graph for this function:

◆ checkAllCategoriesWithExamples()

Gettext\Languages\Language::checkAllCategoriesWithExamples ( )

private

Let's look for categories that don't have examples.

This because with decimals (CLDR) we may have more cases, with integers (gettext) we have some less cases. If we found those categories, we check that they never occur and we strip them out.

Exceptions

Exception

Definition at line 174 of file Language.php.

References array, Gettext\Languages\Language\buildFormula(), and Gettext\Languages\CldrData\OTHER_CATEGORY.

Referenced by Gettext\Languages\Language\__construct().

     {
         $allCategoriesIds = array();
         $goodCategories = array();
         $badCategories = array();
         $badCategoriesIds = array();
         foreach ($this->categories as $category) {
             $allCategoriesIds[] = $category->id;
             if (isset($category->examples)) {
                 $goodCategories[] = $category;
             } else {
                 $badCategories[] = $category;
                 $badCategoriesIds[] = $category->id;
             }
         }
         if (empty($badCategories)) {
             return;
         }
         $removeCategoriesWithoutExamples = false;
         switch (implode(',', $badCategoriesIds).'@'.implode(',', $allCategoriesIds)) {
             case CldrData::OTHER_CATEGORY.'@one,few,many,'.CldrData::OTHER_CATEGORY:
                 switch ($this->buildFormula()) {
                     case '(n % 10 == 1 && n % 100 != 11) ? 0 : ((n % 10 >= 2 && n % 10 <= 4 && (n % 100 < 12 || n % 100 > 14)) ? 1 : ((n % 10 == 0 || n % 10 >= 5 && n % 10 <= 9 || n % 100 >= 11 && n % 100 <= 14) ? 2 : 3))':
                         // Numbers ending with 0                 => case 2 ('many')
                         // Numbers ending with 1 but not with 11 => case 0 ('one')
                         // Numbers ending with 11                => case 2 ('many')
                         // Numbers ending with 2 but not with 12 => case 1 ('few')
                         // Numbers ending with 12                => case 2 ('many')
                         // Numbers ending with 3 but not with 13 => case 1 ('few')
                         // Numbers ending with 13                => case 2 ('many')
                         // Numbers ending with 4 but not with 14 => case 1 ('few')
                         // Numbers ending with 14                => case 2 ('many')
                         // Numbers ending with 5                 => case 2 ('many')
                         // Numbers ending with 6                 => case 2 ('many')
                         // Numbers ending with 7                 => case 2 ('many')
                         // Numbers ending with 8                 => case 2 ('many')
                         // Numbers ending with 9                 => case 2 ('many')
                         // => the 'other' case never occurs: use 'other' for 'many'
                         $removeCategoriesWithoutExamples = true;
                         break;
                     case '(n == 1) ? 0 : ((n % 10 >= 2 && n % 10 <= 4 && (n % 100 < 12 || n % 100 > 14)) ? 1 : ((n != 1 && (n % 10 == 0 || n % 10 == 1) || n % 10 >= 5 && n % 10 <= 9 || n % 100 >= 12 && n % 100 <= 14) ? 2 : 3))':
                         // Numbers ending with 0                  => case 2 ('many')
                         // Numbers ending with 1 but not number 1 => case 2 ('many')
                         // Number 1                               => case 0 ('one')
                         // Numbers ending with 2 but not with 12  => case 1 ('few')
                         // Numbers ending with 12                 => case 2 ('many')
                         // Numbers ending with 3 but not with 13  => case 1 ('few')
                         // Numbers ending with 13                 => case 2 ('many')
                         // Numbers ending with 4 but not with 14  => case 1 ('few')
                         // Numbers ending with 14                 => case 2 ('many')
                         // Numbers ending with 5                  => case 2 ('many')
                         // Numbers ending with 6                  => case 2 ('many')
                         // Numbers ending with 7                  => case 2 ('many')
                         // Numbers ending with 8                  => case 2 ('many')
                         // Numbers ending with 9                  => case 2 ('many')
                         // => the 'other' case never occurs: use 'other' for 'many'
                         $removeCategoriesWithoutExamples = true;
                         break;
                 }
         }
         if (!$removeCategoriesWithoutExamples) {
             throw new Exception("Unhandled case of plural categories without examples '".implode(', ', $badCategoriesIds)."' out of '".implode(', ', $allCategoriesIds)."'");
         }
         if ($badCategories[count($badCategories) - 1]->id === CldrData::OTHER_CATEGORY) {
             // We're removing the 'other' cagory: let's change the last good category to 'other'
             $lastGood = $goodCategories[count($goodCategories) - 1];
             $lastGood->id = CldrData::OTHER_CATEGORY;
             $lastGood->formula = null;
         }
         $this->categories = $goodCategories;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkAlwaysFalseCategories()

Gettext\Languages\Language::checkAlwaysFalseCategories ( )

private

Let's look for categories that will never occur.

This because with decimals (CLDR) we may have more cases, with integers (gettext) we have some less cases. If we found those categories we strip them out.

Definition at line 154 of file Language.php.

References array.

Referenced by Gettext\Languages\Language\__construct().

     {
         $filtered = array();
         foreach ($this->categories as $category) {
             if ($category->formula === false) {
                 if (isset($category->examples)) {
                     throw new Exception("The category '{$category->id}' should never occur, but it has examples (so for CLDR it may occur!)");
                 }
             } else {
                 $filtered[] = $category;
             }
         }
         $this->categories = $filtered;
     }

Here is the caller graph for this function:

◆ checkAlwaysTrueCategories()

Gettext\Languages\Language::checkAlwaysTrueCategories ( )

private

Let's look for categories that will always occur.

This because with decimals (CLDR) we may have more cases, with integers (gettext) we have just one case. If we found that (single) category we reduce the categories to that one only.

Definition at line 126 of file Language.php.

References array, and Gettext\Languages\CldrData\OTHER_CATEGORY.

Referenced by Gettext\Languages\Language\__construct().

     {
         $alwaysTrueCategory = null;
         foreach ($this->categories as $category) {
             if ($category->formula === true) {
                 if (!isset($category->examples)) {
                     throw new Exception("The category '{$category->id}' should always occur, but it does not have examples (so for CLDR it will never occur for integers!)");
                 }
                 $alwaysTrueCategory = $category;
                 break;
             }
         }
         if (isset($alwaysTrueCategory)) {
             foreach ($this->categories as $category) {
                 if (($category !== $alwaysTrueCategory) && isset($category->examples)) {
                     throw new Exception("The category '{$category->id}' should never occur, but it has some examples (so for CLDR it will occur!)");
                 }
             }
             $alwaysTrueCategory->id = CldrData::OTHER_CATEGORY;
             $alwaysTrueCategory->formula = null;
             $this->categories = array($alwaysTrueCategory);
         }
     }

Here is the caller graph for this function:

◆ getAll()

static Gettext\Languages\Language::getAll ( )

static

Return a list of all languages available.

Exceptions

Exception

Returns: Language[]

Definition at line 96 of file Language.php.

References $result, array, Gettext\Languages\CldrData\getLanguageInfo(), and Gettext\Languages\CldrData\getLanguageNames().

     {
         $result = array();
         foreach (array_keys(CldrData::getLanguageNames()) as $cldrLanguageId) {
             $result[] = new Language(CldrData::getLanguageInfo($cldrLanguageId));
         }
 
         return $result;
     }

Here is the call graph for this function:

◆ getById()

static Gettext\Languages\Language::getById ( $id )

static

Return a Language instance given the language id.

Parameters

string $id

Returns: Language|null

Definition at line 110 of file Language.php.

References Gettext\Languages\Language\$id, $info, $result, and Gettext\Languages\CldrData\getLanguageInfo().

     {
         $result = null;
         $info = CldrData::getLanguageInfo($id);
         if (isset($info)) {
             $result = new Language($info);
         }
 
         return $result;
     }

Here is the call graph for this function:

◆ getUSAsciiClone()

Gettext\Languages\Language::getUSAsciiClone ( )

Returns a clone of this instance with all the strings to US-ASCII.

Returns: Language

Definition at line 352 of file Language.php.

References array.

     {
         $clone = clone $this;
         self::asciifier($clone->name);
         self::asciifier($clone->formula);
         $clone->categories = array();
         foreach ($this->categories as $category) {
             $categoryClone = clone $category;
             self::asciifier($categoryClone->examples);
             $clone->categories[] = $categoryClone;
         }
 
         return $clone;
     }

◆ reduceFormula()

static Gettext\Languages\Language::reduceFormula ( $formula )

staticprivate

Reduce some excessively complex formulas.

Parameters

string $formula

Returns: string

Definition at line 308 of file Language.php.

References Gettext\Languages\Language\$formula, and array.

     {
         $map = array(
             'n != 0 && n != 1'              =>  'n > 1' ,
             '(n == 0 || n == 1) && n != 0'  =>  'n == 1',
         );
 
         return isset($map[$formula]) ? $map[$formula] : $formula;
     }

◆ reverseFormula()

static Gettext\Languages\Language::reverseFormula ( $formula )

staticprivate

Reverse a formula.

Parameters

string $formula

Exceptions

Exception

Returns: string

Definition at line 280 of file Language.php.

References Gettext\Languages\Language\$formula, $m, and array.

     {
         if (preg_match('/^n( % \d+)? == \d+(\.\.\d+|,\d+)*?$/', $formula)) {
             return str_replace(' == ', ' != ', $formula);
         }
         if (preg_match('/^n( % \d+)? != \d+(\.\.\d+|,\d+)*?$/', $formula)) {
             return str_replace(' != ', ' == ', $formula);
         }
         if (preg_match('/^\(?n == \d+ \|\| n == \d+\)?$/', $formula)) {
             return trim(str_replace(array(' == ', ' || '), array(' != ', ' && '), $formula), '()');
         }
         $m = null;
         if (preg_match('/^(n(?: % \d+)?) == (\d+) && (n(?: % \d+)?) != (\d+)$/', $formula, $m)) {
             return "{$m[1]} != {$m[2]} || {$m[3]} == {$m[4]}";
         }
         switch ($formula) {
             case '(n == 1 || n == 2 || n == 3) || n % 10 != 4 && n % 10 != 6 && n % 10 != 9':
                 return 'n != 1 && n != 2 && n != 3 && (n % 10 == 4 || n % 10 == 6 || n % 10 == 9)';
             case '(n == 0 || n == 1) || n >= 11 && n <= 99':
                 return 'n >= 2 && (n < 11 || n > 99)';
         }
         throw new Exception("Unable to reverse the formula '$formula'");
     }

Field Documentation

◆ $baseLanguage

Gettext\Languages\Language::$baseLanguage

Definition at line 40 of file Language.php.

◆ $categories

Gettext\Languages\Language::$categories

Definition at line 45 of file Language.php.

◆ $formula

Gettext\Languages\Language::$formula

Definition at line 50 of file Language.php.

Referenced by Gettext\Languages\Language\buildFormula(), Gettext\Languages\Language\reduceFormula(), and Gettext\Languages\Language\reverseFormula().

◆ $id

Gettext\Languages\Language::$id

Definition at line 15 of file Language.php.

Referenced by Gettext\Languages\Language\getById().

◆ $name

Gettext\Languages\Language::$name

Definition at line 20 of file Language.php.

◆ $script

Gettext\Languages\Language::$script

Definition at line 30 of file Language.php.

◆ $supersededBy

Gettext\Languages\Language::$supersededBy

Definition at line 25 of file Language.php.

◆ $territory

Gettext\Languages\Language::$territory

Definition at line 35 of file Language.php.

The documentation for this class was generated from the following file:

libs/composer/vendor/gettext/languages/src/Language.php

Public Member Functions

Static Public Member Functions

Data Fields

Private Member Functions

Static Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ asciifier()

◆ buildFormula()

◆ checkAllCategoriesWithExamples()

◆ checkAlwaysFalseCategories()

◆ checkAlwaysTrueCategories()

◆ getAll()

◆ getById()

◆ getUSAsciiClone()

◆ reduceFormula()

◆ reverseFormula()

Field Documentation

◆ $baseLanguage

◆ $categories

◆ $formula

◆ $id

◆ $name

◆ $script

◆ $supersededBy

◆ $territory