aait/php-name-parser

PHP library to split names into their respective components (first, last, etc). Fork of joshfraser/PHP-Name-Parser

1.0.1 2017-10-19 07:32 UTC

Requires

• php: ~5.3.0|~5.4.0|~5.5.0|~5.6.0|~7.0.0|~7.1.0|~7.2.0

Apache-2.0

README

PHP library to split names into their respective components. Besides detecting first and last names, this library attempts to handle prefixes, suffixes, initials and compound last names like "Von Fange". It also normalizes prefixes (Mister -> Mr.) and fixes capitalization (JOHN SMITH -> John Smith).

Usage:

include("parser.php");

$parser = new FullNameParser();
$parser->parse_name("Mr Anthony R Von Fange III");

Results:

Array (
	[nickname] =>
    [salutation] => Mr.
    [fname] => Anthony
    [initials] => R
    [lname] => Von Fange
    [suffix] => III
)

The algorithm:

We start by splitting the full name into separate words. We then do a dictionary lookup on the first and last words to see if they are a common prefix or suffix. Next, we take the middle portion of the string (everything minus the prefix & suffix) and look at everything except the last word of that string. We then loop through each of those words concatenating them together to make up the first name. While we’re doing that, we watch for any indication of a compound last name. It turns out that almost every compound last name starts with 1 of 16 prefixes (Von, Van, Vere, etc). If we see one of those prefixes, we break out of the first name loop and move on to concatenating the last name. We handle the capitalization issue by checking for camel-case before uppercasing the first letter of each word and lowercasing everything else. I wrote special cases for periods and dashes. We also have a couple other special cases, like ignoring words in parentheses all-together.

Check examples.php for the test suite and examples of how various name formats are parsed.

To-do

• Handle the "Lname, Fname" format
• Support non-English names (handle unicode characters & better understand global naming rules)
• Separate the parsing of the name from the normalization & capitalization & make those optional.
• Add common name libraries to allow for things like gender detection

Same logic, different languages

• Name Parser in Java
• Name Parser in JavaScript

Credits & license:

• Read more about the inspiration for this PHP Name Parser library by Josh Fraser
• Special thanks to Josh Jones, Timothy Wood, Michael Waskosky, Eric Celeste and Josh Houghtelin for their contributions. Pull requests are always welcome as long as you don't break the test suite.
• Released under Apache 2.0 license