PHP Classes

PHP Person Name Case Corrector: Correct the case of personal names

Recommend this page to a friend!
  Info   View files Example   View files View files (15)   DownloadInstall with Composer Download .zip   Reputation   Support forum   Blog    
Last Updated Ratings Unique User Downloads Download Rankings
2020-03-10 (2 months ago) RSS 2.0 feedNot enough user ratingsTotal: 100 All time: 9,358 This week: 307Up
Version License PHP version Categories
namecase 2.1.1MIT/X Consortium ...7.2Localization, PHP 5, Text processing
Description Author

This class can be used to correct the case of personal names.

It can take a string of a personal name and convert the case of the its letters if possible to make the names appear correctly.

The class can also detect the country of origin of some well known personal names or tell if a given name is the lazy name of the full name for being an abbreviation.

Innovation Award
PHP Programming Innovation award winner
February 2020
Winner
Some systems of the past may have forced storing the names of people in all upper case letters or other form that is not the correct way to write their names.

This class can fix the case of personal names of people of several countries when the case is of the letters is not correct.

Manuel Lemos
  Performance   Level  
Name: Yuriy Tkachenko <contact>
Classes: 2 packages by
Country: Russian Federation Russian Federation
Age: 32
All time rank: 3743105 in Russian Federation Russian Federation
Week rank: 666 Up27 in Russian Federation Russian Federation Up
Innovation award
Innovation award
Nominee: 2x

Winner: 1x

Details

NameCase

[![Latest Version on Packagist][ico-version]][link-packagist] [![Software License][ico-license]](LICENSE.md) [![Build Status][ico-travis]][link-travis] [![Coverage Status][ico-scrutinizer]][link-scrutinizer] [![Quality Score][ico-code-quality]][link-code-quality] [![Total Downloads][ico-downloads]][link-downloads] [![SensioLabsInsight][ico-insight]][link-insight]

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 do 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 which contain apostrophes and hyphens too.

> Warning! This README.md is for version 2.0.x. > If you need PHP 5 compatible version, please use 1.0.x! README.md

Install

Via Composer

$ composer require tamtamchik/namecase

Usage

use \Tamtamchik\NameCase\Formatter;

// 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

// Passing options
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]);

Options

  • lazy ? Default: true. Do not do anything if string is already mixed case and lazy option is true.
  • irish ? Default: true. Correct "Mac" exceptions.
  • spanish ? Default: false. Correct el, la and spanish conjunctions.
  • roman ? Default: true. Correct roman numbers.
  • hebrew ? Default: true. Correct ben, bat.
  • postnominal ? Default: true. Correct post-nominal e.g. PhD.

Global function

This package used to have global function str_name_case. Now it does not have it anymore. But, if you still need to have it, use this snippet.

<?php

use Tamtamchik\NameCase\Formatter;

if ( ! function_exists('str_name_case')) {

    /
     * Wrapper for NameCase object to be used as global function.
     *
     * @param string $string  - string to NameCase.
     * @param array  $options - options for NameCase.
     *
     * @return string
     */
    function str_name_case($string, $options = [])
    {
        return Formatter::nameCase($string, $options);
    }
}

Exclude Post-Nominals

<?php

use Tamtamchik\NameCase\Formatter;

Formatter::excludePostNominals('MOst');

Formatter::nameCase('?ERNƯ MOST');

Changelog

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 &copy; Mark Summerfield 1998-2014. All Rights Reserved.
  • Copyright &copy; Barbie 2014-2019. All Rights Reserved.

Ruby Version:

  • Copyright &copy; Aaron Patterson 2006. All Rights Reserved.

PHP Version:

  • [Yuri Tkachenko][link-author]
  • [All Contributors][link-contributors]

License

The MIT License (MIT). Please see License File for more information.

[ico-version]: https://img.shields.io/packagist/v/tamtamchik/namecase.svg?style=flat-square [ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square [ico-travis]: https://img.shields.io/travis/tamtamchik/namecase/master.svg?style=flat-square [ico-scrutinizer]: https://img.shields.io/scrutinizer/coverage/g/tamtamchik/namecase.svg?style=flat-square [ico-code-quality]: https://img.shields.io/scrutinizer/g/tamtamchik/namecase.svg?style=flat-square [ico-downloads]: https://img.shields.io/packagist/dt/tamtamchik/namecase.svg?style=flat-square [ico-insight]: https://img.shields.io/sensiolabs/i/660fea1e-d105-4064-9caa-f47e8a282f2a.svg?style=flat-square

[link-packagist]: https://packagist.org/packages/tamtamchik/namecase [link-travis]: https://travis-ci.org/tamtamchik/namecase [link-scrutinizer]: https://scrutinizer-ci.com/g/tamtamchik/namecase/code-structure [link-code-quality]: https://scrutinizer-ci.com/g/tamtamchik/namecase [link-downloads]: https://packagist.org/packages/tamtamchik/namecase [link-author]: https://github.com/tamtamchik [link-contributors]: ../../contributors [link-insight]: https://insight.sensiolabs.com/projects/660fea1e-d105-4064-9caa-f47e8a282f2a

  Files folder image Files  
File Role Description
Files folder imageexamples (1 file)
Files folder imagesrc (1 file)
Files folder imagetests (3 files)
Accessible without login Plain text file .editorconfig Data Auxiliary data
Accessible without login Plain text file .scrutinizer.yml Data Auxiliary data
Accessible without login Plain text file .travis.yml Data Auxiliary data
Accessible without login Plain text file CHANGELOG.md Data Auxiliary data
Accessible without login Plain text file composer.json Data Auxiliary data
Accessible without login Plain text file CONDUCT.md Data Auxiliary data
Accessible without login Plain text file CONTRIBUTING.md Data Auxiliary data
Accessible without login Plain text file LICENSE.md Lic. License text
Accessible without login Plain text file phpunit.xml.dist Data Auxiliary data
Accessible without login Plain text file README.md Doc. Documentation

  Files folder image Files  /  examples  
File Role Description
  Accessible without login Plain text file demo.php Example Example script

  Files folder image Files  /  src  
File Role Description
  Plain text file Formatter.php Class Class source

  Files folder image Files  /  tests  
File Role Description
  Plain text file NameCaseTest.php Class Class source
  Plain text file OptionsTest.php Class Class source
  Plain text file PostNominalsTest.php Class Class source

 Version Control Unique User Downloads Download Rankings  
 100%
Total:100
This week:0
All time:9,358
This week:307Up

For more information send a message to info at phpclasses dot org.