Gettext\Languages\Category Class Reference

A helper class that handles a single category rules (eg 'zero', 'one', ...) and its formula and examples. More...

Collaboration diagram for Gettext\Languages\Category:

Public Member Functions
	__construct ($cldrCategoryId, $cldrFormulaAndExamples)
	Initialize the instance and parse the formula. More...
	getExampleIntegers ()
	Return a list of numbers corresponding to the $examples value. More...

Static Public Member Functions
static	expandExamples ($examples)
	Expand a list of examples as defined by CLDR. More...

Data Fields
	$id
	$formula
	$examples

Detailed Description

A helper class that handles a single category rules (eg 'zero', 'one', ...) and its formula and examples.

Definition at line 9 of file Category.php.

Constructor & Destructor Documentation

__construct()

Gettext\Languages\Category::__construct	(		$cldrCategoryId,
			$cldrFormulaAndExamples
	)

Initialize the instance and parse the formula.

Parameters

string	$cldrCategoryId	The CLDR category identifier (eg 'pluralRule-count-one').
string	$cldrFormulaAndExamples	The CLDR formula and examples (eg 'i = 1 and v = 0 @integer 1').

Exceptions

Exception

Definition at line 32 of file Category.php.

    {
        $matches = array();
        if (!preg_match('/^pluralRule-count-(.+)$/', $cldrCategoryId, $matches)) {
            throw new Exception("Invalid CLDR category: '$cldrCategoryId'");
        }
        if (!in_array($matches[1], CldrData::$categories)) {
            throw new Exception("Invalid CLDR category: '$cldrCategoryId'");
        }
        $this->id = $matches[1];
        $cldrFormulaAndExamplesNormalized = trim(preg_replace('/\s+/', ' ', $cldrFormulaAndExamples));
        if (!preg_match('/^([^@]*)(?:@integer([^@]+))?(?:@decimal(?:[^@]+))?$/', $cldrFormulaAndExamplesNormalized, $matches)) {
            throw new Exception("Invalid CLDR category rule: $cldrFormulaAndExamples");
        }
        $cldrFormula = trim($matches[1]);
        $s = isset($matches[2]) ? trim($matches[2]) : '';
        $this->examples = ($s === '') ? null : $s;
        switch ($this->id) {
            case CldrData::OTHER_CATEGORY:
                if ($cldrFormula !== '') {
                    throw new Exception("The '".CldrData::OTHER_CATEGORY."' category should not have any formula, but it has '$cldrFormula'");
                }
                $this->formula = null;
                break;
            default:
                if ($cldrFormula === '') {
                    throw new Exception("The '{$this->id}' category does not have a formula");
                }
                $this->formula = FormulaConverter::convertFormula($cldrFormula);
                break;
        }
    }

References Gettext\Languages\CldrData\$categories, $s, Gettext\Languages\FormulaConverter\convertFormula(), and Gettext\Languages\CldrData\OTHER_CATEGORY.

Here is the call graph for this function:

Member Function Documentation

expandExamples()

static Gettext\Languages\Category::expandExamples (   $examples )

static

Expand a list of examples as defined by CLDR.

Parameters

string

$examples

A string like '1, 2, 5...7, …'.

Exceptions

Exception

Throws an Exception if we weren't able to expand $examples.

Returns

int[]

Definition at line 79 of file Category.php.

    {
        $result = array();
        $m = null;
        if (substr($examples, -strlen(', …')) === ', …') {
            $examples = substr($examples, 0, strlen($examples) -strlen(', …'));
        }
        foreach (explode(',', str_replace(' ', '', $examples)) as $range) {
            if (preg_match('/^\d+$/', $range)) {
                $result[] = intval($range);
            } elseif (preg_match('/^(\d+)~(\d+)$/', $range, $m)) {
                $from = intval($m[1]);
                $to = intval($m[2]);
                $delta = $to - $from;
                $step = (int) max(1, $delta / 100);
                for ($i = $from; $i < $to; $i += $step) {
                    $result[] = $i;
                }
                $result[] = $to;
            } else {
                throw new Exception("Unhandled test range '$range' in '$examples'");
            }
        }
        if (empty($result)) {
            throw new Exception("No test numbers from '$examples'");
        }
 
        return $result;
    }

References Gettext\Languages\Category\$examples, $from, $i, $m, and $result.

Referenced by Gettext\Languages\Category\getExampleIntegers().

Here is the caller graph for this function:

getExampleIntegers()

Gettext\Languages\Category::getExampleIntegers

(

)

Return a list of numbers corresponding to the $examples value.

Exceptions

Exception

Throws an Exception if we weren't able to expand the examples.

Returns

int[]

Definition at line 69 of file Category.php.

    {
        return self::expandExamples($this->examples);
    }

References Gettext\Languages\Category\expandExamples().

Here is the call graph for this function:

Field Documentation

$examples

Gettext\Languages\Category::$examples

Definition at line 25 of file Category.php.

Referenced by Gettext\Languages\Category\expandExamples().

$formula

Gettext\Languages\Category::$formula

Definition at line 20 of file Category.php.

$id

Gettext\Languages\Category::$id

Definition at line 15 of file Category.php.

---

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

• libs/composer/vendor/gettext/languages/src/Category.php