app/SurnameTradition/PolishSurnameTradition.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. Wives take their husband’s surname. Surnames are inflected to indicate an individual’s sex.
*/
class PolishSurnameTradition extends PaternalSurnameTradition
{
// Inflect a surname for females
private const INFLECT_FEMALE = [
'cki\b' => 'cka',
'dzki\b' => 'dzka',
'ski\b' => 'ska',
'żki\b' => 'żka',
];
// Inflect a surname for males
private const INFLECT_MALE = [
'cka\b' => 'cki',
'dzka\b' => 'dzki',
'ska\b' => 'ski',
'żka\b' => 'żki',
];
/**
* The name of this surname tradition
*
* @return string
*/
public function name(): string
{
return I18N::translateContext('Surname tradition', 'Polish');
}
/**
* A short description of this surname tradition
*
* @return string
*/
public function description(): string
{
/* I18N: In the Polish surname tradition, ... */
return
I18N::translate('Children take their father’s surname.') . ' ' .
I18N::translate('Wives take their husband’s surname.') . ' ' .
I18N::translate('Surnames are inflected to indicate an individual’s gender.');
}
/**
* 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_SURN, $this->extractName($father), $match) === 1) {
if ($sex === 'F') {
$name = $this->inflect($match['NAME'], self::INFLECT_FEMALE);
} else {
$name = $this->inflect($match['NAME'], self::INFLECT_MALE);
}
$surn = $this->inflect($match['SURN'], self::INFLECT_MALE);
return [$this->buildName($name, ['TYPE' => NameType::VALUE_BIRTH, 'SURN' => $surn])];
}
return [$this->buildName('//', ['TYPE' => NameType::VALUE_BIRTH])];
}
/**
* 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_SURN, $this->extractName($child), $match) === 1) {
$name = $this->inflect($match['NAME'], self::INFLECT_MALE);
$surn = $this->inflect($match['SURN'], self::INFLECT_MALE);
return [
$this->buildName($name, ['TYPE' => NameType::VALUE_BIRTH, 'SURN' => $surn]),
];
}
return [$this->buildName('//', ['TYPE' => NameType::VALUE_BIRTH])];
}
/**
* What names are given to a new spouse
*
* @param Individual $spouse
* @param string $sex
*
* @return array<int,string>
*/
public function newSpouseNames(Individual $spouse, string $sex): array
{
if ($sex === 'F' && preg_match(self::REGEX_SURN, $this->extractName($spouse), $match) === 1) {
$name = $this->inflect($match['NAME'], self::INFLECT_FEMALE);
$surn = $this->inflect($match['SURN'], self::INFLECT_MALE);
return [
$this->buildName('//', ['TYPE' => NameType::VALUE_BIRTH]),
$this->buildName($name, ['TYPE' => NameType::VALUE_MARRIED, 'SURN' => $surn]),
];
}
return [$this->buildName('//', ['TYPE' => NameType::VALUE_BIRTH])];
}
}