function PoHeader::parsePluralForms

Same name in other branches
  1. 9 core/lib/Drupal/Component/Gettext/PoHeader.php \Drupal\Component\Gettext\PoHeader::parsePluralForms()
  2. 8.9.x core/lib/Drupal/Component/Gettext/PoHeader.php \Drupal\Component\Gettext\PoHeader::parsePluralForms()
  3. 10 core/lib/Drupal/Component/Gettext/PoHeader.php \Drupal\Component\Gettext\PoHeader::parsePluralForms()

Parses a Plural-Forms entry from a Gettext Portable Object file header.

Parameters

string $plural_forms: The Plural-Forms entry value.

Return value

array|bool An indexed array of parsed plural formula data. Containing:

  • 'nplurals': The number of plural forms defined by the plural formula.
  • 'plurals': Array of plural positions keyed by plural value.

False when there is no plural string.

Throws

\Exception

File

core/lib/Drupal/Component/Gettext/PoHeader.php, line 194

Class

PoHeader
Gettext PO header handler.

Namespace

Drupal\Component\Gettext

Code

public function parsePluralForms($plural_forms) {
    $plurals = [];
    // First, delete all whitespace.
    $plural_forms = strtr($plural_forms, [
        " " => "",
        "\t" => "",
    ]);
    // Select the parts that define nplurals and plural.
    $nplurals = strstr($plural_forms, "nplurals=");
    if (strpos($nplurals, ";")) {
        // We want the string from the 10th char, because "nplurals=" length is 9.
        $nplurals = substr($nplurals, 9, strpos($nplurals, ";") - 9);
    }
    else {
        return FALSE;
    }
    $plural = strstr($plural_forms, "plural=");
    if (strpos($plural, ";")) {
        // We want the string from the 8th char, because "plural=" length is 7.
        $plural = substr($plural, 7, strpos($plural, ";") - 7);
    }
    else {
        return FALSE;
    }
    // If the number of plurals is zero, we return a default result.
    if ($nplurals == 0) {
        return [
            $nplurals,
            [
                'default' => 0,
            ],
        ];
    }
    // Calculate possible plural positions of different plural values. All known
    // plural formula's are repetitive above 100.
    // For data compression we store the last position the array value
    // changes and store it as default.
    $element_stack = $this->parseArithmetic($plural);
    if ($element_stack !== FALSE) {
        for ($i = 0; $i <= 199; $i++) {
            $plurals[$i] = $this->evaluatePlural($element_stack, $i);
        }
        $default = $plurals[$i - 1];
        $plurals = array_filter($plurals, function ($value) use ($default) {
            return $value != $default;
        });
        $plurals['default'] = $default;
        return [
            $nplurals,
            $plurals,
        ];
    }
    else {
        throw new \Exception('The plural formula could not be parsed.');
    }
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.