wapmorgan/morphos

A morphological solution written completely in the PHP language. Supports Russian and English. Provides classes to decline personal names, decline and pluralize nouns and generate cardinal and ordinal numerals.

2.4.1 2017-03-15 17:21 UTC

README

A morphological solution written completely in PHP.

Composer package Latest Stable Version License Total Downloads Latest Unstable Version

Tests & Quality: Build Status Scrutinizer Code Quality

  1. Installation
  2. Quick start
  3. Russian
    1. Personal names
    2. Nouns
    3. Numerals
      1. Cardinal
      2. Ordinal
    4. Cases
  4. English
    1. Nouns
    2. Numerals
      1. Cardinal
  5. Contibuting

Installation

  • Download library through composer:
composer require wapmorgan/morphos

Adapters:

Quick Start

  • Decline russian names:

    var_dump(morphos\Russian\name('Иванов Петр', 'родительный', morphos\NamesDeclension::MAN)); // Иванова Петра
  • Pluralize russian nouns:

    var_dump(morphos\Russian\pluralize('дом', 10)); // домов
  • Generate russian cardinal numerals:

    var_dump(morphos\Russian\CardinalNumeral::generate(567)); // пятьсот шестьдесят семь
  • Generate russian ordinal numerals:

    var_dump(morphos\Russian\OrdinalNumeral::generate(961)); // девятьсот шестьдесят первый
  • Pluralize english nouns:

    var_dump(morphos\English\pluralize('house')); // houses
  • Generate english cardinal numerals:

    var_dump(morphos\English\CardinalNumeral::generate(567)); // five hundred sixty-seven

Russian

Russian morphology shortcuts:

  • morphos\Russian\name($fullname, $case, $gender = AUTO)
  • morphos\Russian\pluralize($noun, $count = 2, $animateness = false)
  • morphos\Russian\CardinalNumeral::generate($number, $gender = self::MALE)
  • morphos\Russian\OrdinalNumeral::generate($number, $gender = self::MALE)

Russian class hierarchy:

morphos\
        Russian\
                CardinalNumeral
                Cases
                GeneralDeclension
                FirstNamesDeclension
                LastNamesDeclension
                MiddleNamesDeclension
                OrdinalNumeral
                Plurality

Personal names

To compound all declension functionality in one call there is nameCase function:

string|array name($name, $case = null, $gender = null)

Arguments:

  • $name - full name as Фамилия Имя or Фамилия Имя Отчество.
  • $case - can be null, one of Cases constants, a string (described below). If not null, a string will be returned. If null, an array will be returned.
  • $gender - NamesDeclension::MAN or NamesDeclension::WOMAN or null for autodetection.

There is three declension classes:

  • FirstNamesDeclension - declension of first names in russian language
  • MiddleNamesDeclension - declension of middle names in russian language
  • LastNamesDeclension - declension of last names in russian language

All declension classes are similar and have four common methods:

  • boolean isMutable($word, $gender = null) - Check if name is mutable.
  • string getCase($word, $case, $gender = null) - Declines name. $case is one constant of morphos\Cases or morphos\Russian\Cases class constants (described below).
  • array getCases($word, $gender = null) - Declines name to all cases.
  • string detectGender($word) - Tries to detect gender for given name.

$gender is NamesDeclension::MAN or NamesDeclension::WOMAN or null for autodetection. Note that detection of middle name and last name can make right decision, but first names sometimes can not be used to determine gender of it's owner. Especially if name is not native Russian name. So just specify gender if you want to declinate first names.

Cases in russian language:

  • nominative case - morphos\Russian\Cases::IMENIT or именительный
  • genitive case - morphos\Russian\Cases::RODIT or родительный
  • dative case - morphos\Russian\Cases::DAT or дательный
  • accusative case - morphos\Russian\Cases::VINIT or винительный
  • ablative case - morphos\Russian\Cases::TVORIT or творительный
  • prepositional case - morphos\Russian\Cases::PREDLOJ or предложный

Examples:

FirstNamesDeclension

$dec = new morphos\Russian\FirstNamesDeclension();

// Get any form of a name:
// for example, let it be Иван
$user_name = 'Иван';

$name = $dec->getCase($user_name, 'родительный'); // Ивана

// If you need all forms, you can get all forms of a name:
var_dump($dec->getCases($user_name));
/* Will produce something like
  array(6) {
    ["nominative"]=>
    string(8) "Иван"
    ["genitive"]=>
    string(10) "Ивана"
    ["dative"]=>
    string(10) "Ивану"
    ["accusative"]=>
    string(10) "Ивана"
    ["ablative"]=>
    string(12) "Иваном"
    ["prepositional"]=>
    string(15) "об Иване"
  }
*/

MiddleNamesDeclension

$dec = new morphos\Russian\MiddleNamesDeclension();

// Get any form of a name:
// for example, let it be Сергеевич
$user_name = 'Сергеевич';

$name = $dec->getCase($user_name, 'родительный'); // Сергеевича

// If you need all forms, you can get all forms of a name:
var_dump($dec->getCases($user_name));
/* Will produce something like
  array(6) {
    ["nominative"]=>
    string(18) "Сергеевич"
    ["genitive"]=>
    string(20) "Сергеевича"
    ["dative"]=>
    string(20) "Сергеевичу"
    ["accusative"]=>
    string(20) "Сергеевича"
    ["ablative"]=>
    string(22) "Сергеевичем"
    ["prepositional"]=>
    string(23) "о Сергеевиче"
  }
*/

LastNamesDeclension

$dec = new morphos\Russian\LastNamesDeclension();

// Get any case of a last name
$user_last_name = 'Иванов';

$dative_last_name = $dec->getCase($user_last_name, 'дательный'); // Иванову

echo 'Мы хотим подарить товарищу '.$dative_last_name.' небольшой презент.';

// If you need all forms, you can get all forms of a name:
var_dump($dec->getCases($user_last_name));
/* Will produce something like
  array(6) {
    ["nominative"]=>
    string(12) "Иванов"
    ["genitive"]=>
    string(14) "Иванова"
    ["dative"]=>
    string(14) "Иванову"
    ["accusative"]=>
    string(14) "Иванова"
    ["ablative"]=>
    string(16) "Ивановым"
    ["prepositional"]=>
    string(19) "об Иванове"
  }
*/

Nouns

Nouns declension

Nouns declension class also have few similar methods but arguments are different:

  • boolean isMutable($word, bool $animateness = false) - Check if noun is mutable.
  • string getCase($word, $case, $animateness = false) - Declines noun.
  • array getCases($word, $animateness = false) - Declines noun to all cases.

Usage:

use morphos\Russian\GeneralDeclension;

$dec = new GeneralDeclension();

// Following code will return original word if it's immutable:
$form = $dec->getCase('поле', 'родительный');

// Get all forms of a word at once:
var_dump($dec->getCases('линейка'));
/* Will produce something like
  array(6) {
    ["nominative"]=>
    string(14) "линейка"
    ["genitive"]=>
    string(14) "линейки"
    ["dative"]=>
    string(14) "линейке"
    ["accusative"]=>
    string(14) "линейку"
    ["ablative"]=>
    string(16) "линейкой"
    ["prepositional"]=>
    string(17) "о линейке"
  }
*/

Nouns pluralization

Plurality class have similar methods but not only:

  • string getCase($word, $case, $animateness = false) - Pluralizes noun and declines.
  • array getCases($word, $animateness = false) - Pluralizes noun and declines to all cases.
  • string @pluralize($word, $count, $animateness = false) - Pluralizes noun to coincide with numeral.

Usage:

use morphos\Russian\Plurality;

$plu = new Plurality();

$word = 'дом';
echo 'Множественное число для '.$word.' - '.$plu->getCase($word, 'именительный'); // дома

// Pluralize word and get all forms:
var_dump($plu->getCases('поле'));
/* Result will be like
  array(6) {
    ["nominative"]=>
    string(8) "поля"
    ["genitive"]=>
    string(10) "полей"
    ["dative"]=>
    string(10) "полям"
    ["accusative"]=>
    string(8) "поля"
    ["ablative"]=>
    string(12) "полями"
    ["prepositional"]=>
    string(13) "о полях"
  }
*/

// Also you can use shortcut
// Pluralize noun to use it with numeral

$count = 10;

echo $count.' '.morphos\Russian\pluralize('дом', $count, false); // result: 10 домов

Numerals

All number creation classes are similar and have three common methods:

  • string getCase($number, $case, $gender = NumeralCreation::MALE) - Get one case of a numeral for a number.
  • array getCases($number, $gender = NumeralCreation::MALE) - Get all case of a numeral for a number.
  • string @generate($number, $gender = NumeralCreation::MALE) - Generates a cardinal or ordinal numeral for a number.

$gender is one of morphos\NumeralCreation constants: MALE or FEMALE or NEUTER.

Cardinal (CardinalNumeral)

Creation of cardinal numerals in russian language.

Create generation class object:

use morphos\NumeralCreation;
use morphos\Russian\CardinalNumeral;

$cardinal = new CardinalNumeral();

Get text representation of a number:

$number = 4351;

$numeral = $cardinal->getCase($number, 'именительный'); // четыре тысячи триста пятьдесят один
$numeral = $cardinal->getCase($number, 'именительный', NumeralCreation::FEMALE); // четыре тысячи триста пятьдесят одна

If you need all forms, you can get all cases of a numeral:

var_dump($cardinal->getCases($number));
/* Will produce something like
  array(6) {
    ["nominative"]=>
    string(66) "четыре тысячи триста пятьдесят один"
    ["genitive"]=>
    string(74) "четырех тысяч трехсот пятидесяти одного"
    ["dative"]=>
    string(80) "четырем тысячам тремстам пятидесяти одному"
    ["accusative"]=>
    string(66) "четыре тысячи триста пятьдесят один"
    ["ablative"]=>
    string(90) "четырьмя тысячами тремястами пятьюдесятью одним"
    ["prepositional"]=>
    string(81) "о четырех тысячах трехстах пятидесяти одном"
  }
*/

Generate numeral of a number:

use morphos\Russian\CardinalNumeral;

echo CardinalNumeral::generate(4351);
// result: четыре тысячи триста пятьдесят один

Ordinal (OrdinalNumeral)

Creation of ordinal numerals in russian language.

Create generation class object:

use morphos\NumeralCreation;
use morphos\Russian\OrdinalNumeral;

$ordinal = new OrdinalNumeral();

Get text representation of a number:

$number = 67945;

$numeral = $ordinal->getCase($number, 'именительный'); // шестьдесят семь тысяч девятьсот сорок пятый
$numeral = $ordinal->getCase($number, 'именительный', NumeralCreation::FEMALE); // шестьдесят семь тысяч девятьсот сорок пятая

If you need all forms, you can get all cases of a numeral:

var_dump($ordinal->getCases($number));
/* Will produce something like
  array(6) {
      ["nominative"]=>
      string(81) "шестьдесят семь тысяч девятьсот сорок пятый"
      ["genitive"]=>
      string(83) "шестьдесят семь тысяч девятьсот сорок пятого"
      ["dative"]=>
      string(83) "шестьдесят семь тысяч девятьсот сорок пятому"
      ["accusative"]=>
      string(81) "шестьдесят семь тысяч девятьсот сорок пятый"
      ["ablative"]=>
      string(81) "шестьдесят семь тысяч девятьсот сорок пятым"
      ["prepositional"]=>
      string(84) "о шестьдесят семь тысяч девятьсот сорок пятом"
    }
*/

Generate numeral of a number:

use morphos\Russian\OrdinalNumeral;

echo CardinalNumeral::generate(67945);
// result: шестьдесят семь тысяч девятьсот сорок пятый

English

English morphology shortcuts:

  • morphos\English\pluralize($word, $count = 2)
  • morphos\English\CardinalNumeral::generate($number)

English class hierarchy:

morphos\
        English\
                CardinalNumeral
                Plurality

Pluralization (Plurality)

Pluralization a word in English:

use morphos\English\Plurality;

echo '10 '.Plurality::pluralize('foot');
// result: 10 feet

Numerals

All number creation classes are similar and have one common methods:

  • string @generate($number) - Generates a cardinal numeral for a number.

Cardinal (CardinalNumeral)

Creation of cardinal numerals in english language.

Create declension class object:

use morphos\English\CardinalNumeral;

Get text representation of a number:

$number = 4351;

$numeral = CardinalNumeral::generate($number); // four thousand, three hundred fifty-one

Contibuting

See CONTRIBUTING.md for this.