MagicLegend / namecase

This package allows you to convert names into the correct case where possible.

Home Page:http://tamtamchika.net/namecase

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

NameCase

Latest Version on Packagist Software License Build Status Coverage Status Quality Score Total Downloads SensioLabsInsight

Forenames and surnames are often stored either wholly in UPPERCASE or wholly in lowercase. This package allows you to convert names into the correct case where possible. Although forenames and surnames are normally stored separately if they do appear in a single string, whitespace separated, NameCase deals correctly with them.

Currently correctly name cases names which include any of the following:

Mc, Mac, al, el, ap, da, de, delle, della, di, du, del, der, den, la, le, lo, van and von.

It correctly deals with names which contain apostrophes and hyphens too.

Warning! This library contains global str_name_case function, that potentially can break your function with this name. Now you are warned!

Install

Via Composer

$ composer require tamtamchik/namecase

Warning! For PHP < 5.6, please be sure to setup UTF-8 as defaut encoding in your php.ini
mbstring.internal_encoding = UTF-8;

Usage

// As global function
str_name_case("KEITH");               // => Keith
str_name_case("LEIGH-WILLIAMS");      // => Leigh-Williams
str_name_case("MCCARTHY");            // => McCarthy
str_name_case("O'CALLAGHAN");         // => O'Callaghan
str_name_case("ST. JOHN");            // => St. John
str_name_case("VON STREIT");          // => von Streit
str_name_case("AP LLWYD DAFYDD");     // => ap Llwyd Dafydd
str_name_case("HENRY VIII");          // => Henry VIII

use \Tamtamchik\NameCase\Formatter;

// As static call
Formatter::nameCase("VAN DYKE");      // => van Dyke

// As instance
$formatter = new Formatter();
$formatter->nameCase("LOUIS XIV");    // => Louis XIV

Change log

Please see CHANGELOG for more information what has changed recently.

Testing & Demo

$ composer tests
$ composer demo

Contributing

Please see CONTRIBUTING and 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-2015. 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.

About

This package allows you to convert names into the correct case where possible.

http://tamtamchika.net/namecase

License:MIT License


Languages

Language:PHP 100.0%