Ecodev\Felix\Api\Plural

Complexity

Total Complexity

3

Size/Duplication

Total Lines	32
Duplicated Lines	0 %

Test Coverage

Coverage

92.31%

Importance

Changes	1
Bugs	0	Features	0

1 Method

Rating	Name	Duplication	Size	Complexity
A	make()	0	21	3

<?php

declare(strict_types=1);

namespace Ecodev\Felix\Api;

final class Plural
{
    /**
     * Returns the plural form of the given name.
     *
     * This is **not** necessarily valid english grammar. Its only purpose is for internal usage, not for humans.
     *
     * This **MUST** be kept in sync with Natural's `makePlural()`.
     *
     * This is a bit performance-sensitive, so we should keep it fast and only cover cases that we actually need.
     */
    public static function make(string $name): string
    {
        // Words ending in a y preceded by a vowel form their plurals by adding -s:
        if (preg_match('/[aeiou]y$/', $name)) {
            return $name . 's';
        }

        $plural = $name . 's';

        $replacements = [
            '/ys$/' => 'ies',
            '/ss$/' => 'ses',
            '/xs$/' => 'xes',
        ];

        $plural = preg_replace(array_keys($replacements), $replacements, $plural);
        if ($plural === null) {
            throw new Exception('Error while making plural');
        }

        return $plural;
    }
}