1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/webtrees_ynh.git synced 2024-09-03 18:26:37 +02:00
webtrees_ynh/sources/app/SurnameTradition/SurnameTraditionInterface.php

67 lines
2.1 KiB
PHP

<?php
/**
* webtrees: online genealogy
* Copyright (C) 2016 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;
/**
* Various cultures have different traditions for the use of surnames within families.
* By providing defaults for new individuals, we can speed up data entry and reduce errors.
*/
interface SurnameTraditionInterface {
/**
* Does this surname tradition change surname at marriage?
*
* @return bool
*/
public function hasMarriedNames();
/**
* Does this surname tradition use surnames?
*
* @return bool
*/
public function hasSurnames();
/**
* 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);
/**
* 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);
/**
* What names are given to a new spouse
*
* @param string $spouse_name A GEDCOM NAME
* @param string $spouse_sex M, F or U
*
* @return string[] Associative array of GEDCOM name parts (SURN, _MARNM, etc.)
*/
public function newSpouseNames($spouse_name, $spouse_sex);
}