app/SurnameTradition/PatrilinealSurnameTradition.php
<?php
/**
* webtrees: online genealogy
* Copyright (C) 2023 webtrees development team
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
declare(strict_types=1);
namespace Fisharebest\Webtrees\SurnameTradition;
use Fisharebest\Webtrees\Elements\NameType;
use Fisharebest\Webtrees\I18N;
use Fisharebest\Webtrees\Individual;
/**
* Children take their father’s surname.
*/
class PatrilinealSurnameTradition extends DefaultSurnameTradition
{
/**
* The name of this surname tradition
*
* @return string
*/
public function name(): string
{
/* I18N: A system where children take their father’s surname */
return I18N::translate('patrilineal');
}
/**
* A short description of this surname tradition
*
* @return string
*/
public function description(): string
{
/* I18N: In the patrilineal surname tradition, ... */
return I18N::translate('Children take their father’s surname.');
}
/**
* What name is given to a new child
*
* @param Individual|null $father
* @param Individual|null $mother
* @param string $sex
*
* @return array<int,string>
*/
public function newChildNames(Individual|null $father, Individual|null $mother, string $sex): array
{
if (preg_match(self::REGEX_SPFX_SURN, $this->extractName($father), $match) === 1) {
$name = $match['NAME'];
$spfx = $match['SPFX'];
$surn = $match['SURN'];
return [
$this->buildName($name, ['TYPE' => NameType::VALUE_BIRTH, 'SPFX' => $spfx, 'SURN' => $surn]),
];
}
return parent::newChildNames($father, $mother, $sex);
}
/**
* What name is given to a new parent
*
* @param Individual $child
* @param string $sex
*
* @return array<int,string>
*/
public function newParentNames(Individual $child, string $sex): array
{
if ($sex === 'M' && preg_match(self::REGEX_SPFX_SURN, $this->extractName($child), $match) === 1) {
$name = $match['NAME'];
$spfx = $match['SPFX'];
$surn = $match['SURN'];
return [
$this->buildName($name, ['TYPE' => NameType::VALUE_BIRTH, 'SPFX' => $spfx, 'SURN' => $surn]),
];
}
return parent::newParentNames($child, $sex);
}
/**
* @param string $name A name
* @param array<string,string> $inflections A list of inflections
*
* @return string An inflected name
*/
protected function inflect(string $name, array $inflections): string
{
foreach ($inflections as $from => $to) {
$name = preg_replace('~' . $from . '~u', $to, $name);
}
return $name;
}
}