Code Coverage
 
Classes and Traits
Functions and Methods
Lines
Total
0.00% covered (danger)
0.00%
0 / 1
66.67% covered (warning)
66.67%
2 / 3
CRAP
98.36% covered (success)
98.36%
60 / 61
Inflector
0.00% covered (danger)
0.00%
0 / 1
66.67% covered (warning)
66.67%
2 / 3
31
98.36% covered (success)
98.36%
60 / 61
 __construct
0.00% covered (danger)
0.00%
0 / 1
2
0.00% covered (danger)
0.00%
0 / 1
 singularize
100.00% covered (success)
100.00%
1 / 1
15
100.00% covered (success)
100.00%
30 / 30
 pluralize
100.00% covered (success)
100.00%
1 / 1
15
100.00% covered (success)
100.00%
30 / 30
<?php
/*
 * This file is part of the Symfony package.
 *
 * (c) Fabien Potencier <fabien@symfony.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace Symfony\Component\Inflector;
/**
 * Converts words between singular and plural forms.
 *
 * @author Bernhard Schussek <bschussek@gmail.com>
 */
final class Inflector
{
    /**
     * Map English plural to singular suffixes.
     *
     * @see http://english-zone.com/spelling/plurals.html
     */
    private static $pluralMap = [
        // First entry: plural suffix, reversed
        // Second entry: length of plural suffix
        // Third entry: Whether the suffix may succeed a vocal
        // Fourth entry: Whether the suffix may succeed a consonant
        // Fifth entry: singular suffix, normal
        // bacteria (bacterium), criteria (criterion), phenomena (phenomenon)
        ['a', 1, true, true, ['on', 'um']],
        // nebulae (nebula)
        ['ea', 2, true, true, 'a'],
        // services (service)
        ['secivres', 8, true, true, 'service'],
        // mice (mouse), lice (louse)
        ['eci', 3, false, true, 'ouse'],
        // geese (goose)
        ['esee', 4, false, true, 'oose'],
        // fungi (fungus), alumni (alumnus), syllabi (syllabus), radii (radius)
        ['i', 1, true, true, 'us'],
        // men (man), women (woman)
        ['nem', 3, true, true, 'man'],
        // children (child)
        ['nerdlihc', 8, true, true, 'child'],
        // oxen (ox)
        ['nexo', 4, false, false, 'ox'],
        // indices (index), appendices (appendix), prices (price)
        ['seci', 4, false, true, ['ex', 'ix', 'ice']],
        // selfies (selfie)
        ['seifles', 7, true, true, 'selfie'],
        // movies (movie)
        ['seivom', 6, true, true, 'movie'],
        // feet (foot)
        ['teef', 4, true, true, 'foot'],
        // geese (goose)
        ['eseeg', 5, true, true, 'goose'],
        // teeth (tooth)
        ['hteet', 5, true, true, 'tooth'],
        // news (news)
        ['swen', 4, true, true, 'news'],
        // series (series)
        ['seires', 6, true, true, 'series'],
        // babies (baby)
        ['sei', 3, false, true, 'y'],
        // accesses (access), addresses (address), kisses (kiss)
        ['sess', 4, true, false, 'ss'],
        // analyses (analysis), ellipses (ellipsis), fungi (fungus),
        // neuroses (neurosis), theses (thesis), emphases (emphasis),
        // oases (oasis), crises (crisis), houses (house), bases (base),
        // atlases (atlas)
        ['ses', 3, true, true, ['s', 'se', 'sis']],
        // objectives (objective), alternative (alternatives)
        ['sevit', 5, true, true, 'tive'],
        // drives (drive)
        ['sevird', 6, false, true, 'drive'],
        // lives (life), wives (wife)
        ['sevi', 4, false, true, 'ife'],
        // moves (move)
        ['sevom', 5, true, true, 'move'],
        // hooves (hoof), dwarves (dwarf), elves (elf), leaves (leaf), caves (cave), staves (staff)
        ['sev', 3, true, true, ['f', 've', 'ff']],
        // axes (axis), axes (ax), axes (axe)
        ['sexa', 4, false, false, ['ax', 'axe', 'axis']],
        // indexes (index), matrixes (matrix)
        ['sex', 3, true, false, 'x'],
        // quizzes (quiz)
        ['sezz', 4, true, false, 'z'],
        // bureaus (bureau)
        ['suae', 4, false, true, 'eau'],
        // fees (fee), trees (tree), employees (employee)
        ['see', 3, true, true, 'ee'],
        // roses (rose), garages (garage), cassettes (cassette),
        // waltzes (waltz), heroes (hero), bushes (bush), arches (arch),
        // shoes (shoe)
        ['se', 2, true, true, ['', 'e']],
        // tags (tag)
        ['s', 1, true, true, ''],
        // chateaux (chateau)
        ['xuae', 4, false, true, 'eau'],
        // people (person)
        ['elpoep', 6, true, true, 'person'],
    ];
    /**
     * Map English singular to plural suffixes.
     *
     * @see http://english-zone.com/spelling/plurals.html
     */
    private static $singularMap = [
        // First entry: singular suffix, reversed
        // Second entry: length of singular suffix
        // Third entry: Whether the suffix may succeed a vocal
        // Fourth entry: Whether the suffix may succeed a consonant
        // Fifth entry: plural suffix, normal
        // criterion (criteria)
        ['airetirc', 8, false, false, 'criterion'],
        // nebulae (nebula)
        ['aluben', 6, false, false, 'nebulae'],
        // children (child)
        ['dlihc', 5, true, true, 'children'],
        // prices (price)
        ['eci', 3, false, true, 'ices'],
        // services (service)
        ['ecivres', 7, true, true, 'services'],
        // lives (life), wives (wife)
        ['efi', 3, false, true, 'ives'],
        // selfies (selfie)
        ['eifles', 6, true, true, 'selfies'],
        // movies (movie)
        ['eivom', 5, true, true, 'movies'],
        // lice (louse)
        ['esuol', 5, false, true, 'lice'],
        // mice (mouse)
        ['esuom', 5, false, true, 'mice'],
        // geese (goose)
        ['esoo', 4, false, true, 'eese'],
        // houses (house), bases (base)
        ['es', 2, true, true, 'ses'],
        // geese (goose)
        ['esoog', 5, true, true, 'geese'],
        // caves (cave)
        ['ev', 2, true, true, 'ves'],
        // drives (drive)
        ['evird', 5, false, true, 'drives'],
        // objectives (objective), alternative (alternatives)
        ['evit', 4, true, true, 'tives'],
        // moves (move)
        ['evom', 4, true, true, 'moves'],
        // staves (staff)
        ['ffats', 5, true, true, 'staves'],
        // hooves (hoof), dwarves (dwarf), elves (elf), leaves (leaf)
        ['ff', 2, true, true, 'ffs'],
        // hooves (hoof), dwarves (dwarf), elves (elf), leaves (leaf)
        ['f', 1, true, true, ['fs', 'ves']],
        // arches (arch)
        ['hc', 2, true, true, 'ches'],
        // bushes (bush)
        ['hs', 2, true, true, 'shes'],
        // teeth (tooth)
        ['htoot', 5, true, true, 'teeth'],
        // bacteria (bacterium), criteria (criterion), phenomena (phenomenon)
        ['mu', 2, true, true, 'a'],
        // men (man), women (woman)
        ['nam', 3, true, true, 'men'],
        // people (person)
        ['nosrep', 6, true, true, ['persons', 'people']],
        // bacteria (bacterium), criteria (criterion), phenomena (phenomenon)
        ['noi', 3, true, true, 'ions'],
        // seasons (season), treasons (treason), poisons (poison), lessons (lesson)
        ['nos', 3, true, true, 'sons'],
        // bacteria (bacterium), criteria (criterion), phenomena (phenomenon)
        ['no', 2, true, true, 'a'],
        // echoes (echo)
        ['ohce', 4, true, true, 'echoes'],
        // heroes (hero)
        ['oreh', 4, true, true, 'heroes'],
        // atlases (atlas)
        ['salta', 5, true, true, 'atlases'],
        // irises (iris)
        ['siri', 4, true, true, 'irises'],
        // analyses (analysis), ellipses (ellipsis), neuroses (neurosis)
        // theses (thesis), emphases (emphasis), oases (oasis),
        // crises (crisis)
        ['sis', 3, true, true, 'ses'],
        // accesses (access), addresses (address), kisses (kiss)
        ['ss', 2, true, false, 'sses'],
        // syllabi (syllabus)
        ['suballys', 8, true, true, 'syllabi'],
        // buses (bus)
        ['sub', 3, true, true, 'buses'],
        // circuses (circus)
        ['suc', 3, true, true, 'cuses'],
        // fungi (fungus), alumni (alumnus), syllabi (syllabus), radii (radius)
        ['su', 2, true, true, 'i'],
        // news (news)
        ['swen', 4, true, true, 'news'],
        // feet (foot)
        ['toof', 4, true, true, 'feet'],
        // chateaux (chateau), bureaus (bureau)
        ['uae', 3, false, true, ['eaus', 'eaux']],
        // oxen (ox)
        ['xo', 2, false, false, 'oxen'],
        // hoaxes (hoax)
        ['xaoh', 4, true, false, 'hoaxes'],
        // indices (index)
        ['xedni', 5, false, true, ['indicies', 'indexes']],
        // boxes (box)
        ['xo', 2, false, true, 'oxes'],
        // indexes (index), matrixes (matrix)
        ['x', 1, true, false, ['cies', 'xes']],
        // appendices (appendix)
        ['xi', 2, false, true, 'ices'],
        // babies (baby)
        ['y', 1, false, true, 'ies'],
        // quizzes (quiz)
        ['ziuq', 4, true, false, 'quizzes'],
        // waltzes (waltz)
        ['z', 1, true, true, 'zes'],
    ];
    /**
     * A list of words which should not be inflected, reversed.
     */
    private static $uninflected = [
        'atad',
        'reed',
        'kcabdeef',
        'hsif',
        'ofni',
        'esoom',
        'seires',
        'peehs',
        'seiceps',
    ];
    /**
     * This class should not be instantiated.
     */
    private function __construct()
    {
    }
    /**
     * Returns the singular form of a word.
     *
     * If the method can't determine the form with certainty, an array of the
     * possible singulars is returned.
     *
     * @param string $plural A word in plural form
     *
     * @return string|array The singular form or an array of possible singular forms
     */
    public static function singularize(string $plural)
    {
        $pluralRev = strrev($plural);
        $lowerPluralRev = strtolower($pluralRev);
        $pluralLength = \strlen($lowerPluralRev);
        // Check if the word is one which is not inflected, return early if so
        if (\in_array($lowerPluralRev, self::$uninflected, true)) {
            return $plural;
        }
        // The outer loop iterates over the entries of the plural table
        // The inner loop $j iterates over the characters of the plural suffix
        // in the plural table to compare them with the characters of the actual
        // given plural suffix
        foreach (self::$pluralMap as $map) {
            $suffix = $map[0];
            $suffixLength = $map[1];
            $j = 0;
            // Compare characters in the plural table and of the suffix of the
            // given plural one by one
            while ($suffix[$j] === $lowerPluralRev[$j]) {
                // Let $j point to the next character
                ++$j;
                // Successfully compared the last character
                // Add an entry with the singular suffix to the singular array
                if ($j === $suffixLength) {
                    // Is there any character preceding the suffix in the plural string?
                    if ($j < $pluralLength) {
                        $nextIsVocal = false !== strpos('aeiou', $lowerPluralRev[$j]);
                        if (!$map[2] && $nextIsVocal) {
                            // suffix may not succeed a vocal but next char is one
                            break;
                        }
                        if (!$map[3] && !$nextIsVocal) {
                            // suffix may not succeed a consonant but next char is one
                            break;
                        }
                    }
                    $newBase = substr($plural, 0, $pluralLength - $suffixLength);
                    $newSuffix = $map[4];
                    // Check whether the first character in the plural suffix
                    // is uppercased. If yes, uppercase the first character in
                    // the singular suffix too
                    $firstUpper = ctype_upper($pluralRev[$j - 1]);
                    if (\is_array($newSuffix)) {
                        $singulars = [];
                        foreach ($newSuffix as $newSuffixEntry) {
                            $singulars[] = $newBase.($firstUpper ? ucfirst($newSuffixEntry) : $newSuffixEntry);
                        }
                        return $singulars;
                    }
                    return $newBase.($firstUpper ? ucfirst($newSuffix) : $newSuffix);
                }
                // Suffix is longer than word
                if ($j === $pluralLength) {
                    break;
                }
            }
        }
        // Assume that plural and singular is identical
        return $plural;
    }
    /**
     * Returns the plural form of a word.
     *
     * If the method can't determine the form with certainty, an array of the
     * possible plurals is returned.
     *
     * @param string $singular A word in singular form
     *
     * @return string|array The plural form or an array of possible plural forms
     */
    public static function pluralize(string $singular)
    {