README

This package allows you to get the correct plural form for words based on the Language Plural Rules defined in Unicode. You can get forms for cardinal and ordinal numbers, as well as ranges of cardinal numbers.

To check which languages are supported, check the src folder. In you need another language, create an issue or a PR.

Installation

With Composer:

composer require oblik/pluralization

Usage

There are six plural categories and each is represented with a constant: ZERO, ONE, TWO, FEW, MANY, and OTHER. You should use those constants in your code:

namespace Oblik\Pluralization {
    function place($n)
    {
        $class = LANGUAGES['en'];
        $form = $class::getOrdinal($n);

        switch ($form) {
            case ONE: return "{$n}st";
            case TWO: return "{$n}nd";
            case FEW: return "{$n}rd";
            case OTHER: return "{$n}th";
        }
    }

    echo place(1);    // 1st
    echo place(2);    // 2nd
    echo place(103);  // 103rd
    echo place(14);   // 14th
}

API

Each language is represented by a class that extends the abstract Language class and has the following static methods:

`getCardinal($number)`

Returns the plural form of a cardinal number.

`getOrdinal($number)`

Returns the plural form of an ordinal number.

`getRange($start, $end)`

Returns the plural form of a range.

`formName($form)`

Returns the string name of a form constant.

Example

use Oblik\Pluralization\EnglishLanguage;

EnglishLanguage::getCardinal(0);    // => Oblik\Pluralization\OTHER
EnglishLanguage::getCardinal(1);    // => Oblik\Pluralization\ONE
EnglishLanguage::getCardinal(1.5);  // => Oblik\Pluralization\OTHER
EnglishLanguage::getCardinal(2);    // => Oblik\Pluralization\OTHER

EnglishLanguage::getOrdinal(2);     // => Oblik\Pluralization\TWO
EnglishLanguage::getOrdinal(3);     // => Oblik\Pluralization\FEW
EnglishLanguage::getOrdinal(4);     // => Oblik\Pluralization\OTHER
EnglishLanguage::getOrdinal(103);   // => Oblik\Pluralization\FEW

EnglishLanguage::getRange(0, 2);    // => Oblik\Pluralization\OTHER
EnglishLanguage::getRange(1, 2);    // => Oblik\Pluralization\OTHER

EnglishLanguage::formName(Oblik\Pluralization\ZERO);    // => "zero"
EnglishLanguage::formName(Oblik\Pluralization\ONE);     // => "one"

To get the correct language class based on a language code, use the LANGUAGES constant:

use const Oblik\Pluralization\LANGUAGES;

$lang = LANGUAGES['en'];  // => "Oblik\Pluralization\EnglishLanguage"
$lang::getCardinal(1);    // => Oblik\Pluralization\ONE

oblik / pluralization

Maintainers

Details