xref: /webtrees/app/SurnameTradition/PatrilinealSurnameTradition.php (revision 01ffdfd0eecd9ab07c810118a9c56e450f5d4323) 
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2021 webtrees development team
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program. If not, see <https://www.gnu.org/licenses/>.
16 */
17
18declare(strict_types=1);
19
20namespace Fisharebest\Webtrees\SurnameTradition;
21
22use Fisharebest\Webtrees\Individual;
23
24/**
25 * Children take their father’s surname.
26 */
27class PatrilinealSurnameTradition extends DefaultSurnameTradition
28{
29    /**
30     * What name is given to a new child
31     *
32     * @param Individual|null $father
33     * @param Individual|null $mother
34     * @param string          $sex
35     *
36     * @return array<int,string>
37     */
38    public function newChildNames(?Individual $father, ?Individual $mother, string $sex): array
39    {
40        if (preg_match(self::REGEX_SPFX_SURN, $this->extractName($father), $match)) {
41            $name = $match['NAME'];
42            $spfx = $match['SPFX'];
43            $surn = $match['SURN'];
44
45            return [
46                $this->buildName($name, ['TYPE' => 'birth', 'SPFX' => $spfx, 'SURN' => $surn]),
47            ];
48        }
49
50        return parent::newChildNames($father, $mother, $sex);
51    }
52
53    /**
54     * What name is given to a new parent
55     *
56     * @param Individual $child
57     * @param string     $sex
58     *
59     * @return array<int,string>
60     */
61    public function newParentNames(Individual $child, string $sex): array
62    {
63        if ($sex === 'M' && preg_match(self::REGEX_SPFX_SURN, $this->extractName($child), $match)) {
64            $name = $match['NAME'];
65            $spfx = $match['SPFX'];
66            $surn = $match['SURN'];
67
68            return [
69                $this->buildName($name, ['TYPE' => 'birth', 'SPFX' => $spfx, 'SURN' => $surn]),
70            ];
71        }
72
73        return parent::newParentNames($child, $sex);
74    }
75
76    /**
77     * @param string               $name        A name
78     * @param array<string,string> $inflections A list of inflections
79     *
80     * @return string An inflected name
81     */
82    protected function inflect(string $name, array $inflections): string
83    {
84        foreach ($inflections as $from => $to) {
85            $name = preg_replace('~' . $from . '~u', $to, $name);
86        }
87
88        return $name;
89    }
90}
91