xref: /webtrees/app/Elements/DescriptiveTitle.php (revision 5aa15f0cb4850a749ed8a36424cc3c3da095c70d)
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2022 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\Elements;
21
22use Fisharebest\Webtrees\Tree;
23
24/**
25 * DESCRIPTIVE_TITLE := {Size=1:248}
26 * The title of a work, record, item, or object.
27 */
28class DescriptiveTitle extends AbstractElement
29{
30    /**
31     * Convert a value to a canonical form.
32     *
33     * @param string $value
34     *
35     * @return string
36     */
37    public function canonical(string $value): string
38    {
39        return $this->canonicalText($value);
40    }
41
42    /**
43     * An edit control for this data.
44     *
45     * @param string $id
46     * @param string $name
47     * @param string $value
48     * @param Tree   $tree
49     *
50     * @return string
51     */
52    public function edit(string $id, string $name, string $value, Tree $tree): string
53    {
54        return $this->editTextArea($id, $name, $value);
55    }
56}
57