Pluralizer Library
, (*1)
Pluralizer is a pluralize/singularize library, extracted from Propel Orm codebase., (*2)
Install
Via Composer, (*3)
``` bash
$ composer require cristianoc72/pluralizer, (*4)
## Usage
The library exposes two methods: `getPluralForm`, which transforms a word from singular to plural, and `getSinguarForm`
doing the opposite.
``` php
$pluralizer = new cristianoc72\Pluralizer();
$plural = $pluralizer->getPluralForm('Author');
echo $plural; // Authors
$singular = $pluralizer->getSingularForm('Books');
echo $singular; // Book
The library can transform the most common irregular words:, (*5)
``` php
$pluralizer = new cristianoc72\Pluralizer();, (*6)
$plural = $pluralizer->getPluralForm('tooth');
echo $plural; // teeth, (*7)
Besides, the library exposes two checker method `isPlural` and `isSingular`:
```php
$pluralizer = new cristianoc72\Pluralizer();
var_dump($pluralizer->isPlural('Author'); // (bool) false
var_dump($pluralizer->isPlural('Books')); // (bool) true
Testing
Simply run:
bash
$ vendor/bin/phpunit
A directory coverage
will be automatically created and it contains the code coverage report., (*8)
Contributing
Contributions are welcome and will be fully credited., (*9)
We accept contributions via Pull Requests on Github., (*10)
When you submit a Pull Request, please follow this recommendations:, (*11)
-
PSR-2 Coding Standard - Check the code style and fix it via Php CS Fixer, (*12)
-
Add tests! - Your patch won't be accepted if it doesn't have tests., (*13)
-
Document any change in behaviour - Make sure the README.md
is kept up-to-date., (*14)
-
Send coherent history - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please squash them before submitting., (*15)
Versions
-
0.x: Developmnet versions. v0.5 can be considered stable. PHP 5.6 support.
-
1.x: Stable versions. PHP >= 7.1
Credits
License
The MIT License (MIT). Please see License File for more information., (*16)