xref: /webtrees/app/Census/CensusColumnSexF.php (revision d11be7027e34e3121be11cc025421873364403f9)

<?php

/**
 * webtrees: online genealogy
 * Copyright (C) 2023 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 <https://www.gnu.org/licenses/>.
 */

declare(strict_types=1);

namespace Fisharebest\Webtrees\Census;

use Fisharebest\Webtrees\Individual;

/**
 * The individual's sex Female?
 */
class CensusColumnSexF extends AbstractCensusColumn implements CensusColumnInterface
{
    protected const MALE = 'M';

    protected const FEMALE = 'F';

    protected const X = 'X';

    /**
     * Generate the likely value of this census column, based on available information.
     * X is the value returned for this column as it is a selection of F column or M
     * column.
     *
     * @param Individual $individual
     * @param Individual $head
     *
     * @return string
     */
    public function generate(Individual $individual, Individual $head): string
    {
        if ($individual->sex() === 'F') {
            return static::X;
        }

        return '';
    }
}