xref: /webtrees/app/SurnameTradition/MatrilinealSurnameTradition.php (revision 7e1a70f919760b36ee05568bafb6f2f13dbaf511) 
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2022 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\Elements\NameType;
23use Fisharebest\Webtrees\Individual;
24
25/**
26 * Children take their mother’s surname.
27 */
28class MatrilinealSurnameTradition extends DefaultSurnameTradition
29{
30    /**
31     * What name is given to a new child
32     *
33     * @param Individual|null $father
34     * @param Individual|null $mother
35     * @param string          $sex
36     *
37     * @return array<int,string>
38     */
39    public function newChildNames(?Individual $father, ?Individual $mother, string $sex): array
40    {
41        if (preg_match(self::REGEX_SPFX_SURN, $this->extractName($mother), $match)) {
42            $name = $match['NAME'];
43            $spfx = $match['SPFX'];
44            $surn = $match['SURN'];
45
46            return [
47                $this->buildName($name, ['TYPE' => NameType::VALUE_BIRTH, 'SPFX' => $spfx, 'SURN' => $surn]),
48            ];
49        }
50
51        return parent::newChildNames($father, $mother, $sex);
52    }
53
54    /**
55     * What name is given to a new parent
56     *
57     * @param Individual $child
58     * @param string                           $sex
59     *
60     * @return array<int,string>
61     */
62    public function newParentNames(Individual $child, string $sex): array
63    {
64        if ($sex === 'F' && preg_match(self::REGEX_SPFX_SURN, $this->extractName($child), $match)) {
65            $name = $match['NAME'];
66            $spfx = $match['SPFX'];
67            $surn = $match['SURN'];
68
69            return [
70                $this->buildName($name, ['TYPE' => NameType::VALUE_BIRTH, 'SPFX' => $spfx, 'SURN' => $surn]),
71            ];
72        }
73
74        return parent::newParentNames($child, $sex);
75    }
76}
77