xref: /webtrees/app/Elements/GenerationsOfDescendants.php (revision c2ed51d13a57743094c11c8fe84befd9d4f158cd)

<?php

/**
 * webtrees: online genealogy
 * Copyright (C) 2021 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\Elements;

use Fisharebest\Webtrees\Tree;

/**
 * GENERATIONS_OF_DESCENDANTS := {Size=1:4}
 * The number of generations of descendants included in this transmission. This
 * value is usually provided when FamilySearch programs build a GEDCOM file for
 * a patron requesting a download of descendants.
 */
class GenerationsOfDescendants extends AbstractElement
{
    protected const MAX_LENGTH = 4;

    /**
     * Display the value of this type of element.
     *
     * @param string $value
     * @param Tree   $tree
     *
     * @return string
     */
    public function value(string $value, Tree $tree): string
    {
        return $this->valueNumeric($value);
    }
}