cristianoc72/pluralizer

View on GitHub
src/PluralizerInterface.php

Summary

Maintainability
A
0 mins
Test Coverage
<?php declare(strict_types=1);

/**
 * This file is part of the Pluralizer package.
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @license MIT License
 */

namespace cristianoc72\Pluralizer;

/**
 * The generic interface to create a plural form of a name.
 *
 * @author Hans Lellelid <hans@xmpl.org>
 * @author Cristiano Cinotti <cristianocinotti@gmail.com>
 */
interface PluralizerInterface
{
    /**
     * Generate a plural name based on the passed in root.
     *
     * @param  string $root The root that needs to be pluralized (e.g. Author)
     * @return string The plural form of $root.
     */
    public function getPluralForm(string $root): string;

    /**
     * Generate a singular name based on the passed in root.
     *
     * @param  string $root The root that needs to be singularized (e.g. Authors)
     * @return string The singular form of $root.
     */
    public function getSingularForm(string $root): string;
}