xref: /webtrees/app/Census/CensusColumnSexM.php (revision e873f434551745f888937263ff89e80db3b0f785)
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2023 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\Census;
21
22use Fisharebest\Webtrees\Individual;
23
24/**
25 * The individual's sex Male?
26 */
27class CensusColumnSexM extends AbstractCensusColumn implements CensusColumnInterface
28{
29    protected const string MALE = 'M';
30
31    protected const string FEMALE = 'F';
32
33    protected const string X = 'X';
34
35    /**
36     * Generate the likely value of this census column, based on available information.
37     * X is the value returned for this column as it is a selection of F column or M
38     * column.
39     *
40     * @param Individual $individual
41     * @param Individual $head
42     *
43     * @return string
44     */
45    public function generate(Individual $individual, Individual $head): string
46    {
47        if ($individual->sex() === 'M') {
48            return static::X;
49        }
50
51        return '';
52    }
53}
54