tamtamchik / namecase
This package allows you to convert names into the correct case where possible.
Installs: 301 952
Dependents: 1
Suggesters: 0
Security: 0
Stars: 77
Watchers: 5
Forks: 7
Open Issues: 5
Requires
- php: >=7.3
- ext-mbstring: *
Requires (Dev)
This package is auto-updated.
Last update: 2024-11-06 16:01:19 UTC
README
Forenames and surnames are often stored either entirely in UPPERCASE or lowercase. This package allows you to convert names into the correct case where possible. Although forenames and surnames are typically stored separately if they appear in a single string, whitespace-separated, NameCase deals correctly with them.
Currently, NameCase correctly name-cases names which include any of the following:
Mc, Mac, al, el, ap, bat, ben, bin, binti, binte, da, de, das, dos, delle, della, di, du, del, der, den, ten, ter, la, le, lo, van and von.
It correctly deals with names that contain apostrophes and hyphens, too.
Note
This README.md is for version 3.x.
If you need a PHP 5 compatible version, please use
1.0.x! README.md
Install
Via Composer
$ composer require tamtamchik/namecase
Usage
use \Tamtamchik\NameCase\Formatter; use function \Tamtamchik\NameCase\str_name_case; // As a static call Formatter::nameCase("KEITH"); // => Keith Formatter::nameCase("LEIGH-WILLIAMS"); // => Leigh-Williams Formatter::nameCase("MCCARTHY"); // => McCarthy Formatter::nameCase("O'CALLAGHAN"); // => O'Callaghan Formatter::nameCase("ST. JOHN"); // => St. John Formatter::nameCase("VON STREIT"); // => von Streit Formatter::nameCase("AP LLWYD DAFYDD"); // => ap Llwyd Dafydd Formatter::nameCase("HENRY VIII"); // => Henry VIII Formatter::nameCase("VAN DYKE"); // => van Dyke // Or as an instance $formatter = new Formatter(); $formatter->nameCase("LOUIS XIV"); // => Louis XIV // Or as a function str_name_case("JJ ABRAMS"); // => JJ Abrams // Passing options (see below for details) Formatter::setOptions([ 'lazy' => true, 'irish' => true, 'spanish' => false, 'roman' => true, 'hebrew' => true, 'postnominal' => true, ]); // Or $formatter = new Formatter(['spanish' => true]); // Or $formatter->setOptions([ 'lazy' = false, 'postnominal' => false ]); // Or even Formatter::nameCase("VAN DYKE", ['lazy' = false]); // And for function str_name_case("VAN DYKE", ['lazy' = false]);
Options
lazy
– Default:true
. Do not do anything if the string is already mixed case and the lazy option istrue
.irish
– Default:true
. Correct "Mac" exceptions.spanish
– Default:false
. Correctel, la
and Spanish conjunctions.roman
– Default:true
. Correct Roman numbers.hebrew
– Default:true
. Correctben, bat
.postnominal
– Default:true
. Correct post-nominal e.g.PhD
.
Exclude Post-Nominals
<?php use Tamtamchik\NameCase\Formatter; Formatter::excludePostNominals('MOst'); Formatter::nameCase('ČERNÝ MOST');
Changelog
Please see CHANGELOG for more information on what has changed recently.
Testing & Demo
$ composer tests $ composer demo
Contributing
Please see CONTRIBUTING and CODE_OF_CONDUCT for details.
Security
If you discover any security-related issues, please email yuri.tam.tkachenko@gmail.com instead of using the issue tracker.
Acknowledgements
This library is a port of the Perl library and owes most
of its functionality to the Perl version by Mark Summerfield.
I also used some solutions from Ruby version by Aaron Patterson.
Any bugs in the PHP port are my fault.
Credits
Original PERL Lingua::EN::NameCase
Version:
- Copyright © Mark Summerfield 1998-2014. All Rights Reserved.
- Copyright © Barbie 2014-2019. All Rights Reserved.
Ruby Version:
- Copyright © Aaron Patterson 2006. All Rights Reserved.
PHP Version:
License
The MIT License (MIT). Please see License File for more information.