Permalink
Switch branches/tags
Nothing to show
Find file
Fetching contributors…
Cannot retrieve contributors at this time
120 lines (109 sloc) 3.33 KB
<?php
/**
* Does cutting and matching stuff with a name string.
* Note that the string has to be UTF8-encoded.
*
*/
class HumanNameParser_Name {
private $str;
function __construct($str)
{
$this->setStr($str);
}
/**
* Checks encoding, normalizes whitespace/punctuation, and sets the name string.
*
* @param String $str a utf8-encoding string.
* @return Bool True on success
*/
public function setStr($str)
{
if (!mb_check_encoding($str)){
throw new Exception("Name is not encoded in UTF-8");
}
$this->str = $str;
$this->norm();
return true;
}
public function getStr()
{
return $this->str;
}
/**
* Uses a regex to chop off and return part of the namestring
* There are two parts: first, it returns the matched substring,
* and then it removes that substring from $this->str and normalizes.
*
* @param string $regex matches the part of the namestring to chop off
* @param integer $submatchIndex which of the parenthesized submatches to use
* @param string $regexFlags optional regex flags
* @return string the part of the namestring that got chopped off
*/
public function chopWithRegex($regex, $submatchIndex = 0, $regexFlags = '')
{
$t = $this;
$regex = $regex . "ui" . $regexFlags; // unicode + case-insensitive
preg_match($regex, $this->str, $m);
$subset = (isset($m[$submatchIndex])) ? $m[$submatchIndex] : '';
if ($subset){
$this->str = preg_replace($regex, ' ', $this->str, -1, $numReplacements);
if ($numReplacements > 1){
throw new Exception("The regex being used to find the name has multiple matches.");
}
$this->norm();
return $subset;
} else {
return '';
}
}
/**
* @return boolean True if only one name component is left - i.e. no spaces or punctuation characters
*/
public function onlyOneComponentLeft()
{
$x = preg_match('#^\s*\w+\s*$#ui', $this->str);
return $x == 1;
}
/*
* Flips the front and back parts of a name with one another.
* Front and back are determined by a specified character somewhere in the
* middle of the string.
*
* @param String $flipAroundChar the character(s) demarcating the two halves you want to flip.
* @return Bool True on success.
*/
public function flip($flipAroundChar)
{
$substrings = preg_split("/$flipAroundChar/u", $this->str);
if (count($substrings) == 2){
$this->str = $substrings[1] . " " . $substrings[0];
$this->norm();
} else if (count($substrings) > 2) {
throw new Exception("Can't flip around multiple '$flipAroundChar' characters in namestring.");
}
return true; // if there's 1 or 0 $flipAroundChar found
}
/**
* Removes extra whitespace and punctuation from $this->str
* Strips whitespace chars from ends, strips redundant whitespace, converts whitespace chars to " ".
*
* @return Bool True on success
*/
private function norm()
{
$this->str = preg_replace( "#^\s*#u", "", $this->str );
$this->str = preg_replace( "#\s*$#u", "", $this->str );
$this->str = preg_replace( "#\s+#u", " ", $this->str );
$this->str = preg_replace( "#,$#u", " ", $this->str );
$this->str = preg_replace( "#[^\s\.\(\)\,\-\w]#ui", '', $this->str);
return true;
}
/**
* Remove the nickname components from this name - ()s etc
*/
public function removeNicknameComponents()
{
$this->str = preg_replace("#[\(\)]#u", '', $this->str);
}
}
?>