xref: /webtrees/app/Elements/SourceOriginator.php (revision d11be7027e34e3121be11cc025421873364403f9)
1c2ed51d1SGreg Roach<?php
2c2ed51d1SGreg Roach
3c2ed51d1SGreg Roach/**
4c2ed51d1SGreg Roach * webtrees: online genealogy
5*d11be702SGreg Roach * Copyright (C) 2023 webtrees development team
6c2ed51d1SGreg Roach * This program is free software: you can redistribute it and/or modify
7c2ed51d1SGreg Roach * it under the terms of the GNU General Public License as published by
8c2ed51d1SGreg Roach * the Free Software Foundation, either version 3 of the License, or
9c2ed51d1SGreg Roach * (at your option) any later version.
10c2ed51d1SGreg Roach * This program is distributed in the hope that it will be useful,
11c2ed51d1SGreg Roach * but WITHOUT ANY WARRANTY; without even the implied warranty of
12c2ed51d1SGreg Roach * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13c2ed51d1SGreg Roach * GNU General Public License for more details.
14c2ed51d1SGreg Roach * You should have received a copy of the GNU General Public License
15c2ed51d1SGreg Roach * along with this program. If not, see <https://www.gnu.org/licenses/>.
16c2ed51d1SGreg Roach */
17c2ed51d1SGreg Roach
18c2ed51d1SGreg Roachdeclare(strict_types=1);
19c2ed51d1SGreg Roach
20c2ed51d1SGreg Roachnamespace Fisharebest\Webtrees\Elements;
21c2ed51d1SGreg Roach
225aa15f0cSGreg Roachuse Fisharebest\Webtrees\Tree;
235aa15f0cSGreg Roach
24c2ed51d1SGreg Roach/**
25c2ed51d1SGreg Roach * SOURCE_ORIGINATOR := {Size=1:248}
26c2ed51d1SGreg Roach * The person, agency, or entity who created the record. For a published work, this could be the
27c2ed51d1SGreg Roach * author, compiler, transcriber, abstractor, or editor. For an unpublished source, this may be an
28c2ed51d1SGreg Roach * individual, a government agency, church organization, or private organization, etc.
29c2ed51d1SGreg Roach */
30c2ed51d1SGreg Roachclass SourceOriginator extends AbstractElement
31c2ed51d1SGreg Roach{
325aa15f0cSGreg Roach    /**
335aa15f0cSGreg Roach     * Convert a value to a canonical form.
345aa15f0cSGreg Roach     *
355aa15f0cSGreg Roach     * @param string $value
365aa15f0cSGreg Roach     *
375aa15f0cSGreg Roach     * @return string
385aa15f0cSGreg Roach     */
395aa15f0cSGreg Roach    public function canonical(string $value): string
405aa15f0cSGreg Roach    {
415aa15f0cSGreg Roach        return $this->canonicalText($value);
425aa15f0cSGreg Roach    }
435aa15f0cSGreg Roach
445aa15f0cSGreg Roach    /**
455aa15f0cSGreg Roach     * An edit control for this data.
465aa15f0cSGreg Roach     *
475aa15f0cSGreg Roach     * @param string $id
485aa15f0cSGreg Roach     * @param string $name
495aa15f0cSGreg Roach     * @param string $value
505aa15f0cSGreg Roach     * @param Tree   $tree
515aa15f0cSGreg Roach     *
525aa15f0cSGreg Roach     * @return string
535aa15f0cSGreg Roach     */
545aa15f0cSGreg Roach    public function edit(string $id, string $name, string $value, Tree $tree): string
555aa15f0cSGreg Roach    {
565aa15f0cSGreg Roach        return $this->editTextArea($id, $name, $value);
575aa15f0cSGreg Roach    }
58c2ed51d1SGreg Roach}
59