xref: /webtrees/app/SurnameTradition/PatrilinealSurnameTradition.php (revision c1010eda29c0909ed4d5d463f32d32bfefdd4dfe)

<?php
/**
 * webtrees: online genealogy
 * Copyright (C) 2018 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 <http://www.gnu.org/licenses/>.
 */
namespace Fisharebest\Webtrees\SurnameTradition;

/**
 * Children take their father’s surname.
 */
class PatrilinealSurnameTradition extends DefaultSurnameTradition implements SurnameTraditionInterface
{
    /**
     * What names are given to a new child
     *
     * @param string $father_name A GEDCOM NAME
     * @param string $mother_name A GEDCOM NAME
     * @param string $child_sex   M, F or U
     *
     * @return string[] Associative array of GEDCOM name parts (SURN, _MARNM, etc.)
     */
    public function newChildNames($father_name, $mother_name, $child_sex)
    {
        if (preg_match(self::REGEX_SPFX_SURN, $father_name, $match)) {
            return array_filter([
                'NAME' => $match['NAME'],
                'SPFX' => $match['SPFX'],
                'SURN' => $match['SURN'],
            ]);
        } else {
            return [
                'NAME' => '//',
            ];
        }
    }

    /**
     * What names are given to a new parent
     *
     * @param string $child_name A GEDCOM NAME
     * @param string $parent_sex M, F or U
     *
     * @return string[] Associative array of GEDCOM name parts (SURN, _MARNM, etc.)
     */
    public function newParentNames($child_name, $parent_sex)
    {
        if ($parent_sex === 'M' && preg_match(self::REGEX_SPFX_SURN, $child_name, $match)) {
            return array_filter([
                'NAME' => $match['NAME'],
                'SPFX' => $match['SPFX'],
                'SURN' => $match['SURN'],
            ]);
        } else {
            return [
                'NAME' => '//',
            ];
        }
    }

    /**
     * @param string   $name        A name
     * @param string[] $inflections A list of inflections
     *
     * @return string An inflected name
     */
    protected function inflect($name, $inflections)
    {
        foreach ($inflections as $from => $to) {
            $name = preg_replace('~' . $from . '~u', $to, $name);
        }

        return $name;
    }
}